模板:Csdoc

来自集智百科 - 复杂系统|人工智能|复杂科学|复杂网络|自组织
跳到导航 跳到搜索


模板:Tsh


This is the {{High-use}} message box.

It is meant to be put at the top of the documentation for templates used on more than 2000 pages.

For templates where the number of pages is more than 100,000 or if the first parameter is set as "risk" a stronger wording is given.

Note! It is normal that some of the links in the message box are red.

Usage

模板:Small


This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlx模板:\sandbox|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{tlx模板:\sandbox|Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use 模板:Tlf, like so:

{{tlx模板:\sandbox|tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlx模板:\sandbox|Template|first=first value|second|third=third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlx模板:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{tlx模板:\sandbox|Template|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after template link).

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in &#124;. A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see Examples at bottom. For more details, see this talk page. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really 模板:Em be used, and just hardcode the usage with <code><nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>.

If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>.

Parameters

检查到模板循环：模板:Tlx will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlx模板:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlx模板:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlx模板:\sandbox|tlxs}} template: {{tlx模板:\sandbox|tlxs|Welcome}} produces: 模板:Tlxs.

|SISTER=

For an interwiki link to other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl|x}}, {{tlp|x}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "模板:Thin space{模板:Thin space", "模板:Thin space|模板:Thin space", "模板:Thin space}模板:Thin space" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).

Usage

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Note
At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.

模板:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlx模板:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

TemplateData

模板:Collapse top

Csdoc-{zh-cn:模板数据;zh-tw:模板資料}-

<templatedata> { "params": { "1": { "label": "Template name", "description": "Name of the template to link.", "example": "Tlx", "type": "wiki-template-name", "required": true }, "2": { "label": "1st parameter", "type": "string" }, "3": { "label": "2nd parameter", "type": "string" }, "4": { "label": "3rd parameter", "type": "string" }, "5": { "label": "4th parameter", "type": "string" }, "6": { "label": "5th parameter", "type": "string" }, "7": { "label": "6th parameter", "type": "string" }, "8": { "label": "7th parameter", "type": "string" }, "9": { "label": "8th parameter", "type": "string" }, "10": { "label": "9th parameter", "type": "string" }, "11": { "label": "10th parameter", "type": "string" }, "12": { "label": "11th parameter", "type": "string" }, "13": { "label": "12th parameter", "type": "string" }, "14": { "label": "13th parameter", "type": "string" }, "15": { "label": "14th parameter", "type": "string" }, "16": { "label": "15th parameter", "type": "string" }, "17": { "label": "16th parameter", "type": "string" }, "18": { "label": "17th parameter", "type": "string" }, "19": { "label": "18th parameter", "type": "string" }, "20": { "label": "19th parameter", "type": "string" }, "21": { "label": "20th parameter", "type": "string" }, "subst": { "description": "Set to any value to show \"subst:\" before the template name", "example": "true", "type": "boolean", "label": "Show subst:" }, "LANG": { "label": "Language", "description": "The prefix for a link to Wikipedias in other languages.", "example": "de:", "type": "line" }, "SISTER": { "description": "The prefix for an interwiki link to other sister projects", "example": "M:", "type": "line", "label": "Sister project" } }, "description": "Show example template usage without expanding the template itself. 模板:Tnull is similar without linking the template.", "paramOrder": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "subst", "LANG", "SISTER" ], "format": "inline" } </templatedata> 模板:Collapse bottom

See also

  • {{tlxb}}, a version of 模板:Tlf where the template name is shown in bold.
  • {{tlb}}, a version of 模板:Tlf where the template name is shown in bold.
  • {{temt}}, a version of 模板:Tlf that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
  • {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=).
  • {{tnull}}, like 模板:Tnull without linking the template.

模板:Template-linking templates 模板:Sandbox other

模板:Small


This template is used to show example template usage without expanding the template itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{tlx模板:\sandbox|tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}} produces: {{tlx模板:\sandbox|Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use 模板:Tlf, like so:

{{tlx模板:\sandbox|tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{tlx模板:\sandbox|Template|first=first value|second|third=third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlx模板:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{tlx模板:\sandbox|Template|first|second|third=value|...|999th}}

Purpose and naming

Mnemonically, template link expanded (after template link).

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in &#124;. A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see Examples at bottom. For more details, see this talk page. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.

Exceptions

If the intended template lists numerous parameters, then perhaps this template should really 模板:Em be used, and just hardcode the usage with <code><nowiki>. For example:

<code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>.

If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>.

Parameters

检查到模板循环：模板:Tlx will also not take nor display additional parameters.
Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlx模板:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlx模板:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlx模板:\sandbox|tlxs}} template: {{tlx模板:\sandbox|tlxs|Welcome}} produces: 模板:Tlxs.

|SISTER=

For an interwiki link to other sister projects, such as: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc, facilitating interwiki template documentation and/or discussion.

|LANG=

For a link to Wikipedias in other languages, such as: |LANG=de: (German), |LANG=sv: (Swedish), etc, facilitating cross-language template documentation and/or discussion.

Documentation

{{Tlx}} is a generalization of {{tl|x}}, {{tlp|x}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "模板:Thin space{模板:Thin space", "模板:Thin space|模板:Thin space", "模板:Thin space}模板:Thin space" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).

Usage

{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{tlx|Templatename|param&#61;value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

Note
At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.

模板:Aligned table

Unlimited parameters as one <nowiki>...</nowiki> string
{{tlx模板:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

TemplateData

模板:Collapse top

Csdoc-{zh-cn:模板数据;zh-tw:模板資料}-

<templatedata> { "params": { "1": { "label": "Template name", "description": "Name of the template to link.", "example": "Tlx", "type": "wiki-template-name", "required": true }, "2": { "label": "1st parameter", "type": "string" }, "3": { "label": "2nd parameter", "type": "string" }, "4": { "label": "3rd parameter", "type": "string" }, "5": { "label": "4th parameter", "type": "string" }, "6": { "label": "5th parameter", "type": "string" }, "7": { "label": "6th parameter", "type": "string" }, "8": { "label": "7th parameter", "type": "string" }, "9": { "label": "8th parameter", "type": "string" }, "10": { "label": "9th parameter", "type": "string" }, "11": { "label": "10th parameter", "type": "string" }, "12": { "label": "11th parameter", "type": "string" }, "13": { "label": "12th parameter", "type": "string" }, "14": { "label": "13th parameter", "type": "string" }, "15": { "label": "14th parameter", "type": "string" }, "16": { "label": "15th parameter", "type": "string" }, "17": { "label": "16th parameter", "type": "string" }, "18": { "label": "17th parameter", "type": "string" }, "19": { "label": "18th parameter", "type": "string" }, "20": { "label": "19th parameter", "type": "string" }, "21": { "label": "20th parameter", "type": "string" }, "subst": { "description": "Set to any value to show \"subst:\" before the template name", "example": "true", "type": "boolean", "label": "Show subst:" }, "LANG": { "label": "Language", "description": "The prefix for a link to Wikipedias in other languages.", "example": "de:", "type": "line" }, "SISTER": { "description": "The prefix for an interwiki link to other sister projects", "example": "M:", "type": "line", "label": "Sister project" } }, "description": "Show example template usage without expanding the template itself. 模板:Tnull is similar without linking the template.", "paramOrder": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "subst", "LANG", "SISTER" ], "format": "inline" } </templatedata> 模板:Collapse bottom

See also

  • {{tlxb}}, a version of 模板:Tlf where the template name is shown in bold.
  • {{tlb}}, a version of 模板:Tlf where the template name is shown in bold.
  • {{temt}}, a version of 模板:Tlf that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
  • {{para}}, for the presentation of template parameters and values (e.g. |paraname=val, |another=).
  • {{tnull}}, like 模板:Tnull without linking the template.

模板:Template-linking templates 模板:Sandbox other

The template can be used as is, and will automatically use bot-updated transclusion counts from subpages of Module:Transclusion_count/data/ when available. But it can also take some parameters:

  • number of transclusions: The first parameter is either a static number of times the template has been transcluded, or the word "risk" (without quotes) to display "a very large number of" instead of the actual value. This value will be ignored if transclusion data is available for the current page (generally for templates with more than 2000 transclusions).
  • discussion page, or use + notation: The second parameter is overloaded. It will cause the number of transclusions to display as "#,###+" instead of "approximately #,###" when set equal to "yes" (without quotes). When used in this manner, values will be rounded down, instead of rounded to the nearest number with the appropriate number of significant figures. When set to any other non-blank value, it will replace the link to the template's talk page to the value of the parameter (for example, 2=WP:VPT will insert a link to WP:VPT),
  • all-pages=yes: Will also output what percentage of all pages use the template. This should only be used for very highly transcluded templates.
  • info=extra information: When set to non-blank, will insert extra information into the template text if the template has more than 10,000 transclusions or paramter 1 is set to "risk".
  • demo=Template_name: Will use the transclusion count for the template at Template:Template_name instead of detecting what template it is being used on. Capitalization must exactly match the value used in Special:PrefixIndex/Module:Transclusion_count/data/.
  • form=: When set to "editnotice", will display the message using {{editnotice}} instead of {{ombox}}.
  • expiry=: Sets the |expiry= paramter for {{editnotice}}.

Examples

The full code for a /doc page top can look like this: 

{{documentation subpage}}
{{high-use}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

Standard form

{{high-use| 4,000 }}
{{high-use| 4,000 | Wikipedia talk:High-risk templates }}
{{high-use| | Wikipedia talk:High-risk templates }}

检查到模板循环：模板:High-use 检查到模板循环：模板:High-use 检查到模板循环：模板:High-use

Rounding and + notation

{{high-use| 49,500 | demo=A template that does not exist }}
{{high-use| 49,500+ | demo=A template that does not exist }}

检查到模板循环：模板:High-use 检查到模板循环：模板:High-use

Editnotice form

{{high-use| form=editnotice }}

检查到模板循环：模板:High-use

High risk

{{high-use| demo=Yesno }}
{{high-use| risk }}
{{high-use| risk | Wikipedia talk:High-risk templates | all-pages = yes | info = This is a very large number! }}

检查到模板循环：模板:High-use 检查到模板循环：模板:High-use 检查到模板循环：模板:High-use

Technical details

The /sandbox and /testcases links are the standard names for such subpages. If those pages are created then the green /doc box for the template will detect them and link to them in its heading. For instance see the top of this documentation.

Ahechtbot compiles usage statistics for all templates with 2,000 or more transclusions using User:Ahechtbot/transclusioncount.py, and writes them to subpages of Module:Transclusion count/data (see Wikipedia:Bots/Requests for approval/Ahechtbot 6). These pages are usually updated every Sunday, but since running the query is resource intensive, it may be delayed or skipped if Wikipedia server usage is high. If a transclusion count is available in Module:Transclusion count/data, any manually input values will be ignored by this template.

Supporting templates and modules

See also

Template counters

模板:Sandbox other This template displays one or more of a template's shortcuts (that is, redirects, also known as aliases, as in the box appearing at the right. {{Tsh}} is a shortcut to this template, {{template shortcut}}, and can be used in its place, as it is in this documentation's source wikitext.

Usage

Place this template and its list of few to one, carefully selected shortcut(s) at the top of the template documentation page's wikitext, right underneath {{Documentation subpage}}. In the saved, rendered text, those shortcuts will appear in this template's Shortcut(s) box, whose title will reflect the number of list items by automatically being singular or plural in form.

Which ones to display here

Although the template can show up to ten shortcuts, you are encouraged to choose well which ones to display in this template's box. Even if many redirects exist, two or three at the most is almost always enough. By keeping the number of redirects presented in the Shortcut box small, it makes it easier to remember them, and the documentation is kept well organized.

Where to list any others

List others in the Redirects section of the template documentation. Again, not all of them need to be listed; some shortcuts are there just for historical reasons, and others differ only in minor points such as white spaces or capitalization. Such shortcut-name variations are unnecessary to list at all—just list the standard, most common version of such a variation.

Optional parameters

This template has several optional parameters:

  • float – if set to "left", then the box will float to the left of the page, instead of the default float "right".
  • clear – if set to "right" (when float also is set to "right"), the box will be pushed to the right margin of the page, and 模板:Clarify Similarly, if set to "left" (when float also is set to "left"), the box will be pushed to the left margin of the page.
  • pre, pre2, pre3 ... up to pre10 – can be used to show some text before the shortcut links, but within the braces. This is mostly used to add the text "subst:". This shows the proper syntax for using the template with substitution.
As with the other shortcuts in the saved, rendered version of this template, this shortcut code can be copied from its line in the box on the documentation page, as it is, and pasted in the wikitext of another page where you wish its rendered version to appear.
  • top – to change the padding above the box (e.g. |top=0 for no padding, |top=0.2em, |top=4模板:\|top=4px).

Examples of basic code

To display one template shortcut named {{uw-v1}}:

模板:Tlc 检查到模板循环：模板:Template shortcut

To display three template shortcuts for {{uw-vandalism1}} named {{uw-v1}}, {{uw-vand1}}, and {{uw-vandal1}}:

模板:Tlc 检查到模板循环：模板:Template shortcut

Example with the float parameter

Using |float=left makes this template flow to the left of the page:

{{template shortcut|float=left|uw-v1}} 检查到模板循环：模板:Template shortcut

Example with text ("subst:") within the braces

This is mostly used to add text to show how the template could be used with substitution.

Use |pre2=subst: and |pre3=subst: to show "subst:" before the shortcut links, but within the braces:

{{template shortcut|uw-v1|pre2=subst:|uw-vand1|pre3=subst:|uw-vandal1}} 检查到模板循环：模板:Template shortcut

See also

模板:Sandbox other 模板:Notice

Usage

This template is used to build consistent documentation pages for 模板:Cs1 templates.

For example: 模板:Tlx 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 模板:Tlx to create consistent content for the lead:

模板:Citation Style documentation/edit 模板:Citation Style documentation/opt

模板:Markup

Lua notice

#invoke:Suppress categories 模板:Clear

Usage section

Start the usage section with 模板:Tlx:

模板:Csdoc

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

Full horizontal style

模板:Pre2 模板:Csdoc

{{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-year= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |nopp= |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= |lay-url= |lay-format= |lay-source= |lay-date= |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=}}

模板:End 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: 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para (deprecated); 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para; 模板:Para.

Most commonly used horizontal style

模板:Pre2 模板:Csdoc

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

模板:End

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; authorlink1; authorlink; 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-year            =
 |df                   =
 |publisher            =
 |location             =
 |publication-place    =
 |via                  =
 |language             =
 |page                 =
 |pages                =
 |nopp                 =
 |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       =
 |lay-url              =
 |lay-format           =
 |lay-source           =
 |lay-date             =
 |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 chapterurl 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-year year or date
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.
nopp page or pages set nopp 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
lay-url
lay-format lay-url
lay-source lay-url
lay-date lay-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
模板:Nowrap
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)
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para (deprecated)
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
模板:Para
(available from late April 2020) 模板:Para

Sub-templates

Usage

模板:Citation Style documentation/edit 模板:End

Usage full

模板:Citation Style documentation/edit 模板:End

Usage common

模板:Citation Style documentation/edit 模板:End

Usage vertical

模板:Citation Style documentation/edit 模板:End

Usage vertical mid

模板:Citation Style documentation/edit 模板:End

Usage vertical end

模板:Citation Style documentation/edit

Examples section

Use 模板:Tl to format the examples 模板:Crossref. 

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

whats new

模板:Citation Style documentation/edit

deprecated

模板:Citation Style documentation/edit

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

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_author

模板:Citation Style documentation/edit

interview_interviewer

模板:Citation Style documentation/edit

season

模板:Citation Style documentation/edit

network

模板:Citation Style documentation/edit

transcript

模板:Citation Style documentation/edit

conference

模板:Citation Style documentation/edit

Notes


模板:Citation Style 1


取自“https://wiki.swarma.org/index.php?title=模板:Csdoc&oldid=18262”