Notice When updating this template keep in mind that it is used on a number of template documentation pages. If the parameters in question are unique to a template, then either add it manually to the template documentation or create a new section here for transclusion.

This template is used to build consistent documentation pages for Citation Style 1 templates.

For example:

{{Citation Style documentation|author}} 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.

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
Use

{{csdoc|lead|content}} to create consistent content for the lead:

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

Markup Renders as
{{csdoc|lead|books}} 
This Citation Style 1 template is used to create citations for books.

ފަންވަތް:Citation Style documentation/edit

Start the usage section with

{{csdoc|usage}}:

Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge the page.

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

  • Start with

{{csdoc|usage full}}

  • Precede the sample markup with : to create an indent
  • Enclose the sample in <code><nowiki>...</nowiki></code>
  • Close the table with

{{end}}

ފަންވަތް:Pre2

Full parameter set in horizontal format
{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |layurl= |laysource= |laydate= |author-mask= |display-authors= |postscript= |lastauthoramp=}}

Most commonly used horizontal style

އުނިއިތުރު ގެންނަވާ
  • Start with

{{csdoc|usage common}}

  • Precede the sample markup with : to create an indent
  • Enclose the sample in <code><nowiki>...</nowiki></code>
  • Close the table with

{{end}}

ފަންވަތް:Pre2

Most commonly used parameters in horizontal format
{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}

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

  • Start with:

ފަންވަތް:Pre2

  • Create the vertical list column
  • Separate the next column with:

ފަންވަތް:Pre2

  • Create the prerequisites column; blank lines must include a &nbsp;
  • Separate the next column with:

ފަންވަތް:Pre2

  • Create the instructions column; blank lines must include a &nbsp;
  • End with:

ފަންވަތް:Pre2

Example: ފަންވަތް:Pre2

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{cite book
| last                  =
| first                 =
| authorlink            =
}}
 
 
last
 
 
 
same as last1
same as first1
 
 
  • If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.

ފަންވަތް:Citation Style documentation/edit |}

ފަންވަތް:Citation Style documentation/edit |}

ފަންވަތް:Citation Style documentation/edit |}

ފަންވަތް:Citation Style documentation/edit |}

ފަންވަތް:Citation Style documentation/edit |}

ފަންވަތް:Citation Style documentation/edit

Use

{{markup2}} to format the examples; see the template documentation for use.

{{markup2 |t=Basic usage with url (and accessdate) and edition
|m={{cite book |title=Mysterious book}}
|r={{cite book |title=Mysterious book}}
}}

ފަންވަތް:Markup2

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit ފަންވަތް:Citation Style documentation/opt

Subscription or registration required

އުނިއިތުރު ގެންނަވާ

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style documentation/edit

ފަންވަތް:Citation Style 1