Help:Editing

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 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

• See Also section should list relevant similar functions and link to each function