साचा: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. |
Usage
[संपादन]This template is used to build consistent documentation pages for Citation Style 1 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
Markup | Renders as |
---|---|
{{csdoc|lead|books}} |
ह्या Citation Style 1 साच्याचा वापर books साठी citations निर्माण करायला प्रयोग होतो. |
Lua notice
[संपादन]साचा:Citation Style documentation/edit
Usage section
[संपादन]Start the usage section with {{csdoc|usage}}
:
- वापरण्यासाठी रिक्त आवृत्ती कॉपी करा. सर्व प्रचालांचे नाव lowercase मध्ये असले पाहिजे. प्रत्येक प्रचालाच्या मध्ये "|" (पाइप) वर्णाचा वापर करा. एडिट विंडो मध्ये नुसती गर्दी नसावी, म्हणून, न वापरलेल्या प्रचाल हटवा. काही नामुन्यांमध्ये आज ची तारीख असेल. जर असं नसलं, तर पान purge करा.
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}}
|
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}}
|
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
- 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;"> last </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> same as last1 same as first1 </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.
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