Help:Editing: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy No edit summary |
imported>Jeremy No edit summary |
||
| Line 5: | Line 5: | ||
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. | ||
====Top-level Segments==== | |||
* These segments get three =s <nowiki>===Synopsis===</nowiki> | |||
* These sections include: | |||
**Purpose | **Purpose | ||
**Synopsis | **Synopsis | ||
| Line 14: | Line 16: | ||
**See Also | **See Also | ||
====Sub-Topics==== | |||
* Some standard sub-topics can be used in Description. These sections are delineated with four =s <nowiki>====Inputs====</nowiki> and include: | * Some standard sub-topics can be used in the Description section. | ||
* These sub-topic sections are delineated with four =s <nowiki>====Inputs====</nowiki> and include: | |||
**Inputs | **Inputs | ||
**Optional Inputs | **Optional Inputs | ||
| Line 21: | Line 24: | ||
: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 provided using either: | * 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 | ** 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 | ** 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 | *** start line with one or more space characters | ||
*** wrap code in a <pre> </pre> tag | *** wrap code in a <pre> </pre> tag | ||
<pre> | |||
preformatted code looks like this | |||
</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 17:07, 3 September 2008
This page contains editing information specific to the Eigenvector Research Documentation Wiki. For information on working with the editor see the wikEd_help page
Eigenvector Reference Manual Style Guide
The following style rules should be followed for all new reference manual entries.
Top-level Segments
- These segments get three =s ===Synopsis===
- These sections 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 sections are delineated with 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 using one of the methods below - use any time there are multiple lines of associated code shown together
preformatted code looks like this
See Also
- See Also section should list relevant similar functions and link to each function