STx Documentation Style Guide: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (Jw moved page STx wiki formatting and structure to STx Documentation Style Guide) |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
=Classes= | =Classes= | ||
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. | 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> | |||
=HTML Tags= | |||
You can surround STx output with the <code>samp</code> HTML tag. | |||
Surround keyboard shortcuts with the HTML tag <code>kbd</code>. E.g. the hotkey <kbd>S</kbd> can be used to update the spectrogram. | |||
Latest revision as of 10:32, 2 August 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.
Surround keyboard shortcuts with the HTML tag kbd. E.g. the hotkey S can be used to update the spectrogram.
