TemplateDoc:Ref/Marketing: Difference between revisions
From Halopedia, the Halo wiki
No edit summary |
(minor comma wrangling) |
||
| Line 2: | Line 2: | ||
==Description== | ==Description== | ||
This template should be used when citing marketing media created for other pieces of ''Halo'' media. | This template should be used when citing marketing media created for other pieces of ''Halo'' media. For other citation templates, see [[Template:Ref]]. | ||
For other citation templates, see [[Template:Ref]]. | |||
==Usage== | ==Usage== | ||
===Syntax=== | ===Syntax=== | ||
To insert this template onto a page, place one of the following wikitext samples onto the article, and fill in as necessary. You may also add any | To insert this template onto a page, place one of the following wikitext samples onto the article, and fill in as necessary. You may also add any additional parameters seen [[#Parameters|below]] such as a quote or particular detail you want to highlight. | ||
====Citing a standalone marketing piece==== | ====Citing a standalone marketing piece==== | ||
<pre><nowiki> | <pre><nowiki> | ||
{{Ref/Marketing|Id= | {{Ref/Marketing|Id=Ref ID|Marketed media name or acronym|Piece of marketing you're citing}} | ||
</nowiki></pre> | </nowiki></pre> | ||
====Citing a piece from a larger marketing campaign==== | ====Citing a piece from a larger marketing campaign==== | ||
<pre><nowiki>{{Ref/Marketing|Id= | <pre><nowiki>{{Ref/Marketing|Id=Ref ID|Marketed media name or acronym|Name of marketing campaign|Piece of marketing you're citing}}</nowiki></pre> | ||
===Parameters=== | ===Parameters=== | ||
| Line 85: | Line 83: | ||
This template can emit the following warnings: | This template can emit the following warnings: | ||
*[[Template:Internal/Warning/MissingParam|Missing recommended parameter]] - If a recommended parameter is not passed to the template. | * [[Template:Internal/Warning/MissingParam|Missing recommended parameter]] - If a recommended parameter is not passed to the template. | ||
*[[Template:Internal/Warning/DeprecatedParam|Deprecated parameter]] - If a deprecated template parameter is used in a template call. | * [[Template:Internal/Warning/DeprecatedParam|Deprecated parameter]] - If a deprecated template parameter is used in a template call. | ||
====Errors==== | ====Errors==== | ||
This template can throw the following errors: | This template can throw the following errors: | ||
*[[Template:Internal/Error/MissingParam|Missing required parameter]] - If a required parameter is not passed to the template. | * [[Template:Internal/Error/MissingParam|Missing required parameter]] - If a required parameter is not passed to the template. | ||
*[[Template:Internal/Error/InvalidParam|Invalid parameter]] - If an unrecognised parameter is passed to the template. | * [[Template:Internal/Error/InvalidParam|Invalid parameter]] - If an unrecognised parameter is passed to the template. | ||
*[[Template:Internal/Error/ClobberedParam|Overwritten parameter]] - If the same | * [[Template:Internal/Error/ClobberedParam|Overwritten parameter]] - If the same parameter is given multiple values in the template call. | ||
===Examples=== | ===Examples=== | ||
Here are some examples of what the template will output | Here are some examples of what the template will output when used: | ||
====Standard usage==== | ====Standard usage==== | ||
Latest revision as of 21:07, September 15, 2022
This is a template documentation page!
You cannot edit the associated template from here. To do so, please see Template:Ref/Marketing instead!
Description[edit]
This template should be used when citing marketing media created for other pieces of Halo media. For other citation templates, see Template:Ref.
Usage[edit]
Syntax[edit]
To insert this template onto a page, place one of the following wikitext samples onto the article, and fill in as necessary. You may also add any additional parameters seen below such as a quote or particular detail you want to highlight.
Citing a standalone marketing piece[edit]
{{Ref/Marketing|Id=Ref ID|Marketed media name or acronym|Piece of marketing you're citing}}
Citing a piece from a larger marketing campaign[edit]
{{Ref/Marketing|Id=Ref ID|Marketed media name or acronym|Name of marketing campaign|Piece of marketing you're citing}}
Parameters[edit]
| Field Name | Aliases | Optional or Required? | Description | Example |
|---|---|---|---|---|
| Id | - | Recommended | An ID for the reference, so it can be reused. Make it specific to your particular citation, so that it does not conflict with other IDs, and so other editors can understand it. It should always be put at the start. | ReachJFO
|
| 1 (unnamed field) | Media, MediaLink | Required | The name of the piece of media that was being marketed. This field supports the use of Halopedia's acronym system, so CE can be used in place of Halo: Combat Evolved. If the game's page name includes a suffix, please include the MediaText field too.
|
Halo 3
|
| MediaText | MediaLinkText (Deprecated) | Required only if Media includes a suffix | If the Media page includes a suffix, this field should be filled in with what the display text of the link should be - i.e. the page name, but without the suffix.
|
Halo 3
|
| 2 (unnamed field) | Campaign | Optional | The marketing campaign that the cited piece of marketing was a part of. | Believe
|
| 3 (unnamed field) | Ad | Required | The particular advert or piece of marketing being cited. | Shooting a Hero
|
| Detail | - | Optional | Any additional details you wish to specifically highlight about the cited game element. | JFO is a player customisation item
|
| Quote | - | Optional | Used to cite a particular quote from the game that supports your citation. | Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.
|
| Quotee | QuoteeLink | Optional | If Quote is used, this field can be used to specify who or what is being quoted. This field can receive a page name, in which case it will create a link. If the page name includes a suffix please include the QuoteeText.
|
Official description
|
| QuoteeText | QuoteeLinkText (Deprecated) | Required only if Quotee is a page name and includes a suffix | If Quotee contains a page name, this field can be used to override the link display text.
|
Official description
|
Error states[edit]
Warnings[edit]
This template can emit the following warnings:
- Missing recommended parameter - If a recommended parameter is not passed to the template.
- Deprecated parameter - If a deprecated template parameter is used in a template call.
Errors[edit]
This template can throw the following errors:
- Missing required parameter - If a required parameter is not passed to the template.
- Invalid parameter - If an unrecognised parameter is passed to the template.
- Overwritten parameter - If the same parameter is given multiple values in the template call.
Examples[edit]
Here are some examples of what the template will output when used:
Standard usage[edit]
{{Ref/Marketing|Id=DelivHope|HR|Deliver Hope}}- ^ Halo: Reach marketing, Deliver Hope
Campaign field usage[edit]
{{Ref/Marketing|Id=H3Bel|H3|Believe|Shooting a Hero}}- ^ Halo 3 marketing, Believe campaign, Shooting a Hero
Dependencies[edit]
Template dependencies[edit]
This template does not depend on any other templates.
Module dependencies[edit]
This template depends on the following Lua module:
Extension dependencies[edit]
This template requires the following extensions:
- Extension:Scribunto
- Extension:Acronym (In-house extension)
- Extension:UniqueLink (In-house extension)
Dependent templates[edit]
No other templates are known to depend on this one.