الگو:Citation Style documentation

از ویکی‌پدیا، دانشنامهٔ آزاد
پرش به ناوبری پرش به جستجو
توضیحات الگو[نمایش] [ویرایش] [تاریخچه] [پاکسازی]

Usage[ویرایش]

This template is used to build consistent documentation pages for شیوه یادکرد ۱ 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

متن نمایش
{{csdoc|lead|books}}
This شیوه یادکرد ۱ template is used to create citations for books.

Lua notice[ویرایش]

الگو:Citation Style documentation/edit

Usage section[ویرایش]

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

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters to avoid clutter in the edit window. Some samples 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}}
{{csdoc|usage full}}
:<code><nowiki>{{cite book |last1= |first1= |author1-link= |last2= |first2= |author2-link= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans-title= |url= |archive-url= |archive-date= |format= |access-date= |type= |edition= |series= |volume= |date= |year= |orig-year= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans-chapter= |chapter= |chapter-url= |quote= |ref= |bibcode= |lay-url= |lay-source= |lay-date= |author-mask= |display-authors= |postscript= |last-author-amp=}}</nowiki></code>
{{end}}
Full parameter set in horizontal format
{{cite book |last1= |first1= |author1-link= |last2= |first2= |author2-link= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans-title= |url= |archive-url= |archive-date= |format= |access-date= |type= |edition= |series= |volume= |date= |year= |orig-year= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans-chapter= |chapter= |chapter-url= |quote= |ref= |bibcode= |lay-url= |lay-source= |lay-date= |author-mask= |display-authors= |postscript= |last-author-amp=}}


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}}
{{csdoc|usage common}}
:<code><nowiki>{{cite book |last= |first= |author-link= |title= |url= |access-date= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}
Most commonly used parameters in horizontal format
{{cite book |last= |first= |author-link= |title= |url= |access-date= |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:
{{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 &nbsp;
  • Separate the next column with:
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
  • Create the instructions column; blank lines must include a &nbsp;
  • 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}}
Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{cite book
| last                  =
| first                 =
| author-link           =
}}
 
 
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[ویرایش]

الگو:Citation Style documentation/edit

Examples section[ویرایش]

Use {{markup2}} to format the examples (see that template's 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}}
}}

Basic usage with url (and accessdate) and edition

  • {{cite book |title=Mysterious book}}
Mysterious book.


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

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[ویرایش]