Oh you're right sorry for my mistake everything works perfect!

I thought about this long time ago, but I have forgot...
Added to TODO list.

Great work dude, think you've already fixed/added most of the things I mentioned!


For a moment I thought the "Handle F1" feature wasn't working, but I now realise I had the wrong idea about how it works.

This short cut is only for the context sensitive help* that appears in the OpenTheDoc window. I think I was expecting behaviour like in the Flash IDE, where if there is no context help available the main help window is displayed instead.

What I was trying to do was make F1 the shortcut for the Help Contents window. Could the context help be a separate settable short cut so I could swap the short cuts for these features? (or could they all be integrated into one function like in the Flash IDE?)


* the OpenTheDoc window does not come to the top when a context help search is done - pressing CTRL+F1 makes it come to the top, just pressing F1 does not.


My wish list now looks like this (in order of preference :)

- copy shortcut
- full integration into FD (which would also take care of state saving?)
- help book category sorting

And (as if I hadn't suggested enough things already :) another nice touch would be enabling forward/backward mouse buttons to browse through page history.

Some people might not know where to find this folder (I had to do a bit of searching!)

On my XP system it's here:
C:\Documents and Settings\<user>\Local Settings\Application Data\FlashDevelop\Data\OpenTheDoc

Sorry for this.
I installed FD in standalone mode, so the Data folder is just in the FD installation folder which is esay to find.
Added to readme.

Just had a play with the new title search and, wow! Searches all documentation (including anything I've half written) and really quickly.

This isn't just a handy replacement for the Flash IDE help anymore, it's way better :)


Edit: Ah I see it just searches through the TOCs (explains how it's so fast), still very cool though.

Yes, title search just searches through the nodes of TOCs.
I thought about Full-text search, but I am not sure it is necessary.

Yeah I don't think it's useful enough to justify the effort (I very occasionally do a free text search of the Flash help, but opening Flash would take care of that! :)


Had a quick go with TocGen today, very nice :) My third party documentation now has all its method and property branches completely populated (never bothered with that before).

Would it be possible to make TOC output type selectable? The Flex TOC format isn't that different to the Flash IDE version (I converted the files I generated with a few simple find and replaces).

Sure. I will make it an option in the next version of TocGen.

yay! \o/


...sorry, more feedback... :)

The output window is excellent, it picked up on a couple of incomplete doc files I didn't know about.

The "Overwrite" check box seems to be positioned relative to the window corner (it doesn't move when the window is resized).

Clicking into the "Title" to change its name seems a bit tricky (not quite sure how this is supposed to behave).

Perhaps "Title" could default to the name of the folder in the input path? (for example my Google Maps API docs are in a folder called "GoogleMapsAPI" :)

Not sure how the other attributes of the "book" node translate to the Flex structure...? (manually putting these in isn't hard though)

how can i create a TOC by myself ?

I have a solution right now, but have not enough time.
It won't be long though.

There are two kinds of TOC.
The Flex TOC:
<?xml version="1.0" encoding="UTF-8"?>
<toc label="ActionScript 3.0 Language and Components Reference">
<topic label="All Classes" href="class-summary.html">
<topic label="Accessibility" href="flash/accessibility/Accessibility.html">
<topic label="Public Properties" href="flash/accessibility/Accessibility.html#propertySummary">
<topic label="active" href="flash/accessibility/Accessibility.html#active" />
</topic>
...
Save it to "otd_toc.xml" or "toc.xml" or "tocAPI.xml".
It's a well-structured xml.

The Flash TOC:
<?xml version="1.0" encoding="UTF-8"?>
<book title="ActionScript 3.0 Language and Components Reference" directory="ActionScriptLangRefV3" categories="languagereferences,as3,components3" language="en" version="3.0" sort="mm_3">
<level1 name="All Classes" href="class-summary.html"/>
<level2 name="Accessibility class" href="flash/accessibility/Accessibility.html"/>
<level3 name="Methods" href="flash/accessibility/Accessibility.html#methodSummary"/>
<level4 name="updateProperties()" href="flash/accessibility/Accessibility.html#updateProperties()"/>
<level3 name="Properties" href="flash/accessibility/Accessibility.html#propertySummary"/>
...
Save it to "help_toc.xml".
This kind of TOC is not well-structured and hard to understand, but can work in Flash IDE (except CS4?).
The "level" represent the depth of the node.

Both can work in OpenTheDoc, just put them in the docPath.

thank you reply my message, thanks,and then i will check out documents all i have ,and create toc for each other.

Hello,

I have both problems and praise to share. Thank you for your plugin!

The table of contents generator is immensely helpful. I downloaded this plugin some time ago, but without the generator I was not able to use the language reference I downloaded. Now things are working very well!

For anyone who wants to download a ZIP of the Actionscript reference, visit this page:

http://www.adobe.com/devnet/actionscript/references/

When I visited there were two links available, but they may change over time with new versions of Flex and Flash:

http://help.adobe.com/support/documenta ... angRef.zip
http://livedocs.adobe.com/flex/3/flex3_ ... tation.zip

Be aware -- the Flash 10 reference is 6 MB, but the Flex reference is over 70 MB. It includes references for Flash and Flex classes, as well as PDFs on other Flex topics.

To use these files, download and extract them on your machine, run the path through the table of contents generator, then add it to your DocPaths value in your OpenTheDoc settings.

So far the plugin has been working great, but I experienced a few hiccups with the generator:

1. Minor: The program appears as "Not Responding" when generating the table of contents file. Might be nice if it didn't show up this way.
2. Major: The table of contents file for my Flex 3.3 reference was placed in the wrong folder. It took some time to figure out that this is what had happened.

I first used the table of contents generator with the Flash 10 reference, and placed the files in "D:\Users\{user}\AppData\Local\Adobe\Flash CS3\en\Configuration\HelpPanel\ActionScriptLangRefV3". This worked fine. I then used the table of contents generator for the Flex 3.3 reference instead, which I placed in "D:\Program Files\Adobe\Adobe Flex 3 SDK\documentation\langref".

The table of contents file was placed inside "D:\Users\{user}\AppData\Local\VirtualStore\Program Files\Adobe\Adobe Flex 3 SDK\documentation\langref", which did not allow my reference to work until I found it and copied it into the correct SDK directory. This may have something to do with needing Administrator privileges to write into the SDK folder.

For anyone else who experiences this issue, I hope this comment helps you find where your table of contents file went. I also hope that these links for the latest Actionscript references come in handy for others. Thanks again for your work!