STx Documentation Style Guide: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
You can use the class <code>sourcelabel</code> to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples: | You can use the class <code>sourcelabel</code> to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples: | ||
<div class="sourcelabel">Usage:</div> | <div class="sourcelabel">Usage:</div> | ||
=HTML Tags= | |||
You can surround STx output with the <code>samp</code> HTML tag. | |||
Revision as of 11:49, 18 January 2018
This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation.
Classes
You can use the class sourcelabel to format such elements as 'Usage', 'Parameters', 'Results', etc. in the documentation. This is prefered to using headers. Here's an examples:
Usage:
HTML Tags
You can surround STx output with the samp HTML tag.
