موضيل:Citation Style documentation

شرح د لقالب[شوف] [عدل] [تاريخ] [تحديت]

موضيل ؤلا شرح د لموضيل مامطرجمش. عافاك عاون ف طّرجامة ديالو.

تخدام

This template is used to build consistent documentation pages for موضيل:Cs1 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:

Lua notice

Usage section

Start the usage section with {{csdoc|usage}}:

موضيل:Csdoc

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

{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}

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

{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}

|}

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".

<!--
* Start with: 
-->
{{csdoc|usage vertical}}
<pre style="margin:0px;">
<!--
* Create the vertical list column
* Separate the next column with:
-->
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
<!--
* Create the prerequisites column; blank lines must include a <code>&nbsp;</code>
* Separate the next column with:
-->
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
<!--
* Create the instructions column; blank lines must include a <code>&nbsp;</code>
* End with:
-->
</pre>
{{csdoc|usage vertical end}}

Example:

{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| author-link           =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
&nbsp;
last
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
same as last1
same as first1
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical end}}
{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| author-link           =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
&nbsp;
last
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
same as last1
same as first1
&nbsp;
&nbsp;
{{csdoc|usage vertical end}}

Four-columns format

{| class="wikitable"
|+ Full parameter set in vertical format
! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list
|-
| {{Hover title|or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| 
| Author's last name or single name author. Don't link.
| rowspan="3" style="vertical-align:top;" | <pre style="margin:0px; border:none;">
{{cite xxxxx 
 |last1                =
 |first1               =
 |author-link1         =
}}
</pre>
|-
| {{Hover title|or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}
| {{Hover title|or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Author's first name. Don't link.
|-
| {{Hover title|or any of its aliases, including: author-link; subject-link1; subject-link; (etc.)|author-link1}}
| {{Hover title|or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Title of Wikipedia article about the first author. Don't link.
|}

Full parameter set in vertical format

Parameters	Prerequisites	Brief instructions / notes	Vertical list
موضيل:Hover title		Author's last name or single name author. Don't link.	{{cite xxxxx |last1 = |first1 = |author-link1 = |last2 = |first2 = |author-link2 = |last3 = |first3 = |author-link3 = |last4 = |first4 = |author-link4 = |last5 = |first5 = |author-link5 = |name-list-style = |vauthors = |translator-last1 = |translator-first1 = |translator-link1 = |translator-last2 = |translator-first2 = |translator-link2 = |collaboration = |contributor-last1 = |contributor-first1 = |contributor-link1 = |contributor-last2 = |contributor-first2 = |contributor-link2 = |others = |editor-last1 = |editor-first1 = |editor-link1 = |editor-last2 = |editor-first2 = |editor-link2 = |editor-last3 = |editor-first3 = |editor-link3 = |veditors = |title = |script-title = |trans-title = |work = |script-work = |trans-work = |issue = |department = |chapter = |script-chapter = |trans-chapter = |contribution = |type = |edition = |series = |series-link = |episode = |event = |agency = |volume = |date = |year = |orig-date = |df = |publisher = |location = |publication-place = |via = |language = |page = |pages = |no-pp = |at = |minutes = |time = |time-caption = |id = |arxiv = |asin = |asin-tld = |bibcode = |biorxiv = |citeseerx = |doi = |doi-broken-date = |eissn = |hdl = |sbn = |isbn = |ismn = |issn = |jfm = |jstor = |lccn = |mr = |oclc = |ol = |osti = |pmc = |embargo = |pmid = |rfc = |ssrn = |zbl = |url = |format = |archive-url = |archive-format = |url-status = |archive-date = |chapter-url = |chapter-format = |access-date = |no-tracking = |quote = |ref = |mode = |author-mask1 = |author-mask2 = |author-mask3 = |author-mask4 = |author-mask5 = |display-authors = |translator-mask1 = |translator-mask2 = |display-translators = |contributor-mask1 = |contributor-mask2 = |display-contributors = |editor-mask1 = |editor-mask2 = |editor-mask3 = |display-editors = |postscript = |url-access = |chapter-url-access = |bibcode-access = |doi-access = |hdl-access = |jstor-access = |ol-access = |osti-access = |map = |script-map = |trans-map = |map-url = |map-format = |map-url-access = |scale = |cartography = |inset = |sections = |interviewer-last1 = |interviewer-first1 = |interviewer-link1 = |interviewer-last2 = |interviewer-first2 = |interviewer-link2 = |interviewer-mask1 = |interviewer-mask2 = |display-interviewers = |season = |series-number = |series-separator = |network = |station = |transcript = |transcript-url = |transcript-format = |conference = |conference-url = |conference-format = }}
موضيل:Hover title	موضيل:Hover title	Author's first name. Don't link.
موضيل:Hover title	موضيل:Hover title	Title of Wikipedia article about the first author. Don't link.
موضيل:Hover title	موضيل:Hover title	Like last1, but for 2nd author.
موضيل:Hover title	موضيل:Hover title	Like first1, but for 2nd author.
موضيل:Hover title	موضيل:Hover title	Like author-link1, but for 2nd author.
موضيل:Hover title	موضيل:Hover title	Like last1, but for 3rd author.
موضيل:Hover title	موضيل:Hover title	Like first1, but for 3rd author.
موضيل:Hover title	موضيل:Hover title	Like author-link1, but for 3rd author.
موضيل:Hover title	موضيل:Hover title	Like last1, but for 4th author.
موضيل:Hover title	موضيل:Hover title	Like first1, but for 4th author.
موضيل:Hover title	موضيل:Hover title	Like author-link1, but for 4th author.
موضيل:Hover title	موضيل:Hover title	Like last1, but for 5th author. Similar: last6, etc.
موضيل:Hover title	موضيل:Hover title	Like first1, but for 5th author. Similar: first6, etc.
موضيل:Hover title	موضيل:Hover title	Like author-link1, but for 5th author. Similar: author-link6, etc.
name-list-style		vanc to emulate Vancouver style
vauthors
translator-last1
translator-first1	translator-last1
translator-link1	translator-last1
translator-last2	translator-last1	Additional translators: translator-last3, etc.
translator-first2	translator-last2
translator-link2	translator-last2
collaboration
contributor-last1
contributor-first1
contributor-link1
contributor-last2
contributor-first2
contributor-link2
others
editor-last1
editor-first1	editor-last1
editor-link1	editor-last1
editor-last2	editor-last1
editor-first2	editor-last2
editor-link2	editor-last2
editor-last3	editor-last2
editor-first3	editor-last3
editor-link3	editor-last3
veditors
title
script-title
trans-title	title or script-title
work
script-work
trans-work	work or script-work
issue
department
chapter		Chapter title can be wikilinked unless when a chapter-url is given
script-chapter
trans-chapter	chapter or script-chapter
contribution
type
edition		Ordinal number
series
series-link
episode
event
agency
volume
date
year
orig-date	date or year
df
publisher
location	publisher
publication-place
via
language
page		choose one: "page", "pages", or "at"
pages		choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text.
no-pp	page or pages	set no-pp to "yes" to suppress the "p." or "pp." before page numbers
at		choose one: "page", "pages", or "at"
minutes
time
time-caption
id
arxiv
asin
asin-tld
bibcode
biorxiv
citeseerx
doi
doi-broken-date	doi
eissn
hdl
sbn
isbn		always include ISBN, if one has been assigned
ismn
issn
jfm
jstor
lccn
mr
oclc
ol
osti
pmc
embargo
pmid
rfc
ssrn
zbl
url	title or script-title
format	url
archive-url	archive-date, url
archive-format
url-status	archive-url
archive-date	archive-url
chapter-url	chapter or script-chapter
chapter-format	chapter-url
access-date	url
no-tracking
quote
ref
mode		cs1 or cs2
author-mask1	last1
author-mask2	last2
author-mask3	last3
author-mask4	last4
author-mask5	last5
موضيل:Hover title	موضيل:Hover title	number (number of authors displayed) or etal (more authors)
translator-mask1	translator-last1
translator-mask2	translator-last2
display-translators
contributor-mask1
contributor-mask2
display-contributors
editor-mask1	editor-last1
editor-mask2	editor-last2
editor-mask3	editor-last3
display-editors
postscript
url-access
chapter-url-access
bibcode-access
doi-access
hdl-access
jstor-access
ol-access
osti-access
map
script-map
trans-map
map-url
map-format
map-url-access
scale
cartography
inset
sections
interviewer-last1
interviewer-first1
interviewer-link1
interviewer-last2
interviewer-first2
interviewer-link2
interviewer-mask1
interviewer-mask2
display-interviewers
season
series-number
series-separator
network
station
transcript
transcript-url
transcript-format
conference
conference-url
conference-format
If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left.
Additional parameters (available for at least some cite templates)
			|authors=
			|book-title=
			|class=
			|degree=
			|docket=
			|encyclopedia=
			|mailing-list=
			|message-id=
			|number=
			|publication-date=
			|section=
			|sheet=
			|sheets=
			|title-link=
		(available from late April 2020)	|s2cid=

Sub-templates

تخدام

|}

Usage full

|}

Usage common

|}

Usage vertical

|}

Usage vertical mid

|}

Usage vertical end

Examples section

Use {{markup2}} to format the examples موضيل:Crossref.

{{markup2 |t=تخدام بسيط with url and edition
|m={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}
|r={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}
}}

Parameters section

syntax

COinS

sep_period

sep_comma

required

whats new

deprecated

author

editor

title

web

chapter

نوع

journal

edition

series

series_episode

event

agency

volume

date

publisher

newsgroup

language

pages

time

id1

id2

url

chapterurl

lay

quote

ref

display

Subscription or registration required

map_series

map_pages

interview_author

interview_interviewer

season

network

transcript

conference

نوطات

موضيل:Citation Style 1