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

ފަންވަތް ޑޮކިއުމަންޓޭޝަން[view] [edit] [history] [ޕާރޖް]

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.

Usage

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.

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

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

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

Lua notice

Usage section

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.

Full horizontal style

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

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

Most commonly used parameters in horizontal format

{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}

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: ފަންވަތް: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.

Sub-templates

Usage

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

Usage full

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

Usage common

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

Usage vertical

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

Usage vertical mid

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

Usage vertical end

Examples section

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

Parameters section

syntax

COinS

sep_period

sep_comma

required

deprecated

author

editor

title

web

chapter

type

journal

edition

series

series_episode

event

agency

volume

date

publisher

newsgroup

language

pages

time

id1

id2

url

chapterurl

lay

quote

ref

ref2

display

Subscription or registration required

map_series

map_pages

interview_id

interview_author

interview_interviewer

album_name

season

network

transcript

conference

See also