Template:Cite dialog/doc: Difference between revisions

From Guild of Archivists
(Created page with " <templatedata> { "params": { "speaker": { "label": "Speaker", "description": "The person speaking in the dialog scene.", "example": "Atrus", "type": "string",...")
 
(Document the new 'quote' parameter.)
 
(One intermediate revision by one other user not shown)
Line 11: Line 11:
},
},
"scene": {
"scene": {
"label": "Scene",
"label": "Scene title",
"description": "A short name for the dialog scene, including a wikilink to the scene's reference page.",
"description": "A short name for the dialog scene. A wikilink to the corresponding reference page is added automatically.",
"example": "[[Reference:Atrus, forechamer recording|Forechamber recording]]",
"example": "Forechamber recording",
"type": "string",
"required": true
},
"scene-page": {
"label": "Scene page name",
"description": "The name of the dialog scene's reference page on the wiki. Use if the reference page name doesn't follow the standard format.",
"example": "Reference:Atrus, forechamber recording",
"type": "wiki-page-name",
"default": "Reference:{{{speaker}}}, {{{journal}}}"
},
"scene-nolink": {
"label": "Scene title (no automatic wikilink)",
"description": "A short name for the dialog scene. May contain arbitrary wiki markup; no automatic wikilink is added.",
"type": "content",
"type": "content",
"default": "[[{{{scene-page}}}|{{{scene}}}]]",
"example": "[[Reference:Atrus, forechamber recording|Forechamber recording]]"
},
"game": {
"label": "Game name",
"description": "The game that the dialog scene 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 dialog scene 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 (game)",
"type": "wiki-page-name"
},
"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]]",
"example": "[[Myst (game)|Myst]]",
"type": "content",
"type": "content",
"required": true
"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"
}
}
},
},

Latest revision as of 07:25, 3 December 2024

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Speakerspeaker

The person speaking in the dialog scene.

Example
Atrus
Stringrequired
Scene titlescene

A short name for the dialog scene. A wikilink to the corresponding reference page is added automatically.

Example
Forechamber recording
Stringrequired
Scene page namescene-page

The name of the dialog scene's reference page on the wiki. Use if the reference page name doesn't follow the standard format.

Default
Reference:{{{speaker}}}, {{{journal}}}
Example
Reference:Atrus, forechamber recording
Page nameoptional
Scene title (no automatic wikilink)scene-nolink

A short name for the dialog scene. May contain arbitrary wiki markup; no automatic wikilink is added.

Default
[[{{{scene-page}}}|{{{scene}}}]]
Example
[[Reference:Atrus, forechamber recording|Forechamber recording]]
Contentoptional
Game namegame

The game that the dialog scene 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.

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