View source for STx Documentation Style Guide

This page aims to help the STx documentation team apply consistent formatting and structure to the STx documentation.

=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. 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.