Template:Cite DRC notebook/doc: Difference between revisions

From Guild of Archivists
(Create documentation for 'Cite DRC notebook' template.)
 
(Document the new 'quote' parameter.)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
<templatedata>
<templatedata>
{
{
"description": "This template is a simpler to use alternative to the cite journal template, specifically tailored for citing DRC notebooks from the DRC research notebooks area.",
"params":
"params":
{
{
"notebook":
{
"label": "Notebook",
"description": "The name of the notebook. Should correspond to the tail end of a page name in the [[Reference:DRC research notebooks]] area.",
"example": "King Ri'neref",
"type": "wiki-page-name",
"required": true
},
"notebook-nolink":
"notebook-nolink":
{
{
Line 11: Line 20:
"default": "[[Reference:DRC research notebooks/{{{notebook}}}|{{notebook}}} notebook]]"
"default": "[[Reference:DRC research notebooks/{{{notebook}}}|{{notebook}}} notebook]]"
},
},
"notebook":
"quote": {
{
"label": "Quote",
"label": "Notebook",
"description": "An optional quote from the source material that is relevant to the fact or claim being cited.",
"description": "The name of the notebook. Should correspond to the tail end of a page name in the [[Reference:DRC research notebooks]] area.",
"type": "string"
"example": "King Ri'neref",
"type": "wiki-page-name",
"required": true
}
}
},
}
"description": "This template is a simpler to use alternative to the {{t|cite journal}} template, specifically tailored for citing DRC notebooks from the [[Reference:DRC research notebooks|DRC research notebooks]] area."
}
}
</templatedata>
</templatedata>

Latest revision as of 07:25, 3 December 2024

This template is a simpler to use alternative to the cite journal template, specifically tailored for citing DRC notebooks from the DRC research notebooks area.

Template parameters

ParameterDescriptionTypeStatus
Notebooknotebook

The name of the notebook. Should correspond to the tail end of a page name in the [[Reference:DRC research notebooks]] area.

Example
King Ri'neref
Page namerequired
Notebook (no automatic wikilink)notebook-nolink

The name of the notebook. Should be used if the reference page name doesn't follow the standard format.

Default
[[Reference:DRC research notebooks/{{{notebook}}}|{{notebook}}} notebook]]
Contentoptional
Quotequote

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

Stringoptional