Template:TableTop/Documentation: Difference between revisions

Help

Revision as of 19:25, 21 November 2023

Template:TableTop is used in conjunction with other Table Templates in the creation of properly formatted tables.

Usage

It accepts one mandatory unnamed string parameter and up to six additional optional unnamed string parameters. All seven are used as headers in the table.

It also requires mandatory named string parameter:

caption — adds a table caption.

It supports two optional named parameters:

float — controls which side of the content the table appears on, left or right.
sortable — if set to true it adds the sortable option to the <table /> class.

Return

The table starts with <table class="wikitable">, then the supplied parameters are used to construct a <th /> with each parameter wrapped in a <td />. For example, {{TableTop|Column A|Column B|Column C|caption=Sample|sortable=true}} produces the header in:

Sample

Column A	Column B	Column C
Cell A1	Cell B1	Cell C1
Cell A2	Cell B2	Cell C2
Cell A3	Cell B3	Cell C3

@@ Line 2: / Line 2: @@
 {{Template|TableTop}} is used in conjunction with other {{Category|Table Template}}s in the creation of properly formatted tables.
 ==Usage==
-It accepts one {{Parameter|mandatory|string}} and up to six additional {{Parameter|optional|string}}s. All seven are used as headers in the table.
+It accepts one {{Parameter|mandatory|unnamed string}} and up to six additional {{Parameter|optional|unnamed string}}s. All seven are used as headers in the table.
-It supports four {{Parameter|optional|named}}s:
+It also requires {{Parameter|mandatory|named string}}:
+* {{Code|caption}} &mdash; adds a table caption.
+It supports two {{Parameter|optional|named}}s:
 * {{Code|float}} &mdash; controls which side of the content the table appears on, {{Code|left}} or {{Code|right}}.
 * {{Code|sortable}} &mdash; if set to {{code|true}} it adds the {{code|sortable}} option to the {{Code|<nowiki><table /></nowiki>}} class.
-* {{Code|caption}} &mdash; adds a table caption.
-** {{Code|edit}} &mdash; If {{Code|caption}} is set, this parameter can be set to the table article's name to invoke {{Template|Edit}} and add a quick-edit link to the caption.
 ==Return==
 The table starts with {{Code|<nowiki><table class="wikitable"></nowiki>}}, then the supplied parameters are used to construct a {{Code|<nowiki><th /></nowiki>}} with each parameter wrapped in a {{Code|<nowiki><td /></nowiki>}}. For example, {{code|<nowiki>{{TableTop|Column A|Column B|Column C|caption=Sample|sortable=true}}</nowiki>}} produces the header in:
 {{Return|{{Table:Sample}}}}