If the application isn't ViewKit-based, the writer and the developer need to agree on a name to use for the helpmap file. The AppName should be the same as the name of the application's defaults file in /usr/lib/X11/app-defaults (usually a capitalized form of the name of the executable). If the application is based on IRIS ViewKit, name the file AppName. The name and location of the helpmap file are important. In this ASCII text file, you list the topics that you've designated as “help” in your FrameMaker files, and you specify when the topic should appear-when a user chooses a particular item from the Help menu, for example, or when the user clicks in a certain place in the window. The helpmap file acts as the glue that binds the help topics to the application. The application developer will then incorporate these labels into the application's code. If it is not ViewKit-based, you need to provide the developer with a list of the topics for the menu and all of the associated labels. If the application is based on the IRIS ViewKit interface toolkit, you do not have to pass this information on to the developer. If the application has a Help menu, add a label to your book above each section that should appear in the Help menu or should appear when a user requests context sensitive help for a particular area of the window. The application passes this info to the help server when the user clicks a Help button. Provide the help labels to the application developer so they can be incorporated into the application's code. If the application allows you to open several windows, each with its own Help button and help card, put a different label above each topic that should come up in response to a Help button. If the application has a Help button, add a label to your book above the heading of the section that you want to appear when the user clicks the Help button. Click the left-pointing arrow button in the dialog to move “HelpSubTopic” into the “In:” column then click the Apply button. Choose HelpSubTopic from the Conditional Text dialog. Now select all of the text that you wish to appear in the help topic. Click the left-pointing arrow button in the dialog to move “OnlineOnly” into the “In:” column then click the Apply button. Select the entire paragraph containing the new label then choose OnlineOnly from the Conditional Text dialog. Tag the paragraph with the HelpSubTopic paragraph tag. Remember not to put spaces or hyphens in the label, and to choose a name that another writer isn't likely to use. The label and title are eventually put into the helpmap file by the bookbuilding tools, thereby tying the help topic to the application. The label follows the same rules as for HelpTopic, above the title is necessary since there's no section title to use for the help card title. Type a unique label for that topic, then a colon, then a title for the topic. Place the cursor on a blank line above the first paragraph of the subsection you want to use as a help topic. To create a help topic from a piece of a section, follow these steps: In fact, if you use a table you must also use the entire paragraph that the table anchor appears in. Note that such pieces must be complete SGML structural units, such as paragraphs or tables or figures you can't use part of a paragraph, or part of a table, or part of a figure, as a help topic. Parts of sections of a book can also be used as help topics. Tag the paragraph with the HelpTopic paragraph tag.
For example, you might want to include the application name, or an abbreviation of the name, followed by some other text. Ensure that you choose a name that another writer isn't likely to use.
Later, you'll be entering this label into the helpmap file, thereby tying the help topic to the application.ĭo not put spaces or hyphens in the label. If you place it above a Heading2, the help topic will include any Heading3 subsections that the marked section contains. If you place it above a Heading1, the help topic will include any Heading2 and Heading3 subsections that the marked section contains. Place the cursor on a blank line above the heading of the section you want to use as a help topic.
0 kommentar(er)
