Reference Manual Style Guide: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (New page: The following style rules should be followed for all new reference manual entries. ===Top-level Segments=== These segment titles are wrapped in three =s <nowiki>===Synopsis===</nowiki> ...) |
imported>Jeremy No edit summary |
||
| Line 1: | Line 1: | ||
The following style rules should be followed for all new reference manual entries. | The following style rules should be followed for all new reference manual entries. | ||
| Line 25: | Line 24: | ||
::indented code looks like this | ::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 | * 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 | |||
<pre> | <pre> | ||
preformatted code looks like this | preformatted code looks like this | ||
Revision as of 16:11, 3 September 2008
The following style rules should be followed for all new reference manual entries.
Top-level Segments
These segment titles are wrapped in 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 in four =s ====Inputs==== and include:
- Inputs
- Optional Inputs
- Outputs
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 provided 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