Benutzer:Matthiasb/Citation/Style-Dokumentation
Info: Bei Änderungen auf dieser Seite sollte man sich bewußt sein, daß dies Auswirkungen hat auf zahlreichen Vorlagendokumentationsseiten. Falls es Parameter betrifft, die nur eine einzige Vorlage betreffen, sollte man dies dort manuell einfügen oder hier eine neuen Abschnitt anlegen.
Verwendung
[Bearbeiten | Quelltext bearbeiten]This template is used to build consistent documentation pages for Vorlage:Cs1 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
[Bearbeiten | Quelltext bearbeiten]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
[Bearbeiten | Quelltext bearbeiten]Use {{csdoc|lead|content}} to create consistent content for the lead:
Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
{{csdoc|lead|books}}
Lua notice
[Bearbeiten | Quelltext bearbeiten]Skriptfehler: Ein solches Modul „Suppress categories“ ist nicht vorhanden.
Usage section
[Bearbeiten | Quelltext bearbeiten]Start the usage section with {{csdoc|usage}}:
Parameters to copy are enclosed in tables created by sub-templates.
Full horizontal style
[Bearbeiten | Quelltext bearbeiten]- Start with {{csdoc|usage full}}
- Precede the sample markup with
:
to create an indent - Enclose the sample in Vorlage:Tag
- Close the table with {{end}}
{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |layurl= |laysource= |laydate= |author-mask= |display-authors= |postscript= |lastauthoramp=}}
Most commonly used horizontal style
[Bearbeiten | Quelltext bearbeiten]- Start with {{csdoc|usage common}}
- Precede the sample markup with
:
to create an indent - Enclose the sample in Vorlage:Tag
- Close the table with {{end}}
{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}
Full vertical style
[Bearbeiten | Quelltext bearbeiten]The full vertical style is created in three columns: Vertical list, Prerequisites and Brief instructions / notes.
- Start with:
- Create the vertical list column
- Separate the next column with:
- Create the prerequisites column; blank lines must include a
- Separate the next column with:
- Create the instructions column; blank lines must include a
- End with:
Example: Vorlage:Pre2 Vorlage:Csdoc
{{cite book | last = | first = | authorlink = }}
last
same as last1 same as first1
Sub-templates
[Bearbeiten | Quelltext bearbeiten]Usage
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:End
Usage full
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:End
Usage common
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:End
Usage vertical
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:End
Usage vertical mid
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:End
Usage vertical end
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
Examples section
[Bearbeiten | Quelltext bearbeiten]Use {{Markup2}} to format the examples; see the template 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}} }}
Parameters section
[Bearbeiten | Quelltext bearbeiten]syntax
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
COinS
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
sep_period
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
sep_comma
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
required
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
deprecated
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
author
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
editor
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
title
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
Vorlage:Citation Style documentation/opt
web
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
chapter
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
type
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
journal
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
edition
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
series
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
series_episode
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
event
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
agency
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
volume
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
date
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
publisher
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
newsgroup
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
language
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
pages
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
time
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
id1
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
id2
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
url
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
chapterurl
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
lay
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
quote
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
ref
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
ref2
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
display
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt
Subscription or registration required
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
map_series
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
map_pages
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
interview_id
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
interview_author
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
interview_interviewer
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
album_name
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
season
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
network
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
transcript
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
conference
[Bearbeiten | Quelltext bearbeiten]Vorlage:Citation Style documentation/edit
See also
[Bearbeiten | Quelltext bearbeiten]
Category:Documentation assistance templates