Help:Editing: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (New page: This page contains editing information specific to the Eigenvector Research Documentation Wiki. For information on working with the editor see the [http://en.wikipedia.org/wiki/User:Cacyc...) |
imported>Jeremy No edit summary |
||
| Line 1: | Line 1: | ||
This page contains editing information specific to the Eigenvector Research Documentation Wiki. For information on working with the editor see the [http://en.wikipedia.org/wiki/User:Cacycle/wikEd_help wikEd_help page] | This page contains editing information specific to the Eigenvector Research Documentation Wiki. For information on working with the editor see the [http://en.wikipedia.org/wiki/User:Cacycle/wikEd_help wikEd_help page] | ||
| Line 14: | Line 13: | ||
**Algorithm | **Algorithm | ||
**See Also | **See Also | ||
* 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 Description. These sections are delineated with four =s <nowiki>====Inputs====</nowiki> and include: | ||
| Line 21: | Line 21: | ||
: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 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 | ||
| Line 26: | Line 27: | ||
*** 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 | ||
* See Also section should list relevant similar functions and link to each function | |||
Revision as of 16:53, 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 get three =s ===Synopsis=== These sections include:
- Purpose
- Synopsis
- Description
- Examples
- Options
- Algorithm
- See Also
- Some standard sub-topics can be used in Description. These 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 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
- Preformatted code using either:
- start line with one or more space characters
- wrap code in a <pre> </pre> tag
- See Also section should list relevant similar functions and link to each function