Template:Factions/doc: Difference between revisions
From MediaWiki
Jump to navigationJump to search New page: <div style="text-align:right;font-size:xx-small;">(Transcluded documentation: view)</div> <p>'''<tt>{{factions}}</tt>''' creates a small 30x30 clickable icon of ... |
No edit summary |
||
| Line 1: | Line 1: | ||
<p>'''<tt>{{factions}}</tt>''' creates a small 30x30 clickable icon of a character's faction symbol to the right of the page title. Up to 10 icons can be created this way.<ref>10 is an arbitrary number. Arbitrary-length MediaWiki templates like this are generally encouraged to have no more than 20 parameters though. And really... if a character has more than 10 factions, the icons cease to communicate information and simply become noise.</ref> | |||
<p>'''<tt>{{factions}}</tt>''' creates a small 30x30 clickable icon of a character's faction symbol to the right of the page title. Up to 10 icons can be created this way.<ref> | |||
</p> | </p> | ||
<div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''This template is based on an almost-identical template on [http://starwars.wikia.com/wiki/Template:Eras Wookiepedia] used to place "Era" icons in the titlebar.''</div> | <div style="width: 90%; margin: 0 auto .2em auto; background-color:#efefef; border: 2px solid #eeeeee; padding: 2px; text-align: left;">'''Note:''' ''This template is based on an almost-identical template on [http://starwars.wikia.com/wiki/Template:Eras Wookiepedia] used to place "Era" icons in the titlebar.''</div> | ||
| Line 173: | Line 171: | ||
* The [[Template talk:Factions|development process]] of this template included a truly ''spectacular'' recursion error that knocked the entire wiki offline as its stack overflowed, repeatedly and <small>we think</small> corrupted link-table entries that couldn't be resolved without deleting the whole thing and starting from scratch. That is why the current version of the template exists in a 'dumb' (non-recursive) form. ''Bad [[User:Derik|Derik]]!''' | * The [[Template talk:Factions|development process]] of this template included a truly ''spectacular'' recursion error that knocked the entire wiki offline as its stack overflowed, repeatedly and <small>we think</small> corrupted link-table entries that couldn't be resolved without deleting the whole thing and starting from scratch. That is why the current version of the template exists in a 'dumb' (non-recursive) form. ''Bad [[User:Derik|Derik]]!''' | ||
==Footnotes== | |||
<references/> | |||
<noinclude>[[Category: Externalized documentation]]</noinclude> | |||
Revision as of 16:38, 23 March 2009
creates a small 30x30 clickable icon of a character's faction symbol to the right of the page title. Up to 10 icons can be created this way.[1]
Note: This template is based on an almost-identical template on Wookiepedia used to place "Era" icons in the titlebar.
{{factions
|Autobot
|Decepticon}}
Contents
|
<script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script> <a name="Faction_icon_names"></a>
[[[Template:Factions/doc|edit]]] Faction icon names
Faction names used by this template are case-insensitive.
Any mis-typed text not recognized as the template will be rendered as text. (You will notice, it's hard to miss.)
| FACTION NAME | TEMPLATE TEXT | ICON |
|---|---|---|
| Autobot | autobot | |
| Decepticon | decepticon | |
| Optimus | optimus | |
| Malignus | malignus | |
| Quintesson | quintesson | |
| Autobot Generation 2 | autobotg2 | |
| Decepticon Generation 2 | decepticong2 | |
| Cybertronian Generation 2 | cybEmpireG2 | |
| Maximal | maximal | |
| Predacon (Beast Wars) | predacon | |
| Blendtron | blendtron | |
| Maximal (Beast Machines) | maximalbm | |
| Vehicon | vehicon | |
| Dinobot | dinobot | |
| Mutant | mutant | |
| Predacon (Robots in Disguise) | predaconrid | |
| Wreckers | wreckers | |
| Mini-Con | minicon | |
| Unicron | unicron | |
| Velocitron | velocitron | |
| Jungle Planet | jungleplanet | |
| Gigantion | gigantion | |
| Ultracon | ultracon | |
| Sector Seven | sector7 | |
| Autobot (TransTech) | ttautobot | |
| Decepticon (TransTech) | ttdecepticon | |
| Autobot (Shattered Glass) | sgAutobot | |
| Decepticon (Shattered Glass) | sgDecepticon | |
| G.I. Joe | gijoe | |
| Cobra | cobra | |
| EDC | edc | |
| First Transformers | 1stTF | |
| Playskool Go-Bots | gogogobot |
<a name="Custom_faction_icons"></a>
[[[Template:Factions/doc|edit]]] Custom faction icons
There are some characters who have their own faction symbol, (example: Moon) essentially used nowhere else. Rather than clutter the template with these, it is possible to declare a custom faction icon via the following format;
{{factions/icons
|custom=Moon symbol clean.png -REQUIRED, filename of image
|cSize=30x30px -Optional, maximum size of image.
|cLink=Celestial -REQUIRED, Page the image links to.
|cPretty=Celestials -Optional, mouseover text. Will use the link if not supplied.
}}
This is, in turn, included along with the other non-custom tags.
{{factions
|{{factions/icons|custom=Moon symbol clean.png|cLink=Celestial|cPretty=Celestials}}
|maximal
}}<a name="General_considerations"></a>
[[[Template:Factions/doc|edit]]] General considerations
As of this writing(Jan-16-09), this is the only template on TFWiki that requires Javascript to function. The icons in question are created within a non-rendering
tag, which is then copied into the titlebar when the page finishes loading.
As a result, the
template doesn't HAVE to be at the page... but by convention it always should be.Between 0.5 - 1.0% of internet surfers have either disabled Javascript or access the internet in a way that does not support it. Those users will not be able to see these faction icons. These faction icons are intended to serve as a convenient visual shorthand for information already in the article, and are not a primary means of communicating that information. Any information presented by these icons should also be present in the article text.
<a name="Technical_notes"></a>[[[Template:Factions/doc|edit]]] Technical notes
- The Javascript function associated with this template is called showFactions().
- The non-rendering has an id of "title-factionicons." There is a single CSS rule associated with this ID-- causing the <imagemap>s to render inline rather than as blocks.
- The "custom" imagemaps use "#tag: syntax" to allow parameters to be passed to them. (Don't think this will ever have to be edited.)
- The icons themselves are generated by the "Template:Factions/icons" sub-page.
[[[Template:Factions/doc|edit]]] Trivia
- The development process of this template included a truly spectacular recursion error that knocked the entire wiki offline as its stack overflowed, repeatedly and we think corrupted link-table entries that couldn't be resolved without deleting the whole thing and starting from scratch. That is why the current version of the template exists in a 'dumb' (non-recursive) form. Bad Derik!'
Footnotes
- ↑ 10 is an arbitrary number. Arbitrary-length MediaWiki templates like this are generally encouraged to have no more than 20 parameters though. And really... if a character has more than 10 factions, the icons cease to communicate information and simply become noise.
