[FD3][FD4]OpenTheDoc 3.0 & TocGen 1.0
OpenTheDocOpen ASDocs for FlashDevelop
Download Page
http://code.google.com/p/asrelevant/downloads/listSource Code
http://asrelevant.googlecode.com/svn/tr ... TheDoc_FD4Screenshot
http://asrelevant.googlecode.com/svn/tr ... Doc220.pngChangelog3.0.0 2011-08-11
* Support FD4 (only)
* Real tabbed browsing
- Added tab context menu
- Double click tab bar to create a new tab, middle click a tab to close it
- Shift + click a link will open a new tab
- Shift + click a contents tree node will open a new tab
* Browser supports backward/forward mouse buttons
Installation* Get FlashDevelop
* Get OpenTheDoc, v 3.0.0+ for FD4 only
- If FD4, run OpenTheDoc.fdz
- If FD3, unzip OpenTheDoc.zip and in FD click Tools > Application Files, then put OpenTheDoc.dll into the Plugins folder
* Restart FD
Settings* DocPaths: enter your documentation folders, then click button "Refresh Contents" on (OpenTheDoc) Help Panel to update
- 4 kinds of DocPath accepted:
X:\path\to\alldocs\as3\
X:\path\to\alldocs\*, means all folders in alldocs
$(ProjectPath)\docs, documentation of current project
$(GlobalClasspaths)\..\docs, documentations of global classes
Usage* Move cursor on an word (a class, method, property, etc.) and press F1, the documentation will be open in Help Panel if exsits
* Ctrl+F1, same to F1 but open in a new tab
* Shift+F1 to simply open Help Panel
* Use all three shortcuts to close Help Panel
Help Panel* Shows contents tree of a documentation (A TOC(Table Of Contents) file is needed) (See TocGen below)
* Title search: search titles of TOC files
* Tabbed browsing
* SingleInstanceMode: Only one HelpPanel for multiple FlashDevelop instances
Documentations* Support unorganized documentations with TOC, e.g. AS2 reference in Flash IDE.
* Support Well-organized documentations without TOC. (Use TocGen to generate a TOC).
* Well-organized documentations with TOC, check out
http://livedocs.adobe.com.
* Documentation categories. Categorize by attribute "categories" of the root node of TOC file.
* Categories are also used to sort context search (API search) results, i.e. docs categorized in as2 will be at top of the result list in as2 projects. Possible value: as2, as3, haxe.
Some ASDocs release with Flash IDE and Flex Builder.
Flex3 reference in Flex Builder 3:
Find doc.zip and extract it to SomeFolder\doc\, put toc.xml and tocAPI.xml to the same folder.
toc.xml is for Flex Help, and tocAPI.xml is for Language Reference.
Flex 4 Reference
Download:
http://www.adobe.com/go/learn_flex4_alldocumentation_enIt contains some pdfs (we don't need) and a zip file named AS3_Reference.zip,
unzip it to a folder and generate a TOC for it.
If you find there is something wrong with scrolling on these pages,
here is a work around:
Open style.css in that folder, go to line 1382, and change
Code:
div.mainright {
height:100%;
overflow-y:auto;
bottom:0px;
left:6px;
top:0px;
right:0px;
position:absolute;
}
to
Code:
div.mainright {
height:100%;
/* overflow-y:auto; */
bottom:0px;
left:6px;
top:0px;
right:0px;
position:absolute;
}
contains the ActionScript language elements, core libraries, and component packages and classes for the tools, runtimes, services and servers in the Flash Platform.
http://www.adobe.com/devnet/actionscrip ... ences.htmlThere is a known issue of current release in IE:
http://help.adobe.com/en_US/FlashPlatfo ... -7ffd.htmlQuote:
To view the downloadable version in Internet Explorer, you must make sure to set your security options correctly.
In Internet Explorer, set the security options by using the following procedure:
- Use Tools > Internet Options to open the Internet Options dialog box.
- Select the Security tab.
- Select the Custom Level button.
- Scroll to the “ActiveX controls and plug-ins” option.
- Enable the “Initialize an script ActiveX controls not marked as safe for scripting” option.
The folder name must be "langref".
TocGenGenerate TOC from Standard ASDoc
Download Page
http://code.google.com/p/asrelevant/downloads/listSource Code
http://asrelevant.googlecode.com/svn/trunk/TocGenNote: TOC generated by TocGen is the same as the Flex Help TOC but deferent from Flash Help TOC, cannot be used in Flash IDE.
Jimmy Ye
