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
 * Lay summary
 * 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





The above set is organised contextually rather than alphabetically. The following parameters, which are usually available for at least a few cite templates, are not included in the full parameter set above: authors; book-title; class; degree; docket; encyclopedia; mailing-list; message-id; number; publication-date; section; sheet; sheets; title-link; s2cid.

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 can be implemented in a three-columns format (only practical when the number of parameters is not too extended) or in a four-columns format.

Three-columns format
The full vertical style in three columns consists of a "Vertical list", "Prerequisites" and "Brief instructions / notes". Example:

Examples section
Use markup2 to format the examples.