Benutzer:Matthiasb/Citation/Style-Dokumentation

aus Wikipedia, der freien Enzyklopädie


 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

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

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:

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

{{csdoc|lead|books}}

Lua notice

Skriptfehler: Ein solches Modul „Suppress categories“ ist nicht vorhanden.

Usage section

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

Vorlage:Csdoc

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= |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=}}</nowiki></code>
{{end}}

Vorlage:Csdoc

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

Vorlage: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= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}

Vorlage:Csdoc

{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}

Vorlage: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 &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                 =
| authorlink            =
}}
</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}}

Vorlage:Csdoc

{{cite book
| last                  =
| first                 =
| authorlink            =
}}

Vorlage:Csdoc

 
 
last
 
 

Vorlage:Csdoc

 
same as last1
same as first1
 
 

Vorlage:Csdoc

Sub-templates

Usage

Vorlage:Citation Style documentation/edit Vorlage:End

Usage full

Vorlage:Citation Style documentation/edit Vorlage:End

Usage common

Vorlage:Citation Style documentation/edit Vorlage:End

Usage vertical

Vorlage:Citation Style documentation/edit Vorlage:End

Usage vertical mid

Vorlage:Citation Style documentation/edit Vorlage:End

Usage vertical end

Vorlage:Citation Style documentation/edit

Examples section

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

Vorlage:Markup2

Parameters section

syntax

Vorlage:Citation Style documentation/edit

COinS

Vorlage:Citation Style documentation/edit

sep_period

Vorlage:Citation Style documentation/edit

sep_comma

Vorlage:Citation Style documentation/edit

required

Vorlage:Citation Style documentation/edit

deprecated

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

author

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

editor

Vorlage:Citation Style documentation/edit

title

Vorlage:Citation Style documentation/edit

Vorlage:Citation Style documentation/opt

web

Vorlage:Citation Style documentation/edit

chapter

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

type

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

journal

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

edition

Vorlage:Citation Style documentation/edit

series

Vorlage:Citation Style documentation/edit

series_episode

Vorlage:Citation Style documentation/edit

event

Vorlage:Citation Style documentation/edit

agency

Vorlage:Citation Style documentation/edit

volume

Vorlage:Citation Style documentation/edit

date

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

publisher

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

newsgroup

Vorlage:Citation Style documentation/edit

language

Vorlage:Citation Style documentation/edit

pages

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

time

Vorlage:Citation Style documentation/edit

id1

Vorlage:Citation Style documentation/edit

id2

Vorlage:Citation Style documentation/edit

url

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

chapterurl

Vorlage:Citation Style documentation/edit

lay

Vorlage:Citation Style documentation/edit

quote

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

ref

Vorlage:Citation Style documentation/edit

ref2

Vorlage:Citation Style documentation/edit

display

Vorlage:Citation Style documentation/edit Vorlage:Citation Style documentation/opt

Subscription or registration required

Vorlage:Citation Style documentation/edit

map_series

Vorlage:Citation Style documentation/edit

map_pages

Vorlage:Citation Style documentation/edit

interview_id

Vorlage:Citation Style documentation/edit

interview_author

Vorlage:Citation Style documentation/edit

interview_interviewer

Vorlage:Citation Style documentation/edit

album_name

Vorlage:Citation Style documentation/edit

season

Vorlage:Citation Style documentation/edit

network

Vorlage:Citation Style documentation/edit

transcript

Vorlage:Citation Style documentation/edit

conference

Vorlage:Citation Style documentation/edit

See also

Vorlage:Citation Style 1


Category:Documentation assistance templates