Parent: DITA Structure Applications
Related concepts
Special Instructions for FM12 and Earlier
Alternate Location for the Structure Applications
Related information
Description of the Structure Application Files
 

Manual Installation of the Structure Applications

Perform a manual installation of the structure applications or gain an understanding of what needs to be done.

The following steps describe the installation of the structure applications provided with DITA-FMx.

Note: If you’re installing on a system where the user does not have “admin” permissions, you’ll want to install the structure applications in a more accessible location. For details, see Alternate Location for the Structure Applications.
Tip: We’ve posted a video of the complete DITA-FMx installation process. If you haven’t watched this video you may want to take a moment to do so: http://blog.leximation.com/2010/03/installing-dita-fmx-1-1/

  1. Make a backup copy of your current structure application definitions file (typically found at FrameMaker\Structure\structapps.fm for FM7.2 and FM8, or <user appdata>\Adobe\FrameMaker\<version> for FM9 and later). Store this file in a safe location before making modifications.

  2. Extract the contents of the DITA-FMx_apps.zip file to the FrameMaker\Structure\xml folder. This will create a folder named DITA-FMx_1.2 that contains folders named Book, dtd-fmx, Map, and Topic. These folders contains the three structure application as well as the DITA 1.2 DTD files used by the applications.

  3. Start FrameMaker and open the structure application definitions file (Structure Tools > Edit Application Definitions). (If running FM9 or later, this opens the structapps.fm file in your “USERNAME\AppData” area, not the one in the FrameMaker program files area).

  4. Open the Structure View window (for FM7.2 or FM8 click the button on the upper right of the document window, in FM9 and later choose Structure Tools > Structure View). In the structure application definitions file place the insertion point just after the Version element. When the insertion point is in the right location, you’ll see a black triangle pointing to the right in the Structure View window (see the following image).

    Figure 1. Structure View window insertion point

  5. Choose File > Import > File, then navigate to the structapps-stub_topic_1.2.fm file in the DITA-FMx_1.2\Topic folder created in step 2. Select the Import by Reference option and choose the Import button. In the next dialog accept the defaults and choose Import.

    Note: If you see red dotted lines in the Structure View window after importing the “stub” file, it has been inserted into the wrong location. Delete the inset and try again. Make sure that the black triangle is placed as shown in Figure 1.

  6. Repeat step 4 for the “structapps-stub” files in the DITA-FMx_1.2\Map and DITA-FMx_1.2\Book folders.

    Note:

    If installing on FM 2022 (FM17), use the structapps-stub_book_1.2-fm17.fm file instead of the default “stub” file.

  7. Save the file, then choose Structure Tools > Read Application Definitions.

  8. Close the file and exit FrameMaker.

  9. Restart FrameMaker and run the DITA-FMx > Options command and select DITA-FMx-Topic-1.2 for the DITA Topic Application, DITA-FMx-Map-1.2 for the DITA Map Application, and DITA-FMx-Book-1.2 for the DITA Book Application.

Note: If your folder structure is non-standard, you may need to modify the paths specified in the “structapps-stub” files to match the file paths on your system. To do this, just open the structure application definitions file and double-click each application’s text inset. In the dialog that displays, choose the Open Source button and make the changes in the “stub” file. When you have finished editing the stub file, save and close that file, then double-click the text inset again and choose the Update Now button.

If you plan to make use of the DITA Open Toolkit for generating output, see Publishing with the DITA Open Toolkit.