Reference Manual Style Guide

The following style rules should be followed for all new reference manual entries. See the Reference Manual Template page for a starting template page.

Top-level Segments

These segment titles are wrapped with three =s ===Synopsis=== and include:

• Purpose
• Synopsis
• Description
• Examples
• Options
• Algorithm
• See Also

Sub-Topics

Some standard sub-topics can be used in the Description section. These sub-topic titles are wrapped with four =s ====Inputs==== and include:

• Inputs
• Optional Inputs
• Outputs

The contents of these sections should be given as bulleted lists with each input/output as a separate item in the list.

Note: These sub-topics are always plural, even if there is only one item in the list (e.g. one output)

Options

Options

Matlab Code

Matlab code can be included in the body of the description using either:

• Indenting (i.e. start line with a semicolon) - use for Synopsis section and for single lines of code in description

indented code looks like this

• Preformatted code using one of the methods below - use any time there are multiple lines of associated code shown together
  • start line with one or more space characters
  • wrap code in a <pre> </pre> tag

       preformatted code looks like this

See Also

• See Also section should list relevant similar functions and link to each function