

The guided-tour like authoring experience of FrameMaker just got even better. In addition to the structured view, element catalog, and view elements as tags, FrameMaker 10 displays element descriptions next to the element names in the element catalog. This article introduces Element Descriptions and illustrates how you can port additional text/help that appears next to the elements in FrameMaker for writers, resulting in savings in the cost and effort involved in training new writers.
FrameMaker 10 further simplifies structured authoring by displaying description of the various elements next to the elements.
You can edit the element descriptions to provide contextual, element-level help to your authors. A good, thorough implementation of these descriptions can save you time, effort, and money and will be especially useful for the new authors in the team. You can do this with a fraction of the cost and effort of having to train new writers about the vocabulary (i.e. elements) of your structured applications.
Using the DITA 1.2 task template as example, the following steps illustrate how you can augment the textual descriptions of your templates to simplify the task of using structure even further.
1. Open the relevant structured template .fm file and select StrutureTools > Export Element Catalog as EDD. (See structapps.fm for the name and location of the template file.)
FrameMaker creates a new document as an EDD that includes the structure and the elements of the template.
2. Save this document.
1. In the EDD, locate the element tag in the EDD that you want to edit.
2. After the “Container” tag in the relevant element tag, insert the DescriptiveTag element and type in a description relevant to the element. If the DescriptiveTag element is already present, you can edit the description.
The element descriptions you typed into the EDD are now in template. Now when you create a new document based on the updated template, you see the element descriptions next to the elements in the Element Catalog. The figure below displays the edited descriptions of the elements prolog, related-links, shortdesc, task, and taskbody.
Over time, edit the descriptions recursively to address the doubts and frequently asked questions of your writers for various elements.
This entry was posted on April 11, 2011, 4:13 am and is filed under FrameMaker. You can follow any responses to this entry through RSS 2.0. You can leave a response, or trackback from your own site.If you want to:
Remove options to edit template components, from an author’s FrameMaker installation.Personalize the existing FrameMaker menus by rearranging commands on menus or moving out a sub-menu command that you use frequently.Shorten FrameMaker menus by removing distracting (for you) options.… then read on.
Let’s add menus first and then understand how to create them. Here’s something that you can try out:
Caution: Settings (flags) in the maker.ini file impact how your FrameMaker works. Be sure of what you edit, lest your destabilize your FrameMaker environment. Make a copy of the maker.ini file. Restore it back, if need be.
Download and extract this zip file containing the configuration file.Place the configuration file (cc.cfg) in the path ‘C:\Program Files (x86)\Adobe\AdobeFrameMaker10\fminit\configui\’ or a similar path in your Program Files folder.Open in Notepad, the maker.ini file from the path ‘C:\Program Files (x86)\Adobe\AdobeFrameMaker10\’ or a similar path in your Program Files folder.Change the value of the parameter ‘ConfigCustomUIFile’ to ‘fminit\configui\cc.cfg’.Save and close the maker.ini file. Restart FrameMaker.Notice the drop-down menus called CC and Paratags appear in the main menu bar (as seen below). They contain common commands (hence the name CC) and all the paragraph tags available in an open document.Open the configuration (cc.cfg) file in Notepad and read through the instructions, comparing them to what you see in FrameMaker UI.
Want to know about how to write the configuration file? Read this (PDF) document about customizing FrameMaker.
Do share your use cases and experience in the comments section below.
This entry was posted on March 31, 2011, 9:47 am and is filed under FrameMaker, How to. You can follow any responses to this entry through RSS 2.0. You can leave a response, or trackback from your own site.