Template:Infobox Tip/doc: Difference between revisions
Jump to navigation
Jump to search
imported>Sekoia (historical) No edit summary |
m (Added name=) |
||
(10 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
==Overview== | |||
This template is used to show an infobox at the top of a Tip mission article. In addition to showing the infobox, it also supplies the appropriate categories using a default sort key that strips off the first six characters (which should always be "Tip - "); thus, "Mission:Tip - Example" would sort under "E". | |||
This template has special magic that ensures that it will only activate in the Mission: namespace. If an article in another namespace transcludes the article, the infobox and categories will automatically suppress. (Conversely, this means it can ''only'' be used in the Mission: namespace.) | |||
==Usage== | ==Usage== | ||
Copy and paste to use: | |||
<pre>{{Infobox Tip | |||
|name= | |||
|image= | |||
|type= | |||
|place= | |||
|available= | |||
|levelfrom= | |||
|levelto= | |||
|choice= | |||
}}</pre> | |||
Explanation of parameters: | |||
; name= | |||
: Overwrite for main header. Defaults to name drawn from PageName. | |||
; image= | |||
: An associated icon for the tip for special tip missions. If left blank will default to File:Salvage TipIcon.png | |||
; sub= | |||
: Overwrites sub header if unique. By default derives from type=. | |||
; type= | |||
: The type of tip mission. This must be one of the following: | |||
:* '''alignment''', for an alignment mission | |||
:* '''morality''', for a morality mission | |||
:* '''introduction''', for introduction missions that unlock a contact | |||
:* '''event''', for an event mission | |||
; place= | |||
: The place where the tip drops. Possible options: | |||
:* '''Paragon City''', required for alignment and morality missions in Paragon City | |||
:* '''Rogue Isles''', required for alignment and morality missions in the Rogue Isles | |||
:* '''Anywhere''', recommended for tips that can drop anywhere (such as event tips) | |||
; available= | |||
: Specifies who the tip is available to. That is, who the tip will drop for. This must be one of the following: | |||
:* '''hero''', for Heroes | |||
:* '''vill''', for Villains | |||
:* '''rog''', for Rogues | |||
:* '''vig''', for Vigilantes | |||
:* '''herovig''', for Heroes and Vigilantes | |||
:* '''villrog''', for Villains and Rogues | |||
:* '''herovigrog''', for Heroes, Vigilantes, and Rogues | |||
:* '''villrogvig''', for Villains, Rogues, and Vigilantes | |||
:* '''all4''', for Heroes, Vigilantes, Villains, and Rogues | |||
:* '''everyone''', for Everyone | |||
; levelfrom= | |||
; levelto= | |||
: Together, these two parameters specify the level range, with levelfrom= being the lower bound and levelto= being the upper bound. If the levels aren't known, then leave these parameters blank and a question mark will automatically be supplied. | |||
; choice= | |||
: Specifies what alignment/morality choice is available in the mission. This must be one of the following: | |||
:* '''hero''', for Heroes | |||
:* '''vill''', for Villains | |||
:* '''rog''', for Rogues | |||
:* '''vig''', for Vigilantes | |||
:* '''herovig''', for Heroes and Vigilantes | |||
:* '''villrog''', for Villains and Rogues | |||
; demo= | |||
: (Not shown in the copy-and-paste above.) This enables demo mode. The Infobox will be forcibly shown. The categories will be forcibly suppressed. | |||
==Examples== | ==Examples== | ||
Line 7: | Line 76: | ||
{{Infobox Tip | {{Infobox Tip | ||
|demo=1 | |demo=1 | ||
|name= | |||
|type= | |type= | ||
|place= | |place= | ||
Line 15: | Line 85: | ||
}} | }} | ||
<pre>{{Infobox Tip | <pre>{{Infobox Tip | ||
| | |name= | ||
|type= | |type= | ||
|place= | |place= | ||
Line 27: | Line 97: | ||
{{Infobox Tip | {{Infobox Tip | ||
|demo=1 | |demo=1 | ||
|name=Example | |||
|type=alignment | |type=alignment | ||
|place=Paragon City | |place=Paragon City | ||
Line 35: | Line 106: | ||
}} | }} | ||
<pre>{{Infobox Tip | <pre>{{Infobox Tip | ||
| | |name=Example | ||
|type=alignment | |type=alignment | ||
|place=Paragon City | |place=Paragon City | ||
Line 47: | Line 118: | ||
{{Infobox Tip | {{Infobox Tip | ||
|demo=1 | |demo=1 | ||
|name=Example | |||
|type=morality | |type=morality | ||
|place=Rogue Isles | |place=Rogue Isles | ||
Line 55: | Line 127: | ||
}} | }} | ||
<pre>{{Infobox Tip | <pre>{{Infobox Tip | ||
| | |name=Example | ||
|type=morality | |type=morality | ||
|place=Rogue Isles | |place=Rogue Isles | ||
Line 67: | Line 139: | ||
{{Infobox Tip | {{Infobox Tip | ||
|demo=1 | |demo=1 | ||
|name=Example | |||
|image=Halloween 2010 TipIcon.png | |||
|type=event | |type=event | ||
|place=Anywhere | |place=Anywhere | ||
Line 75: | Line 149: | ||
}} | }} | ||
<pre>{{Infobox Tip | <pre>{{Infobox Tip | ||
| | |name=Example | ||
|image=Halloween 2010 TipIcon.png | |||
|type=event | |type=event | ||
|place=Anywhere | |place=Anywhere | ||
Line 84: | Line 159: | ||
}}</pre> | }}</pre> | ||
{{clr}} | {{clr}} | ||
<includeonly><!-- | <includeonly><!-- | ||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ||
</includeonly> | </includeonly> |
Latest revision as of 20:42, 12 October 2020
Overview
This template is used to show an infobox at the top of a Tip mission article. In addition to showing the infobox, it also supplies the appropriate categories using a default sort key that strips off the first six characters (which should always be "Tip - "); thus, "Mission:Tip - Example" would sort under "E".
This template has special magic that ensures that it will only activate in the Mission: namespace. If an article in another namespace transcludes the article, the infobox and categories will automatically suppress. (Conversely, this means it can only be used in the Mission: namespace.)
Usage
Copy and paste to use:
{{Infobox Tip |name= |image= |type= |place= |available= |levelfrom= |levelto= |choice= }}
Explanation of parameters:
- name=
- Overwrite for main header. Defaults to name drawn from PageName.
- image=
- An associated icon for the tip for special tip missions. If left blank will default to File:Salvage TipIcon.png
- sub=
- Overwrites sub header if unique. By default derives from type=.
- type=
- The type of tip mission. This must be one of the following:
- alignment, for an alignment mission
- morality, for a morality mission
- introduction, for introduction missions that unlock a contact
- event, for an event mission
- place=
- The place where the tip drops. Possible options:
- Paragon City, required for alignment and morality missions in Paragon City
- Rogue Isles, required for alignment and morality missions in the Rogue Isles
- Anywhere, recommended for tips that can drop anywhere (such as event tips)
- available=
- Specifies who the tip is available to. That is, who the tip will drop for. This must be one of the following:
- hero, for Heroes
- vill, for Villains
- rog, for Rogues
- vig, for Vigilantes
- herovig, for Heroes and Vigilantes
- villrog, for Villains and Rogues
- herovigrog, for Heroes, Vigilantes, and Rogues
- villrogvig, for Villains, Rogues, and Vigilantes
- all4, for Heroes, Vigilantes, Villains, and Rogues
- everyone, for Everyone
- levelfrom=
- levelto=
- Together, these two parameters specify the level range, with levelfrom= being the lower bound and levelto= being the upper bound. If the levels aren't known, then leave these parameters blank and a question mark will automatically be supplied.
- choice=
- Specifies what alignment/morality choice is available in the mission. This must be one of the following:
- hero, for Heroes
- vill, for Villains
- rog, for Rogues
- vig, for Vigilantes
- herovig, for Heroes and Vigilantes
- villrog, for Villains and Rogues
- demo=
- (Not shown in the copy-and-paste above.) This enables demo mode. The Infobox will be forcibly shown. The categories will be forcibly suppressed.
Examples
x Tip/doc | |
---|---|
Type | Tip |
Level range | ?–? |
{{Infobox Tip |name= |type= |place= |available= |levelfrom= |levelto= |choice= }}
Example | |
---|---|
Alignment Mission | |
Type | Alignment Tip |
Place | Paragon City |
Available to | Heroes and Vigilantes |
Level range | 20–29 |
Choice | Hero or Vigilante |
{{Infobox Tip |name=Example |type=alignment |place=Paragon City |available=herovig |levelfrom=20 |levelto=29 |choice=herovig }}
Example | |
---|---|
Morality Mission | |
Type | Morality Tip |
Place | Rogue Isles |
Available to | Heroes, Vigilantes, and Rogues |
Level range | 40–50 |
Choice | Hero |
{{Infobox Tip |name=Example |type=morality |place=Rogue Isles |available=herovigrog |levelfrom=40 |levelto=50 |choice=hero }}
Example | |
---|---|
Event Mission | |
Type | Event Tip |
Place | Anywhere |
Available to | Heroes, Vigilantes, Villains, and Rogues |
Level range | 20–50 |
{{Infobox Tip |name=Example |image=Halloween 2010 TipIcon.png |type=event |place=Anywhere |available=all4 |levelfrom=20 |levelto=50 |choice= }}