Difference between revisions of "Template:SupergroupBox/doc"

From Ouroboros Portal
Jump to: navigation, search
m (info moved out of template and into documentation - will update when template is complete)
 
m (adding rank6, adjusting descriptions accordingly)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
==Usage==
 
==Usage==
−
The SupergroupBox as presented here is a template with a lot of placeholders for the most basic of data on a supergroup.
+
The SupergroupBox is an Infobox style template intended for use on [[:Category:Supergroups|Supergroup pages]] to provide at-a-glance information about a supergroup.
  
−
The long and involved process works thusly. If you just want the Box, go directly to the Cheat Sheet.
+
Including the SupergroupBox template in an article can be accomplished by placing the following tag in the page:
−
 
+
−
Trigger the use of the SupergroupBox on your page if you plan to include it. At the top of your edit window, enter:
+
  
 
  {{SupergroupBox
 
  {{SupergroupBox
  
−
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:
+
Following the opening template call, there are several parameter that may be specified to fill in the information displayed by the template. A complete list of these parameters is documented below. The format for filling in a parameter is as follows:
  
 
  | parameter = value
 
  | parameter = value
−
eg.
 
−
| name = Herodude
 
  
−
This will replace the {{{name}}} placeholder in the original HeroBox/VillainBox with 'Herodude'. Each parameter should be put in a new line for ease of parsing and debugging in case something goes wrong.
+
i.e.
  
−
The last four fields of the HeroBox/VillainBox 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 is mostly meant for an at-a-glance summary of the most important character data.
+
| name = Superheroes of Paragon
  
−
Close the Template. This is done by appending the following at the end of your list:
+
This will replace the {{{name}}} placeholder in the template with "Superheroes of Paragon". (Placing each parameter on its own line makes parsing and debugging the template call easier in the event that something goes wrong.)
 +
 
 +
The '''footnotes''' field of the HeroBox/VillainBox use a smaller font because it is designed to accommodate what could potentially be a lengthy block of text.
 +
 
 +
While the template allows for rather lengthy descriptions in almost every field, the main body of the page is a better place to expand on any information, leaving SupergroupBox for a quick summary of the most important supergroup data.
 +
 
 +
Closing the template call is accomplished by appending the following at the end of your parameter list:
  
 
  |}}
 
  |}}
Line 28: Line 30:
 
== List of Parameters ==
 
== 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.
+
;alignment
−
* 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.
+
: This parameter specifies whether your supergroup is a hero or villain group. The value defined for this parameter will change the color palette of the template to blue for heroes and red for villains. If an invalid value is specified for this parameter or definition of this parameter is omitted from the template call, the color scheme of the template will default to black text on a white background.
−
* 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.
+
  
 +
;image
 +
:This is an image which you feel is representative of your supergroup.  For example, you might use a screenshot of several of your members gathered together for a picture with everyone wearing your supergroup's colors or fighting together in a PvP zone.  You might use a high-resolution, custom-designed image that shows off your supergroup's colors and emblem.
 +
:''Using an uploaded image'' - If using an image that has been uploaded to the wiki, be sure to size-limit any image over 300 pixels wide in the file tag.
  
−
* archetype - Your character's AT (Blaster, Brute, Controller etc.). Defaults to 'Confidential' if not further specified.
+
[[File:''image_name''|300px]]
−
* origin - Your character's Origin (Magic, Mutant, Natural, Science, Technology). Defaults to 'Confidential' if not further specified.
+
−
* level - Your character's Security Level. Defaults to 'Confidential' if not further specified.
+
  
 +
:''Using an external image'' - If using an image that has not been uploaded to the wiki, be sure that the image you are using is 300 or fewer pixels wide since (as of 20 January 2010) there is apparently no existing method for limiting the display size of an external image in MediaWiki.  Note that no brackets are used when embedding an external image.
  
−
* realname - Your character's civilian Identity. Defaults to 'Confidential' if not further specified.
+
http://''site''/''path''/''image''
−
* 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. Defaults to 'Presumed Human' 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.
+
−
* 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.
+
  
 +
[[File:Confidentialimage.jpg|thumb|100px]]
 +
:If the image parameter is not defined, the image will default to the Confidentialimage.jpg image shown to the right.
 +
{{clr}}
  
−
* nationality - The country of interstellar empire your character claims citizenship of. Defaults to 'Confidential' if not further specified.
+
;caption
−
* 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.
+
:Text defined with this parameter will be placed beneath the image specified by the '''image''' parameter. If this parameter is not defined, no text will be placed below the image.
−
* 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.
+
  
 +
;name
 +
:The name of the supergroup.  If this parameter is not defined, it will default to a displayed value of "Unknown".
  
−
* powers - A place for a short listing of the powers your character possesses, eg. 'Weather Control'. Defaults to 'Confidential' if not further specified.
+
;server
 +
:The [[paragonwiki::Servers|server]] on which the supergroup resides. If this parameter is not defined, no value will be displayed.
  
 +
;founded
 +
:This is the date when the supergroup was created by registering with the [[paragonwiki::Super Group Registrar|Registrar]].  If this parameter is not defined, it will default to a displayed value of "Confidential".
  
−
* abilities - A place for short notes on your character's non-superhuman abilities, eg. 'Black Belt Karateka'. Defaults to 'Confidential' if not further specified.
+
;founders
 +
:The founding member(s) of the supergroup.  This may be a simple list, and names of founders may be linked to character profiles here in Ouroborous Portal. (Separating each founder with a line break can be forced by placing a <nowiki><br /></nowiki> tag between names in the list.)  If this parameter is not defined, it will default to a displayed value of "Confidential".
  
 +
;emblem
 +
:This is the supergroup's in-game emblem.  All in-game [[paragonwiki::Category:Super Group Emblem Images|SG emblem images]] have already been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki.  These images can be used by placing a File tag in this parameter as with using uploaded images in the '''image''' parameter (described above).  In the event that an emblem does not display well against the background of the template, it may help to make use of a {{tl|Emblem Contrast}} template call in this parameter.  If this parameter is not defined, it will default to a displayed value of "Confidential".
  
−
* 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.
+
;color1
 +
:The supergroup's primary color.  This parameter will take normal text if desired.  A full set of [[paragonwiki::Costume Colors#Gallery of Color Samples|color samples]] from the costume color palette has been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki. These images can be used by placing a File tag in this parameter as with using uploaded images in the '''image''' parameter (described above).  It is recommended due to the size of the color sample images that the displayed image size be limited to 50 pixels.  You may also wish to center the image for aesthetic purposes.
  
 +
[[File:''filename''|50px|center]]
  
−
* footnotes - Room for any notes you want available at a glance that aren't covered by the above categories.
+
;color2
 +
:The supergroup's secondary color.  This parameter will take normal text if desired.  A full set of [[paragonwiki::Costume Colors#Gallery of Color Samples|color samples]] from the costume color palette has been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki.  These images can be used by placing a File tag in this parameter as with using uploaded images in the '''image''' parameter (described above).  It is recommended due to the size of the color sample images that the displayed image size be limited to 50 pixels.  You may also wish to center the image for aesthetic purposes.
  
 +
[[File:''filename''|50px|center]]
  
−
== The HeroBox/VillainBox Cheat Sheet ==
+
;rank1
 +
:The title given to the highest ranking members of the supergroup.  This is the title displayed next to Leader on the hero [[:File:UI_Super_Group_Registration.jpg|supergroup registration form]] or Overlord on the villain registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
  
−
Just copy/paste the below list into your character's Edit box. Just remove either the word HeroBox or VillainBox, whichever is not applicable and fill in any categories that you might care to fill in. Leave all other lines blank or delete them.
+
;rank2
 +
:The title given to the second highest ranking members of the supergroup. This is the title displayed next to Commander on the hero supergroup registration form or Kingpin on the villain registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
  
−
<nowiki>{{HeroBox</nowiki>
+
;rank3
−
  | image =
+
:The title given to the upper-middle ranking members of the supergroup. This is the title displayed next to General on the hero supergroup registration form or Ringleader on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
−
| caption =
+
−
| name =
+
−
| player =
+
−
| archetype =
+
−
| origin =
+
−
| level =
+
−
| realname =
+
−
| aliases =
+
−
| species =
+
−
| age =
+
−
| height =
+
−
| weight =
+
−
| eyes =
+
−
| hair =
+
−
| nationality =
+
−
| occupation =
+
−
| birthplace =
+
−
| hometown =
+
−
| marital =
+
−
| relatives =
+
−
| powers =
+
−
| abilities =
+
−
| equipment =
+
−
| footnotes =
+
−
  |}}
+
  
 +
;rank4
 +
:The title given to the lower-middle ranking members of the supergroup.  This is the title displayed next to Captain on the hero supergroup registration form or Taskmaster on the villain registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
 +
 +
;rank5
 +
:The title given to the second lowest ranking members of the supergroup.  This is the title displayed next to Lieutenant on the hero supergroup registration form or Enforcer on the villain registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
 +
 +
;rank6
 +
:The title given to the lowest ranking members of the supergroup.  This is the title displayed next to Member on the hero supergroup registration form or Flunky on the villain registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
 +
 +
;motto
 +
:The supergroup's motto that appears on the supergroup registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
 +
 +
;description
 +
:The supergroup's description that appears on the supergroup registration form.  If this parameter is not defined, it will default to a displayed value of "Confidential".
 +
 +
;footnotes
 +
:Use this parameter to include any additional notes you wish to place in the infobox.  If this parameter is not defined, it will default to a displayed value of "No additional information available."
 +
 +
== Cheat Sheet ==
 +
 +
Just copy/paste the below list into your supergroup's page.  Fill in any parameters that you wish to specify and leave all other lines blank or delete them.
 +
 +
<nowiki>{{SupergroupBox</nowiki>
 +
|alignment=
 +
|image=
 +
|caption=
 +
|name=
 +
|server=
 +
|founded=
 +
|founders=
 +
|emblem=
 +
|color1=
 +
|color2=
 +
|rank1=
 +
|rank2=
 +
|rank3=
 +
|rank4=
 +
|rank5=
 +
|rank6=
 +
|motto=
 +
|description=
 +
|footnotes=
 +
|}}
  
 
==See also==
 
==See also==
  
−
<includeonly>[[Category:Supergroup Templates]]</includeonly><noinclude>
+
<includeonly>[[Category:Supergroup templates]]</includeonly><noinclude>
 
[[Category:Template documentation]]
 
[[Category:Template documentation]]
 
</noinclude>
 
</noinclude>

Latest revision as of 14:17, 21 January 2010

Usage

The SupergroupBox is an Infobox style template intended for use on Supergroup pages to provide at-a-glance information about a supergroup.

Including the SupergroupBox template in an article can be accomplished by placing the following tag in the page: 

{{SupergroupBox

Following the opening template call, there are several parameter that may be specified to fill in the information displayed by the template. A complete list of these parameters is documented below. The format for filling in a parameter is as follows: 

| parameter = value

i.e. 

| name = Superheroes of Paragon

This will replace the {{{name}}} placeholder in the template with "Superheroes of Paragon". (Placing each parameter on its own line makes parsing and debugging the template call easier in the event that something goes wrong.)

The footnotes field of the HeroBox/VillainBox use a smaller font because it is designed to accommodate what could potentially be a lengthy block of text.

While the template allows for rather lengthy descriptions in almost every field, the main body of the page is a better place to expand on any information, leaving SupergroupBox for a quick summary of the most important supergroup data.

Closing the template call is accomplished by appending the following at the end of your parameter list: 

|}}

And with this, you're set.

List of Parameters

alignment
This parameter specifies whether your supergroup is a hero or villain group. The value defined for this parameter will change the color palette of the template to blue for heroes and red for villains. If an invalid value is specified for this parameter or definition of this parameter is omitted from the template call, the color scheme of the template will default to black text on a white background.
image
This is an image which you feel is representative of your supergroup. For example, you might use a screenshot of several of your members gathered together for a picture with everyone wearing your supergroup's colors or fighting together in a PvP zone. You might use a high-resolution, custom-designed image that shows off your supergroup's colors and emblem.
Using an uploaded image - If using an image that has been uploaded to the wiki, be sure to size-limit any image over 300 pixels wide in the file tag.
300px
Using an external image - If using an image that has not been uploaded to the wiki, be sure that the image you are using is 300 or fewer pixels wide since (as of 20 January 2010) there is apparently no existing method for limiting the display size of an external image in MediaWiki. Note that no brackets are used when embedding an external image.
http://site/path/image
Confidentialimage.jpg
If the image parameter is not defined, the image will default to the Confidentialimage.jpg image shown to the right.


caption
Text defined with this parameter will be placed beneath the image specified by the image parameter. If this parameter is not defined, no text will be placed below the image.
name
The name of the supergroup. If this parameter is not defined, it will default to a displayed value of "Unknown".
server
The server on which the supergroup resides. If this parameter is not defined, no value will be displayed.
founded
This is the date when the supergroup was created by registering with the Registrar. If this parameter is not defined, it will default to a displayed value of "Confidential".
founders
The founding member(s) of the supergroup. This may be a simple list, and names of founders may be linked to character profiles here in Ouroborous Portal. (Separating each founder with a line break can be forced by placing a <br /> tag between names in the list.) If this parameter is not defined, it will default to a displayed value of "Confidential".
emblem
This is the supergroup's in-game emblem. All in-game SG emblem images have already been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki. These images can be used by placing a File tag in this parameter as with using uploaded images in the image parameter (described above). In the event that an emblem does not display well against the background of the template, it may help to make use of a {{Emblem Contrast}} template call in this parameter. If this parameter is not defined, it will default to a displayed value of "Confidential".
color1
The supergroup's primary color. This parameter will take normal text if desired. A full set of color samples from the costume color palette has been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki. These images can be used by placing a File tag in this parameter as with using uploaded images in the image parameter (described above). It is recommended due to the size of the color sample images that the displayed image size be limited to 50 pixels. You may also wish to center the image for aesthetic purposes.
50px
color2
The supergroup's secondary color. This parameter will take normal text if desired. A full set of color samples from the costume color palette has been uploaded to the image repository shared between Ouroboros Portal and Paragon Wiki. These images can be used by placing a File tag in this parameter as with using uploaded images in the image parameter (described above). It is recommended due to the size of the color sample images that the displayed image size be limited to 50 pixels. You may also wish to center the image for aesthetic purposes.
50px
rank1
The title given to the highest ranking members of the supergroup. This is the title displayed next to Leader on the hero supergroup registration form or Overlord on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
rank2
The title given to the second highest ranking members of the supergroup. This is the title displayed next to Commander on the hero supergroup registration form or Kingpin on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
rank3
The title given to the upper-middle ranking members of the supergroup. This is the title displayed next to General on the hero supergroup registration form or Ringleader on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
rank4
The title given to the lower-middle ranking members of the supergroup. This is the title displayed next to Captain on the hero supergroup registration form or Taskmaster on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
rank5
The title given to the second lowest ranking members of the supergroup. This is the title displayed next to Lieutenant on the hero supergroup registration form or Enforcer on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
rank6
The title given to the lowest ranking members of the supergroup. This is the title displayed next to Member on the hero supergroup registration form or Flunky on the villain registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
motto
The supergroup's motto that appears on the supergroup registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
description
The supergroup's description that appears on the supergroup registration form. If this parameter is not defined, it will default to a displayed value of "Confidential".
footnotes
Use this parameter to include any additional notes you wish to place in the infobox. If this parameter is not defined, it will default to a displayed value of "No additional information available."

Cheat Sheet

Just copy/paste the below list into your supergroup's page. Fill in any parameters that you wish to specify and leave all other lines blank or delete them. 

{{SupergroupBox
|alignment=
|image=
|caption=
|name=
|server=
|founded=
|founders=
|emblem=
|color1=
|color2=
|rank1=
|rank2=
|rank3=
|rank4=
|rank5=
|rank6=
|motto=
|description=
|footnotes=
|}}

See also

Retrieved from "https://ouroportal.com/w/index.php?title=Template:SupergroupBox/doc&oldid=6669"