Difference between revisions of "Template:NPCTableHead/doc"

From EVE University Wiki
Jump to: navigation, search
(Update doc to include NPCTableFoot)
 
(36 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This template is used to create NPC table header for the pages describing combat complexes.
+
; Description
== Dependencies ==
+
: This template is used to start an NPCTable. It needs to be paired with the standard wiki parser code to end the table <nowiki>|}</nowiki>. It needs to be used once for every NPCTable on a page.
* Uses {{t|NPCTableRow}} to generate rows.
 
* Uses {{t|Complex}} to acquire proper CSS.
 
== Syntax ==
 
<code>{{t|Complex|Name of the complex}}<br>
 
{{t|NPCTableHead|Table header}}<br>
 
{{t|NPCTableRow|Parameters - see NPCTableRow documentation}}<br>
 
{{t|NPCTableFoot}}</code>
 
  
=== Parameters ===
+
; Dependencies:
;Name of complex
+
:; Requires
:This is the title of the NPC group, e.g. <code>Wave 1</code>, <code>Initial defenders</code>, <code>Commander wave</code>, etc.  
+
:: {{T|NPCTableCSS}} is required only <em>once</em> per page where there's at least one NPCTable. It is included into {{T|CMBSiteInfo}} and {{T|CMBSite}}(deprecated), so when one of those is used there is no need to add it separately.
 +
:; Paired with
 +
:: <nowiki>|}</nowiki> to close the table, or include <nowiki>|end=true}}</nowiki> as the last parameter of the last {{T|NPCTableRow}}.
 +
:; Sub templates
 +
:: {{T|NPCTableRow}} one or more for each NPCTable.
 +
:: {{T|NPCTableSeparator}} zero or more for each NPCTable.
  
== Sample output ==
+
; Syntax
<code><nowiki>{{Complex|Serpentis Lookout}}</nowiki><br>
+
: {{T|NPCTableHead|caption}}
<nowiki>{{NPCTableHead|Wave #34}}</nowiki><br>
+
:; Parameters
<nowiki>{{NPCTableRow|Frigate|100|Coreli Agent|point=yes|ewar={{icon|damp|24}}{{icon|web|24}}|cargo={{icon|shiny cargo|24|Drops Gist X-Type 100MN Microwarpdrive}}}}</nowiki><br>
+
::; caption : Caption of the table. May be omitted.
<nowiki>|}</nowiki></code>
 
:gives...
 
{{Complex|Serpentis Lookout}}{{NPCTableHead|Wave #34}}{{NPCTableRow|Frigate|100|Coreli Agent|point=yes|ewar={{icon|damp|24}}{{icon|web|24}}|cargo={{icon|shiny cargo|24|Drops Gist X-Type 100MN Microwarpdrive}}}}|}
 
  
<includeonly>[[Category:Template|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
+
; Sample
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
{{NPCTableCSS}}
 +
: <code><nowiki>{{NPCTableHead|Initial defenders}}</nowiki></code>
 +
 
 +
: <code><nowiki>|}</nowiki></code>
 +
:: gives...
 +
{{NPCTableHead|Initial defenders}}
 +
 
 +
|}
 +
Note: #222222 is used for the background color of the NPCTable headers. But because the background color of the documentation section of a template is also #222222 it can not be seen on a template page.
 +
 
 +
 
 +
; See also
 +
* [[UniWiki:Mission formatting guidelines|Mission formatting guidelines]]
 +
 
 +
<includeonly>[[Category:Formatting templates]]<!-- Any categories for the template itself --></includeonly>
 +
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 20:01, 6 June 2023

Description
This template is used to start an NPCTable. It needs to be paired with the standard wiki parser code to end the table |}. It needs to be used once for every NPCTable on a page.
Dependencies
Requires
{{NPCTableCSS}} is required only once per page where there's at least one NPCTable. It is included into {{CMBSiteInfo}} and {{CMBSite}}(deprecated), so when one of those is used there is no need to add it separately.
Paired with
|} to close the table, or include |end=true}} as the last parameter of the last {{NPCTableRow}}.
Sub templates
{{NPCTableRow}} one or more for each NPCTable.
{{NPCTableSeparator}} zero or more for each NPCTable.
Syntax
{{NPCTableHead|<caption>}}
Parameters
caption
Caption of the table. May be omitted.
Sample
{{NPCTableHead|Initial defenders}}
|}
gives...
Initial defenders
WD EWAR L


Note: #222222 is used for the background color of the NPCTable headers. But because the background color of the documentation section of a template is also #222222 it can not be seen on a template page.


See also