Template:Csdoc/doc

Usage
This template is used to build consistent documentation pages for templates.


 * For example: will show the author documentation.

Where a particular section of documentation is not appropriate for a certain template, simply add the text manually or create a new subtemplate.

Each module of text is a subtemplate that can be edited using the link.

Section usage
When creating template documentation, use the following order of sections and content:
 * Lead: a brief overview of the template intent
 * Usage: samples of blank parameters that can be copied and pasted
 * Examples: examples of various usage
 * Parameters: detailed descriptions of each parameter
 * Syntax: overview of the template syntax
 * Deprecated: list of deprecated parameters
 * Description: parameter descriptions separated by function in this general order:
 * Authors
 * Title
 * Date
 * Publisher
 * Edition, series, volume
 * In-source locations
 * URL
 * Anchor
 * Identifiers
 * Quote
 * Editors
 * Laysummary
 * Display options

Lead section
Use to create consistent content for the lead:

Usage section
Start the usage section with :

Parameters to copy are enclosed in tables created by sub-templates.

Full horizontal style

 * Start with
 * Precede the sample markup with  to create an indent
 * Enclose the sample in 
 * Close the table with





Most commonly used horizontal style

 * Start with
 * Precede the sample markup with  to create an indent
 * Enclose the sample in 
 * Close the table with





Full vertical style
The full vertical style is created in three columns: Vertical list, Prerequisites and Brief instructions / notes.

  
 * Start with:
 * Create the vertical list column
 * Separate the next column with:
 * Create the prerequisites column; blank lines must include a
 * Separate the next column with:
 * Create the instructions column; blank lines must include a
 * End with:

Example: 

 &amp;nbsp; &amp;nbsp; last &amp;nbsp; &amp;nbsp;

 &amp;nbsp; same as last1 same as first1 &amp;nbsp; &amp;nbsp;



 last

<pre style="margin:0px;"> same as last1 same as first1

Examples section
When creating examples, use these styles for consistency:
 * A title before the example, formatted in bold by the use of
 * The sample markup for the example: preceded by  to create a bullet, then the markup enclosed in <code ></nowiki></code>
 * The live markup: preceded by  to create an indent