Template:Dnd ref/doc
Description
- This template will make it easier to add references to official Dungeons & Dragons materials. It has been designed to accept similar parameters to {{ep ref}}. Currently, it works with the following publications:
- D&D: Player's Handbook
- D&D: Dungeon Master's Guide
- D&D: Monster Manual
- D&D errata
- D&D: Unearthed Arcana
- D&D: Hoard of the Dragon Queen
- D&D: The Rise of Tiamat
- D&D: Elemental Evil Player's Companion
- D&D: Princes of the Apocalypse
- D&D: Out of the Abyss
- D&D: Sword Coast Adventurer's Guide
- D&D: Curse of Strahd
- D&D: Storm King's Thunder
- D&D: Volo's Guide to Monsters
- D&D: Tales from the Yawning Portal
- D&D: Tomb of Annihilation
- D&D: The Tortle Package
- D&D: One Grung Above
- D&D: Xanathar's Guide to Everything
- D&D: Mordenkainen's Tome of Foes
- D&D: Baldur's Gate: Descent into Avernus
- D&D: Eberron: Rising From The Last War
- D&D: Guildmaster's Guide to Ravnica
- D&D: Ghosts of Saltmarsh
- D&D: Waterdeep: Dragon Heist
- D&D: Waterdeep: Dungeon of the Mad Mage
- D&D: Tales from the Yawning Portal
- D&D: The Lost Kenku
- D&D: Wayfinder's Guide to Eberron
- D&D: Lost Laboratory of Kwalish
- D&D: Acquisitions Incorporated
- D&D: Locathah Rising
- D&D: Mythic Odysseys of Theros
- D&D: Tasha's Cauldron of Everything
- D&D: Candlekeep Mysteries
- D&D: Icewind Dale: Rime of the Frostmaiden
- D&D: The Wild Beyond the Witchlight
Copy/Paste Code
{{dnd ref|notag=|group=|name=|intro=|SOURCE|version=|PAGE1|PAGE2|cite=|more=}}
Syntax
{{ep ref|<notag=>|<group="REFGROUP">|<name="REFNAME">|<intro=INTRO>|<SOURCE>|<version=VERSION>|<PAGE1>|<PAGE2>|<cite=TRUE>|<more=MORE>}}
Parameters
- {{{notag}}} will deactivate the reference tag, meaning that the output will appear wherever it is typed rather than in a footnote. It will also hide the "See " text and the period, allowing the reference to be used within a sentence. Any value (including "1" or "true", or even "0" or "false") will deactivate the reference tag. {{{group}}} and {{{name}}} will be ignored, but all other parameters will still function.
- {{{notag}}} may be useful when including a reference inside another reference, such as in the {{{more}}} section of an {{ep ref}}.
- {{{group}}} and {{{name}}} (optional) both function as their respective attributes in the <ref> tag.
- Use quotation marks around the REFGROUP or REFNAME in the template, just like you would for a normal <ref> tag.
- To invoke a named reference, just use the name (and its corresponding group, if applicable):
{{dnd ref|name="REFNAME"}} - If you do not supply {{{name}}}, then a reference name will be automatically generated in the format
name="{{#var:DnD}}-{{{2|}}}-{{{3|}}}"- Thus, you can simply copy/paste the same reference to other places where you want the citation to appear, and the template will automatically combine them into the same reference in the references section of the article.
- Grouped references are considered completely separate from other groups of references. Therefore, if you are invoking a named reference that belongs to a group, then you must also include that same group in the invocation. In other words, the following two references are completely separate from each other, even though they have the same name:
{{dnd ref|name="scrying spell"}}{{dnd ref|group="art"|name="scrying spell"}}
- {{{intro}}} is any text you want to include before the episode reference. Wikimarkup is allowed.
- SOURCE is the first unnamed parameter, which must be the D&D source material. Select one of the materials below by using one of the codes (case insensitive):
| Publication | Accepted Names (case insensitive) |
|---|---|
| Player's Handbook | ph; phb; player; handbook; players handbook; player's handbook |
| Dungeon Master's Guide | dm; dmg; dungeon; dungeon master; master; dungeon master guide; dungeon masters guide; dungeon master's guide; guide |
| Unearthed Arcana | ua; unearthed; arcana; unearthed arcana |
| errata | errata |
| Volo's Guide to Monsters | vgtm; vgm; volo; volos guide; volo's; volo's guide; volos guide to monsters; volo's guide to monsters |
| Xanathar's Guide to Everything | xgte; xanathar; xanathars; xanathar's; xanathars guide to everything; xanathar's guide to everything |
| Mordenkainen's Tome of Foes | mtof; mtf; mordenkainen; tome; foes; mordenkainen's; mordenkainens tome of foes; mordenkainen's tome of foes |
| Hoard of the Dragon Queen | hotdq; hoard; hoard of the dragon queen |
| Elemental Evil Player's Companion | ee; eepc; elemental; elemental evil; elemental evil players companion; elemental evil player's companion |
| Princes of the Apocalypse | pota; princes; apocalypse; princes of the apocalypse |
| Rise of Tiamat, The | trot; rise; tiamat; the rise of tiamat |
| Out of the Abyss | oota; abyss; out of the abyss |
| Sword Coast Adventurer's Guide | sc; scag; sword; coast; sword coast; sword coast adventurers guide; sword coast adventurer's guide |
| Curse of Strahd | cos; curse; strahd; curse of strahd |
| Storm King's Thunder | skt; storm; storm king; thunder; storm kings thunder; storm king's thunder |
| Tales from the Yawning Portal | tftyp; tales; yawning; portal; tales from the yawning portal |
| Tomb of Annihilation | toa; tomb; annihilation; tomb of annihilation |
| Tortle Package, The | tp; ttp; tortle; tortle package; the tortle package |
| One Grung Above | oga; grung; one grung above |
| Baldur's Gate: Descent into Avernus | bgdia; avernus; baldur's gate: descent into avernus; baldur's gate descent into avernus; baldurs gate descent into avernus; baldurs gate: descent into avernus; |
| Baldur's Gate: Descent into Avernus | descent into avernus |
| Eberron: Rising From The Last War | erlw; erftlw; eberron rising; eberron: rising from the last war; eberron rising from the last war; rising from the last war |
| Guildmaster's Guide to Ravnica | ggtr; ravnica; guildmaster's guide to ravnica; guide to ravnica |
| Ghosts of Saltmarsh | gos; saltmarsh; ghosts of saltmarsh; ghosts |
| Waterdeep: Dragon Heist | wdh; dragon heist; waterdeep: dragon heist; waterdeep dragon heist |
| Waterdeep: Dungeon of the Mad Mage | wdotmm; dotmm; dungeon of the mad mage; waterdeep: dungeon of the mad mage; waterdeep dungeon of the mad mage |
| Tales from the Yawning Portal | tftyp; tales; yawning; portal; tales from the yawning portal |
| The Lost Kenku | tlk; the lost kenku; kenku |
| Wayfinder's Guide to Eberron | wgte; wayfinder's guide to eberron; wayfinders guide to eberron; guide to eberron |
| Lost Laboratory of Kwalish | llok; llk; lost laboratory of kwalish; lost laboratory; kwalish |
| Acquisitions Incorporated | ai; acquisitions incorporated |
| Locathah Rising | lr; locathah rising; locathah |
| Mythic Odysseys of Theros | moot; odysseys; odyssey; theros; mythic odsseys of theros; mythic odysseys; mythic odyssey; mythic; mot |
| Tasha's Cauldron of Everything | tcoe; tasha's; tasha; tashas; tasha's cauldron of everything; tashas cauldron of everything; cauldron; tce |
| Candlekeep Mysteries | cm; candlekeep; candlekeep mysteries |
| Icewind Dale | icewind; icewind dale; idrotf |
| Wild Beyond the Witchlight | witchlight; wbtw |
- If SOURCE is left blank, then the containing page will be added to [[Category:D&D refs with unknown titles]].
- {{{errata}}} works with the SOURCE/{{{1}}} as an additional parameter. It does not supply the title of the publication. This is a binary parameter, so any value will activate it.
- {{{version}}} allows you to insert some text between the "5th ed.," phrase and the page numbers. It is ideal for adding the article title or publication date of Unearthed Arcana and the version number of errata.
- PAGE1 and PAGE2 are page numbers for the content being referenced. They are the second and third unnamed parameters (respectively), meaning you don't type them after a parameter name and equals sign.
- If PAGE2 is included, then the pages are treated as a page range.
- {{{dndb}}} accepts a full URL for a resource on the D&D Beyond website.
- {{{cite}}} causes the {{cite}} tag to appear immediately after the period for the main sentence. Entering any value (such as "1" or "true", or even "0" or "false") will cause the citation tag to be applied.
- {{{more}}} is any additional text that should be appended to the citation.
Sample Output
{{dnd ref|notag=true|group="sample"|name="test citation"|intro=Here's some introductory text from <nowiki />|phb|errata=true|version=[https://media.wizards.com/2015/downloads/dnd/PH_Errata_1.1.pdf version 1.1]|123|321|dndb=https://www.dndbeyond.com/characters/classes/warlock#TheHexblade|more=, and here's some additional text.}}- produces this citation: Template:Dnd ref
{{dnd ref|group="sample"|name="test citation"|intro=Here's some introductory text.|phb|errata=true|version=[https://media.wizards.com/2015/downloads/dnd/PH_Errata_1.1.pdf version 1.1]|123|321|dndb=https://www.dndbeyond.com/characters/classes/warlock#TheHexblade|cite=true|more=Here's some additional text.}}- produces this citation: Template:Dnd ref
Ref Group "sample":