Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP Help System Developer's Guide > Chapter 3 Writing a Help Topic

Entering Inline Elements

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Glossary

 » Index

Inline elements are used to mark words or phrases within a paragraph of text. These elements affect the font used to format particular items.

To emphasize a word or phrase

  • Use the <emph> element (emphasis) as shown:

       <emph> text <\emph>
    

    Or, use the shorthand form:

       !! text !!
    

Emphasized text is displayed using an italic font.

Example.  Here's how you might emphasize an important word:

   A thousand times <emph>no<\emph>

Or, using the shorthand form:

   A thousand times !!no!!

In both cases, the word "no" is displayed in italics.

To enter a book title

  • Use the <book> element as shown:

       <book> title <\book>
    

    Or, use the short form:

       <book| title |
    

Book titles are displayed using an italic font.

Example. Here's how you would enter the title of this guide:

   <book|The HP Help System Developer's Guide|

To display a computer literal

  • Use the <computer> element as shown:

       <computer> text <\computer>
    

    Or, use the shorthand form:

       ''text'' 
    

Example. Computer text is useful for identifying a file name. Here the helptag.opt file name is marked to be displayed in computer text.

   Add the search path to your ''helptag.opt'' file.

To display a variable

  • Use the <var> element (variable) as shown:

       <var> text <\var>
    

    Or, use the short form:

       <var| text |
    

    Or, use the shorthand form:

    
    
       %%text %%
    

Variables are displayed using an italic font.

Example. Here's a variable within a normal sentence.

   When you enter your %%password%%, the

   computer unlocks your screen and keyboard.

Variables can appear within computer text or computer example listings. This example specifies "volume" as a variable part of a file name:

   The HelpTag software takes your 

   ''%%volume%%.htg'' as input.

In both of these examples, the %% pairs could have been entered with the long form (<var> ... <\var>) or the short form (<var| ... |).

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 1988 Hewlett-Packard Development Company, L.P.