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
Common Desktop Environment: Help System Author's and Programmer's Guide > Chapter 3 Writing a Help Topic

Entering Inline Elements

» 

Technical documentation

» 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 Emphasis element as shown:

<emphasis>text </emphasis>

Example

Here's how you might emphasize an important word:

A thousand times <emphasis>no</emphasis>

To Cite a Title

Use the CiteTitle element as shown:

<CiteTitle> title
of a Book</CiteTitle>

Example

Here's how you would cite the title of this guide:

<CiteTitle>The Help System Author's and Programmer's Guide<CiteTitle>

To Mark the Title of a Book, Chapter, or Section

Use the Title element as shown:

<Title> title
of the Book, Chapter, or Section</Title>

Example

Here's how you would cite the title of this section:

<Title>To Mark the Title of a Book, Chapter, or Section</Title>

To Display a Computer Literal

To display data presented to the user by a computer use the ComputerOutput element as follows:

<computeroutput> text</computeroutput>

To Display a Filename

To display the name of a computer file, use the Filename element as follows:

<filename>some
filename</filename>

Example

This markup:

Add the entity to your <filename>Volume.sgm</filename> file.

produces this output:

Add the entityto your Volume.sgm file.

To Display a Variable

To dispaly a variable, use the Symbol element as shown:

<symbol Role="Variable"> text</symbol>

Example

This command-line syntax uses a variable to show that the user supplies a file name.

dtpad <symbol Role="Variable">filename</symbol>

It produces this output:

dtpad filename

Symbol can appear within ComputerOutputs or ProgramListings.

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