Nodyn:Citation Style documentation/doc

Oddi ar Wicipedia
Jump to navigation Jump to search

Usage[golygu cod y dudalen]

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.

Parameters[golygu cod y dudalen]

syntax[golygu cod y dudalen]

[edit subtemplate]

Nested parameters rely on their parent parameters:

  • parent
  • OR: parent2—may be used instead of parent
    • child—may be used with parent (and is ignored if parent is not used)
    • OR: child2—may be used instead of child (and is ignored if parent2 is not used)
Where aliases are listed, only one of the parameters may be defined; if aliased parameters are defined, then only one will show.

coins[golygu cod y dudalen]

[edit subtemplate]

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.

  • Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
    • Known templates that should not be used: {{smallcaps}}.

sep_period[golygu cod y dudalen]

[edit subtemplate]

By default, sets of fields are terminated with a period (.); this can be an issue when the last field in an abbreviation or initial with a period, as two periods then display. The only solution is to not include the last period in the value for the set of fields.

sep_comma[golygu cod y dudalen]

[edit subtemplate]

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

required[golygu cod y dudalen]

[edit subtemplate]

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

author[golygu cod y dudalen]

[edit subtemplate]

  • last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source.
    • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead.
    • OR: for multiple authors, use first1, last1 through first9, last9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author.
  • authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink.
  • OR: for multiple authors, use authorlink1 through authorlink9.
Aliases: last, last1, author, authors; last1, author1 through last9, author9
When using Shortened footnotes or Parenthetical referencing styles with templates, do not use multiple names in one parameter else the anchor will not match the inline link.

coauthors[golygu cod y dudalen]

[edit subtemplate]

  • coauthors: Names of of coauthors. Use the same format as the authors.
When using Shortened footnotes or Parenthetical referencing styles with templates, do not use this parameter else the anchor will not match the inline link.

editor[golygu cod y dudalen]

[edit subtemplate]

  • editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor1-last, editor, editors.
    • editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor1-first.
    • OR: for multiple editors, use editor1-last, editor1-first through editor4-last, editor4-first for up to four editors.
  • 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 editor1-link through editor4-link.
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."; more than three editors will be followed by "et al., eds."

others[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/others

title_italics[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/title italics

title_quotes[golygu cod y dudalen]

[edit subtemplate]


  • title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in quotes.
    • trans_title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans_title is included in the link. Use of the language parameter is recommended.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space [ ] |

encyclopedia[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/encyclopedia

work[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/work

chapter[golygu cod y dudalen]

[edit subtemplate]

  • chapter: The chapter heading of the source. May be wikilinked or may use chapter-url, but not both. Displays in quotes.
    • script-chapter: Chapter heading for languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc); follows transliteration defined in chapter. Should be prefixed with an ISO 639-1 two-character code to help browsers properly display the script:
      ... |chapter=Tōkyō tawā |script-chapter=ja:東京タワー |trans-chapter=Tokyo Tower ...
    • trans-chapter: English translation of the chapter heading, if the source cited is in a foreign language. Displays in square brackets after the chapter field; if chapter-url is defined, then trans-chapter is included in the link. Use of the language parameter is recommended.

type[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/type Nodyn:Citation Style documentation/opt

journal[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/journal

edition[golygu cod y dudalen]

[edit subtemplate]

  • edition: When the publication has more than one edition; for example: "2nd", "Revised", and so forth. Appends the string " ed." after the field, so |edition=2nd produces "2nd ed." Does not display if a periodical field is defined.

series[golygu cod y dudalen]

[edit subtemplate]

  • series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.

series_episode[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/series episode

event[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/event

agency[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/agency

volume[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/volume

date[golygu cod y dudalen]

[edit subtemplate]

  • date: Full date of source being referenced in the same format as other publication dates in the citations.[1] Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.
  • OR: year: Year of source being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • origyear: Original publication year; displays after the date or year. For clarity, please supply specifics; example: |origyear=First published 1859 or |origyear=Composed 1904.
  1. Publication dates in references within an article should all have the same format. See MOS:DATEUNIFY.

publisher[golygu cod y dudalen]

[edit subtemplate]

  • publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
  • location: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays preceding publisher.
  • publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.

publisher_periodical[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/publisher periodical

newsgroup[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/newsgroup

language[golygu cod y dudalen]

[edit subtemplate]

  • language: The language the source is written in, if not English. Displays in parentheses with "in" before the language name. Use the full language name; do not use icons or templates.

pages[golygu cod y dudalen]

[edit subtemplate]

  • page: Page in the source that supports the content. Displays preceded with p. unless |nopp=y.
  • 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. Displays preceded with pp. unless |nopp=y.
    • nopp: Set to y to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover.
  • OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=.
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.

pages_periodical[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/pages periodical

time[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/time

id1[golygu cod y dudalen]

[edit subtemplate]

  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.

id2[golygu cod y dudalen]

[edit subtemplate]

url[golygu cod y dudalen]

[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. Do not link to any commercial booksellers such as Amazon.com; see WP:PAGELINKS.
    • accessdate: Full date when URL was accessed; use the same format as other access and archive dates in the citations;[1] do not wikilink. Can be hidden by registered editors.
    • archiveurl: 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 and the Internet Archive; requires archivedate.
      • archivedate: Date when the item was archived; use the same format as other access and archive dates in the citations;[1] do not wikilink. Displays preceded by "archived from the original on".
      • deadurl: When the URL is still live, but preemptively archived, then set |deadurl=no. This changes the display order with the title retaining the original link and the archive linked at the end.
    • template doc demo: The archive parameters have error checking to ensure that all the required parameters are included, else {{citation error}} is invoked. 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.
  • format: Format of the work referred to by url; examples: PDF, DOC, XLS; HTML is implied and should not be specified; displayed in parentheses after title. Does not change external link icon.
URLs must begin with a supported URI scheme: http:// and https:// will be supported by all browsers; irc://, ircs://, ftp://, news:, mailto: and gopher:// will require a plugin 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 they will display and link incorrectly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace these characters:
sp " ' < > [ ] | }
%20 %22 %27 %3c %3e %5b %5d %7c %7d
Single apostrophes do not need to be encoded; but unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; but an unencoded pair will be parsed as the double closing braces for the template transclusion.
  1. 1.0 1.1 Access and archive dates in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.

url_periodical[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/url periodical

chapterurl[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/chapterurl

lay[golygu cod y dudalen]

[edit subtemplate]

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

quote[golygu cod y dudalen]

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

ref[golygu cod y dudalen]

[edit subtemplate]

ref2[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/ref2

display[golygu cod y dudalen]

[edit subtemplate]

  • author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value to set the dash in em spaces; set author-mask to a text value to display a word instead; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control as to the order that references will display.
  • author-name-separator: Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • author-separator: Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • display-authors: By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; for example, use |display-authors=2 for only two authors. The "et al." may be suppressed altogether by setting |display-authors=9.
  • lastauthoramp: When set to any value, changes the separator to use between the last two names in lists of authors to an ampersand (&); defaults to a semicolon and space (; ), else author-separator if set.
  • postscript: The closing punctuation for the citation; defaults to a period (.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if quote is defined.
  • separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • cs2: When set, changes the separator to "comma (,)"}}

map_series[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/map series

map_id[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/map id

map_pages[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/map pages

interview_id[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/interview id

interview_author[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/interview author

interview_interviewer[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/interview interviewer

DVD-notes_date[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/DVD-notes date

album_name[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/album name

album_artist[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/album artist

season[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/season

network[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/network

airdate[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/airdate

transcript[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/transcript

notestitle[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/notestitle

conference[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/conference

conference_title[golygu cod y dudalen]

[edit subtemplate]

Nodyn:Citation Style documentation/conference title

See also[golygu cod y dudalen]