Project Herzl

Template:Cite web/doc: Difference between revisions

← Older edit
VisualWikitext
Waki285 (talk | contribs)
3 edits
import from https://en.wikipedia.org/w/index.php?title=Template:Documentation/doc&oldid=1280569207
Tag: Reverted
Waki285 (talk | contribs)
3 edits
delete many
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Short description|Displays documentation from a subpage}}
<noinclude>{{pp-template}}</noinclude>
<noinclude>{{pp-semi-indef}}
</noinclude>{{Documentation subpage}}
{{Distinguish|Template:Documentation subpage}}
{{High-use}}
{{Never substitute}}
{{template shortcut|doc}}
{{Lua|Module:Documentation}}


The {{tlx|documentation}} template is used to contain the [[WP:TDOC|documented information and instructions]] of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.
{{#invoke:cs1 documentation support|template_data_validate|{{ROOTPAGENAME}}}}
<templatedata>
{
"description": "Formats a citation to a website using the provided information such as URL and title. Used only for sources that are not correctly described by the specific citation templates for books, journals, news sources, etc.",
"params": {
"url": {
"label": "URL",
"description": "The URL of the online location where the text of the publication can be found. Requires schemes of the type \"https://...\" or maybe even the protocol relative scheme \"//...\"",
"type": "url",
"aliases": [
"URL"
],
"required": true,
"example": "https://www.metacritic.com//..."
},
"title": {
"label": "Title",
"description": "The title of the source page on the website; will display with quotation marks added. Usually found at the top of your web browser. Not the name of the website.",
"type": "string",
"required": true
},
"date": {
"label": "Source date",
"description": "Full date when the source was published; if unknown, use access-date instead; do not wikilink",
"type": "date",
"suggested": true
},
"access-date": {
"label": "URL access date",
"description": "The full date when the original URL was accessed; do not wikilink",
"type": "date",
"suggested": true,
"aliases": [
"accessdate"
]
},
"website": {
"label": "Name of the website",
"description": "Title (name) of the website (or its short URL if no plain-language title is discernible); may be wikilinked; will display in italics. Having both 'publisher' and 'website' is redundant in many cases.",
"type": "string",
"aliases": [
"work"
],
"suggested": true,
"example": "[[Rotten Tomatoes]]"
},
"publisher": {
"label": "Publisher",
"description": "Name of the publisher; may be wikilinked. Having both 'publisher' and 'website' (a.k.a. 'work') is redundant in many cases.",
"type": "string",
"example": "[[Fandom, Inc.]] (which owns \"Metacritic.com\")"
},
"last": {
"label": "Last name",
"description": "The surname of the author; don't wikilink, use 'author-link'; can suffix with a numeral to add additional authors",
"aliases": [
"last1",
"author",
"author1",
"author1-last",
"author-last",
"surname1",
"author-last1",
"subject1",
"surname",
"subject"
],
"type": "line",
"suggested": true
},
"first": {
"label": "First name",
"description": "Given or first name, middle names, or initials of the author; don't wikilink, use 'author-link'; can suffix with a numeral to add additional authors",
"aliases": [
"given",
"author-first",
"first1",
"given1",
"author-first1",
"author1-first"
],
"type": "line",
"suggested": true
},
"author-link": {
"label": "Author link",
"description": "Title of existing Wikipedia article about the author; can suffix with a numeral to add additional authors",
"type": "wiki-page-name",
"aliases": [
"author-link1",
"author1-link",
"subject-link",
"subject-link1",
"subject1-link",
"authorlink"
]
},
"last2": {
"label": "Last name 2",
"description": "The surname of the second author; don't wikilink, use 'author-link2'.",
"type": "line",
"aliases": [
"author2"
]
},
"first2": {
"label": "First name 2",
"type": "line",
"description": "Given or first name, middle names, or initials of the second author; don't wikilink."
},
"author-link2": {
"label": "Author link 2",
"description": "Title of existing Wikipedia article about the second author.",
"type": "wiki-page-name",
"aliases": [
"author2-link"
]
},
"others": {
"label": "Others",
"description": "Used to record other (non-author) contributions to the work, such as 'Illustrated by John Smith' or 'Translated by John Smith'. Only one ''others'' parameter is allowed: e.g., 'Illustrated by Jane Doe; Translated by John Smith'",
"type": "string"
},
"year": {
"label": "Year of publication",
"description": "Year of the source being referenced; deprecated in favor of 'date', except for the special case of ISO dates with disambiguating letter",
"type": "string"
},
"orig-date": {
"label": "Original date",
"description": "Original date of publication; provide specifics",
"type": "date"
},
"editor-last": {
"label": "Editor last name",
"description": "The surname of the editor; don't wikilink, use 'editor-link'; can suffix with a numeral to add additional editors.",
"type": "line",
"aliases": [
"editor1-last",
"editor"
]
},
"editor-first": {
"label": "Editor first name",
"description": "Given or first name, middle names, or initials of the editor; don't wikilink, use 'editor-link'; can suffix with a numeral to add additional editors; alias of 'editor1-first'",
"type": "line",
"aliases": [
"editor1-first"
]
},
"editor-link": {
"label": "Editor link",
"description": "Title of existing Wikipedia article about the editor; can suffix with a numeral to add additional editors",
"aliases": [
"editor1-link"
],
"type": "wiki-page-name"
},
"series": {
"label": "Series identifier",
"description": "Series identifier when the source is part of a series, such as a book series or a journal",
"type": "string"
},
"publication-place": {
"label": "Place of publication",
"description": "Publication place shows after title; if 'place' or 'location' are also given, they are displayed before the title prefixed with 'written at'",
"type": "string"
},
"publication-date": {
"label": "Publication date",
"description": "Date of publication when different from the date the work was written; do not wikilink",
"type": "date"
},
"page": {
"label": "Page",
"description": "Page in the source that supports the content; displays after 'p.'",
"type": "string"
},
"pages": {
"label": "Pages",
"description": "Pages in the source that support the content (not an indication of the number of pages in the source); displays after 'pp.'",
"type": "string"
},
"no-pp": {
"label": "No pp",
"description": "Set to 'y' to suppress the 'p.' or 'pp.' display with 'page' or 'pages' when inappropriate (such as 'Front cover')",
"type": "boolean",
"autovalue": "y"
},
"at": {
"label": "At",
"description": "May be used instead of 'page' or 'pages' where a page number is inappropriate or insufficient",
"type": "string"
},
"language": {
"label": "Language",
"description": "The language in which the source is written, if not English; use a two-letter language code or the full language name. Do not use icons or templates. Separate multiple languages with commas",
"type": "string",
"aliases": [
"lang"
],
"example": "de, fr, es"
},
"script-title": {
"label": "Script title",
"description": "For titles in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.). Prefix with two-character ISO639-1 language code followed by a colon. For Japanese use: |script-title=ja:...",
"type": "string"
},
"trans-title": {
"label": "Translated title",
"description": "An English language title, if the source cited is in a foreign language; 'language' is recommended",
"type": "string"
},
"type": {
"label": "Type",
"description": "Additional information about the media type of the source; format in sentence case",
"type": "string"
},
"format": {
"label": "Format",
"description": "Format of the work referred to by 'url'; examples: PDF, DOC, XLS; do not specify HTML",
"type": "string"
},
"arxiv": {
"label": "arXiv identifier",
"description": "An identifier for arXive electronic preprints of scientific papers",
"type": "string"
},
"asin": {
"label": "ASIN",
"description": "Amazon Standard Identification Number; 10 characters",
"type": "string"
},
"asin-tld": {
"label": "ASIN TLD",
"description": "ASIN top-level domain for Amazon sites other than the US",
"type": "string"
},
"bibcode": {
"label": "Bibcode",
"description": "Bibliographic Reference Code (REFCODE); 19 characters",
"type": "string"
},
"biorxiv": {
"label": "biorXiv",
"description": "biorXiv identifier; 6 digits",
"type": "line"
},
"citeseerx": {
"label": "CiteSeerX",
"description": "CiteSeerX identifier; found after the 'doi=' query parameter",
"type": "line"
},
"doi": {
"label": "DOI",
"description": "Digital Object Identifier; begins with '10.'",
"type": "string"
},
"doi-broken-date": {
"label": "DOI broken date",
"description": "The date that the DOI was determined to be broken",
"type": "date",
"autovalue": ""
},
"isbn": {
"label": "ISBN",
"description": "International Standard Book Number; use the 13-digit ISBN where possible",
"type": "string"
},
"issn": {
"label": "ISSN",
"description": "International Standard Serial Number; 8 characters; may be split into two groups of four using a hyphen",
"type": "string"
},
"jfm": {
"label": "jfm code",
"description": "Jahrbuch über die Fortschritte der Mathematik classification code",
"type": "string"
},
"jstor": {
"label": "JSTOR",
"description": "JSTOR identifier",
"type": "string"
},
"lccn": {
"label": "LCCN",
"description": "Library of Congress Control Number",
"type": "string"
},
"mr": {
"label": "MR",
"description": "Mathematical Reviews identifier",
"type": "string"
},
"oclc": {
"label": "OCLC",
"description": "Online Computer Library Center number",
"type": "string"
},
"ol": {
"label": "OL",
"description": "Open Library identifier",
"type": "string"
},
"osti": {
"label": "OSTI",
"description": "Office of Scientific and Technical Information identifier",
"type": "string"
},
"pmc": {
"label": "PMC",
"description": "PubMed Center article number",
"type": "string"
},
"pmid": {
"label": "PMID",
"description": "PubMed Unique Identifier",
"type": "string"
},
"rfc": {
"label": "RFC",
"description": "Request for Comments number",
"type": "string"
},
"ssrn": {
"label": "SSRN",
"description": "Social Science Research Network",
"type": "string"
},
"zbl": {
"label": "Zbl",
"description": "Zentralblatt MATH journal identifier",
"type": "string"
},
"id": {
"label": "id",
"description": "A unique identifier used where none of the specialized ones are applicable",
"type": "string"
},
"archive-url": {
"label": "Archive URL",
"description": "The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'",
"type": "url",
"suggested": true,
"autovalue": "",
"aliases": [
"archiveurl"
]
},
"archive-date": {
"label": "Archive date",
"description": "Date when the original URL was archived; do not wikilink",
"type": "date",
"suggested": true,
"aliases": [
"archivedate"
]
},
"archive-format": {
"label": "Archive format",
"description": "Format of the archived copy; do not specify HTML",
"type": "string",
"example": "PDF, DOC, XLS"
},
"quote": {
"label": "Quote",
"description": "Relevant text quoted from the source; displays last, enclosed in quotes; must include terminating punctuation",
"type": "string"
},
"trans-quote": {
"label": "Translated quote",
"description": "English translation of the quotation if the source quoted is in a foreign language. Displays in square brackets.",
"type": "string"
},
"ref": {
"label": "Ref",
"description": "An anchor identifier; can be made the target of wikilinks to full references",
"type": "string"
},
"postscript": {
"label": "Postscript",
"description": "The closing punctuation for the citation; ignored if 'quote' is defined",
"type": "string",
"default": "."
},
"author-mask": {
"label": "Author mask",
"description": "Replaces the name of the first author with em dashes or text; set to a numeric value 'n' to set the dash 'n' em spaces wide; set to a text value to display the text without a trailing author separator; for example, 'with' instead",
"type": "string"
},
"last3": {
"label": "Last name 3",
"description": "The surname of the third author; don't wikilink, use 'author-link3'.",
"type": "line",
"aliases": [
"author3"
]
},
"first3": {
"label": "First name 3",
"type": "line",
"description": "Given or first name, middle names, or initials of the third author; don't wikilink."
},
"author-link3": {
"label": "Author link 3",
"description": "Title of existing Wikipedia article about the third author.",
"type": "wiki-page-name",
"aliases": [
"author3-link"
]
},
"last4": {
"label": "Last name 4",
"description": "The surname of the fourth author; don't wikilink, use 'author-link4'.",
"type": "line",
"aliases": [
"author4"
]
},
"first4": {
"label": "First name 4",
"type": "line",
"description": "Given or first name, middle names, or initials of the fourth author; don't wikilink."
},
"author-link4": {
"label": "Author link 4",
"description": "Title of existing Wikipedia article about the fourth author.",
"type": "wiki-page-name",
"aliases": [
"author4-link"
]
},
"last5": {
"label": "Last name 5",
"description": "The surname of the fifth author; don't wikilink, use 'author-link5'.",
"type": "line",
"aliases": [
"author5"
]
},
"first5": {
"label": "First name 5",
"type": "line",
"description": "Given or first name, middle names, or initials of the fifth author; don't wikilink."
},
"author-link5": {
"label": "Author link 5",
"description": "Title of existing Wikipedia article about the fifth author.",
"type": "wiki-page-name",
"aliases": [
"author5-link"
]
},
"last6": {
"label": "Last name 6",
"description": "The surname of the sixth author; don't wikilink, use 'author-link6'.",
"type": "line",
"aliases": [
"author6"
]
},
"first6": {
"label": "First name 6",
"description": "Given or first name, middle names, or initials of the sixth author; don't wikilink.",
"type": "line"
},
"author-link6": {
"label": "Author link 6",
"description": "Title of existing Wikipedia article about the sixth author.",
"type": "wiki-page-name",
"aliases": [
"author6-link"
]
},
"last7": {
"label": "Last name 7",
"description": "The surname of the seventh author; don't wikilink, use 'author-link7'.",
"type": "line",
"aliases": [
"author7"
]
},
"first7": {
"label": "First name 7",
"type": "line",
"description": "Given or first name, middle names, or initials of the seventh author; don't wikilink."
},
"author-link7": {
"label": "Author link 7",
"description": "Title of existing Wikipedia article about the seventh author.",
"type": "wiki-page-name",
"aliases": [
"author7-link"
]
},
"last8": {
"label": "Last name 8",
"description": "The surname of the eighth author; don't wikilink, use 'author-link8'.",
"type": "line",
"aliases": [
"author8"
]
},
"first8": {
"label": "First name 8",
"type": "line",
"description": "Given or first name, middle names, or initials of the eighth author; don't wikilink."
},
"author-link8": {
"label": "Author link 8",
"description": "Title of existing Wikipedia article about the eighth author.",
"type": "wiki-page-name",
"aliases": [
"author8-link"
]
},
"last9": {
"label": "Last name 9",
"description": "The surname of the ninth author; don't wikilink, use 'author-link9'.",
"type": "line",
"aliases": [
"author9"
]
},
"first9": {
"label": "First name 9",
"type": "line",
"description": "Given or first name, middle names, or initials of the ninth author; don't wikilink."
},
"author-link9": {
"label": "Author link 9",
"description": "Title of existing Wikipedia article about the ninth author.",
"type": "wiki-page-name",
"aliases": [
"author9-link"
]
},
"display-authors": {
"label": "Display authors",
"description": "Number of authors to display before 'et al.' is used. By default, all authors are displayed. Examples: |display-authors=2 will display only the first two authors in a citation followed by et al. |display-authors=etal displays all authors in the list followed by et al.",
"type": "string"
},
"name-list-style": {
"label": "Name list style",
"description": "Set to 'amp' or 'and' to change the separator between the last two names of the name list to ' & ' or ' and ', respectively. Set to 'vanc' to display name lists in Vancouver style.",
"type": "string",
"suggestedvalues": [
"amp",
"and",
"vanc"
]
},
"editor2-last": {
"label": "Editor last name 2",
"description": "The surname of the second editor; don't wikilink, use 'editor2-link'.",
"aliases": [
"editor2"
],
"type": "line"
},
"editor2-first": {
"label": "Editor first name 2",
"description": "Given or first name, middle names, or initials of the second editor; don't wikilink.",
"type": "line"
},
"editor3-last": {
"label": "Editor last name 3",
"description": "The surname of the third editor; don't wikilink, use 'editor3-link'.",
"aliases": [
"editor3"
],
"type": "line"
},
"editor3-first": {
"label": "Editor first name 3",
"description": "Given or first name, middle names, or initials of the third editor; don't wikilink.",
"type": "line"
},
"editor4-last": {
"label": "Editor last name 4",
"description": "The surname of the fourth editor; don't wikilink, use 'editor4-link'.",
"aliases": [
"editor4"
],
"type": "line"
},
"editor4-first": {
"label": "Editor first name 4",
"description": "Given or first name, middle names, or initials of the fourth editor; don't wikilink.",
"type": "line"
},
"editor5-last": {
"label": "Editor last name 5",
"description": "The surname of the fifth editor; don't wikilink, use 'editor5-link'.",
"aliases": [
"editor5"
],
"type": "line"
},
"editor5-first": {
"label": "Editor first name 5",
"description": "Given or first name, middle names, or initials of the fifth editor; don't wikilink.",
"type": "line"
},
"editor6-last": {
"label": "Editor last name 6",
"description": "The surname of the sixth editor; don't wikilink, use 'editor6-link'.",
"aliases": [
"editor6"
],
"type": "line"
},
"editor6-first": {
"label": "Editor first name 6",
"description": "Given or first name, middle names, or initials of the sixth editor; don't wikilink.",
"type": "line"
},
"editor7-last": {
"label": "Editor last name 7",
"description": "The surname of the seventh editor; don't wikilink, use 'editor7-link'.",
"aliases": [
"editor7"
],
"type": "line"
},
"editor7-first": {
"label": "Editor first name 7",
"description": "Given or first name, middle names, or initials of the seventh editor; don't wikilink.",
"type": "line"
},
"editor8-last": {
"label": "Editor last name 8",
"description": "The surname of the eighth editor; don't wikilink, use 'editor8-link'.",
"aliases": [
"editor8"
],
"type": "line"
},
"editor8-first": {
"label": "Editor first name 8",
"description": "Given or first name, middle names, or initials of the eighth editor; don't wikilink.",
"type": "line"
},
"editor9-last": {
"label": "Editor last name 9",
"description": "The surname of the ninth editor; don't wikilink, use 'editor9-link'.",
"aliases": [
"editor9"
],
"type": "line"
},
"editor9-first": {
"label": "Editor first name 9",
"description": "Given or first name, middle names, or initials of the ninth editor; don't wikilink.",
"type": "line"
},
"editor2-link": {
"label": "Editor link 2",
"description": "Title of existing Wikipedia article about the second editor.",
"type": "wiki-page-name"
},
"editor3-link": {
"label": "Editor link 3",
"description": "Title of existing Wikipedia article about the third editor.",
"type": "wiki-page-name"
},
"editor4-link": {
"label": "Editor link 4",
"description": "Title of existing Wikipedia article about the fourth editor.",
"type": "wiki-page-name"
},
"editor5-link": {
"label": "Editor link 5",
"description": "Title of existing Wikipedia article about the fifth editor.",
"type": "wiki-page-name"
},
"editor6-link": {
"label": "Editor link 6",
"description": "Title of existing Wikipedia article about the sixth editor.",
"type": "wiki-page-name"
},
"editor7-link": {
"label": "Editor link 7",
"description": "Title of existing Wikipedia article about the seventh editor.",
"type": "wiki-page-name"
},
"editor8-link": {
"label": "Editor link 8",
"description": "Title of existing Wikipedia article about the eighth editor.",
"type": "wiki-page-name"
},
"editor9-link": {
"label": "Editor link 9",
"description": "Title of existing Wikipedia article about the ninth editor.",
"type": "wiki-page-name"
},
"edition": {
"label": "Edition",
"type": "line",
"description": "Specify the edition or revision of the source, when applicable. For example: '2nd' or '5.1'. What you supply here is suffixed by ' ed.'",
"example": "2nd"
},
"url-access": {
"label": "URL access level",
"description": "Classification of the access restrictions on the URL",
"type": "string",
"suggestedvalues": [
"registration",
"subscription",
"limited"
],
"example": "'registration', 'subscription' or 'limited'"
},
"bibcode-access": {
"label": "Bibcode access level",
"description": "If the full text is available from ADS via this Bibcode, type 'free'.",
"type": "string",
"autovalue": "free"
},
"doi-access": {
"label": "DOI access level",
"description": "If the full text is free to read via the DOI, type 'free'.",
"type": "string",
"autovalue": "free"
},
"hdl-access": {
"label": "HDL access level",
"description": "If the full text is free to read via the HDL, type 'free'.",
"type": "string",
"autovalue": "free"
},
"jstor-access": {
"label": "Jstor access level",
"description": "If the full text is free to read on Jstor, type 'free'.",
"type": "string",
"autovalue": "free"
},
"ol-access": {
"label": "OpenLibrary access level",
"description": "If the full text is free to read on OpenLibrary, type 'free'.",
"type": "string",
"autovalue": "free"
},
"osti-access": {
"label": "OSTI access level",
"description": "If the full text is free to read on OSTI, type 'free'.",
"type": "string",
"autovalue": "free"
},
"via": {
"label": "Published via",
"description": "Name of the entity hosting the original copy of the work, if different from the publisher. This entity is committed not to alter the work.",
"example": "[[GitHub]], [[SourceForge]], [[CodePlex]], [[YouTube]], [[Vimeo]], [[Dailymotion]], [[Netflix]], [[Archive.org]], [[Wikimedia Commons]], [[grc.com]]",
"type": "string"
},
"url-status": {
"label": "URL status",
"description": "If set to 'live', the title display is adjusted; useful for when the URL is archived preemptively but still live. Set to \"dead\" or 'usurped' for broken links. Entering 'unfit' or 'usurped' makes the original link not appear at all.",
"example": "'dead' or 'live'",
"type": "string",
"default": "'dead' if an Archive URL is entered",
"suggested": true,
"suggestedvalues": [
"dead",
"live",
"usurped",
"unfit",
"deviated"
]
},
"agency": {
"label": "Agency",
"description": "The news agency (wire service) that provided the content; examples: Associated Press, Reuters, Agence France-Presse",
"type": "string"
},
"place": {
"label": "Place",
"description": "For news stories with a dateline, the location where the story was written; will be treated as the publication place if publication place is absent; alias of 'location'",
"type": "string"
},
"author-link10": {
"aliases": [
"author10-link"
],
"label": "Author link 10",
"description": "Title of existing Wikipedia article about the tenth author.",
"type": "wiki-page-name"
},
"author-link11": {
"aliases": [
"author11-link"
],
"label": "Author link 11",
"description": "Title of existing Wikipedia article about the eleventh author.",
"type": "wiki-page-name"
},
"last10": {
"aliases": [
"author10"
],
"label": "Last name 10",
"description": "The surname of the tenth author; don't wikilink, use 'author-link10'.",
"type": "line"
},
"first10": {
"label": "First name 10",
"description": "Given or first name, middle names, or initials of the tenth author; don't wikilink.",
"type": "line"
},
"first11": {
"label": "First name 11",
"description": "Given or first name, middle names, or initials of the eleventh author; don't wikilink.",
"type": "line"
},
"last11": {
"aliases": [
"author11"
],
"label": "Last name 11",
"description": "The surname of the eleventh author; don't wikilink, use 'author-link11'.",
"type": "line"
},
"last12": {
"aliases": [
"author12"
],
"label": "Last name 12",
"description": "The surname of the twelfth author; don't wikilink, use 'author-link12'.",
"type": "line"
},
"first12": {
"label": "First name 12",
"description": "Given or first name, middle names, or initials of the twelfth author; don't wikilink.",
"type": "line"
},
"author-link12": {
"aliases": [
"author12-link"
],
"label": "Author link 12",
"description": "Title of existing Wikipedia article about the twelfth author.",
"type": "wiki-page-name"
},
"last13": {
"aliases": [
"author13"
],
"label": "Last name 13",
"description": "The surname of the thirteenth author; don't wikilink, use 'author-link13'.",
"type": "line"
},
"first13": {
"label": "First name 13",
"description": "Given or first name, middle names, or initials of the thirteenth author; don't wikilink.",
"type": "line"
},
"author-link13": {
"aliases": [
"author13-link"
],
"label": "Author link 13",
"description": "Title of existing Wikipedia article about the thirteenth author.",
"type": "wiki-page-name"
},
"last14": {
"aliases": [
"author14"
],
"label": "Last name 14",
"description": "The surname of the fourteenth author; don't wikilink, use 'author-link14'.",
"type": "line"
},
"first14": {
"label": "First name 14",
"description": "Given or first name, middle names, or initials of the fourteenth author; don't wikilink.",
"type": "line"
},
"author-link14": {
"aliases": [
"author14-link"
],
"label": "Author link 14",
"description": "Title of existing Wikipedia article about the fourteenth author.",
"type": "wiki-page-name"
},
"last15": {
"aliases": [
"author15"
],
"label": "Last name 15",
"description": "The surname of the fifteenth author; don't wikilink, use 'author-link15'.",
"type": "line"
},
"first15": {
"label": "First name 15",
"description": "Given or first name, middle names, or initials of the fifteenth author; don't wikilink.",
"type": "line"
},
"author-link15": {
"aliases": [
"author15-link"
],
"label": "Author link 15",
"description": "Title of existing Wikipedia article about the fifteenth author.",
"type": "wiki-page-name"
},
"df": {
"label": "Date format",
"description": "Sets rendered dates to the specified format",
"type": "string"
}
},
"maps": {
"citoid": {
"title": "title",
"url": "url",
"subject": "title",
"publicationTitle": "website",
"blogTitle": "website",
"forumTitle": "website",
"seriesTitle": "website",
"websiteTitle": "website",
"publisher": "publisher",
"date": "date",
"PMCID": "pmc",
"PMID": "pmid",
"oclc": "oclc",
"pages": "pages",
"series": "series",
"accessDate": "access-date",
"archiveUrl": "archive-url",
"archiveDate": "archive-date",
"DOI": "doi",
"language": "language",
"contributor": "others",
"author": [
[
"first",
"last"
],
[
"first2",
"last2"
],
[
"first3",
"last3"
],
[
"first4",
"last4"
],
[
"first5",
"last5"
],
[
"first6",
"last6"
],
[
"first7",
"last7"
],
[
"first8",
"last8"
],
[
"first9",
"last9"
]
],
"editor": [
[
"editor-first",
"editor-last"
],
[
"editor2-first",
"editor2-last"
],
[
"editor3-first",
"editor3-last"
],
[
"editor4-first",
"editor4-last"
],
[
"editor5-first",
"editor5-last"
],
[
"editor6-first",
"editor6-last"
],
[
"editor7-first",
"editor7-last"
],
[
"editor8-first",
"editor8-last"
],
[
"editor9-first",
"editor9-last"
]
]
}
},
"paramOrder": [
"last",
"first",
"author-link",
"last2",
"first2",
"author-link2",
"last3",
"first3",
"author-link3",
"last4",
"first4",
"author-link4",
"last5",
"first5",
"author-link5",
"last6",
"first6",
"author-link6",
"last7",
"first7",
"author-link7",
"last8",
"first8",
"author-link8",
"last9",
"first9",
"author-link9",
"last10",
"first10",
"author-link10",
"last11",
"first11",
"author-link11",
"last12",
"first12",
"author-link12",
"last13",
"first13",
"author-link13",
"last14",
"first14",
"author-link14",
"last15",
"first15",
"author-link15",
"author-mask",
"display-authors",
"name-list-style",
"date",
"year",
"orig-date",
"editor-last",
"editor-first",
"editor-link",
"editor2-last",
"editor2-first",
"editor2-link",
"editor3-last",
"editor3-first",
"editor3-link",
"editor4-last",
"editor4-first",
"editor4-link",
"editor5-last",
"editor5-first",
"editor5-link",
"editor6-last",
"editor6-first",
"editor6-link",
"editor7-last",
"editor7-first",
"editor7-link",
"editor8-last",
"editor8-first",
"editor8-link",
"editor9-last",
"editor9-first",
"editor9-link",
"others",
"title",
"script-title",
"trans-title",
"url",
"url-access",
"url-status",
"archive-url",
"archive-date",
"archive-format",
"access-date",
"website",
"series",
"publisher",
"place",
"page",
"pages",
"at",
"language",
"type",
"format",
"publication-place",
"publication-date",
"df",
"via",
"no-pp",
"arxiv",
"asin",
"asin-tld",
"bibcode",
"biorxiv",
"citeseerx",
"doi",
"doi-broken-date",
"isbn",
"issn",
"jfm",
"jstor",
"lccn",
"mr",
"oclc",
"ol",
"osti",
"pmc",
"pmid",
"rfc",
"ssrn",
"zbl",
"id",
"quote",
"trans-quote",
"ref",
"postscript",
"edition",
"bibcode-access",
"doi-access",
"hdl-access",
"jstor-access",
"ol-access",
"osti-access",
"agency"
],
"format": "{{_ |_=_}}"
}
</templatedata>


For detailed instructions on how and when to use this template, see [[Wikipedia:Template documentation]] (shortcut: [[WP:TDOC]]).
== See also ==
 
{{Citation Style 1}}
This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the <code>[view][edit][history][purge]</code> links), and the smaller "link box" that shows metadata about the documentation alongside the [[Wikipedia:Template sandbox and test cases|sandbox and testcases]] links.
{{Wikipedia referencing}}
 
{{UF-COinS}}
Use of this template allows templates to be [[Wikipedia:Protection policy|protected]], where necessary, while allowing anyone to edit the documentation and categories.
 
== General syntax ==
Normally, the template is used without parameters and is placed inside {{tag|noinclude}} at the bottom of the template page (see {{section link|#Placement and tags}} for more information):
 
<syntaxhighlight lang="wikitext">
<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>
</syntaxhighlight>
 
=== Transcluding a different page ===
To transclude a different page other than the /doc subpage, simply provide {{para|1}} like this:
 
<syntaxhighlight lang="wikitext">
<!--Last line of your template code--><noinclude>
{{Documentation|Template:Other page/doc}}
</noinclude>
</syntaxhighlight>
 
Note that when loading the documentation from a page other than the local /doc subpage, it becomes tricky to handle the categories.
 
=== Using the {{para|content}} parameter ===
The documentation can also be fed directly as text, by using the {{para|content}} parameter:
 
<syntaxhighlight lang="wikitext">
<!--Last line of your template code--><noinclude>
{{Documentation
| content =
<!-- template documentation -->
}}</noinclude>
</syntaxhighlight>
 
When using this parameter, the toolbar will not show. Note that the /doc subpage in the link box will still show up if it exists.
 
Also note that when {{para|1}} and {{para|content}} is specified, {{para|content}} takes precedence and always shows in the documentation box.
 
== Advanced syntax ==
=== Customizing the heading ===
The heading in the documentation box changes depending on namespace. See the below list for the default text in each namespace:
 
* Template namespace: [[File:Test Template Info-Icon - Version (2).svg|32px|link=[[Wikipedia:Template documentation]]]] '''Template documentation'''
* Module namespace: [[File:Test Template Info-Icon - Version (2).svg|32px|link=[[Wikipedia:Template documentation]]]] '''Module documentation'''
* Other namespaces: '''Documentation'''
 
To customize the heading, simply set the parameter {{para|heading}} to anything you like, for example {{para|heading|Infobox documentation}}.
 
Note that if the heading parameter is empty but defined (like {{para|heading|}}) the heading alongside the toolbar will not show.
 
The {{para|heading-style}} parameter can be fed optional [[Cascading Style Sheets|CSS]] values, like {{para|heading-style|font-size:150%;color:red;}}. Not that you should omit quotation marks <code>" "</code> and add the ending semicolon <code>;</code>.
 
=== Customizing the link box ===
To customize the link box, set {{para|link box}} to something else, like {{para|link box|The above documentation is automatically generated from [[Template:Foo]]}}.
 
To hide the link box, simply set {{para|link box}} to <code>off</code>.
 
=== Testing ===
You can simulate the output for a given page by using the {{para|page}} parameter. For example, if you use the code {{para|page|Template:Edit protected}}, the template will behave exactly as if it were on the page [[Template:Edit protected]], including showing the documentation from [[Template:Edit protected/doc]], linking to [[Template:Edit protected/sandbox]], etc. This parameter is useful for testing and is used extensively on the [[Module:Documentation/testcases|module testcases page]].
 
== Placement and tags ==
{{Further information|Wikipedia:Template documentation#Where to place it}}
This code should be added at the bottom of the template code page, with no space before {{Tag|noinclude|o}} (which causes extra whitespace to show on pages where the template is transcluded):
 
<syntaxhighlight lang="wikitext"><!--Last line of your template code--><noinclude>
{{documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude></syntaxhighlight>
 
To automatically insert the above text, you can also use the [[Wikipedia:Substitution|substitution]] code shortcut {{tlxs|doc-code}}.
 
=== Categories and interwikis ===
Depending on where to the documentation is placed, it may be tricky to handle the categories and interwikis. See {{section link|Wikipedia:Template documentation#Categories and interwiki links}} for information about adding these.
 
== Technical details ==
=== Automatic functions ===
If the documentation page does not exist, the toolbar is replaced with a <code>[create][purge]</code> link. The <code>[create]</code> link automatically [[mw:Manual:Creating pages with preloaded text|creates the page with preloaded text]] with the basic documentation syntax. Preload text is also used for the /sandbox and /testcases [create] links.
 
The preload page for the /doc <code>[create]</code> link is [[Template:Documentation/preload]]. The preload pages for the /sandbox and /testcases links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]]. The preload page for the /sandbox <code>[mirror]</code> link is [[Template:Documentation/mirror]].
 
This template also automatically adds {{tl|pp-template}} to a protected template page. When this template is on a /sandbox subpage, it also adds the {{tl|Template sandbox notice}} template.
 
=== Link box features ===
Depending on the namespace, the link box may have less features, or may not show up at all. The following table shows this:
 
{| class="wikitable"
! Namespace
! Behavior
|-
| Template
| Full behavior
|-
| Module
| Full behavior, with the addition of a "create documentation" link when the page does not exist
|-
| User
| Full behavior
|-
| Other namespaces
| Hidden, unless {{para|1}} is specified (which will show "The above documentation is transcluded from {{param|1}}")
|}
 
Alongside that, if {{para|1}} or {{para|content}} is specified, the "Add categories to the /doc subpage" text will not show.
 
=== Subject namespaces vs. talk namespaces ===
This template is usually placed in the [[WP:NS#Subject namespaces|subject namespace]]. But in some cases this template needs to be on the [[WP:TALKSPACE|Talk namespace]]:
 
* In the MediaWiki namespace, since {{tag|noinclude|o}} often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
 
When placed on talk pages, this template usually is placed near the top of the page and without {{tag|noinclude}} tags.
 
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[meta:Help:Link#Subpage feature|subpage feature]] enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.
 
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
 
=== Color scheme ===
{| class="wikitable" style="font-size:90%"
|+ Wikipedia background colors for {{Template link|documentation}} <small>([[Help:Using colors]])</small>
! !! RGB !! HSV !! Color !! General usage !! Note
|-
| A&nbsp;
| <kbd>#ECFCF4</kbd> || 150&deg;, 6%, 99%
| style="background:#ECFCF4" | &nbsp;
| Sample || Current documentation background
|-
| B
| <kbd>#00FF80</kbd>
| style="font-size:90%;" | {{nowrap|1=Hue=150&deg; <small>(41.7%; 106/255<small>dec</small>)</small> 100%, 100%}}
| style="background:#00FF80" | &nbsp;
| Basic hue || What we'd call ''the color''
|-
| colspan="6" |
|-
| 1
| <kbd>#A3BFB1</kbd> || 150&deg;, 15%, 75%
| style="background:#A3BFB1" | &nbsp;
| Header border only ||
|-
| 2
| <kbd>#CEF2E0</kbd> || 150&deg;, 15%, 95%
| style="background:#CEF2E0" | &nbsp;
| Main&nbsp;border; header&nbsp;background ||
|-
| 3
| <kbd>#E6FFF2</kbd> || 150&deg;, 10%, 100%
| style="background:#E6FFF2" | &nbsp;
| 2nd header, accent colour ||
|-
| 4
| <kbd>#F5FFFA</kbd> || 150&deg;, 4%, 100%
| style="background:#F5FFFA" | &nbsp;
| Main background || So saturation in A is a bit off
|}
{{collapse top|title=Colors for documentation navbox}}
As a suggestion, here are colors for a navbox intended for documentation pages only.
They follow the shading of regular blue navbox colors:
<syntaxhighlight lang="wikitext">
| titlestyle = background:#ccffe5
| basestyle  = background:#ddffee
<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->
</syntaxhighlight>
For subgroups, in child navboxes:
<syntaxhighlight lang="wikitext">
{{Navbox|child
| groupstyle = background:#e6fff2
...
</syntaxhighlight>
 
Example:{{Template link expanded|Periodic table templates overview}}
{{collapse bottom}}
 
== Full syntax ==
<syntaxhighlight lang="wikitext">
{{Documentation}}
 
or
 
{{Documentation
| [path to documentation page]
}}
 
{{Documentation
| content =
}}
 
or
 
{{Documentation
| [path to documentation page]
| heading-style =
| heading =
| link box =
}}
 
or
 
{{Documentation
| [path to documentation page]
| content =
| heading-style =
| heading =
| link box =
| page =
}}
</syntaxhighlight>
 
==See also==
* {{tl|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
* {{tl|Barnstar documentation}}, a variant of {{tl|Documentation}} for use with [[Wikipedia:Barnstars|barnstar]] templates.
* {{tl|Navbox documentation}}, a variant of {{tl|Documentation}} for use with [[Wikipedia:Navigation template|navigation templates]].
* [[Wikipedia:Template documentation]] is a how-to guide to template documentation.
* [[Wikipedia:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing.
 
<includeonly><!-- Make sure that only page [[Template:Documentation]] is categorised. No other page (no subpages, not when transcluded).
-->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|
[[Category:Documentation templates| ]]
[[Category:Template namespace templates|Documentation]]


<includeonly>{{Sandbox other||
[[Category:Citation Style 1 templates|W]]
}}</includeonly>
}}</includeonly>
Retrieved from "https://wiki.projectherzl.com/wiki/Template:Cite_web/doc"