STx Documentation Style Guide

From STX Wiki
Jump to navigation Jump to search

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.