Help:Style guide/Card

From Hearthstone Wiki
Jump to navigation Jump to search

Currently, all card articles use {{Card template v2}} to display the layout of the article.

Every single card MUST have a dbfId. For collectible cards, you can easily check its ID by looking at the links on PlayHearthstone Card Library or the Blizzard API. For example, https://playhearthstone.com/en-us/cards/66876-rokara-the-valorous means  Rokara, the Valorous's dbfId is 66876.

This article is aimed at helping editors manage the {{Card template v2}} template on card articles specifically. For more information about wiki editing in general, see Help:Style guide, and for information about Hearthstone Wiki-specific editing, see Hearthstone Wiki:Editor's Handbook.

Page Titles[edit source]

Pages or articles that depict cards must have their title match with their name and captialization.

Usage[edit source]

{{Card template v2
 |dbfId=

// Derived keys: Keys that have default value based on the official data we get. You can edit these key values, but it's suggested that you keep them as their default value.

 |derived_img=
 |derived_imgMain=
 |derived_imgMainPremium=
 |derived_imgBg=
 |derived_imgBgPremium=
 |derived_imgMercTemplate=
 |derived_imgMercAbility=
 |derived_imgMercPortrait=
 |derived_imgArt=
 |derived_imgFullArt=
 |derived_imgSignatureFullArt=
 |derived_artist=
 |derived_classIds=
 |derived_classOrder=
 |derived_coreUnlockedLevel=
 |derived_exclusions=
 |derived_faction=
 |derived_formats=
 |derived_goldenUncraftable=
 |derived_isRemoved=
 |derived_regularUncraftable=
 |derived_relatedCardDbfIds=
 |derived_choiceCardDbfIds=
 |derived_setId=
 |derived_text=
 |derived_trimText=
 |derived_lastAdded=
 |derived_lastModified=
 |derived_minionTypeIds=
 |derived_minionTypeStrings=

// Custom keys: Made-up keys that are non-existent or unrelated to official data, but prove to be useful. You can edit these keys freely without being afraid of disrupting official data.

 |custom_advPools=
 |custom_advHeroPowerDbfIds=
 |custom_advSignatureDbfIds=
 |custom_artistReferences=
 |custom_bannedOfferDbfIds=
 |custom_bgPage=
 |custom_bgSoundId=
 |custom_characs=
 |custom_characsInArt=
 |custom_coreInYears=
 |custom_cycles=
 |custom_externalLinks=
 |custom_genders=
 |custom_hearthpwnId=
 |custom_hiddenTags=
 |custom_mechanicTags=
 |custom_onBlizzardApi=
 |custom_originalCardDbfId=
 |custom_outOfCardsId=
 |custom_races=
 |custom_racesInArt=
 |custom_refTags=
 |custom_voiceActor=
 |custom_voiceActorReferences=

 // Article sections: These keys generate sections in the article itself, such as Notes, History, or Lore

 |article_description=
 |article_relatedCards=
 |article_relatedWith=
 |article_notes=
 |article_tipsUsing=
 |article_tipsAgainst=
 |article_sounds=
 |article_soundsCUSTOM_trigger=
 |article_soundsCUSTOM_other=
 |article_soundsCUSTOM_triggerReferences=
 |article_soundsCUSTOM_otherReferences=
 |article_history=
 |article_lore=
 |article_trivia
 |article_gallery=
 |article_videos=
 |article_meta=
 |article_addedCategories=
}}

Styling and functionality[edit source]

Adding sections[edit source]

On articles that do not use article_custom=true, the parameters must be used as listed above. For example, if you want to add a Lore section to a card, the way to add it is different depending on whether article_custom is used or not. Generally, using article_custom is not preferred, as default layouts are easier to manage. However, on particularly complex articles such as bosses, article_custom can be helpful.

If article_custom=true is used, the section is added normally, e.g.:

==Lore== {{fromwow}} :''The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland.

If article_custom=true is not used, the section needs to be added as follows:

|article_lore= {{fromwow}} :''The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland.

You can see from the example that the addition of sections is very similar, only the title is automatically generated when the content is placed in the article_lore section.

The content that is added to a section differs depending on the parameter used (See #Examples below for extra details).

Don't mix![edit source]

It is important to not mix up these ways of adding sections. For example, do not use the article_custom=true way of adding sections if the article does not have a custom layout. For example, in a Card template such as this:

{{Card template v2 |dbfId=101056 }}

The section should be added as follows:

{{Card template v2 |dbfId=101056 |article_lore=Text here, etc etc }}

And NOT like this:

{{Card template v2 |dbfId=101056 }} ==Lore== Text here, etc etc

The latter way should always be used in only card article that use article_custom=true!

Separators[edit source]

If you want to add multiple values to a parameter, for example listing multiple races in custom_racesInArt, they are separated by a limiter that varies between parameters. Usually this limiter is && on text parameters, , on files, and {{!}} on image captions. But be sure to look at the description of the parameter to know which one to use.

DbfIds[edit source]

As every card has an unique dbfId, these are often used in Card templates to add information.

If you don't know the dbfId of a card, you can use {{subst:Fetch card|<card pagename>}} if you know the page name of the card on this wiki. For example, {{subst:Fetch card|Aman'Thul}} produces 97103. Remember that this needs to be the exact page name on the card. This means typing Battlegrounds/Mini-Myrmidon, not Mini-Myrmidon, since the page name is Battlegrounds/Mini-Myrmidon. Similarly, using Aracne Shot (Core) instead of Aracne Shot if you specifically want the dbfId of the Core version: Arcane Shot (Core).

Section styling[edit source]

Here are a few examples of sections that may require special styling or information.

Tags[edit source]

If you don't know what tags to use, see Help:Style guide/Tag for more information.

Full art[edit source]

Full art files should be written without the [[File: part. For example, Rokara, the Valorous full.jpg.

List-format sections[edit source]

In non-custom layout card articles, Notes, Trivia, Tips, and other sections that use a list format (mentioned on the Description of the parameter), use && as the "bullet point", instead of the typical *. For example, the following would be a correctly written article_notes section:

|article_notes= &&Note 1 goes here. &&Note 2 goes here. * Subnote regarding Note 2. * Another subnote regarding Note 2. ** Subnote regarding the subnote above. &&Note 3 goes here.

On the article, the example above would produce the following:

  • Note 1 goes here.
  • Note 2 goes here.
    • Subnote regarding Note 2.
    • Another subnote regarding Note 2.
      • Subnote regarding the subnote above.
  • Note 3 goes here.

As you can see, the && functions as the "first" bullet point, which starts a new bullet point section. Then the additional * and ** under Note 2 produce additional bullet points related to Note 2. This can also be produced with <ul><li></li></ul> if that is your preferred format.

On non-list format sections, such as Lore or History, bullet points are written as normal.

Tips[edit source]

Tips should follow a certain editing policy to remain as neutral and readable as possible. For more information, see Help:Style guide/Tips.

Gallery[edit source]

In the gallery section, files are split by line breaks, and captions are added with {{!}}. The full art of a card is always added by default on non-custom layout articles, and doesn't need to be added here. An example of a gallery with multiple images added would look like this:

|article_gallery=Rheastrasza WoW.jpg{{!}}Rheastrasza in ''[[World of Warcraft]]'' Rhea WoW.jpg{{!}}Rhea in ''[[World of Warcraft]]''

Lore[edit source]

Generally, it is preferred that card lore is indented and italicized:

:''The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland.

Which produces:

The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland.

Additionally, if card lore is directly copy-pasted from Warcraft Wiki, the template {{fromwow}} should be used before it:

Warcraft Wiki icon.pngThis section uses content from the Warcraft Wiki.
The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland.

Examples[edit source]

These examples are presented when a card article is edited visually (not using source editor), and while article_custom is not being used. Template used for card articles. See Help:Style guide/Card for more information.

Parameters[edit source]

Parameters used in Card template v2.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
dbfIddbfId

The official unique numerical id of the card. Every single card must have this. For collectible cards, you can easily check its ID by looking at the links on PlayHearthstone Card Library or the Blizzard API. For example, [https://hearthstone.blizzard.com/en-us/cards/66876-rokara-the-valorous] means Rokara, the Valorous's dbfId is 66876. Use ONLY one of dbfId, id, or name to search cards.

Example
66876
Numberrequired
IDid

The official string ID of the card. Use ONLY one of dbfId, id, or name to search cards.

Example
AV_202
Stringoptional
Namename

The official name of the card. Use ONLY one of dbfId, id, or name to search cards.

Example
Rokara, the Valorous
Stringoptional
Related card dbfIdsderived_relatedCardDbfIds

List of the dbfIds of cards that this card generates, summons, or references (Separated by &&). For example, Kara Kazham! is a card that summons three different tokens with unique dbfIds.

Example
39198&&39199&&39200
Numberoptional
Choice card dfbIdsderived_choiceCardDbfIds

List of the dbfIds of choice cards that can be chosen from this card (Separated by &&). For example, Living Roots has two choice cards that each have an unique dbfId.

Example
2789&&2791
Numberoptional
Exclusionsderived_exclusions

List of exclusions where this card cannot be seen (Separated by &&). Valid options are: Arena, Card generation, Duels deck-building, Duels card buckets, Wild.

Example
Duels deck-building&&Duels card buckets
Stringoptional
Mechanics/Abilitiescustom_mechanicTags

Mechanics, abilities, or keywords on the card (Separated by &&). (e.g. Taunt, Lifesteal, Draw cards, Shuffle into deck). Examples of abilities can be seen at [Help:Style guide/Tag]

Example
Rush&&Taunt&&Draw cards&&Destroy
Stringsuggested
Referenced mechanicscustom_refTags

Mechanics, abilities, or keywords that are referenced by the card (Separated by &&). (e.g. Taunt-granting, Stealth-generating, Rush-related). Examples of referenced tags can be seen at [Help:Style guide/Tag]

Example
Taunt-granting&&Stealth-generating&&Rush-related
Stringsuggested
Hidden tagscustom_hiddenTags

Tags that are useful for querying, but do not need to be presented on the infobox (Separated by &&). Examples of hidden tags can be seen at [Help:Style guide/Tag]

Example
Triggered effect - after your opponent casts a spell
Stringsuggested
Cyclescustom_cycles

List of cycles that this card belongs to (Separated by &&). Cycles can be small card pools that are referenced by various cards (e.g. Libram or SI:7). They can also help categorize Battlegrounds cards which tend to have inconsistent data (e.g. BG tavern token, BG removed tavern minion)

Example
Libram
Stringoptional
Racescustom_races

The Warcraft race(s) of a minion or hero, or occasionally weapon (Separated by &&). Used for card art articles. Valid options can be seen at the bottom of any card art article (e.g. Night elf art)

Example
Night elf
Stringoptional
Background racescustom_racesInArt

Warcraft races that are on the background of a card's art, or not as the main subject, or are referenced by the art (Separated by &&). Can be used for all card types. Valid options can be seen at the bottom of any card art article (e.g. Night elf art)

Example
Gnome&&Goblin
Stringoptional
Charactercustom_characs

The named character on the card. Used for disambiguation pages. If multiple, separated by &&.

Example
Khadgar
Stringoptional
Background characterscustom_characsInArt

Named characters that are on the background of the card art, or not as the main focus of the art, or are otherwise referenced by the art (Separated by &&).

Example
Khadgar&&Medivh
Stringoptional
Gendercustom_genders

Gender of the character on the card. Values are 0, 1, or 2, for female, male, and other.

Example
1
Numberoptional
Full artderived_imgFullArt

The file name of the card's full art. If not declared, by default this will be "<card name> full.jpg"

Example
Rokara, the Valorous full.jpg
Fileoptional
Signature full artderived_imgSignatureFullArt

The file name of the card's full signature art. If not declared, by default this will be "<card name> signature full.jpg"

Example
Invincible signature full.jpg
Fileoptional
Artistderived_artist

The card's artist. On most collectible constructed cards, this value is stored automatically. For some uncollectible or single-player cards, it may need to be manually declared.

Example
Matt Dixon
Stringoptional
Artist referencescustom_artistReferences

If a card's artist needs citation (e.g. the artist themselves said on an external website that they're the artist of a card), the citations can be referenced here (Separated by &&)

Example
Link 1&&Link 2
URLoptional
VFX Artistcustom_vfxArtist

The artist who created the VFX effects for this card or item (NOT the drawn artwork itself).

Example
Matt Dixon
Stringoptional
VFX Artist referencescustom_vfxArtistReferences

If a card's VFX artist needs citation (e.g. the artist themselves said on an external website that they're the VFX artist of a card), the citations can be referenced here (Separated by &&)

Example
Link 1&&Link 2
URLoptional
Voice actorcustom_voiceActor

The voice actor of the card.

Example
Lani Minella
Stringoptional
Voice actor referencescustom_voiceActorReferences

If a card's voice actor needs citation (e.g. the voice actor themselves said on an external website that they're the voice actor of a card), the citations can be referenced here (Separated by &&)

Example
Link 1&&Link 2
Stringoptional
Class IDsderived_classIds

List of classes that this card belongs to (IDs of the classes, separated by &&). Most of the time, this does not need to be declared, however it may be needed for multi-class cards during reveal seasons due to incomplete data. List of class IDs can be seen at [[Template:CardsCardClass table/store1]].

Example
3&&7
Numberoptional
Formatsderived_formats

List of constructed formats that this card belongs to (Separated by &&). Valid options are: Standard, Wild, Twist, Arena, Duels, Boss, System, Classic. Most of the time, this does not need to be declared, but may be required if the card's formats are wrong (e.g. a single-player Boss card is showing Standard in its formats).

Example
Standard&&Wild
Stringoptional
Removedderived_isRemoved

"1" if the card is removed. May be needed if a removed card is not automatically categorized as removed.

Example
1
Numberoptional
Query onlycustom_isQuery

"1" if the card only needs to be displayed along with its infobox, without storing any data. May be needed for constructed cards in Battlegrounds that are the exact same as their constructed counterpart (same dbfId)

Example
1
Numberoptional
Core set yearscustom_coreInYears

List of Hearthstone years (without the "Year of the" part) that have this card in their Core set (Separated by &&). Used for Core set versions of cards only.

Example
Hydra&&Wolf
Stringoptional
Hearthstone Card Library linkcustom_onBlizzardApi

"1" if the card can be seen in the official Hearthstone Card Library. Adds a link to the External links section of the article for the card on the card library. Usually all cards except Solo Adventure and Tavern Brawl cards can be linked to.

Example
1
Numbersuggested
HearthPwn IDcustom_hearthpwnId

ID of the HearthPwn page for the card. Adds a link to the HearthPwn page for the card on the External links section. For example, Arcane Giant's HearthPwn link is [https://www.hearthpwn.com/cards/42049]. This means that Arcane Giant's HearthPwn ID is 42049.

Example
42049
Numbersuggested
Out of Games IDcustom_outOfCardsId

ID of the Out of Games page for the card. Adds a link to the Out of Games page for the card on the External links section. For example, Arcane Giant's Out of Cards link is [https://outof.games/hearthstone/cards/3022]. This means that Arcane Giant's Out of Cards ID is 3022.

Example
3022
Numbersuggested
Original card dbfIdcustom_originalCardDbfId

The dbfId of the card's original version. May be needed for Core or Classic cards.

Example
559
Numberoptional
Unique emotescustomFunctionalityUniqueEmote

Used for hero skins. Values are "1" or "full" if the skin has a full set of custom emotes, and "2" or "base" if the skin only has new base emotes compared to a previous skin using the same character.

Example
1
Numberoptional
Tray imagecustomFunctionalityUniqueTrayImage

Used for hero skins. If the skin comes with an unique tray, the image file can be pasted here to be presented on the hero skin's article.

Example
LeroyJenkins tray PC.png
Fileoptional
Golden tray imagecustomFunctionalityUniqueGoldenTrayImage

Used for hero skins. If the skin comes with an unique golden tray, the image file can be pasted here to be presented on the hero skin's article.

Example
LeroyJenkins tray PC GOLDEN.png
Fileoptional
Phone tray imagecustomFunctionalityUniquePhoneTrayImage

Used for hero skins. If the skin comes with an unique mobile phone tray, the image file can be pasted here to be presented on the hero skin's article.

Example
Leroy tray grounds.png
Fileoptional
External linkscustom_externalLinks

Adds additional links to the "External links" section of the article (Separated by &&)

Example
Link 1&&Link 2
URLoptional
Custom layoutarticle_custom

"1" or "true" if you wish that the card article should use an entirely custom layout. This disables all auto-generated sections, and the article must be written from scratch. This however does not hide the infoboxes.

Example
true
Stringoptional
Pre-descriptionarticle_preDesc

An italicized and indented text, before the description.

Example
You may be looking for this other page.
Stringoptional
Descriptionarticle_description

The first paragraph of the article, before the first section. Usually this does not need to be changed, but can be altered for better presentation.

Example
Leeroy Jenkins is a legendary neutral minion card, from the Legacy set.
Stringoptional
Related cardsarticle_relatedCards

Used to display a custom layout for a card's related cards. By default, the related cards will simply be listed from the "Related card dbfIds" section.

Example
<h2>Concoction cards</h2> {{Card query|layout=article image|format=Standard,Wild|customCycles=Concoction|collectible=}}
Contentoptional
Related witharticle_relatedWith

Used to display a custom layout for cards this card is related with. By default, the cards it's related with will simply be listed from other cards that have this card in their "Related card dbfIds" section.

Example
<h2>Related with</h2> {{Card query|layout=article image|format=Wild|collectible=|customReferencedTags=SI:7-related}}
Contentoptional
Notesarticle_notes

Notes for the card (Separated by &&). Generates a "Notes" section on the article with a list format.

Example
&&This card does a specific thing. &&This card however does not do this other specific thing.
Contentoptional
Tips (using)article_tipsUsing

Tips when using this card (Separated by &&). Similar to Strategy, but avoid using filler text and follow the editing policies at [Hearthstone Wiki:Editing policies/Tips].

Example
This card is recommended for aggressive decks.
Contentoptional
Tips (against)article_tipsAgainst

Tips when playing against this card (Separated by &&). Similar to Strategy, but avoid using filler text and follow the editing policies at [Hearthstone Wiki:Editing policies/Tips].

Example
Avoid building a large board against opponent's who you suspect might be running this card.
Contentoptional
Soundsarticle_sounds

If left empty, by default, this will list the card's play, attack, and death sounds. If not left empty, a custom Sounds section layout can be written here.

Example
(Insert sound files here)
Contentoptional
Achievementsarticle_achievements

Uses {{Achievement query}} to get the achievements that are directly related to this card. No longer recommended from 2023, since this can be handled with [Template:CustomAchievement table], but this section may still be used for pre-2023 cards.

Example
{{Card article achievement|category=Gameplay|Sire Denathrius}}
Templateoptional
Historyarticle_history

History of the card. Generates a "History" section on the article.

Example
This card was part of an OTK combo in 2018... etc.
Contentoptional
Lorearticle_lore

Lore of the card. Generates a "Lore" section on the article.

Example
The Boulderfist clan is a clan of ogres that live throughout the Arathi Highlands in Azeroth and Nagrand in Outland
Contentoptional
Triviaarticle_trivia

Trivia of the card, such as fun facts or information not related to Hearthstone specifically (Separated by &&). Generates a "Trivia" section on the article with a list format.

Example
&&This card's artwork is from the WoW TCG. &&This card's flavor text is a reference to a song.
Contentoptional
Galleryarticle_gallery

Additional images, such as the character or race in WoW, or concept art (Separated by line breaks). The full art and full signature art do not need to be placed here, they are presented automatically.

Example
Vol'jin WoW.jpg{{!}}Vol'jin in ''[[World of Warcraft]]''
Fileoptional
Videosarticle_videos

Videos relating to the card. Recommended presentation is with {{#ev}} (embed video).

Example
{{#ev:youtube|6dVoezmeXpY|350|inline}}
Contentoptional
Trigger soundsarticle_soundsCUSTOM_trigger

Exact file names of the card's triggering sounds (Separated by ,). Usually these are not declared by default, and need to be manually declared.

Example
VO_RLK_571_Male_Geist_Trigger_01.wav
Fileoptional
Other soundsarticle_soundsCUSTOM_other

Exact file names of the card's other sounds (Separated by ,). Usually these are not declared by default, and need to be manually declared. Mostly used for hero skins that have unique start-of-game interactions with other heroes.

Example
VO_HERO_01v_Male_EternalOne_Start_Renathal_01.wav
Fileoptional
Trigger sound referencesarticle_soundsCUSTOM_triggerReferences

List of references for when the triggering sound can be heard (Separated by &&). Use the same order as how you placed the trigger sound files. Usually used for hero skins.

Example
Trigger: [[Cleave]]&&Trigger: [[Mortal Strike]]
Stringoptional
Other sound referencesarticle_soundsCUSTOM_otherReferences

List of references for when the other sounds can be heard (Separated by &&). Use the same order as how you placed the other sound files. Usually used for hero skins.

Example
Start [Prince Renathal]
Stringoptional
Play sound transcriptarticle_soundsTRANSCRIPT_play

Transcript for the card's play quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.

Example
We're gonna be rich!
Stringoptional
Attack sound transcriptarticle_soundsTRANSCRIPT_attack

Transcript for the card's attack quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.

Example
How much?
Stringoptional
Death sound transcriptarticle_soundsTRANSCRIPT_death

Transcript for the card's death quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.

Example
No no no no! Aah!
Stringoptional
Trigger sound transcriptarticle_soundsTRANSCRIPT_trigger

Transcript for the card's trigger quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.

Example
None will survive!
Stringoptional
Other sound transcriptarticle_soundsTRANSCRIPT_other

Transcript for the card's other quote(s) (Separated by ,). Any data added here will not be immediately presented, but will be temporarily stored so that admins can place the transcripts in a storing table, after which they will be presented normally. Only use this if a card does not have a transcript yet, or if you think the transcript is wrong.

Example
You will regret your insolence.
Stringoptional
Metadataarticle_meta

Metadata for this card, if custom metadata is required. Used for disambiguation pages.

Example
unused neutral minion, from the Legacy set
Stringoptional