Table of Contents

Syntax #



Purpose #

The s.user-input annotation is used to tag a span element as the text that a user provides to a program to receive output. This can be to initialize a process, in response to an output, or any other software interaction.

Examples #

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


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>