Template:CMBSiteInfo/doc: Difference between revisions

← Older edit

VisualWikitext

@@ Line 1: / Line 1: @@
-;Description
+; Description
-:This template can be used to output a small table containing information about a particular combat site.
+: This template produces an infobox at the right side of the page containing basic information about a particular combat site.
-:This template also includes {{t|NPCTableCSS}}.
+: This template includes {{T|NPCTableCSS}}.
-;Syntax
+; Dependencies
+:; Uses
+:: {{T|Infobox}}
+:: {{T|Damage to deal}}
+:: {{T|Damage to resist}}
+; Syntax
 <pre>{{CMBSiteInfo
-|name=<Site name>
+| name=
-|type=<Site type>
+| type=
-|rating=<Site rating>
+| rating=
-|location=<Site location>
+| location=
-|ship limit=<Maximum allowed ship size>
+| ship limit=
-|faction=<Opoposing faction in site>
+| faction=
-|damage=<Best damage to deal (optional)>
+| damage=
-|resist=<Damage to resist (optional)>
+| resist=
-|signature strength=<Signature strength>
+| faction2=
+| damage2=
+| resist2=
+| signature strength=
 }}</pre>
-: Valid site types: ded, anomaly, unrated, expedition, chemical and COSMOS.
+: Unused parameters will not be shown in the infobox and may be removed.
-: Valid factions: Angel, Guristas, Sansha, Blood Raider, Mordu, Amarr, Minmatar, Caldari, Khanid, Mercenaries, Rogue Drones, Triglavians. Full names are also supported.
+:; name : Name of the site. (Required)
-: If the optional parameters "damage" or "resist" are not given then they will be retrieved from the faction information.
+:; type : Site type. One of anomaly, chemical, COSMOS, DED, expedition, MTO<ref group=Note >Mercenary Tactical Operation</ref> or unrated. This parameter produces a link to the relative article. The parameter is not case-sensitive.
-;Sample output
+:; rating : The site rating. e.g. 5/10
+:; location : Where the site is found e.g. Highsec or a specific system or constellation etc.
+:; ship limit : Maximum allowed ship size.
+:; faction : The opposing faction in the site. Either one of the well-known factions in the table or free form. The well-known factions produce a link to the relative wiki article. The well-known factions are not case-sensitive.
+{| class="wikitable"style="margin-left: 5em;"
+|+ Well-known factions
+|- style="background-color: var(--background-color-warning-subtle);"
+! Full name !! Valid alternative(s)
+|-
+| Amarr Empire || Amarr
+|-
+| Ammatar
+|-
+| Angel Cartel || Angel, Angels
+|-
+| Blood Raider Covenant || Blood Raider, Blood Raiders
+|-
+| Caldari State || Caldari
+|-
+| EDENCOM
+|-
+| Gallente Federation || Gallente
+|-
+| Guristas pirates || Guristas
+|-
+| Khanid Kingdom || Khanid
+|-
+| Mercenaries || Mercenary
+|-
+| Minmatar Republic ||Minmatar
+|-
+| Mordu's Legion || Mordu, Mordu's
+|-
+| Rogue Drones
+|-
+| Sansha's Nation || Sansha, Sansha's
+|-
+| Serpentis
+|-
+| Triglavians ||
+|}
+:; faction2 : See <code>faction</code>
+: For <code>damage</code> and <code>resist</code> use {{T|Damagetype}}. When one of the well-known factions is used and nothing is entered the factions default values will be used.
+:; damage : Best damage to deal (optional)
+:; damage2 : see <code>damage</code>
+:; resist : Damage to resist (optional)
+:; resist2 : See <code>resist</code>
+:; signature strength : Signature strength
+; Sample
+{{CMBSiteInfo
+| name= Serpentis Lookout
+| type= unrated
+| rating=
+| location= High
+| ship limit= Battlecruiser
+| faction= Serpentis
+| damage=
+| resist=
+| signature strength= 10% in High Sec
+}}
 <pre>{{CMBSiteInfo
-|name = Serpentis Lookout
+| name= Serpentis Lookout
-|type = unrated
+| type= unrated
-|rating = Unrated
+| rating=
-|location = High
+| location= High
-|ship limit= Battlecruiser
+| ship limit= Battlecruiser
-|faction= Serpentis
+| faction= Serpentis
-|signature strength =10% in High Sec
+| damage=
+| resist=
+| signature strength= 10% in High Sec
 }}</pre>
-::gives:
+::gives...
-{{CMBSiteInfo
-|name = Serpentis Lookout
+; Notes
-|type = unrated
+<references group=Note />
-|rating = Unrated
-|location = High
-|ship limit= Battlecruiser
-|faction= Serpentis
-|signature strength =10% in High Sec
-}}
-<includeonly>[[Category:Infobox templates|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
+<includeonly>[[Category:Infobox templates]]<!-- Any categories for the template itself --></includeonly>
-<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+<noinclude>[[Category:Template documentation]]</noinclude>