الگو:Citation Style documentation - ویکی‌پدیا، دانشنامهٔ آزاد

توضیحات الگو[نمایش] [ویرایش] [تاریخچه] [پاکسازی]

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.

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.

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

Use {{csdoc|lead|content}} to create consistent content for the lead:

الگو:Citation Style documentation/edit الگو:Citation Style documentation/opt

{{csdoc|lead|books}}

الگو:Citation Style documentation/edit

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.

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

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

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  
• Separate the next column with:

</pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> 

• Create the instructions column; blank lines must include a  
• 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}} 

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

الگو:Citation Style documentation/edit

|}

الگو:Citation Style documentation/edit

|}

الگو:Citation Style documentation/edit

|}

الگو:Citation Style documentation/edit

|}

الگو:Citation Style documentation/edit

|}

الگو:Citation Style documentation/edit

{{markup2 |t=Basic usage with url (and accessdate) and edition |m={{cite book |title=Mysterious book}} |r={{cite book |title=Mysterious book}} }}