Template:Cite book/doc: Difference between revisions

From Guild of Archivists
m (Allow omitting type/format as some existing citations don't have this information)
(Document the new 'quote' parameter.)
 
Line 51: Line 51:
"type": "string",
"type": "string",
"default": "\"page {{{page}}}\" or \"pages {{{pages}}}\""
"default": "\"page {{{page}}}\" or \"pages {{{pages}}}\""
},
"quote": {
"label": "Quote",
"description": "An optional quote from the source material that is relevant to the fact or claim being cited.",
"type": "string"
}
}
},
},
Line 62: Line 67:
"page",
"page",
"pages",
"pages",
"at"
"at",
"quote"
]
]
}
}
</templatedata>
</templatedata>

Latest revision as of 07:25, 3 December 2024

This template is a way to ensure that books are cited using the appropriate citation formatting.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Book titlebook

The title of the book. A wikilink to the book's page is generated automatically

Example
Myst: The Book of Atrus
Stringrequired
Book page namebook-page

The name of the book's page on the wiki. Use if the title doesn't match the page name exactly.

Default
{{{book}}}
Example
Myst: The Book of Atrus
Page nameoptional
Book title (no automatic wikilink)book-nolink

The title of the book. May contain arbitrary wiki markup; no automatic wikilink is added.

Default
[[{{{book}}}|{{{book-title}}}]]
Example
[[Myst: The Book of Atrus]]
Contentoptional
Book formattype

The format of the book that is being referenced.

Example
Hardcover
Stringsuggested
Page numberpage

The page number being cited. When citing multiple pages, use the pages parameter. When not citing by page number(s), use the at parameter.

Example
10
Stringsuggested
Page numberspages

The page numbers being cited. When citing a single page, use the page parameter. When not citing by page number(s), use the at parameter.

Example
10–11
Stringsuggested
Locationat

The location of the text being cited. Use if no page numbers are available (e. g. for ebooks) or the location needs a more complex description than just page numbers.

Default
"page {{{page}}}" or "pages {{{pages}}}"
Example
chapter 8, section 2, paragraph 48
Stringoptional
Quotequote

An optional quote from the source material that is relevant to the fact or claim being cited.

Stringoptional