Common Desktop Environment: Help System Author's and Programmer's Guide

To Insert a Writer's Memo

    Use the <memo> element as shown:

<memo> text <\memo>  

By default, the text within the <memo> element is ignored by the HelpTag software (just like a comment). However, if you add the memo option to your helptag.opt file (or specify the memo option with the dthelptag command), all memos within your help volume appear in a bold font.


Suppose you are writing about your application and have a question for the project team. You can include the question within the text using the <memo> element like this:

<memo>Team: Will the product also
 support 32-bit characters?<\memo> 

If you process the help volume with the following command (or include memo in your helptag.opt file), the memo appears in the help text in a bold font.

dthelptag  volume  memo

If the memo option is not used (or the nomemo option is used), the text within the memo is ignored and does not appear in the help text.