Template:Cite journal/doc: Difference between revisions

From Guild of Archivists
mNo edit summary
(Document the new 'quote' parameter.)
 
(3 intermediate revisions by one other user not shown)
Line 5: Line 5:
"author": {
"author": {
"label": "Author",
"label": "Author",
"description": "The author of the journal or document. When citing DRC notebooks, use \"DRC\".",
"description": "The author of the journal or document. When citing DRC notebooks, use \"DRC\". Per the citation guidelines this shouldn't be a wikilink.",
"type": "string",
"required": true,
"example": "Atrus"
},
"journal": {
"label": "Journal or document title",
"description": "The title of the journal or document. A wikilink to the corresponding reference page is added automatically.",
"example": "Channelwood journal",
"type": "string",
"type": "string",
"required": true
"required": true
},
},
"journal": {
"journal-page": {
"label": "Journal or document name",
"label": "Journal or document page name",
"description": "The title of the journal, notebook, or document, formatted as a wikilink",
"description": "The name of the journal or document's reference page on the wiki. Use if the reference page name doesn't follow the standard format.",
"example": "[[Reference:DRC research notebooks/Jalak|Jalak]]",
"example": "Reference:Atrus, Channelwood journal",
"type": "wiki-page-name",
"type": "wiki-page-name",
"default": "Reference:{{{author}}}, {{{journal}}}"
},
"journal-nolink": {
"label": "Journal or document title (no automatic wikilink)",
"description": "The title of the journal, notebook, or document. May contain arbitrary wiki markup; no automatic wikilink is added.",
"example": "[[Reference:Atrus, Channelwood journal|Channelwood journal]]",
"type": "content",
"default": "[[{{{journal-page}}}|{{{journal}}}]]"
},
"game": {
"label": "Game name",
"description": "The name of the game that the journal or document is from. A wikilink to the game's page is added automatically.",
"example": "Myst",
"type": "string",
"required": true
"required": true
},
},
"game": {
"game-page": {
"label": "Game",
"label": "Game page name",
"description": "The game that the journal or document is from. including a link to the game's article.",
"description": "The name of the game's page on the wiki. Use if the game page name doesn't match the displayed name.",
"example": "[[Myst III: Exile]]",
"example": "Myst (game)",
"type": "wiki-page-name",
"type": "wiki-page-name",
"required": true
"default": "{{{game}}}"
},
"game-nolink": {
"label": "Game name (no automatic wikilink)",
"description": "The name of the game that the journal or document is from. May contain arbitrary wiki markup; no automatic wikilink is added.",
"example": "[[Myst (game)|Myst]]",
"type": "content",
"default": "[[{{{game-page}}}|{{{game}}}]]"
},
"quote": {
"label": "Quote",
"description": "An optional quote from the source material that is relevant to the fact or claim being cited.",
"type": "string"
}
}
},
},
"format": "inline",
"format": "inline",
"description": "This template is a way to ensure that journals and other notebooks are cited using the appropriate citation formatting."
"description": "This template is a way to ensure that journals and other notebooks are cited using the appropriate citation formatting.",
"paramOrder": [
"author",
"journal",
"journal-page",
"journal-nolink",
"game",
"game-page",
"game-nolink",
"quote"
]
}
}
</templatedata>
</templatedata>

Latest revision as of 07:25, 3 December 2024

This template is a way to ensure that journals and other notebooks are cited using the appropriate citation formatting.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Authorauthor

The author of the journal or document. When citing DRC notebooks, use "DRC". Per the citation guidelines this shouldn't be a wikilink.

Example
Atrus
Stringrequired
Journal or document titlejournal

The title of the journal or document. A wikilink to the corresponding reference page is added automatically.

Example
Channelwood journal
Stringrequired
Journal or document page namejournal-page

The name of the journal or document's reference page on the wiki. Use if the reference page name doesn't follow the standard format.

Default
Reference:{{{author}}}, {{{journal}}}
Example
Reference:Atrus, Channelwood journal
Page nameoptional
Journal or document title (no automatic wikilink)journal-nolink

The title of the journal, notebook, or document. May contain arbitrary wiki markup; no automatic wikilink is added.

Default
[[{{{journal-page}}}|{{{journal}}}]]
Example
[[Reference:Atrus, Channelwood journal|Channelwood journal]]
Contentoptional
Game namegame

The name of the game that the journal or document is from. A wikilink to the game's page is added automatically.

Example
Myst
Stringrequired
Game page namegame-page

The name of the game's page on the wiki. Use if the game page name doesn't match the displayed name.

Default
{{{game}}}
Example
Myst (game)
Page nameoptional
Game name (no automatic wikilink)game-nolink

The name of the game that the journal or document is from. May contain arbitrary wiki markup; no automatic wikilink is added.

Default
[[{{{game-page}}}|{{{game}}}]]
Example
[[Myst (game)|Myst]]
Contentoptional
Quotequote

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

Stringoptional