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

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.


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

dtpad %%filename%%

It produces this output:

dtpad filename

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" file as input.

It produces:

The HelpTag software takes your volume.htg file as input.

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