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

ވިކިޕީޑިއާ އިންވިކިޕީޑިއާ
(މިސްރާބުކުރެވުނީ ފަންވަތް:Csdoc އިން)
Jump to navigation Jump to search
Documentation icon Template documentation[view] [edit] [history] [purge]
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.

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:

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

Lua notice[އުނިއިތުރު ގެންނަވާ]

Script error: No such module "Suppress categories".

Usage section[އުނިއިތުރު ގެންނަވާ]

Start the usage section with

{{csdoc|usage}}:

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

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

ފަންވަތް:Pre2 ފަންވަތް:Citation Style documentation/usage full

{{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 ފަންވަތް:Citation Style documentation/usage common

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

ފަންވަތް: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 ފަންވަތް:Citation Style documentation/usage vertical

{{cite book
| last                  =
| first                 =
| authorlink            =
}}

ފަންވަތް:Citation Style documentation/usage vertical mid

 
 
last
 
 

ފަންވަތް:Citation Style documentation/usage vertical mid

 
same as last1
same as first1
 
 

ފަންވަތް:Citation Style documentation/usage vertical end

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[އުނިއިތުރު ގެންނަވާ]

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

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

ފަންވަތް:Markup2

Parameters section[އުނިއިތުރު ގެންނަވާ]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Subscription or registration required[އުނިއިތުރު ގެންނަވާ]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

See also[އުނިއިތުރު ގެންނަވާ]

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