Archive for August, 2011

What’s not to like?

About 8 months ago, we added a pair of radio buttons to all the Flex 4.5 doc and ActionScript language reference pages that asks you is the content was helpful:

What we were hoping for was a large amount of data, good or bad, that would tell us where weaknesses and strengths exist in the documentation. This would give us much more insight into the efficacy of individual pages, or into groups of pages. It would also help us decide where to put our resources when updating the documentation. Unfortunately, the number of ratings has been extremely low. Like lower than many banner ad click through rates. Like lower than my Angry Birds score kind-of-low.

So, why aren’t you rating the pages?

Are you too busy as a developer to rate the page?
Maybe you’ve got a lot on your mind when you end up at a Flex doc page, and don’t want to distract from your thought process, especially if you’re copying/pasting a code example or trying to grok something.

Are you worried about privacy?
There is absolutely no way for us to track your rating or any comments you add with that rating. It is completely anonymous.

Is the location of the rating “widget” inconvenient?
The widget currently appears at the top of the page. But Flex doc pages tend to be long and dense with material, so maybe you see it and then just forget about it. We’ve thought about moving the widget to the bottom of the page, or adding it multiple times to the pages, but we don’t want to get in your way, either.

Do you think we ignore this data?
We don’t. We look at it very closely, and even read the comments.

We’d love to get your feedback (here, and, of course, on the help pages)!

-Matthew J. Horn
Flex doc team

Add Chrome Search Extension for the ActionScript® 3.0 API Reference (ASDoc)

Use the ActionScript® 3.0 Reference as the API reference for many Adobe products, including Flash Player, AIR, Flex, and LiveCycle. To improve searching of the reference in Chrome, install the “ActionScript 3.0 Search” extension:

ActionScript 3.0 Search

 

Stephen Gilson
Flex Doc Team

Context-sensitive language reference Help in Flash Builder

Context-sensitive language reference Help is not really a new feature in Flash Builder. However, we figured that several people were not aware of the ways in which you can access the ActionScript language reference and ASDoc content from within Flash Builder.

So, this post describes the ways in which you can quickly access the ActionScript API reference and the ASDoc content while writing code.

Display the ActionScript Language Reference in a swift keystroke

The Adobe ActionScript Language Reference is integrated into the MXML and ActionScript editors and lets you quickly view the reference Help for an MXML tag or property, a class, or a Flex framework element.

  1. In the MXML or ActionScript editor, select a Flex framework element (a word in your code) by highlighting or placing the mouse pointer in the word.
  2. To open the relevant ActionScript Language Reference topic directly in the Help viewer, press Shift+F2.
ActionScript Language Reference

 

Display ASDoc content in code hints, as a tool tip, and in the ASDoc view

Flash Builder displays ASDoc content in code hints, as a tool tip while hovering over a code element, and in the ASDoc view.

  1. Begin entering a line of code that contains either an MXML or ActionScript class. You can also hover over the class. As you type, ASDoc content for the class displays next to the code hints, as follows:

    ASDoc Code Hints

    ASDoc Code Hints

  2. If you hover over a class, just the ASDoc reference summary appears. To display the content in a separate, scrollable window, press F2.The ASDoc content is displayed as follows:
    ASDoc Content

    ASDoc Content

    When you finish reading the documentation, click outside the ASDoc window to close it.

  3. To display the complete ASDoc content in a dockable ASDoc view in Flash Builder, select Window > Show View > Other, and select ASDoc.A quicker way of displaying the ASDoc view is to press Ctrl+3, type asdoc, and select Views, as follows:
    ASDoc view

    ASDoc view

    Note: This feature supports user-generated ASDoc documentation. That is, you can document your custom components by adding ASDoc comments to the code that implements the components. The ASDoc comments are then available as code hints in the MXML and ActionScript editors.
    For more information on creating ASDoc comments for your source files, see ASDoc.

New Features Added to Adobe ActionScript API Reference (ASDoc)

Use the ActionScript® 3.0 Reference for the Adobe® Flash® Platform as the API reference for many Adobe products, including Flash Player, AIR, and Flex. The new release of the ActionScript Reference (http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/) contains several new features:

  • Support for a quick search added to the Packages and Classes lists.The quick search lets you filter the content of the Packages and Classes lists as you type. This feature is not supported on IE 7 and IE 8.
  • When displaying all classes in the Classes list, selecting a class name in the list continues to display all classes.In the previous release, selecting a class name in the Classes list while displaying all classes changed the Classes list to display only the classes in the package of the selected class.
  • Added a Home link to the top of all pages.The Home link lets you navigate back to the index.html page from anywhere in the reference.
  • Fixes for issues associated with localization and translation.

 

Stephen Gilson
Flex Doc Team