Return to DITA-to-JavaHelp Help Main Page

DITA-to-JavaHelp Help - Procedure 2-B; Fill in the Configuration Parameters; "Directory" Option

The configuration file is a convenient way to save all of the parameters involved in building a JavaHelp file.

There are three tabs in the configuration file dialog: "Input", "Chunking" and "Helpset".

When you click on "Edit Config" in the main dialog this configuration dialog, opened at the input tab, appears:

1. Input tab
   1. Select the configuration file for the JavaHelp build. If you don't have one click on "Create Example Config".

      

   2. Ignore File Names: When you choose the "Directory" option in Step 2 in the main dialog window, DITA-to-JavaHelp examines all of the files in that directory looking for content. This option tells the DITA-to-JavaHelp module to ignore files that look like input but should be excluded. Typical examples are .backup,.bak,.recover,.auto,temp,Temp,.svn,.git. These filename extensions are included in the defaultss for this tab.
   3. Ignore Dir Names: This option tells the DITA-to-JavaHelp module to ignore files that look like input but should be excluded. Typical examples are .backup,Temp,temp,.Temp,.temp,.tmp,DitaToJavahelpTemp,.svn,.git. These directory names are included in the defaultss for this tab.
   4. Extensions: This is the extension of filenames that you want DITA-to-JavaHelp to look at. The default is "dita".
   5. Include Files: Advanced users can use this list to bring in other files to be included in the JavaHelp build. These might be JavaScript files, other graphics, or anything else you may need in the final build, but that are not directly refrenced by the DITA files in the build. Another convenient place to include such files is under the "Helpset" tab in the "Helpset Include Dir".
   6. Click on "Chunking" in the configuration file dialog then go to 2. Chunking tab
      or
      return to Procedure 1: Fill in the Main Dialog Window.
2. Chunking tab
   1. Type in the chunking level you want to see in JavaHelp. The chunking level determines the level of granularity you will see in your JavaHelp file as well as the DITA elements that will be included in the chunking. For example setting the level to "2" will create a JavaHelp topic for every main title and sub-title. Setting it to "3" will create a JavaHelp topic for every main title, sub-title and sub-sub-title.

      

   2. Specify the DITA elements you want to be looked at when chunking. The values can be "topic", "task", "concept" and "reference".
   3. Click on the "Helpset" tab then go to 3. Helpset tab
      or
      return to Procedure 1: Fill in the Main Dialog Window.
3. Helpset tab
   1. Fill in the the the information as required

      

      • Helpset Name: The name of the JavaHelp helpset. This is important especially if the JavaHelp will be providing context sensitive help for another application; this is name that application will use when calling for help.
      • Helpset Title: This is the name JavaHelp will display at the top of the generated JavaHelp user interface.
      • Header File: The name and path to the HTML file that will provide the content of the header of each page in the JavaHelp. "Next" and "Previous" buttons can be defined in the header HTML by including this code in the header file: <a href="$before"> and <a href="$after">
        An example can be found here: Sample-Header.html .
      • Footer File: The name and path to the HTML file that will provide the content of the footer of each page in the JavaHelp. "Next" and "Previous" buttons can be defined in the footer HTML by including this code in the footer file: <a href="$before"> and <a href="$after">
        An example can be found here: Sample-Header.html .
      • CSS File: This is the Cascading Style Sheet (CSS) that will be used to format the JavaHelp pages.
      • Helpset Include Dir: The name and path to the direcvtory containing resources for the JavaHelp pages. This includes any graphics that will be used in tnhe headers and footers.
      • Remove Image Height and Width: It is normal to define the default height and width of graphics in the DITA XML. This usually done to ensure proper rendering in the PDF, especiallyif you are using FrameMaker to produce PDFs. This height and width definition is usually not appropriate for Web or JavaHelp display. This option allows you to ignore the height and width defined for PDF and go with the 100% height and width in JavaHelp.
   2. Once you have completed the tabs in the configuration dialog, click on "Save and Close" or "Save As" to close the configuration dialog and return to "Procedure 1: Fill in the Main Dialog Window".

Return to DITA-to-JavaHelp Help Main Page