Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Whrats/doc: Difference between revisions

Template page
Djavin novienta (talk | contribs)
Moved documentation from Template:Whrats
 
Rewrite docs.
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<noinclude>{{main|Template:Whrats}}</noinclude>
; Description
== Syntax ==
: A template to use in order to build a flexible table of certain sleeper rats only, without having to get all of them.
* <nowiki>{{whrats|parameter|</nowiki>{{co|gray||parameter2}}|{{co|gray||parameter3}}<nowiki>}}</nowiki>
A template to use in order to build a flexible table of certain sleeper rats only, without having to get all of them.


=== Opening and closing the table ===
; Syntax
* Start
: {{T|Whrats|rowtype|number|option|logistics}}
* ''<Sleeper rat's name>'' ''(plus optional number of spawns, parameter2, and if it's a trigger or optional spawn, parameter3)''
:; Parameters
* End
::; rowtype
:::; Start : table header for a sortable table with notes
:::; Start2 : table header, table not sortable and no notes
:::; Start3 : start of table with no table header
:::; <Sleeper rat's name> : row with NPC information
:::; End, End2 and End 3 : closing the table. Combine with the "same" start parameter e.g. Start2 with End2.
::; number : number of spawns. Only to be used in rowtype <Sleeper rat's name>
::; option : for trigger (t > [[image:icon_red_x.png|16px]]) or optional spawn (o > [[image:icon_yellow_circle.png|16px]]). Only to be used in rowtype <Sleeper rat's name>
::; logistics : use rr if the NPC uses remote repair. Only to be used in rowtype <Sleeper rat's name>
 
: Usage
* Start''<x>''' - Open the table
* ''<Sleeper rat's name>'' ''(plus optional number of spawns and if it's a trigger or optional spawn''
* Repeat ''<Sleeper rat's name>'' as required
* End''<x>'' - Close table
The '''Start''' parameter is to open he table up, then close it with '''End'''. Then add whichever rats in question you want with additional calls, one for each rat you wish to have in the table.
The '''Start''' parameter is to open he table up, then close it with '''End'''. Then add whichever rats in question you want with additional calls, one for each rat you wish to have in the table.


=== Alternatively ===
; Example
You can also use '''Start2''' and '''End2''' for a simpler table without the references and sorting abilities.
 
== Example ==
The following:
The following:
{| style="clear:right; background:#222222; border:1px solid #333333; padding:5px; margin:1em;"
{| style="background-color: var(--background-color-neutral); border: 1px solid #333333; padding: 5px; margin: 1em;"
|- width:auto; vertical-align:middle;">
|- vertical-align:middle;">
| <nowiki>{{whrats|Start}}</nowiki><br><nowiki>{{whrats|Sleepless Safeguard}}</nowiki><br><nowiki>{{whrats|Sleepless Sentinel|3}}</nowiki><br><nowiki>{{whrats|Sleepless Upholder||t}}</nowiki><br><nowiki>{{whrats|Sleepless Warden|2|o}}</nowiki><br><nowiki>{{whrats|End}}</nowiki>
| <nowiki>{{whrats|Start}}</nowiki>
<nowiki>{{whrats|Sleepless Safeguard}}</nowiki><br>
<nowiki>{{whrats|Sleepless Sentinel|3}}</nowiki><br>
<nowiki>{{whrats|Sleepless Upholder| |t}}</nowiki><br>
<nowiki>{{whrats|Sleepless Warden|2|o}}</nowiki><br>
<nowiki>{{whrats|End}}</nowiki>
|}
|}
Would result in this:
Would result in this:
Line 23: Line 37:
{{whrats|Sleepless Safeguard}}
{{whrats|Sleepless Safeguard}}
{{whrats|Sleepless Sentinel|3}}
{{whrats|Sleepless Sentinel|3}}
{{whrats|Sleepless Upholder||t|rr}}
{{whrats|Sleepless Upholder| |t|rr}}
{{whrats|Sleepless Warden|2|o}}
{{whrats|Sleepless Warden|2|o}}
{{whrats|End}}
{{whrats|End}}
And with the alternative:
And with the alternative:
{| style="clear:right; background:#222222; border:1px solid #333333; padding:5px; margin:1em;"
{| style="background-color: var(--background-color-neutral); border: 1px solid #333333; padding: 5px; margin: 1em;"
|- width:auto; vertical-align:middle;">
|- width:auto; vertical-align:middle;">
| <nowiki>{{whrats|Start2}}</nowiki><br><nowiki>{{whrats|Awakened Sentinel}}</nowiki><br><nowiki>{{whrats|Awakened Upholder}}</nowiki><br><nowiki>{{whrats|Awakened Warden}}</nowiki><br><nowiki>{{whrats|Awakened Watchman}}</nowiki><br><nowiki>{{whrats|Argos}}</nowiki><br><nowiki>{{whrats|Orthrus}}</nowiki><br><nowiki>{{whrats|Sirius}}</nowiki><br><nowiki>{{whrats|End2}}</nowiki>
| <nowiki>{{whrats|Start2}}</nowiki>
<nowiki>{{whrats|Awakened Sentinel}}</nowiki><br>
<nowiki>{{whrats|Awakened Upholder}}</nowiki><br>
<nowiki>{{whrats|Awakened Warden}}</nowiki><br>
<nowiki>{{whrats|Awakened Watchman}}</nowiki><br><nowiki>{{whrats|Argos}}</nowiki><br>
<nowiki>{{whrats|Orthrus}}</nowiki><br><nowiki>{{whrats|Sirius}}</nowiki><br>
<nowiki>{{whrats|End2}}</nowiki>
|}
|}
Would result in this:
Would result in this:
Line 41: Line 61:
{{whrats|Sirius}}
{{whrats|Sirius}}
{{whrats|End2}}
{{whrats|End2}}
<includeonly>[[Category:Template]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</includeonly>
 
<includeonly>[[Category:Formatting templates]]</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>