More actions
Content deleted Content added
No edit summary |
No edit summary |
||
| Line 88: | Line 88: | ||
}} |
}} |
||
[[Category:Abilities]]</includeonly><noinclude> |
[[Category:Abilities]]</includeonly><noinclude> |
||
== Template Frontend == |
|||
== Documentation: Ability Template == |
|||
This template categorizes abilities, spells, and skills based on the specified parameters. It is used for organizing content into appropriate categories for easy navigation and grouping. |
|||
This template automatically categorizes ability pages based on provided parameters. Include this template at the end of an ability page and set the appropriate parameters to categorize the ability correctly. |
|||
=== Usage === |
|||
<pre> |
|||
{{Ability |
|||
|1= <!-- Optional content to include --> |
|||
|mental= <!-- Any value if the ability is a mental effect --> |
|||
|divine= <!-- Any value if the ability is divine --> |
|||
|magic= <!-- Any value if the ability is magical --> |
|||
|primal= <!-- Any value if the ability is primal --> |
|||
|spiritual= <!-- Any value if the ability is spiritual --> |
|||
|oc= <!-- Any value if used out of combat --> |
|||
|bc= <!-- Any value if used before combat --> |
|||
|ic= <!-- Any value if used in combat --> |
|||
|life= <!-- Any value if it's a Life spell --> |
|||
|storm= <!-- Any value if it's a Storm spell --> |
|||
|necro= <!-- Any value if it's a Necromancy spell --> |
|||
|flame= <!-- Any value if it's a Flame spell --> |
|||
|nature= <!-- Any value if it's a Nature spell --> |
|||
|spell= <!-- Any value if the ability is a spell --> |
|||
|skill= <!-- Any value if the ability is a skill --> |
|||
|standard= <!-- Any value if it's a standard action ability --> |
|||
|ball= <!-- Any value if it's a ball ability --> |
|||
|ray= <!-- Any value if it's a ray ability --> |
|||
|aura= <!-- Any value if it's an aura ability --> |
|||
|touch= <!-- Any value if it's a touch ability --> |
|||
|passive= <!-- Any value if it's a passive ability --> |
|||
|tag= <!-- Any value if it's a tag ability --> |
|||
|ritual= <!-- Any value if it's a ritual ability --> |
|||
|action= <!-- Specify action type for custom categorization --> |
|||
|rank= <!-- Rank of the ability: 0, 1, 2, 3, 'nr' for non-ranked --> |
|||
|num= <!-- Number of actions: '0', '1', '2', '3', 're', 'act', 'na' --> |
|||
}} |
|||
</pre> |
|||
=== Parameters === |
=== Parameters === |
||
* <code>1</code>: str (required) |
|||
*: The name or description of the ability, spell, or skill. |
|||
* <code>mental</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the ability has a mental effect. |
|||
* <code>divine</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Specifies if the ability is divine. |
|||
* <code>magic</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Specifies if the ability is magical. |
|||
* <code>primal</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the ability is primal in nature. |
|||
* <code>spiritual</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the ability is spiritual. |
|||
* <code>oc</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the ability as out-of-combat. |
|||
* <code>bc</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the ability as before combat. |
|||
* <code>ic</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the ability as in-combat. |
|||
* <code>life</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the spell belongs to the Life domain. |
|||
* <code>storm</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the spell belongs to the Storm domain. |
|||
* <code>necro</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the spell belongs to the Necromancy domain. |
|||
* <code>flame</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the spell belongs to the Flame domain. |
|||
* <code>nature</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Indicates if the spell belongs to the Nature domain. |
|||
* <code>spell</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Marks the entry as a spell. |
|||
* <code>skill</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Marks the entry as a skill. |
|||
* <code>standard</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Identifies the entry as a standard conjure spell or a semblant skill. |
|||
* <code>ball</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Identifies the entry as a ball-type spell or skill. |
|||
* <code>ray</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Identifies the entry as a ray-type spell or skill. |
|||
* <code>aura</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Identifies the entry as an aura-type spell or skill. |
|||
* <code>touch</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Identifies the entry as a touch-type spell or skill. |
|||
* <code>passive</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the entry as passive. |
|||
* <code>tag</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the entry for grouping under tags. |
|||
* <code>ritual</code>: bool (optional, defaults to <code>0</code>) |
|||
*: Tags the entry as a ritual. |
|||
* <code>action</code>: str (optional) |
|||
*: Specifies a custom action type for the skill. |
|||
* <code>rank</code>: str (optional, defaults to <code>nr</code>) |
|||
*: Specifies the rank of the ability (e.g., 0 for Journeyman, 1 for Rank 1). |
|||
* <code>num</code>: str (optional, defaults to <code>na</code>) |
|||
*: Specifies the number of actions required for this ability (e.g., 0 for free, 1 for single). |
|||
== Template Backend == |
|||
'''1''' (optional): Additional content to include where the template is placed. |
|||
This template utilizes a series of conditional statements to determine the appropriate categories based on the parameters provided. It ensures that content is accurately sorted and easily discoverable through the MediaWiki categorization system. |
|||
'''Ability Attributes:''' |
|||
Set these to any non-empty value to include the ability in the corresponding category. |
|||
* '''mental''': The ability is a mental effect. |
|||
* '''divine''': The ability is divine. |
|||
* '''magic''': The ability is magical. |
|||
* '''primal''': The ability is primal. |
|||
* '''spiritual''': The ability is spiritual. |
|||
* '''oc''': Out of Combat ability. |
|||
* '''bc''': Before Combat ability. |
|||
* '''ic''': In Combat ability. |
|||
'''Spell Schools:''' |
|||
* '''life''': Life spell. |
|||
* '''storm''': Storm spell. |
|||
* '''necro''': Necromancy spell. |
|||
* '''flame''': Flame spell. |
|||
* '''nature''': Nature spell. |
|||
'''Ability Types:''' |
|||
* '''spell''': Ability is a spell. |
|||
* '''skill''': Ability is a skill. |
|||
'''Action Types:''' |
|||
Set only one of these per ability. |
|||
* '''standard''': Standard action ability. |
|||
* If '''spell''' is set, categorized under "Conjure Spells". |
|||
* If '''skill''' is set, categorized under "Semblant Skills". |
|||
* '''ball''': Ball ability. |
|||
* Categorizes under "Balls" and further under "Ball Spells" or "Ball Skills". |
|||
* '''ray''': Ray ability. |
|||
* Categorizes under "Rays" and further under "Ray Spells" or "Ray Skills". |
|||
* '''aura''': Aura ability. |
|||
* Categorizes under "Auras" and further under "Aura Spells" or "Aura Skills". |
|||
* '''touch''': Touch ability. |
|||
* Categorizes under "Touches" and further under "Touch Spells" or "Touch Skills". |
|||
* '''passive''': Passive ability. |
|||
* Categorizes under "Passives" and further under "Passive Spells" or "Passive Skills". |
|||
* '''tag''': Tag ability. |
|||
* Categorizes under "Tags" and further under "Tag Spells" or "Tag Skills". |
|||
* '''ritual''': Ritual ability. |
|||
* Categorizes under "Rituals" and further under "Ritual Spells" or "Ritual Skills". |
|||
'''Custom Action Category:''' |
|||
* '''action''': Specify custom action type (e.g., "Free", "Single"). This parameter is used for custom categorization like "Free Action Skills" when combined with '''skill'''. |
|||
'''Rank:''' |
|||
* '''rank''': Rank of the ability. |
|||
* '''0''': Journeyman Abilities. |
|||
* '''1''': Rank 1 Abilities. |
|||
* '''2''': Rank 2 Abilities. |
|||
* '''3''': Rank 3+ Abilities. |
|||
* '''nr''': Non-ranked Abilities. |
|||
* Any other value: Non-standard Abilities. |
|||
'''Number of Actions:''' |
|||
* '''num''': Number of actions required. |
|||
* '''0''': Free Action. |
|||
* '''1''': Single Action. |
|||
* '''2''': Double Action. |
|||
* '''3''': Triple Action. |
|||
* '''re''': Reaction. |
|||
* '''act''': Activity. |
|||
* '''na''': Not applicable. |
|||
* Any other value: Categorizes as "Abilities" by default. |
|||
=== Examples === |
|||
'''Example 1: Rank 1 Single Action Flame Spell''' |
|||
<pre> |
|||
{{Ability |
|||
|spell=1 |
|||
|flame=1 |
|||
|rank=1 |
|||
|num=1 |
|||
}} |
|||
</pre> |
|||
''Categories added:'' |
|||
* Spells |
|||
* Flame Spells |
|||
* Rank 1 Abilities |
|||
* Single Action Abilities |
|||
* Single Action Spells |
|||
* Abilities |
|||
---- |
|||
'''Example 2: Non-Ranked Passive Skill Used in Combat''' |
|||
<pre> |
|||
{{Ability |
|||
|skill=1 |
|||
|passive=1 |
|||
|ic=1 |
|||
|rank=nr |
|||
}} |
|||
</pre> |
|||
''Categories added:'' |
|||
* Skills |
|||
* Passives |
|||
* Passive Skills |
|||
* In Combat Abilities |
|||
* Non-ranked Abilities |
|||
* Abilities |
|||
---- |
|||
'''Example 3: Rank 2 Ritual Nature Spell (Activity)''' |
|||
<pre> |
|||
{{Ability |
|||
|spell=1 |
|||
|ritual=1 |
|||
|nature=1 |
|||
|rank=2 |
|||
|num=act |
|||
}} |
|||
</pre> |
|||
''Categories added:'' |
|||
* Spells |
|||
* Rituals |
|||
* Ritual Spells |
|||
* Nature Spells |
|||
* Rank 2 Abilities |
|||
* Activity Abilities |
|||
* Activity Spells |
|||
* Abilities |
|||
---- |
|||
'''Example 4: Double Action Primal Skill with Custom Action Type''' |
|||
<pre> |
|||
{{Ability |
|||
|skill=1 |
|||
|primal=1 |
|||
|action=Double |
|||
|num=2 |
|||
}} |
|||
</pre> |
|||
''Categories added:'' |
|||
* Skills |
|||
* Primal Abilities |
|||
* Double Action Abilities |
|||
* Double Action Skills |
|||
* Abilities |
|||
---- |
|||
'''Example 5: Ability with Multiple Attributes''' |
|||
<pre> |
|||
{{Ability |
|||
|skill=1 |
|||
|spell=1 |
|||
|magic=1 |
|||
|storm=1 |
|||
|ray=1 |
|||
|rank=3 |
|||
|num=1 |
|||
}} |
|||
</pre> |
|||
''Categories added:'' |
|||
* Skills |
|||
* Spells |
|||
* Magical Abilities |
|||
* Storm Spells |
|||
* Rays |
|||
* Ray Spells |
|||
* Ray Skills |
|||
* Rank 3+ Abilities |
|||
* Single Action Abilities |
|||
* Single Action Spells |
|||
* Single Action Skills |
|||
* Abilities |
|||
=== Notes === |
|||
* The template automatically includes `[[Category:Abilities]]` at the end. |
|||
* Setting any parameter to a non-empty value (e.g., `1`, `yes`) activates the corresponding category. |
|||
* For accurate categorization, set only one action type parameter per ability. |
|||
* The order of parameters does not affect the categorization. |
|||
</noinclude> |
</noinclude> |
||
Revision as of 01:14, 25 December 2024
Template Frontend
This template categorizes abilities, spells, and skills based on the specified parameters. It is used for organizing content into appropriate categories for easy navigation and grouping.
Parameters
1: str (required)- The name or description of the ability, spell, or skill.
mental: bool (optional, defaults to0)- Indicates if the ability has a mental effect.
divine: bool (optional, defaults to0)- Specifies if the ability is divine.
magic: bool (optional, defaults to0)- Specifies if the ability is magical.
primal: bool (optional, defaults to0)- Indicates if the ability is primal in nature.
spiritual: bool (optional, defaults to0)- Indicates if the ability is spiritual.
oc: bool (optional, defaults to0)- Tags the ability as out-of-combat.
bc: bool (optional, defaults to0)- Tags the ability as before combat.
ic: bool (optional, defaults to0)- Tags the ability as in-combat.
life: bool (optional, defaults to0)- Indicates if the spell belongs to the Life domain.
storm: bool (optional, defaults to0)- Indicates if the spell belongs to the Storm domain.
necro: bool (optional, defaults to0)- Indicates if the spell belongs to the Necromancy domain.
flame: bool (optional, defaults to0)- Indicates if the spell belongs to the Flame domain.
nature: bool (optional, defaults to0)- Indicates if the spell belongs to the Nature domain.
spell: bool (optional, defaults to0)- Marks the entry as a spell.
skill: bool (optional, defaults to0)- Marks the entry as a skill.
standard: bool (optional, defaults to0)- Identifies the entry as a standard conjure spell or a semblant skill.
ball: bool (optional, defaults to0)- Identifies the entry as a ball-type spell or skill.
ray: bool (optional, defaults to0)- Identifies the entry as a ray-type spell or skill.
aura: bool (optional, defaults to0)- Identifies the entry as an aura-type spell or skill.
touch: bool (optional, defaults to0)- Identifies the entry as a touch-type spell or skill.
passive: bool (optional, defaults to0)- Tags the entry as passive.
tag: bool (optional, defaults to0)- Tags the entry for grouping under tags.
ritual: bool (optional, defaults to0)- Tags the entry as a ritual.
action: str (optional)- Specifies a custom action type for the skill.
rank: str (optional, defaults tonr)- Specifies the rank of the ability (e.g., 0 for Journeyman, 1 for Rank 1).
num: str (optional, defaults tona)- Specifies the number of actions required for this ability (e.g., 0 for free, 1 for single).
Template Backend
This template utilizes a series of conditional statements to determine the appropriate categories based on the parameters provided. It ensures that content is accurately sorted and easily discoverable through the MediaWiki categorization system.