Andoza:Csdoc
![Documentation icon](http://upload.wikimedia.org/wikipedia/commons/thumb/e/e2/Template-info.png/50px-Template-info.png)
![]() | 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
[manbasini tahrirlash]This template is used to build consistent documentation pages for Andoza: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
[manbasini tahrirlash]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
[manbasini tahrirlash]Use {{csdoc|lead|content}}
to create consistent content for the lead:
Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
Kod | Natija |
---|---|
{{csdoc|lead|books}} |
Lua xatosi: expandTemplate: template "Citation Style documentation/lead" does not exist. |
Lua notice
[manbasini tahrirlash]Skript xatosi: „Suppress categories“ moduli yoʻq.
Usage section
[manbasini tahrirlash]Start the usage section with {{csdoc|usage}}
:
- Lua xatosi: expandTemplate: template "Citation Style documentation/usage" does not exist.
Parameters to copy are enclosed in tables created by sub-templates.
Full horizontal style
[manbasini tahrirlash]- 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}}
Andoza:Pre Lua xatosi: expandTemplate: template "Citation Style documentation/usage full" does not exist.
{{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
[manbasini tahrirlash]- 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}}
Andoza:Pre Lua xatosi: expandTemplate: template "Citation Style documentation/usage common" does not exist.
{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}
|}
Full vertical style
[manbasini tahrirlash]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
[manbasini tahrirlash]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> </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> </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;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
</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;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
{{csdoc|usage vertical end}}
Four-columns format
[manbasini tahrirlash]{| class="wikitable"
|+ Full parameter set in vertical format
! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list
|-
| {{tooltip|2=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>
|-
| {{tooltip|2=or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}
| {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Author's first name. Don't link.
|-
| {{tooltip|2=or any of its aliases, including: author-link; subject-link1; subject-link; (etc.)|author-link1}}
| {{tooltip|2=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.
|}
Parameters | Prerequisites | Brief instructions / notes | Vertical list |
---|---|---|---|
last1 | 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 = }} | |
first1 | last1 | Author's first name. Don't link. | |
author-link1 | last1 | Title of Wikipedia article about the first author. Don't link. | |
last2 | last1 | Like last1 , but for 2nd author.
| |
first2 | last2 | Like first1 , but for 2nd author.
| |
author-link2 | last2 | Like author-link1 , but for 2nd author.
| |
last3 | last2 | Like last1 , but for 3rd author.
| |
first3 | last3 | Like first1 , but for 3rd author.
| |
author-link3 | last3 | Like author-link1 , but for 3rd author.
| |
last4 | last3 | Like last1 , but for 4th author.
| |
first4 | last4 | Like first1 , but for 4th author.
| |
author-link4 | last4 | Like author-link1 , but for 4th author.
| |
last5 | last4 | Like last1 , but for 5th author. Similar: last6, etc.
| |
first5 | last5 | Like first1 , but for 5th author. Similar: first6, etc.
| |
author-link5 | last5 | 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 | ||
display-authors | last1 | 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
[manbasini tahrirlash]Usage
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
|}
Usage full
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
|}
Usage common
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
|}
Usage vertical
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
|}
Usage vertical mid
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
|}
Usage vertical end
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
Examples section
[manbasini tahrirlash]Use {{markup2}} to format the examples Andoza:Crossref.
{{markup2 |t=Basic usage 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
[manbasini tahrirlash]syntax
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
COinS
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
sep_period
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
sep_comma
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
required
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
whats new
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
deprecated
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
author
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
editor
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
title
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
Andoza:Citation Style documentation/opt
web
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
chapter
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
type
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
journal
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
edition
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
series
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
series_episode
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
event
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
agency
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
volume
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
date
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
publisher
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
newsgroup
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
language
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
pages
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
time
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
id1
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
id2
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
url
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
chapterurl
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
lay
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
quote
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
ref
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
display
[manbasini tahrirlash]Andoza:Citation Style documentation/edit Andoza:Citation Style documentation/opt
Subscription or registration required
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
map_series
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
map_pages
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
interview_author
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
interview_interviewer
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
season
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
network
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
transcript
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
conference
[manbasini tahrirlash]Andoza:Citation Style documentation/edit
Notes
[manbasini tahrirlash]Yuqoridagi hujjat Andoza:Csdoc/doc sahifasidan olingan. Tajriba oʻtkazish uchun qumloq va test sahifasidan foydalaning. Iltimos, turkumlarni hujjat sahifasiga va intervikilarni vikimaʼlumotlarga joylashtiring. Ushbu andoza ostsahifalari. |