Help:Editing: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
No edit summary
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]


===Eigenvector Reference Manual Style Guide===
The Eigenvector [[Reference Manual Style Guide]] should be used to correctly format Reference Manual pages.
 
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
**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 <nowiki>====Inputs====</nowiki> 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 &lt;pre&gt; &lt;/pre&gt; tag
<pre>
      preformatted code looks like this
</pre>
 
====See Also====
* See Also section should list relevant similar functions and link to each function

Revision as of 17:09, 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

The Eigenvector Reference Manual Style Guide should be used to correctly format Reference Manual pages.