ਫਰਮਾ:Csdoc/doc

ਵਿਕੀਪੀਡੀਆ, ਇੱਕ ਅਜ਼ਾਦ ਗਿਆਨਕੋਸ਼ ਤੋਂ
Jump to navigation Jump to search

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 ਦੇ ਹਵਾਲੇ ਬਣਾਉਣ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ।

Lua notice[ਸੋਧੋ]

Script error: No such module "Suppress categories".

Usage section[ਸੋਧੋ]

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

ਫਰਮਾ:Citation Style documentation/usage

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

ਫਰਮਾ:Citation Style documentation/usage full

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

ਫਰਮਾ:Citation Style documentation/usage common

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

ਫਰਮਾ:Citation Style documentation/usage vertical

{{cite book
| last                  =
| first                 =
| author-link           =
}}

ਫਰਮਾ:Citation Style documentation/usage vertical mid

 
 
last
 
 

ਫਰਮਾ:Citation Style documentation/usage vertical mid

 
same as last1
same as first1
 
 

ਫਰਮਾ:Citation Style documentation/usage vertical end

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 ਫਰਮਾ:Citation Style documentation/opt

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[ਸੋਧੋ]