Documentation icon Skjalfesting til fyrimyndina[vís] [rætta] [søga] [dagfør]
Shortcut ((csdoc))

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 section

Use ((csdoc|lead|content)) to create consistent content for the lead:

[edit subtemplate]

Henda Citation Style 1 fyrimyndin verður nýtt til at skapa citations fyri .

Options for this field:

One unnamed parameter is used to create the trailing text.

Markup Renders as
((csdoc|lead|books))
Henda Citation Style 1 fyrimyndin verður nýtt til at skapa citations fyri books.

Lua notice

[edit subtemplate]

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

((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))
Full parameter set in horizontal format
((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

((csdoc|usage common))
:<code><nowiki>((cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=))</nowiki></code>
((end))
Most commonly used parameters in horizontal format
((cite book |last= |first= |authorlink= |title= |url= |accessdate= |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. 

((csdoc|usage vertical))
<pre style="margin:0px;">

</pre>
((csdoc|usage vertical mid))
<pre style="margin:0px;">

</pre>
((csdoc|usage vertical mid))
<pre style="margin:0px;">

</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))
Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes 
((cite book
| last                  =
| first                 =
| authorlink            =
))

 
 
last
 
 

 
same as last1
same as first1
 
 

Sub-templates

Usage

[edit subtemplate]

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

Usage full

[edit subtemplate]

Full parameter set in horizontal format

Usage common

[edit subtemplate]

Most commonly used parameters in horizontal format

Usage vertical

[edit subtemplate]

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes

Usage vertical mid

[edit subtemplate]

| style="vertical-align:top;" | |}

Usage vertical end

[edit subtemplate]

|}

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

Basic usage with url (and accessdate) and edition
*((cite book |title=Mysterious book))

Mysterious book. 

Parameters section

syntax

[edit subtemplate]

Nested parameters rely on their parent parameters:

Where aliases are listed, only one of the parameters may be defined; if multiple aliased parameters are defined, then only one will show.

COinS

[edit subtemplate]

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See: Wikipedia:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

Use of templates within the citation template, is discouraged because many of these templates will add extraneous HTML or CSS that will be rendered in the metadata. Also, HTML entities, for example &nbsp;, &ndash;, etc, should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

sep_period

[edit subtemplate]

By default, sets of fields are terminated with a period (.).

sep_comma

[edit subtemplate]

By default, sets of fields are terminated with a comma (,).

required

[edit subtemplate]

This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template-doc-demo=true to disable categorization; mainly used for documentation where the error is demonstrated.

deprecated

[edit subtemplate]

The following parameters are deprecated. Their use will place the page into Category:Pages containing cite templates with deprecated parameters:

Options for this field:

  • |date2=yes adds:
    • date2
    • month2
    • year2

author

[edit subtemplate]

  • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink1, authorlink, author1-link, author1link.
  • OR: for multiple authors, use author-link1 through author-linkn. Aliases: author1link through authornlink.
  • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s)
When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field or else the anchor will not match the inline link.

Options for this field:

  • |coauthors=yes adds "coauthors: (deprecated) Names of coauthors. Use the same format as the authors."
  • |others=yes adds "others: To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith"."
  • |aliases= add aliases for last.

editor

[edit subtemplate]

  • editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor1-link.
  • OR: for multiple editors, use editor-link1 through editor-linkn.
  • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s)
Display:
If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.
If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."; exactly four editors will show three editors followed by "et al., eds." unless display-editors is used.

title

[edit subtemplate]

Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space &#91; &#93; &#124;
((bracket|text)) ((pipe)) – see also: rendering vertical bars in tables
  • title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink. Alias: titlelink.

Options for this field:


title_title sets the display title:

  • encyclopedia = encyclopedia
  • default = title

web

[edit subtemplate]

Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space &#91; &#93; &#124;
((bracket|text)) ((pipe)) – see also: rendering vertical bars in tables
This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template-doc-demo=true to disable categorization; mainly used for documentation where the error is demonstrated.

chapter

[edit subtemplate]

Options for this field:


title_format sets the display format:

  • italics = Displays in italics.
  • work = If work is defined, then title is displayed in quotes, else displays in italics.
  • default = Displays in quotes.

title_title sets the display title:

  • booktitle = booktitle
  • default = chapter

type

[edit subtemplate]

Options for this field:


  • type_default: Adds "Defaults to type_default"

journal

[edit subtemplate]

When set, work changes the formatting of other parameters:
title is not italicized and is enclosed in quotes.
chapter does not display in this citation template (and will produce an error message).
location and publisher are enclosed in parentheses.
page and pages do not show p. or pp.
edition does not display.

Options for this field:

  • department adds:
  • department: Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.

edition

[edit subtemplate]

series

[edit subtemplate]

series_episode

[edit subtemplate]

  • series-link: Wikilink to an existing Wikipedia article.

event

[edit subtemplate]

agency

[edit subtemplate]

volume

[edit subtemplate]

date

[edit subtemplate]

For approximate year, precede with "c. ", like this: |date=c. 1900; for no date, add as |date=n.d.
  1. The template uses |ref=harv, or the template is ((citation)), or |mode=cs2
  2. The |date= format is YYYY-MM-DD.
  3. The citation requires a CITEREF disambiguator.
  1. ↑ Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See: MOS:DATEUNIFY.

Options for this field:

  • aliases includes aliases for date
  • began adds:
  • OR: began: Full date the first part of the program or episode aired.
    • AND: ended: Full date the last part of the program or episode aired.

publisher

[edit subtemplate]

Options for this field:

  • |work=no suppresses "; if work is defined, then publisher and location are enclosed in parentheses"
  • |map=yes changes:
    • publisher: Name of publisher. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Displays before title. Do not wikilink—use publisher-link instead.
    • publisher-link: Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.

newsgroup

[edit subtemplate]

Fyrimynd:Citation Style documentation/newsgroup

language

[edit subtemplate]

pages

[edit subtemplate]

Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

Options for this field:

  • work adds "or work (or an alias) is defined"

time

[edit subtemplate]

Fyrimynd:Citation Style documentation/time

id1

[edit subtemplate]

id2

[edit subtemplate]

These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier. In general, the parameters should include only the variable part of the identifier, e.g. rfc=822 or pmc=345678.

url

[edit subtemplate]

  • url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove spurious tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... Do not link to any commercial booksellers, such as Amazon.com. See: WP:PAGELINKS.
    • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.[date 1] Not required for linked documents that do not change. For example, access-date is not required for links to copies of published research papers accessed via DOI or a published book, but should be used for links to news articles on commercial web sites (these can change from time to time, even if they are also published in a physical medium). Note that access-date is the date that the URL was checked to not just be working, but to support the assertion being cited (which the current version of the page may not do). Can be hidden or styled by registered editors. Alias: accessdate.
    • archive-url: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite (see: Wikipedia:Using WebCite) and Internet Archive (see: Wikipedia:Using the Wayback Machine); requires archive-date and url. Alias: archiveurl.
      • archive-date: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.[date 1] Do not wikilink. Alias: archivedate.
      • dead-url: When the URL is still live, but pre-emptively archived, then set |dead-url=no. This changes the display order with the title retaining the original link and the archive linked at the end. Alias: deadurl.
    • template-doc-demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else ((citation error)) is invoked. With errors, main, help and template pages are placed into one of the subcategories of Category:Articles with incorrect citation syntax. Set |template-doc-demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
  • format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Automatically added when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.
URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: will require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported.
If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:
sp " ' < > [ ] { | }
%20 %22 %27 %3c %3e %5b %5d %7b %7c %7d
Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.
  1. ↑ 1.0 1.1 Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See: MOS:DATEUNIFY.

Options for this field:


  • pmc adds:

" If url is not defined but pmc is, then url is set to the pmc link.

  • Embargo: Date that pmc goes live; if this is in the future, then url is not set to the pmc link until that date."

chapterurl

[edit subtemplate]

Fyrimynd:Citation Style documentation/chapterurl

lay

[edit subtemplate]

  • lay-url: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary". Aliases: lay-summary, laysummary.
    • lay-source: Name of the source of the laysummary. Displays in italics and preceded by an endash. Alias: laysource.
    • lay-date: Date of the summary. Displays in parentheses. Alias: laydate.

quote

[edit subtemplate]

  • quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

Options for this field:

  • |cs2=yes suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."

ref

[edit subtemplate]

  • ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value |ref=ID generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value |ref=harv generates an anchor suitable for the ((harv)) template. See: Anchors for Harvard referencing templates.

ref2

[edit subtemplate]

  • ref: ID for anchor. By default, anchors are always generated. The ordinary nonempty value |ref=ID generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing.

display

[edit subtemplate]

Fyrimynd:Citation Style documentation/display

Options for this field:


  • cs2: When set, changes:
    • postscript to "defaults to none"
    • separator to "Defaults to a comma (,)"

Subscription or registration required

[edit subtemplate]

  • conference: Name of the conference, may include location if different from location and date if different from date or year.
    • conference-url: URL of conference proceedings, if different from url. Alias: conferenceurl.

map_series

[edit subtemplate]

Fyrimynd:Citation Style documentation/map series

map_pages

[edit subtemplate]

  • page: Page in the source that supports the content; overridden by at.
  • OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source.
  • inset: The name of the focused inset referenced; example: Downtown Fooburg. Output appends "inset" after the input, |inset=Downtown Fooburg becomes "Downtown Fooburg inset."; overridden by at.
  • section: The map section(s) of the feature referenced; example: A6, B9, L11, etc; overridden by at.
  • at: For sources where a single set of the above parameters is inappropriate or insufficient to describe the in-source location(s).
Examples: page (p.) or pages (pp.); inset(s); section (§) or sections (§§); other custom location on the map or in the atlas.

interview_id

[edit subtemplate]

Fyrimynd:Citation Style documentation/interview id

interview_author

[edit subtemplate]

Fyrimynd:Citation Style documentation/interview author

interview_interviewer

[edit subtemplate]

Fyrimynd:Citation Style documentation/interview interviewer

album_name

[edit subtemplate]

Fyrimynd:Citation Style documentation/album name

season

[edit subtemplate]

Fyrimynd:Citation Style documentation/season

network

[edit subtemplate]

  • network: The network the episode was aired on. (e.g. ABC, NBC, CBS, Fox, Disney, USA Network, BBC)
    • station: Call letters of the local station (if any).

transcript

[edit subtemplate]

Fyrimynd:Citation Style documentation/transcript

conference

[edit subtemplate]

  • conference: Name of the conference, may include location if different from location and date if different from date or year.
    • conference-url: URL of conference proceedings, if different from url. Alias: conferenceurl.

See also

Bólkar