s.variable-name

Table of Contents

Syntax #

s.variable-name

Purpose #

The s.variable-name annotation is used to tag a span element as being the generic name of a variable.

 

For the annotation to tag a span element as a variable within a syntax diagram, see s.syntax.variable.

Example #

The following is an example of a time when you might want to use the annotation

 

The following is an example of a rule that will apply the annotation

The following is the DITA XML output for the rule:

<p>When the user enters <userinput>&lt;program name>!Start</userinput>, GOS will attempt to launch the specified program. In this input, <varname>&lt;program name></varname> is a variable for the name of the program that the user is attempting to launch.</p>