Posts tagged "asdoc"

Accessing ActionScript and Flex SDK Reference Offline

You can cache content locally using Adobe Help. From Flash Builder, go to Help > Flash Builder Help.

  1. In Adobe Help
    (a.k.a, Adobe Community Help Client), go to Preferences
  2. Select
    Download Preferences, make sure Flex 4 is checked. Select Flex 4 and select the help package for “ActionScript 3.0 Language and Component Reference” and any additional packages you wish to download. The full set of Flex 4 help packages is currently around 70 MB. 
  3. Select Local
    Content, update all packages if an update is available.

With the content cached, you can access offline help.
Make sure you select “Flex 4″ in the search box, “Local Help” for your Search Location and
“ActionScript 3.0 Language and Component Reference” for your Filter Results. Despite the name, this will include both built-in Flash and Flex APIs in the search results.

If you only want reference information about Flash
Builder (not including Flex or Flash ASDoc), you can download this PDF http://help.adobe.com/en_US/flashbuilder/using/flashbuilder_4_help.pdf or simply follow the same steps to cache “Using Adobe Flash Builder 4″. 

It’s important to note that Flash Builder 4 no longer uses Eclipse’s help system to deliver help content.

Share on Facebook

Build SWCs with ASDoc for Flash Builder 4

You might already know that ASDoc support was added in Flash Builder 4. We show ASDoc content in code hints, hovers and in the new ASDoc view. We have built-in support for showing ASDoc content from:
  • Flex 4 SDK
  • playerglobal.swc and airglobal.swc
  • Referenced library projects in the current workspace
  • ASDoc content in your current project
However, what we don’t provide is a way to distribute SWCs that bundle ASDoc content without distributing your source code.
Gaurav wrote a great blog post going into detail on how the SDK uses Ant to include ASDoc using framework.swc as an example. You should be aware that te SDK bundles ASDoc a little differently in order to create local-specific resource bundles that contain local-specific ASDoc content. What that means for our users is that ASDoc content in Flash Builder is localized.
For most library developers that don’t require localizing their documentation, the process is a lot easier.

I’ve put together an example library project that you can download that contains a simple Ant script you can use for your own projects. Instead of creating a separate resource bundle, this script essentially runs the ASDoc tool, unzips your SWC, then bundles the ASDoc DITA files into the SWC.

Download: ExampleFatSWC.zip

In Flash Builder:
  1. File > Import, Flash Builder > Flash Builder Project
  2. Browse to the ZIP file
  3. Finish
  4. Right click on the build.xml file and choose Run As > Ant Build
  5. The “fat” SWC is in your /bin folder ready to be shared
When your users add the SWC to their project library path, they’ll see ASDoc content without any extra work.
Remember, to run Ant within Flash Builder, you’ll need to download the Eclipse Java Development Tools from the appropriate update site. For Eclipse 3.5 or Flash Builder Standalone users, use http://download.eclipse.org/releases/galileo and look for “Eclispe Java Development Tools”.
Share on Facebook

Open ASDoc Language Reference in Browser

If you prefer to see help content in the browser instead of the Adobe Community Help application, do the following:
  1. Open Adobe Community Help
  2. Edit > Preferences
  3. Select “General Settings”
  4. Select “Open Help in browser”
Beware that this will affect all Adobe applications, not just Flash Builder.
Users of prior versions of Flex Builder are accustomed to opening the language reference in a browser. I should point out that for the Flex 4 SDK, available ASDoc content appears in code hints, tooltips and in the ASDoc view that appears in the default Flash perspective.
Share on Facebook