Reference Manual Style Guide: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy No edit summary |
imported>Jeremy No edit summary |
||
| Line 1: | Line 1: | ||
The following style rules should be followed for all new reference manual entries. See the [[Reference Manual Template]] page for a starting template page. | 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 | These segment titles are wrapped with three =s <nowiki>===Synopsis===</nowiki> and include: | ||
*Purpose | *Purpose | ||
*Synopsis | *Synopsis | ||
| Line 11: | Line 11: | ||
*See Also | *See Also | ||
==Sub-Topics== | |||
Some standard sub-topics can be used in the Description section. | Some standard sub-topics can be used in the Description section. These sub-topic titles are wrapped with four =s <nowiki>====Inputs====</nowiki> and include: | ||
These sub-topic titles are wrapped | |||
*Inputs | *Inputs | ||
*Optional Inputs | *Optional Inputs | ||
*Outputs | *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) | Note: These sub-topics are ''always plural'', even if there is only one item in the list (e.g. one output) | ||
===Matlab Code | |||
Matlab code can be | ==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 | * 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 | ::indented code looks like this | ||
| Line 30: | Line 36: | ||
</pre> | </pre> | ||
==See Also== | |||
* See Also section should list relevant similar functions and link to each function | * See Also section should list relevant similar functions and link to each function | ||
Revision as of 08:17, 5 September 2008
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