Difference between revisions of "Template:HeroBox/doc"
(updating references to other templates) |
Cannonfodder (Talk | contribs) m (Added VigilanteBox and RogueBox templates to documentation) |
||
(One intermediate revision by one other user not shown) | |||
Line 8: | Line 8: | ||
The long and involved process works thusly. If you just want the Box, go directly to the Cheat Sheet. | The long and involved process works thusly. If you just want the Box, go directly to the Cheat Sheet. | ||
− | Trigger the use of the [[:Template:HeroBox|HeroBox]]/[[:Template:VillainBox|VillainBox]]/[[:Template:PraetorianBox|PraetorianBox]] on your page if you plan to include it. At the top of your edit window, enter: | + | Trigger the use of the [[:Template:HeroBox|HeroBox]]/[[:Template:VillainBox|VillainBox]]/[[:Template:VigilanteBox|VigilanteBox]]/[[:Template:RogueBox|RogueBox]]/[[:Template:PraetorianBox|PraetorianBox]] on your page if you plan to include it. At the top of your edit window, enter: |
− | {{HeroBox or {{VillainBox or {{PraetorianBox | + | {{HeroBox or {{VillainBox or {{VigilanteBox or {{RogueBox or {{PraetorianBox |
Below that, you'll want to fill out all the parameters that you can fill out or care to fill out. For this, you'll need the name of the parameter that corresponds to the field you'll want to fill; in most cases, the parameter names are the same as the name of the field, but they differ in some. A complete list can be found below. The format for filling in a parameter is as follows: | Below that, you'll want to fill out all the parameters that you can fill out or care to fill out. For this, you'll need the name of the parameter that corresponds to the field you'll want to fill; in most cases, the parameter names are the same as the name of the field, but they differ in some. A complete list can be found below. The format for filling in a parameter is as follows: | ||
Line 18: | Line 18: | ||
| name = Herodude | | name = Herodude | ||
− | This will replace the {{{name}}} placeholder in the original HeroBox/VillainBox/PraetorianBox with 'Herodude'. Each parameter should be put in a new line for ease of parsing and debugging in case something goes wrong. | + | This will replace the {{{name}}} placeholder in the original HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox with 'Herodude'. Each parameter should be put in a new line for ease of parsing and debugging in case something goes wrong. |
− | The last four fields of the HeroBox/VillainBox/PraetorianBox use a smaller font because they're designed for a potentially long list of additions. How you fill the Powers, Abilities and Equipment fields and whether you want to add any footnotes is essentially up to you, but for easiest readability, you'll want to offer single terms that summarize some or all of your character's applicable capabilities there. This could still be a veritable laundry list of things, or it could be as simple as an entry saying 'Pheromone-Based Mind Control' or whatever. Either way, the main body of the page allows sufficient room to expand on things, the HeroBox/VillainBox/PraetorianBox is mostly meant for an at-a-glance summary of the most important character data. | + | The last four fields of the HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox use a smaller font because they're designed for a potentially long list of additions. How you fill the Powers, Abilities and Equipment fields and whether you want to add any footnotes is essentially up to you, but for easiest readability, you'll want to offer single terms that summarize some or all of your character's applicable capabilities there. This could still be a veritable laundry list of things, or it could be as simple as an entry saying 'Pheromone-Based Mind Control' or whatever. Either way, the main body of the page allows sufficient room to expand on things, the HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox is mostly meant for an at-a-glance summary of the most important character data. |
Close the Template. This is done by appending the following at the end of your list: | Close the Template. This is done by appending the following at the end of your list: | ||
Line 41: | Line 41: | ||
* level - Your character's Security Level. Defaults to 'Confidential' if not further specified. | * level - Your character's Security Level. Defaults to 'Confidential' if not further specified. | ||
* sg - Your character's supergroup affiliation (if any.) Optional parameter. Does not display if not specified. | * sg - Your character's supergroup affiliation (if any.) Optional parameter. Does not display if not specified. | ||
+ | |||
* realname - Your character's civilian Identity. Defaults to 'Confidential' if not further specified. | * realname - Your character's civilian Identity. Defaults to 'Confidential' if not further specified. | ||
* aliases - Any other names (civilian or heroic/villainous) your character may be using. Defaults to 'None' if not further specified. | * aliases - Any other names (civilian or heroic/villainous) your character may be using. Defaults to 'None' if not further specified. | ||
− | * species - Your character's species. This is mostly important for aliens, sentient fungi and the like. | + | * species - Your character's species. This is mostly important for aliens, sentient fungi and the like. Optional parameter. Does not display if not specified. |
* age - Your character's age in human (solar) years. Defaults to 'Confidential' if not further specified. | * age - Your character's age in human (solar) years. Defaults to 'Confidential' if not further specified. | ||
* height - Your character's height in feet and inches (I prefer the metric system myself, but since COH/COV defaults to imperial and for the sake of uniformity, feet and inches are preferable). Defaults to 'Confidential' if not further specified. | * height - Your character's height in feet and inches (I prefer the metric system myself, but since COH/COV defaults to imperial and for the sake of uniformity, feet and inches are preferable). Defaults to 'Confidential' if not further specified. | ||
Line 50: | Line 51: | ||
* eyes - Your character's eye color. Defaults to 'Confidential' if not further specified. | * eyes - Your character's eye color. Defaults to 'Confidential' if not further specified. | ||
* hair - Your character's hair color. Defaults to 'Confidential' if not further specified. | * hair - Your character's hair color. Defaults to 'Confidential' if not further specified. | ||
+ | * sexuality - Your character's sexual orientation. Optional parameter. Does not display if not specified. | ||
Line 72: | Line 74: | ||
− | == The HeroBox/VillainBox/PraetorianBox Cheat Sheet == | + | == The HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox Cheat Sheet == |
Just copy/paste the below list into your character's Edit box. Fill in any categories that you might care to fill in. Leave all other lines blank or delete them. | Just copy/paste the below list into your character's Edit box. Fill in any categories that you might care to fill in. Leave all other lines blank or delete them. | ||
Line 93: | Line 95: | ||
| eyes = | | eyes = | ||
| hair = | | hair = | ||
+ | | sexuality = | ||
| nationality = | | nationality = | ||
| occupation = | | occupation = |
Latest revision as of 16:33, 25 December 2012
The HeroBox as presented here is a template with a lot of placeholders for the most basic of data on a character.
How to use the HeroBox/VillainBox/PraetorianBox
The long and involved process works thusly. If you just want the Box, go directly to the Cheat Sheet.
Trigger the use of the HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox on your page if you plan to include it. At the top of your edit window, enter:
{{HeroBox or {{VillainBox or {{VigilanteBox or {{RogueBox or {{PraetorianBox
Below that, you'll want to fill out all the parameters that you can fill out or care to fill out. For this, you'll need the name of the parameter that corresponds to the field you'll want to fill; in most cases, the parameter names are the same as the name of the field, but they differ in some. A complete list can be found below. The format for filling in a parameter is as follows:
| parameter = value eg. | name = Herodude
This will replace the {{{name}}} placeholder in the original HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox with 'Herodude'. Each parameter should be put in a new line for ease of parsing and debugging in case something goes wrong.
The last four fields of the HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox use a smaller font because they're designed for a potentially long list of additions. How you fill the Powers, Abilities and Equipment fields and whether you want to add any footnotes is essentially up to you, but for easiest readability, you'll want to offer single terms that summarize some or all of your character's applicable capabilities there. This could still be a veritable laundry list of things, or it could be as simple as an entry saying 'Pheromone-Based Mind Control' or whatever. Either way, the main body of the page allows sufficient room to expand on things, the HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox is mostly meant for an at-a-glance summary of the most important character data.
Close the Template. This is done by appending the following at the end of your list:
|}}
And with this, you're set.
List of Parameters
- image - Character image. Should not be wider than 300 pixels. If it's too wide (or too small) it will be automatically shrunken (or expanded) to the appropriate size (but clicking on the image will display the actual image rather than the adjusted version). If you have no image, don't include this parameter and it will default to a placeholder image instead.
- caption - Text that goes right beneath the image, if you think the image requires further commentary. If not, don't include this parameter and there will be no blank space between picture and name.
- name - Your character's name. This will appear in big bold letters.
- player - However you'd like to identify yourself. Ideally, you'll want to make this a link to your user topic (User:Yourname, eg. User:Jezebel1669).
- server - Which server the character exists on, or is mainly tied to.
- origin - Your character's Origin (Magic, Mutant, Natural, Science, Technology). Defaults to 'Confidential' if not further specified.
- archetype - Your character's AT (Blaster, Brute, Controller etc.). Defaults to 'Confidential' if not further specified.
- level - Your character's Security Level. Defaults to 'Confidential' if not further specified.
- sg - Your character's supergroup affiliation (if any.) Optional parameter. Does not display if not specified.
- realname - Your character's civilian Identity. Defaults to 'Confidential' if not further specified.
- aliases - Any other names (civilian or heroic/villainous) your character may be using. Defaults to 'None' if not further specified.
- species - Your character's species. This is mostly important for aliens, sentient fungi and the like. Optional parameter. Does not display if not specified.
- age - Your character's age in human (solar) years. Defaults to 'Confidential' if not further specified.
- height - Your character's height in feet and inches (I prefer the metric system myself, but since COH/COV defaults to imperial and for the sake of uniformity, feet and inches are preferable). Defaults to 'Confidential' if not further specified.
- weight - Your character's weight in pounds (see height). Defaults to 'Confidential' if not further specified.
- eyes - Your character's eye color. Defaults to 'Confidential' if not further specified.
- hair - Your character's hair color. Defaults to 'Confidential' if not further specified.
- sexuality - Your character's sexual orientation. Optional parameter. Does not display if not specified.
- nationality - The country of interstellar empire your character claims citizenship of. Defaults to 'Confidential' if not further specified.
- occupation - What your character does for a living. 'Professional Crimefighter', 'Adventurer', 'Career Criminal' etc. are thoroughly legit occupations. Defaults to 'Confidential' if not further specified.
- birthplace - Where your character was born. Defaults to 'Confidential' if not further specified.
- hometown - Your character's current residence and stomping ground. Most likely Paragon City or the Rogue/Etoile Isles. Defaults to 'Confidential' if not further specified.
- marital - Whether your character is single, engaged, married, widowed or whatever other forms of voluntary slavery there are between two people. Defaults to 'Confidential' if not further specified.
- relatives - What kind of (relevant) relatives your character has or had. Most likely you'll want to limit this to any important characters that appear in stories or RP (such as Ascendant's uncle and manager). Defaults to 'Confidential' if not further specified.
- powers - A place for a short listing of the powers your character possesses, eg. 'Weather Control'. Defaults to 'Confidential' if not further specified.
- abilities - A place for short notes on your character's non-superhuman abilities, eg. 'Black Belt Karateka'. Defaults to 'Confidential' if not further specified.
- equipment - A place to mention any notable equipment your character carries around, eg. 'Nemesis Staff carried at all times'. Defaults to 'Confidential' if not further specified.
- footnotes - Room for any notes you want available at a glance that aren't covered by the above categories.
The HeroBox/VillainBox/VigilanteBox/RogueBox/PraetorianBox Cheat Sheet
Just copy/paste the below list into your character's Edit box. Fill in any categories that you might care to fill in. Leave all other lines blank or delete them.
{{HeroBox | image = | caption = | name = | player = | origin = | archetype = | level = | sg = | realname = | aliases = | species = | age = | height = | weight = | eyes = | hair = | sexuality = | nationality = | occupation = | birthplace = | hometown = | marital = | relatives = | powers = | abilities = | equipment = | footnotes = |}}