සැකිල්ල: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}} |
This Citation Style 1 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}}
|
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}}
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 .
{{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