Template:BackgroundCite/doc: Difference between revisions

From Deadlock Wiki
Jump to navigation Jump to search
Gammaton32 (talk | contribs)
Created page with "==Usage== This template can be used to reference character backgrounds. <nowiki>{{BackgroundCite|name=hero_name|transcription=transcription}}</nowiki> There's an optional parameter to change the possessive suffix. ==Example usages== Example: <nowiki>{{BackgroundCite|name=Lash|transcription=Jacob Lash is an asshole.}}</nowiki> Result: {{BackgroundCite|name=Lash|transcription=Jacob Lash is an asshole.}} Example of suffix change: <nowiki>{{BackgroundCite|name=Abrams..."
 
Gammaton32 (talk | contribs)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
This template can be used to reference character backgrounds.
This template can be used to reference character backgrounds.


  <nowiki>{{BackgroundCite|name=hero_name|transcription=transcription}}</nowiki>
  <nowiki>{{BackgroundCite|name=hero_name|quote=quote}}</nowiki>


There's an optional parameter to change the possessive suffix.
There's an optional parameter to change the possessive suffix.
Line 8: Line 8:
==Example usages==
==Example usages==
Example:
Example:
  <nowiki>{{BackgroundCite|name=Lash|transcription=Jacob Lash is an asshole.}}</nowiki>
  <nowiki>{{BackgroundCite|name=Lash|quote=Jacob Lash is an asshole.}}</nowiki>
Result:
Result:


{{BackgroundCite|name=Lash|transcription=Jacob Lash is an asshole.}}
{{BackgroundCite|name=Lash|quote=Jacob Lash is an asshole.}}


Example of suffix change:
Example of suffix change:
  <nowiki>{{BackgroundCite|name=Abrams|suffix='|transcription=Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years.}}</nowiki>
  <nowiki>{{BackgroundCite|name=Abrams|suffix='|quote=Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years.}}</nowiki>


Result:
Result:


{{BackgroundCite|name=Abrams|suffix='|transcription=Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years.}}
{{BackgroundCite|name=Abrams|suffix='|quote=Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years.}}


<templatedata>
<templatedata>
Line 25: Line 25:
"name": {
"name": {
             "type": "string",
             "type": "string",
"description": "The name of the character being cited",
"description": "The name of the character whose background is being cited",
"required": true
"required": true
},
},
Line 33: Line 33:
             "required": false
             "required": false
         },
         },
"transcription": {
"quote": {
             "type": "string",
             "type": "string",
"description": "The relevant passage",
"description": "The relevant passage (without quotation marks)",
             "required": true
             "required": true
}
}
Line 43: Line 43:
"name",
"name",
         "suffix",
         "suffix",
"transcription"
"quote"
]
]
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 03:05, 30 November 2024

Usage[edit source]

This template can be used to reference character backgrounds.

{{BackgroundCite|name=hero_name|quote=quote}}

There's an optional parameter to change the possessive suffix.

Example usages[edit source]

Example:

{{BackgroundCite|name=Lash|quote=Jacob Lash is an asshole.}}

Result:

Lash's background - "Jacob Lash is an asshole."

Example of suffix change:

{{BackgroundCite|name=Abrams|suffix='|quote=Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years.}}

Result:

Abrams' background - "Hard hitting, hard headed, and hard drinking; Detective Abrams has been a fixture on the New York investigating scene for years."

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
namename

The name of the character whose background is being cited

Stringrequired
suffixsuffix

Possessive suffix change for characters whose name ends with 's'

Stringoptional
quotequote

The relevant passage (without quotation marks)

Stringrequired