View source for Template:TableDraw/doc

<noinclude>{{Documentation subpage}}
{{high-risk}}</noinclude>

;Description
This is the {{t|tableDraw|...}} or '''Table draw''' meta-template. This template is used to create datatables populated by data gathered from pages using {{t|argbox}}, {{t|autoArgbox}}, or {{t|argHeader}}. It can be used to display data in one of two table formats, <code>default</code> and <code>small</code>.
;Syntax
Type <code>{{t|tableDraw|...}}</code> somewhere, with parameters as shown below.
;Sample output
<pre>{{tableDraw
| pageFilter  = rootpage
| type        = Official
| nameFilter  = !~Waking Titan
}}</pre>

Results in...
{{tableDraw
| pageFilter  = rootpage
| type        = Official
| nameFilter  = !~Waking Titan
}}
{{clear}}

<pre>{{tableDraw
| tableType   = small
| nameFilter  = ~*Waking Titan*
| pageFilter  = subpage
}}</pre>

Results in...
{{tableDraw
| tableType   = small
| nameFilter  = ~*Waking Titan*
| pageFilter  = subpage
}}

;Parameters
{| class="wikitable"
! Parameter
! Description
! Default
! Accepted Values
! Type
! Status
|-
| tableType
| controls the format of the table
| default
| <code>small</code>
| String
| Optional
|-
| pageFilter
| defines the [[Property:argPageType|page type]] of pages returned
|
|<code>subpage</code> or <code>rootpage</code>
| String
| Optional
|-
| type
| defines the [[Property:argType|type]] of pages returned
|
|<code>Official</code>, <code>Unofficial</code>, or <code>Investigation</code>
| String
| Optional
|-
| cat
| defines the category of page returned
| 
| any valid category name, ie <code>Waking Titan</code>, <code>Official</code>, etc
| String
| Optional
|-
| nameFilter
| defines an string with optional comparators which returned [[Property:argName|page names]] will be compared to
|
| string with or without [https://www.semantic-mediawiki.org/wiki/Help:Search_operators#Comparators comparators], ie <code>~Waking Titan</code>, <code>~Waking Titan*</code>, <code>Frog Fractions 2</code>
| String with optional comparators
| Optional
|}