Ticket #154 (closed enhancement: fixed)

Opened 17 months ago

Last modified 14 months ago

add flash documentation plugin

Reported by: mb0 Owned by: asdt.org
Priority: major Milestone: AXDT 0.0.7
Component: editor Version: AXDT 0.0.6
Keywords: Cc:

Description

the official  as3 documentation is licensed under  cc by-nc-sa. it should be a part of axdt.

i think the documentation preparation should be an automatic process. so users can add ziped documentations or doc folders to their a workspace configuration.

the documentation plugin should be able to look up any qualified name. and a fulltext indexing/ search would be ideal (haven't looked into the eclipse doc or help part yet).

even better would be to parse doc info and the api interface and put it into the index along with source types (i have no idea how to read type members from a library.swf). we could also clean up the flex schema that way and add docs for the mxml editor assistance.

Change History

Changed 17 months ago by mb0

oh no i just discovered that it is not the documentation that is cc by-nc-sa but only the comments. what a disappointment. however i can provide links in the help pages and user can still drop in their zip files.

Changed 14 months ago by mb0

  • status changed from new to closed
  • resolution set to fixed
  • milestone changed from AXDT 0.1.0 to AXDT 0.0.7

i build a emf model for indexing. a (for now still minimal) asdoc parser and added source indexing.

due to the licences/copyright issue i cannot redistribute the langref asdoc. so i build the whole indexer with caching in mind.

just add a url pointing to an online asdoc site, local folder or an zip/jar archive to the axdoc preference. once configured the indexer will load basic package and type information witch will result in x web requests (n+1 >= x >=n*2+1, for n number of packages) which is very fast. if a package or type is then imported and used somewhere in the code, axdt will request more information for the particular type from the documentation source.

however every query to the documentation source will be executed only once and then persisted to xml files in .metadata/.plugins/org.axdt.axdoc you can delete the folder to clear all index caches.

the parser will automatically index all configured axdt source folders as soon as the as3 plugin loads. you can use a full or clean build to refresh a source index. manual added types will also be index by the parser schedule (but the package and type names will not automatically be caches for proposals right now)

prepared for 0.0.7. i need 1 or 2 weeks more to clean everything up.

Note: See TracTickets for help on using tickets.