Syntax Summary Panel
The syntax summary panel is used to highlight or describe syntax components of a programming language.
Syntax
if Statement
if(condition) statement
This is the description of the syntax. It could be text and/or images as appropriate.
|
The syntaxsummary environment is defined below:
panels module
\begin{syntaxsummary}[header='Syntax']{title}
\begin{syntax}
...
\end{syntax}
\begin{descp}
...
\end{descp}
\end{syntaxsummary}
Used to highlight and describe various syntax components of a programming language. The environment requires two sub environments.
- syntax
- specifies the syntax that is being summarized. It uses the same format as the langsyntax environment;
- descp
- contains the description of the syntax or it could include an image that highlights various parts of the syntax.
Argument:
- title
-
The title of the syntax summary.
Key:
- header
-
The panel header label typically displayed as a black tab with white text. The default is 'Syntax'.
Plugin: SyntaxSummaryPanel
The Syntax Summary panel shown above is produced from the following code
\begin{syntaxsummary}{if Statement}
\begin{syntax}
if(<:condition:>)
<:statement:>
\end{syntax}
\begin{descp}
This is the description of the syntax. It could be text and/or images as appropriate.
\end{descp}
\end{syntaxsummary}