Parameters of the @html tag are passed verbatim to the HTML output format.
Simple example
var
{ This variable can have one of the following values:
@html(
<ul>
<li>SOME_CONSTANT</li>
<li>SOME_OTHER_CONSTANT</li>
</ul>) }
MyVariable: Integer;Which will result in the following HTML output:
This variable can have one of the following values:
- SOME_CONSTANT
- SOME_OTHER_CONSTANT
Notes
This tag does not recursively expand its parameter (see TagsParameters), so @-tags are *not* expanded inside the parameters of this tag, paragraphs are *not* inserted, and you can simply write the @ char to get it in the output (no need to double it, like @@). Special html characters (like < or >) are *not* escaped for HTML output. You have to write < to get the < character in HTML output. To rephrase it: The text inside the parameters of @html is copied absolutely verbatim to the output.
- When pasdoc generates documentation in a format, that can not use HTML markup, the @html() tag is ignored.
See also the @latex tag
Example how to include graphics in HTML output
The @html tag can be used to include graphics with the html output. For example, the following puts a figure in the top row of an (invisible) table with two rows and one column. The second row is used for a caption for the figure.
@html(
<table
style="margin-left: auto; margin-right: auto; width: 100%; text-align: left;"
border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top; text-align: center;"><img src="algorithm1.png" alt="Polygon, point, and line illustrating algorithm."><br>
</td>
</tr>
<tr>
<td style="vertical-align: top; text-align: center;"><em>Figure 2.1, Polygon, point, and line illustrating algorithm.</em><br>
</td>
</tr>
</tbody>
</table>
)