Using Templates: Difference between revisions

From Epic Path
Jump to navigation Jump to search
No edit summary
No edit summary
Line 49: Line 49:
<pre>
<pre>
{{Template:Feats
{{Template:Feats
|Category=
| Category=
|Flavor=You are skilled at attacking opponents that you cannot clearly perceive.
| Flavor=You are skilled at attacking opponents that you cannot clearly perceive.
|Prerequisites=None
| Prerequisites=None
|Benefit=In melee, every time you roll to see if you missed an attack because of  
| Benefit=In melee, every time you roll to see if you missed an attack because of  
concealment (see Combat), roll twice and choose the best result.
concealment (see Combat), roll twice and choose the best result.


Line 76: Line 76:
===Spell Template===
===Spell Template===
The spell template allows spells to be added to the wiki after copying the content from an OGL site (such as the Paizo PRD, or the d20pfsrd).   
The spell template allows spells to be added to the wiki after copying the content from an OGL site (such as the Paizo PRD, or the d20pfsrd).   
<pre>
{{Template:Spell
| Links=[[Alchemist Extracts]] \ [[Bard Spells]] \ [[Cleric Spells]] \ [[Druid Spells]] \ [[Paladin Spells]] \ [[Ranger Poultices]] \ [[Sorcerer/Wizard Spells]]
| Level=
| School=
| CastTime=
| Components=
| Range=
| Target=
| Duration=
| Save=
| SR=
| Description=
| Source=
}}
</pre>
* '''Links:''' The schema includes links to the spells page for every spell-casting character class. Remove any which are not able to cast the spell in question (which can be seen in the "Level" section).
* '''Level:''' Copy the spell level information into this section.
* '''School:''' Copy the spell school information into this section. If the spell includes any Subschools or Elemental Schools, these should be included in the same section, but on separate lines, with a ":" in front of them, and the word '''Subschools:''' and/or '''Elemental School:''' bolded.
* '''CastTime:''' Copy the casting time information into this section.
* '''Components:'''  Copy the components into this section. Just put the letter codes, not the full text ("V, S, M" not "Verbal, Somatic, Material").
* '''Range:''' Copy the spell's range into this section.
* '''Target:''' This section could be for '''Target''', '''Area''' or '''Effect''', depending on the spell. Do not change the parameter name if you input Area or Effect information here, just leave it as "Target=".
* '''Duration:''' Input the spell's duration here.
* '''Save:''' Input the spell's saving throw information here.
* '''SR:''' Input the spell's Spell Resistance information here (usually "Yes" or "No").
* '''Description:''' Copy the spell's description into this section. It's okay if there are line breaks, links to other pages, etc.  If there are tables, or more complicated wiki text, you may want to ask Reese to help, or take a look at the [[#Advanced: Exclusion Template]] section below for help.
* '''Source:''' If the spell you are copying is not open gaming license, but instead has a "Section 15: Copyright" notice at the bottom, please copy the sourcebooks bibliography info from inside that copyright box and paste it into this section.  Once copied, make the titles of any sourcebooks bold, but leave everything from the copyright symbol on as regular text.  If the spell has no copyright information listed, or the spell is part of the Open Gaming License (OGL), just leave this section blank.
Here's an example of a filled-out Spell schema:
<pre>
{{Template:Spell
| Links=[[Bard Spells]] \ [[Sorcerer/Wizard Spells]]
| School=enchantment (compulsion) (mind-affecting)
| Level=bard 0, sorcerer/wizard 0
| CastTime=1 standard action
| Components=V, S, M (a pinch of wool or similar substance)
| Range=close (25 ft. + 5 ft./2 levels)
| Target=one humanoid creature of 4 HD or less
| Duration=1 round
| Save=Will negates
| SR=yes
| Description=This spell clouds the mind of a humanoid creature with 4 or fewer Hit Dice so that it takes no actions. Humanoids of 5 or more HD are not affected. A [[Dazed]] subject is not stunned, so attackers get no special advantage against it. After a creature has been dazed by this spell, it is immune to the effects of this spell for 1 minute.
| Source='''Pathfinder Roleplaying Game Core Rulebook.''' 2009, Paizo Publishing, LLC; Author: Jason Bulmahn, based on material by Jonathan Tweet, Monte Cook, and Skip Williams.<br>
'''Pathfinder Roleplaying Game Ultimate Magic.''' 2011, Paizo Publishing, LLC; Authors: Jason Bulmahn, Tim Hitchcock, Colin McComb, Rob McCreary, Jason Nelson, Stephen Radney-MacFarland, Sean K Reynolds, Owen K.C. Stephens, and Russ Taylor.}}
</pre>
You can see the resulting page here: [[Daze (Spell)]].  Note that only the "Bard" and "Sorcerer/Wizard" links remain in the schema, since only those classes have access to this cantrip.  Also note the Copyright information in the "Source" section and note how the title of each book was bolded manually.


===Magic Item Template===
===Magic Item Template===
Magic items also have a template to make inputting them into the wiki simpler, whether from another source, or when creating new items.
<pre>
{{Template:Magic Item
| Slot=
| Price=
| CL=
| Aura=
| Weight=
| Description=
| Requirements=
| Source=
}}
</pre>
* '''Slot:''' This is the slot on the character's body where the magic item can be worn.  E.g. "Wrist" or "Neck".
* Price: This is how much the item costs.  If an item has multiple prices, because it can be bought at different levels of power, list each price here and its associated power level (see example below).
* CL: This is the caster level required to make the item.
* Aura: Most magic items give off an aura of some kind, indicating what kind of magic was used to make them.  Input that information here.
* Weight: All items in Epic Path have a weight.  If you are copying an item from somewhere else, and no weight is listed, unless it can magically float or fly, it must have a weight of at least 0.1 lbs.
* Description: Input the item's description here. It's okay if there are line breaks, links to other pages, etc.  If there are tables, or more complicated wiki text, you may want to ask Reese to help, or take a look at the [[#Advanced: Exclusion Template]] section below for help.
* Requirements: These are the requirements for building the item using the Creator feat.  The template will automatically add the Creator feat as a requirement, but any other requirements should be added here (such as a spell or specific material component(s)).
* Source: If the item you are copying is not open gaming license, but instead has a "Section 15: Copyright" notice at the bottom, please copy the sourcebooks bibliography info from inside that copyright box and paste it into this section.  Once copied, make the titles of any sourcebooks bold, but leave everything from the copyright symbol on as regular text.  If the item has no copyright information listed, or the item is part of the Open Gaming License (OGL), just leave this section blank.
Here's an example of a filled-out Magic Item schema:
<pre>
{{Template:Magic Item
|Slot=wrist
|Price=1,000 gp (+1), 4,000 gp (+2), 9,000 gp (+3), 16,000 gp (+4), 25,000 gp (+5), 36,000 gp (+6), 49,000 gp (+7), 64,000 gp (+8), 800,000 gp (+9), 1,500,000 gp (+10), 2,500,000 gp (+11), 4,500,000 gp (+12), 7,500,000 gp (+13), 11,500,000 gp (+14)
|CL=6 + the armor bonus
|Aura=moderate conjuration
|Weight=1 lb
|Description=These items appear to be wrist or arm guards, sometimes etched with symbols of protection or depictions of vigilant-looking animals.
: Bracers of Armor surround the wearer with an invisible but tangible field of force, granting him an Armor Bonus to his AC of between +1 and +14, just as though he were wearing armor. Both bracers must be worn for the magic to be effective.
: Bracers of Armor cannot make use of dweomermetals, nor can they be enchanted with enhancement bonuses or magic armor properties.
|Requirements=[[Mage Armor (Spell)|Mage Armor]], caster level must be at least 6 + the armor bonus placed in the bracers.
|Source='''Pathfinder Roleplaying Game: Ultimate Equipment (OGL)''' 2012, Paizo Publishing, LLC; Authors: Dennis Baker, Jesse Benner, Benjamin Bruck, Ross Byers, Brian J. Cortijo, Ryan Costello, Mike Ferguson, Matt Goetz, Jim Groves, Tracy Hurley, Matt James, Jonathan H. Keith, Michael Kenway, Hal MacLean, Jason Nelson, Tork Shaw, Owen KC Stephens, Russ Taylor, and numerous RPG Superstar contributors
}}
</pre>
You can see the resulting page here: [[Bracers of Armor (Magic Item)]].  Note the price information and how it is laid out, as well as the spacing in the description section.  Note also the sourcebooks listed in the "Source" section, and the fact that the book title was made bold.
===Advanced: Exclusion Template===
If you are comfortable using the templates, and also comfortable creating tables and other complex(-ish) wiki techniques, the Exclusion template can be very helpful to avoid having special wiki text interpreted as part of the template's own schema.  In particular, trying to put a table inside of a schema parameter will cause the template to behave oddly.
To avoid this, whenever you are using wiki markup that includes the "|" character (such as tables), you will need to surround the entire table's code with the following template: "<nowiki>{{#!:</nowiki>" in front of the code, and "<nowiki>}}</nowiki>" after the code (do not include the quotes).
This is pretty advanced stuff, so feel free to just defer such situations to Reese.  Send him an email or something.

Revision as of 02:10, 12 March 2016

Epic Path \

Templates offer a means of ensuring the formatting and spacing of each page is uniform, when those pages share a common set of characteristics. Several templates have been developed for the Epic Path wiki to make inputting these data easier for everyone. This page provides the appropriate schemas to use when using these templates.

Please do not make changes to the Template pages without consulting Reese. If you have any questions about this, please ask Reese.

Feats Template

To input new feats, or update the page contents of existing feats, please use the following schema:

{{Template:Feats
| Category=
| Flavor=
| Prerequisites=
| Benefit=
}}
  • Category: The template will put every feat into the [[Category:Epic Path]] and [[Category:Feats]] category, but if you want to add additional categories (in particular, categories for character classes which pertain directly to the feats, please do so. Note that you do not need to include spaces between the categories, nor should you add line breaks. Here's a list of commonly used categories, in case you need them:
[[Category:Metamagic Feats]]
[[Category:Bard]]
[[Category:Cleric]]
[[Category:Druid]]
[[Category:Paladin]]
[[Category:Sorcerer]]
[[Category:Wizard]]

[[Category:Alchemist]]
[[Category:Barbarian]]
[[Category:Brawler]]
[[Category:Fighter]]
[[Category:Monk]]
[[Category:Prowler]]
[[Category:Ranger]]
[[Category:Rogue]]
[[Category:Warlord]]
  • Flavor: Use this section to put any flavor text the feat may have. The template will automatically change the text to italics.
  • Prerequisites: Use this section to input any prerequisites (duh!). Ideally, any specific level requirement, or the requirement with the highest implied level should come first in the list. If a feat has no prerequisites, make sure to put "None" in this section.
  • Benefit: In addition to pasting the feat's effects into this section, additional information like Special, Normal and Level Increase (metamagic feats only) should be pasted into this section, when present. Note that, while the Benefit: text is supplied to the page from the template, additional sections like Special: will have to be made bold manually after pasting it into the section.

Here's an example of a filled out schema:

{{Template:Feats
| Category=
| Flavor=You are skilled at attacking opponents that you cannot clearly perceive.
| Prerequisites=None
| Benefit=In melee, every time you roll to see if you missed an attack because of 
concealment (see Combat), roll twice and choose the best result.

An invisible attacker gets no advantages related to hitting you in melee. That is, 
you don't lose your Dexterity bonus to Armor Class, and the attacker doesn't get 
the usual +2 bonus for being invisible. The invisible attacker's bonuses do still 
apply for ranged attacks, however.

You do not need to make Acrobatics skill checks to move at full speed while 
blinded.

'''Normal''': Regular attack roll modifiers for invisible attackers trying to hit 
you apply, and you lose your Dexterity bonus to AC. The speed reduction for 
darkness and poor visibility also applies.

'''Special''': The Blind-Fight feat is of no use against a character who is the 
subject of a blink spell.
}}

You can see the resulting page here: Blind-Fight. Note that no additional categories were added (since the feat could be taken by anyone), so the section was left blank. Also note the Normal: and Special: sections were manually added as part of the contents of the "Benefit=" section of the schema.

Spell Template

The spell template allows spells to be added to the wiki after copying the content from an OGL site (such as the Paizo PRD, or the d20pfsrd).

{{Template:Spell
| Links=[[Alchemist Extracts]] \ [[Bard Spells]] \ [[Cleric Spells]] \ [[Druid Spells]] \ [[Paladin Spells]] \ [[Ranger Poultices]] \ [[Sorcerer/Wizard Spells]]
| Level=
| School=
| CastTime=
| Components=
| Range=
| Target=
| Duration=
| Save=
| SR=
| Description=
| Source=
}}
  • Links: The schema includes links to the spells page for every spell-casting character class. Remove any which are not able to cast the spell in question (which can be seen in the "Level" section).
  • Level: Copy the spell level information into this section.
  • School: Copy the spell school information into this section. If the spell includes any Subschools or Elemental Schools, these should be included in the same section, but on separate lines, with a ":" in front of them, and the word Subschools: and/or Elemental School: bolded.
  • CastTime: Copy the casting time information into this section.
  • Components: Copy the components into this section. Just put the letter codes, not the full text ("V, S, M" not "Verbal, Somatic, Material").
  • Range: Copy the spell's range into this section.
  • Target: This section could be for Target, Area or Effect, depending on the spell. Do not change the parameter name if you input Area or Effect information here, just leave it as "Target=".
  • Duration: Input the spell's duration here.
  • Save: Input the spell's saving throw information here.
  • SR: Input the spell's Spell Resistance information here (usually "Yes" or "No").
  • Description: Copy the spell's description into this section. It's okay if there are line breaks, links to other pages, etc. If there are tables, or more complicated wiki text, you may want to ask Reese to help, or take a look at the #Advanced: Exclusion Template section below for help.
  • Source: If the spell you are copying is not open gaming license, but instead has a "Section 15: Copyright" notice at the bottom, please copy the sourcebooks bibliography info from inside that copyright box and paste it into this section. Once copied, make the titles of any sourcebooks bold, but leave everything from the copyright symbol on as regular text. If the spell has no copyright information listed, or the spell is part of the Open Gaming License (OGL), just leave this section blank.

Here's an example of a filled-out Spell schema:


You can see the resulting page here: Daze (Spell). Note that only the "Bard" and "Sorcerer/Wizard" links remain in the schema, since only those classes have access to this cantrip. Also note the Copyright information in the "Source" section and note how the title of each book was bolded manually.

Magic Item Template

Magic items also have a template to make inputting them into the wiki simpler, whether from another source, or when creating new items.

{{Template:Magic Item
| Slot=
| Price=
| CL=
| Aura=
| Weight=
| Description=
| Requirements=
| Source=
}}
  • Slot: This is the slot on the character's body where the magic item can be worn. E.g. "Wrist" or "Neck".
  • Price: This is how much the item costs. If an item has multiple prices, because it can be bought at different levels of power, list each price here and its associated power level (see example below).
  • CL: This is the caster level required to make the item.
  • Aura: Most magic items give off an aura of some kind, indicating what kind of magic was used to make them. Input that information here.
  • Weight: All items in Epic Path have a weight. If you are copying an item from somewhere else, and no weight is listed, unless it can magically float or fly, it must have a weight of at least 0.1 lbs.
  • Description: Input the item's description here. It's okay if there are line breaks, links to other pages, etc. If there are tables, or more complicated wiki text, you may want to ask Reese to help, or take a look at the #Advanced: Exclusion Template section below for help.
  • Requirements: These are the requirements for building the item using the Creator feat. The template will automatically add the Creator feat as a requirement, but any other requirements should be added here (such as a spell or specific material component(s)).
  • Source: If the item you are copying is not open gaming license, but instead has a "Section 15: Copyright" notice at the bottom, please copy the sourcebooks bibliography info from inside that copyright box and paste it into this section. Once copied, make the titles of any sourcebooks bold, but leave everything from the copyright symbol on as regular text. If the item has no copyright information listed, or the item is part of the Open Gaming License (OGL), just leave this section blank.

Here's an example of a filled-out Magic Item schema:


You can see the resulting page here: Bracers of Armor (Magic Item). Note the price information and how it is laid out, as well as the spacing in the description section. Note also the sourcebooks listed in the "Source" section, and the fact that the book title was made bold.


Advanced: Exclusion Template

If you are comfortable using the templates, and also comfortable creating tables and other complex(-ish) wiki techniques, the Exclusion template can be very helpful to avoid having special wiki text interpreted as part of the template's own schema. In particular, trying to put a table inside of a schema parameter will cause the template to behave oddly.

To avoid this, whenever you are using wiki markup that includes the "|" character (such as tables), you will need to surround the entire table's code with the following template: "{{#!:" in front of the code, and "}}" after the code (do not include the quotes).

This is pretty advanced stuff, so feel free to just defer such situations to Reese. Send him an email or something.