DITA Structure Applications

You can use the DITA structure applications provided with DITA-FMx, those provided by Adobe, or your own custom applications. If you’re using apps other than the DITA-FMx apps, you’ll need to make some minor adjustments.

In order for FrameMaker to properly open and save DITA files, you must have structure applications that support the authoring of topic and map files. DITA-FMx provides both of these applications as well as a structure application for book processing.

Using the default DITA-FMx structure applications is the easiest way to get started, because those applications will support all of the advanced features provided by 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.

Important: The structure applications provided with DITA-FMx 2.0 are in FM8 format. This works fine for FM8 and later, but if you’re using FM7.2, you’ll need to open them in FM8 and downsave to FM7 format. If you’re unable to do this, contact Leximation.

If you are already working with DITA structure applications, and want to continue using them, you’ll need to do the following:

Edit the structure application definition for each of your structure applications. Change the Use API Client node so it references the client ditafmx_app instead of ditafm_app. This is required; if you do not do this, you’ll get an error message.
Add new element definitions that support special features provided by DITA-FMx. For details see DITA-FMx Specific Element Definitions. This is optional, but may limit the available functionality.
Create a special “Book” application for publishing. DITA-FMx relies on a structure application for Book publishing. It is possible that your current “Topic” application will do the job.

If you want to customize the appearance of default DITA-FMx structure applications, you should clone the provided structure application folders and modify the cloned versions. For additional information, refer to Cloning the Default Structure Applications.

After installing DITA-FMx, when you run FrameMaker you should see a message asking to install the default structure applications. Unless you’re doing something special, you should choose Yes to this message. To manually install the structure applications or if you’d like to understand what this automated process is doing, read the topic titled Manual Installation of the Structure Applications.

Important: On Windows Vista, 7, 8, or 10, the automated structure application installation process may fail unless FrameMaker is run “As Administrator.” Exit FrameMaker, then right-click the program icon and choose “Run As Administrator.”

After the structure applications have been installed, you may want to take a look at the structure application definitions so you will better understand how they work. Just choose Structure Tools > Edit Application Definitions to open the structure application definitions file. You should see the three DITA-FMx structure application definitions at the top of the file. These are added as text insets to make it easier to manage. If you need to modify these entries, you’ll ned to open the source file by double-clicking the inset and choosing the Open button. When you’re done reviewing the structure application definitions file, just close the file. You’ll be prompted to save when closing. Unless you’ve made intentional changes, there is no need to save.