PDA

View Full Version : Request for clarity re offline docs



iccle
30 Mar 2008, 2:38 AM
I was not sure where to post this but here goes:

I downloaded extjs almost a week ago, and have spent each day since then trying to figure out why opening the index.html file within the docs folder would not correctly display the documentation.

Firebug gave the error:

this.el has no properties
Component("search")ext-all.js (line 58)
Component(Object applyTo=search tpl=Object loadingText=Searching...)ext-all.js (line 58)
apply()ext-base.js (line 9)
apply()ext-base.js (line 9)
initSearch()docs.js (line 236)
Updater(Object tId=0 status=0 statusText=communication failure)ext-all.js (line 18)
apply(function(), Object el=Object defaultUrl=welcome.html events=Object, [Object tId=0 status=0 statusText=communication failure, Object url=welcome.html scope=Object timeout=30000], undefined)ext-base.js (line 9)
Connection(Object tId=0 status=0 statusText=communication failure, undefined)ext-all.js (line 17)
getViewWidth(Object conn=XMLHttpRequest tId=0, Object scope=Object argument=Object timeout=30000, undefined)ext-base.js (line 10)
getViewWidth()

Thankfully after hunting around in the forums i eventually found a small comment within a post saying that the documentation is designed to be served and not read directly.

Until i found this information i was under the impression that the extjs distribution was broken as it is not immediately clear that the documentation only works when served from a webserver.

Can you add this minor point to a readme.txt within the main distribution, hopefully this will help other people new to extjs (or like me, new to javascript and extjs) being able to read the documentation sooner.

JeffHowden
30 Mar 2008, 10:20 AM
It could be added to a README of some sort. However, it's already an advertised fact on the download page where you got the docs from to begin with:


After downloading Ext
The Ext SDK download contains the entire framework including all source files. Unzip the archive to your web server and navigate to http://your-server/<ext-directory>/docs to view the documentation and complete working examples. Any samples that use XMLHTTPRequest (Ajax) will require an HTTP webserver in order to work correctly.

jay@moduscreate.com
30 Mar 2008, 11:48 AM
I think it would be beneficial to add, to the documen source code, error handling that reports this error. so few people actually read the readme. :(

iccle
1 Apr 2008, 12:59 PM
I completely missed that text doh!

iccle
14 Apr 2008, 9:46 AM
I have also since found that the API search function does not work offline as the api.php required file is not included :( is there any alternative?

vmorale4
14 Apr 2008, 9:51 AM
I have also since found that the API search function does not work offline as the api.php required file is not included :( is there any alternative?

Just use the AIR Documentation, it is much faster and search works there:

http://jackslocum.com/blog/2008/02/14/air-docs/
http://extjs.com/downloads/extdocs-2.0.2.air

My only pet-peeve with the AIR app is that the view source code links are broken (They just open an empty window)

It would also be nice if there was a link to download the AIR documentation from http://extjs.com/download (it is not)