View unanswered posts | View active topics


Reply to topic  [ 122 posts ]  Go to page 1, 2, 3, 4, 5 ... 9  Next
[FD3]OpenTheDoc 2.2 & TocGen 1.0 
Author Message
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post [FD3]OpenTheDoc 2.2 & TocGen 1.0
OpenTheDoc: Open ASDocs for FlashDevelop 3
TocGen: Generate TOC from Standard ASDoc, including 3rd part ASDoc

Download
http://code.google.com/p/asrelevant/downloads/list
dev version: r19

Source File
http://asrelevant.googlecode.com/svn/trunk/OpenTheDoc
http://asrelevant.googlecode.com/svn/trunk/TocGen

* Screenshot

Changes
dev version r19 2009-09-19 download
Fixed: a bug in SaveContentTreeState that causes an exception.

2.2.0 r17 2009-09-19
* Enable WebBrowser shortcuts (Ctrl+C, Ctrl+F, etc.)
* Language detecting. You have to add attribute "categories" to the root node of TOC file, with value: as2, as3, etc.
* HelpPanel = HelpContents + OpenTheDocPanel, like other FD panels
* Save and restore states, size...
* Documentation categories. Categorize by attribute "categories" of the root node of TOC file
* Press Refresh button to update Contents
* 3 more kinds of DocPath:
X:\path\to\alldocs\*, means all folders in alldocs
$(ProjectPath)\docs
$(GlobalClasspaths)\..\docs
* Tabs
* SingleInstanceMode: Only one HelpPanel for multiple FlashDevelop instances
* New search option: "Equals"
* Others refer to Settings

Installation
* Main Menu - Tools - Application Files - Copy OpenTheDoc.dll to the Plugins folder

API Search
* F1 to search when cursor on a word and OpenTheDoc in HelpPenal.
* Ctrl+F1 to search and open in new tab in HelpPenal.

Help Penal
* Supports ASDocs with TOC(Table Of Contents) file.
* Title search.
* Shift+F1 to show, F1, Ctrl+F1, Shift+F1 to hide.
* Tabs
* SingleInstanceMode: Only one HelpPanel for multiple FlashDevelop instances

Documentations
* Unorganized documentations with TOC, e.g. AS2 reference in Flash IDE.
* Well-organized documentations without TOC. You can use TocGen to generate TOCs from standard ASDocs.
* Well-organized documentations with TOC, you can find and download them in http://livedocs.adobe.com.
* Documentation categories. Categorize by attribute "categories" of the root node of TOC file
* 4 kinds of DocPath:
X:\path\to\alldocs\as3\
X:\path\to\alldocs\*, means all folders in alldocs
$(ProjectPath)\docs
$(GlobalClasspaths)\..\docs

Some ASDocs release with Flash IDE, 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.

The Flex 4 Reference
Download: http://www.adobe.com/go/learn_flex4_alldocumentation_en
It 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;
}


Note: TOC generated by TocGen is the same as the Flex Help TOC.
It cannot be used in Flash IDE, because Flash Help TOC is deferent from Flex Help TOC.


Last edited by ordinaryj on Sun Aug 08, 2010 11:09 am, edited 19 times in total.



Tue Dec 11, 2007 6:24 am
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
Interesting project :)

Your questions:
1. Use a .NET process execution directly instead of RunProcess. So you'll have more control on the process configuration.
2. You can ask for the Hashtable anytime you want:
http://www.flashdevelop.org/community/v ... c.php?t=81 (the doc was for FD2 but it still work this way)

Your suggestions:
1. Resolution in MXML is not implemented yet, planned in the future
2. Both vars added to SVN


Tue Dec 11, 2007 11:43 am
Profile WWW
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
Thank you for the reply :)
ResolveElement() is cool~~
I've made some changes to it :D
but It still has the 2 Problems :(


Wed Dec 12, 2007 10:46 am
Profile
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
ordinaryj wrote:
Change "someClass.html#function" to "someClass.html#function()".

I get something strange:
I use fl.containers.ScrollPane in a project by adding a SWC library.
Code:
var sp:ScrollPane = new ScrollPane();
sp.horizontalScrollPolicy = "off";

I point to "horizontalScrollPolicy", it did shows "public property". But when OpenTheDoc , I got this path:
/fl/containers/BaseScrollPane.html#horizontalScrollPolicy(), while
/fl/containers/BaseScrollPane.html#horizontalScrollPolicy should be right.
The HashTable contains :
ItmName: horizontalScrollPolicy
ItmKind: function
Then I add the following path to Classpaths:
FlashDevelop\FirstRun\Library\AS3\frameworks\FlashCS3
Then everything is right except compiling(that's why i didnot add this path):
ItmName: horizontalScrollPolicy
ItmKind: var


Thu Dec 13, 2007 5:06 am
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
Technically getters are functions, but that's true they appear as variables in the documentation.
I'll change that - or maybe should I return ItmKind="property"?


Thu Dec 13, 2007 8:12 am
Profile WWW
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
Yes, getters and setters are functions, but
Code:
var tf:TextField = new TextField();
tf.width = 100;

"width" is a getter too. but ItmKind: var.

What I meant is that getter's ItmKind: function, when it belongs to a SWC libray, otherwise getter's ItmKind: var.
And I mentioned that
ItmName: horizontalScrollPolicy
ItmKind: var
when I add the Classpath: FlashDevelop\FirstRun\Library\AS\frameworks\FlashCS3
FD did it anyother way.


Thu Dec 13, 2007 8:47 am
Profile
Member

Joined: Wed Jan 04, 2006 8:49 am
Posts: 100
Post 
Great plugin! Any chance of making it work for both AS3 and AS2? I can see that it would be a bigger task but if well done, it sure would be a nice feature to integrate into FD3.


Thu Dec 13, 2007 9:04 am
Profile
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
I am working on it. :)
I didnot know that AS2 docs arenot well organized until yesterday.
I am new to FD and .net, so it may take much time.


Thu Dec 13, 2007 9:24 am
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
ordinaryj wrote:
I am working on it. :)
I didnot know that AS2 docs arenot well organized until yesterday.
I am new to FD and .net, so it may take much time.

There is an AS2 documentation which should work directly:
http://download.macromedia.com/pub/docu ... _as2lr.zip


Thu Dec 13, 2007 9:28 am
Profile WWW
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
ordinaryj wrote:
Yes, getters and setters are functions, but
Code:
var tf:TextField = new TextField();
tf.width = 100;

"width" is a getter too. but ItmKind: var.

What I meant is that getter's ItmKind: function, when it belongs to a SWC libray, otherwise getter's ItmKind: var.
And I mentioned that
ItmName: horizontalScrollPolicy
ItmKind: var
when I add the Classpath: FlashDevelop\FirstRun\Library\AS\frameworks\FlashCS3
FD did it anyother way.

Fixed in the SVN.


Thu Dec 13, 2007 9:50 am
Profile WWW
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
Actually I cannot get ASCompletion complied so far.
There are two errors in line 379 and 401 in ASCompletion\Completion\ASDocumentation.cs:
Code:
string details = " ?;
Code:
if (lines.Length > 2) details += " ?;


Thu Dec 13, 2007 11:44 am
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
ordinaryj wrote:
Actually I cannot get ASCompletion complied so far.
There are two errors in line 379 and 401 in ASCompletion\Completion\ASDocumentation.cs:
Code:
string details = " ?;
Code:
if (lines.Length > 2) details += " ?;

It should be " ..."; (with ... as one graphical character).
What is your OS language?


Thu Dec 13, 2007 12:28 pm
Profile WWW
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
The kernel language is English, and I use MUI to get Chinese zh_CN interface.
And now I change the language to English, but system cannot recognize character either.


Thu Dec 13, 2007 1:09 pm
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 7507
Location: Paris, France
Post 
ordinaryj wrote:
The kernel language is English, and I use MUI to get Chinese zh_CN interface.
And now I change the language to English, but system cannot recognize character either.

Try to get the file again from SVN - the source was probably screwed.
It should be: " …";


Thu Dec 13, 2007 5:32 pm
Profile WWW
Member

Joined: Fri Nov 30, 2007 3:01 pm
Posts: 58
Location: Guangdong, China
Post 
Philippe wrote:
Try to get the file again from SVN - the source was probably screwed.
It should be: " …";

I tried several times, but nothing changes.
So I just ues this one "…" to get ASCompletion compiled.
Is there a space " " before the "…" ?


Last edited by ordinaryj on Fri Dec 14, 2007 8:09 am, edited 1 time in total.



Fri Dec 14, 2007 3:42 am
Profile
Display posts from previous:  Sort by  
Reply to topic   [ 122 posts ]  Go to page 1, 2, 3, 4, 5 ... 9  Next

Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum

Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by ST Software for PTF.