Accessibility

Extending Flash Help Panel Content

Distributing Help panel content


Table of Contents

  1. Introduction
  2. About the Help panel format
  3. The TOC file format
  4. The search index file format
  5. Converting Flash MX Reference panel content
  6. Creating new Help panel content
  7. Distributing Help panel content

You can easily package your Help panel content as a Flash MX 2004 extension. Any user can install your extension with the Macromedia Extension Manager, and your Help panel content is automatically placed into Flash, ready for viewing.

The Flash MX 2004 Extension Builder is a convenient way to deliver Help panel files and it can be used to create any type of Flash extension.

Download the Flash MX 2004 Extension Builder

Using the Flash MX 2004 Extension Builder

The Flash MX 2004 Extension Builder writes the .mxi file used to create a Flash MX 2004 extension. The .mxi file is based on user input and the contents of any given directory, including all subdirectories.

To create a Flash MX 2004 extension:

  1. Create a staging folder containing only the files and folders that you want to include in your extension. The directory structure of the staging folder should mirror the final destination of the extension contents at its root level. For example:
    Configuration-staging/
      ActionsPanel/
        CustomActions/
          myCustomActions.xml
      Components/
        myComponents/
      ...
      HelpPanel/
        Help/
          myBook/
          ...
    
  2. Run Extension Builder and provide the following input:

    Name Type the name of the extension, as you would like it to appear in the Extension Manager.

    Version Type the version number, in the format a{.b{.c}}, for example 1, or 1.0, or 1.0.0.

    Type Select the extension type. Certain types of extensions install the files into specific root folders within Configuration. "Suite" and "Other" can be used to install files anywhere within the Configuration folder. See The Macromedia Extension Installation File Format on the Macromedia website for more details.

    Author Type the author, as you would like it to appear in the Extension Manager.

    Description Type a description of the extension. Type carriage returns to create new lines, and type   to create multiple spaces.

    License Agreement Type any additional license agreement info that you would like appended to the standard extensions agreement. This field is optional.

    UI Access Type a description of where you can access the extension in the UI.

    MXI File Name Type the name of the .mxi file to be created. The filename must be no more than 23 characters long, including the .mxi file extension. If you do not add the .mxi extenion to the filename, it is added for you.

    Staging Folder Select the staging folder containing the files and folders to be included in the extension.

  3. Click OK.
  4. Launch the Extension Manager, version 1.6 or later. Select File > Package Extension and navigate to the newly created .mxi file. Click OK.
  5. Click Save to create the extension.