View Categories

s.syntax.note

< 1 min read

Table of Contents

Syntax #

s.syntax.note

Purpose #

The s.syntax.note annotation is used to tag a span element as being footnote-like content within a syntax diagram or syntax fragment. This content is used to explain concepts or present information not in the markup. This content is placed at the end of the syntax diagram.

 

See s.syntax.note-reference for more information.

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:

<synnote>user_input is a variable input by the user.</synnote>