Generating tabular output (examples)

Manual

Examples

Generating tabular output

The following examples explain how to generate tabular output.

Using template parameter values

Single template value

Example:

{{#lsth:Examples/Parameter: tablerow (example 1)|Example}}

Test in sandbox

View Result

Result:
{{#lsth:Examples/Parameter: tablerow (example 1)|Result}}

Note: The %% in tablerow allows precise positioning of the column value, inside whatever formatting you want to apply.

Omit (automatic) 1st column

This selects articles in Category:Fruit examples, it includes the "grows" parameter value from "Fruit-Infobox" template. The table statement formats the table as "wikitable" and "sortable" and uses - in second position to omit the first (automatic) page column; the "grows" value now appears in the first column. With the first column left off, tablerow corresponds 1:1 to the include statement, so the first column is styled green using %% to position the value after the styling.

Note: If the page name is omitted, and one of the "grows" cells is empty (its page doesn't have a value for "grows" parameter), it appears as an empty row in the table.

Example:

{{#dpl:
|category      = Fruit examples
|include       = {Fruit-Infobox}:grows
|table         = class="wikitable sortable",-,The first parameter<br>of the Template Call
|tablerow      = style="background:#eeffee;"¦%%
|count         = 5
}}

Result:

{{#dpl: |category = Fruit examples |include = {Fruit-Infobox}:grows |table = class="wikitable sortable",-,The first parameter
of the Template Call |tablerow = style="background:#eeffee;"¦%% |count = 5 }}

Move page to 2nd column

This selects articles in Category:Fruit examples, it includes the "grows" parameter value from the "Fruit-Infobox" template, and the page name (%PAGE% gives name with namespace, if applicable) which is linked, using %TITLE% (page name without namespace) as the link text. The table statement formats the table, then uses - in the second position to omit the first (automatic) page column. With the page column omitted, the tablerow formatting corresponds 1:1 to the include statement and the first column containing the "grows" parameter value is displayed using %%. The last column uses %% position the value for bold formatting.

Note: Linking a page name can be done in an include statement, though magic words, parser functions, and other formatting needs to be done in the tablerow statement.

Example:

{{#dpl:
|category      = Fruit examples
|include       = {Fruit-Infobox}:grows:[[%PAGE%|%TITLE%]]
|table         = ,-,The first parameter<br>of the Template Call,Page
|tablerow      = %%,<b>%%</b>
|count         = 5
}}

Result:
{{#dpl: |category = Fruit examples |include = {Fruit-Infobox}:grows:%TITLE% |table = ,-,The first parameter
of the Template Call,Page |tablerow = %%,%% |count = 5 }}

Move page to 2nd column and format

This selects articles in Category:Fruit examples, it includes the "grows" parameter value from "Fruit-Infobox" template, and the page (with namespace). The table statement uses - in second position to omit the (automatic) page column which makes the tablerow value corresponds 1:1 to the include statement position. tablerow has no formatting set for the first column, so its content is displayed as-is from the "grows" include statement, and in the second column the page (and title) is linked with italic formatting applied.

Example:

{{#dpl:
|category      = Fruit examples
|include       = {Fruit-Infobox}:grows:%PAGE%
|table         = ,-,The first parameter<br>of the Template Call,Page
|tablerow      = %%,<i>[[%PAGE%|%TITLE%]]</i>
|count         = 5
}}

Result:
{{#dpl: |category = Fruit examples |include = {Fruit-Infobox}:grows:%PAGE% |table = ,-,The first parameter
of the Template Call,Page |tablerow = %%,%TITLE% |count = 5 }}

Multiple parameter values

Multiple template parameter values can be added, these can also be formatted in the tablerow statement.

Example:

{{#lsth:Examples/Parameter: include (example 4)|Example}}

Test in sandbox

View Result

Result:
{{#lsth:Examples/Parameter: include (example 4)|Result}}

#dplvar to move/duplicate parameters between columns

Example: {{#lsth:Examples/Parameter: tablerow (example 2)|Example}}

Test in sandbox

View Result

Result:
{{#lsth:Examples/Parameter: tablerow (example 2)|Result}}

Include multiple (different) template's values

This selects articles in Category:Fruit examples whose article names are automatically generated and placed in the first column. It then includes the "Fruit-Infobox" template "grows" parameter value in the second column, and the "Color" template's first (numbered parameter) 1 value in the third column. The table= statement sets the table style and headings, the tablerow= statement's %% values correspond 1:1 with the position of the include statement, and allows each cell to be styled (or variables, parser functions, or other DPL3 modules to be used). The last column reuses its value, to both set the font color and display the parameter value text itself.

Example:

{{#dpl:
|category   = Fruit examples
|include    ={Fruit-Infobox}:grows,{color}:1
|table      = class="wikitable sortable",Page,Fruit-Infobox <br>template "grows" value, Color template "1" <br>(unnamed parameter) value 
|tablerow   = style="background:#eeffee;"¦<i>%%</i>,style="color:%%"¦%%
|count      = 5
}}

Notes:

• %% values can be reused in the same column.
• %% allows the values of a column to be positioned precisely within whatever formatting is to be applied; otherwise, it simply carries the value down from the corresponding include column to its cell, if other formatted values need to appear in columns after it. Given values correspond to the include position, they can't be moved or used between columns, without the use of #dplvar (though surrogate templates can better achieve this same goal, allowing values to be used anywhere within the output they format).
• Templates used multiple times on a page, have their values automatically grouped and listed under the same page line (the Apple page uses the "{{Color}}" template twice, so two color names appear), since these are grouped under the same page result, the color value %% can only be used to set the style for text color once, which is why the "green" value is red and not green.
• If you need the contents of templates reused on the same page to be displayed on separate lines, see the multisecseparators example of how this is done instead of tablerow (by using a combination of include, listseparators, secseparators, and multisecseparators instead.

Result:
{{#dpl: |category = Fruit examples |include ={Fruit-Infobox}:grows,{color}:1 |table = class="wikitable sortable",Page,Fruit-Infobox
template "grows" value, Color template "1"
(unnamed parameter) value |tablerow = style="background:#eeffee;"¦%%,style="color:%%"¦%% |count = 5 }}

Using page section contents

Single page section

This example includes the content of article's "Notes" section content, for pages in Category:Fruit examples that have a section named "Notes" (pages that don't contain this show no content for it). The sort order is set to descending using tablesortcol to cause descending order sorting.

Note: If any page contains more than one included section, the page name will appear multiple times in the output with each section's contents (as can be seen below).

Example:

{{#dpl:
|category   = Fruit examples
|include    = #notes
|table    = ,,Notes
|tablerow = style="background:#eeffee;"¦%%
|tablesortcol = -1
|count         = 3
}}

Result:
{{#dpl: |category = Fruit examples |include = #notes |table = ,,Notes |tablerow = style="background:#eeffee;"¦%% |tablesortcol = -1 |count = 3 }}

Multiple page sections

This example includes article's "Notes" and "More" page section contents, for pages in Category:Fruit examples that have these sections. The "More" section content is limited to 15 characters #More[15]. The tablerow statement has %% for each value that allow for precise positioning of its contents in applied formatting (if any) or simply display the value if no formatting is needed. The second is section is formatted in italics, the output count also limited to 3 results.

Note: If any article contains more than one of any section, the page name will appear in the output the matching number of times the section appears. If farther sections are included, and these don't have multiple instances, their contents are displayed in both rows (it repeats, as can be observed below).

Example:

{{#dpl:
|category   = Fruit examples
|include    = #Notes,#More[15]
|table      = ,,Notes,More
|tablerow   = %%,<i>%%</i>
|count      = 3
}}

Result:
{{#dpl: |category = Fruit examples |include = #Notes,#More[15] |table = ,,Notes,More |tablerow = %%,%% |count = 3 }}

Dummy section trick

If a #dummy section is added in the include statement (and an empty corresponding column header is also added), this causes unique behavior when the article results contain multiple sections of the same name. The result is that rather than one line per section being output (along with the page name repeating as was the case in this example), the repeats are instead grouped together, each on a separate line, in one table row. The new lines from subsequent templates have been marked to begin in bold.

Note: Such a trick may not be visually appealing, the other method to achieving this ensures the first column does not repeat because it is specified in a listseparators statement, the the other columns can then be formatted and appear normally using a surrogate/phantom template as can be seen in multisecseparators (example 3).

Example:

{{#dpl:
|category   = Fruit examples
|include    = #dummy,#More[30],#Notes[30]
|table      = ,Page,,''More'' text,''Notes'' text
|tablerow   = ,<i><small>%%</small></i>,<small>%%</small>
|count      = 5
}}

Result:
{{#dpl: |category = Fruit examples |include = #dummy,#More[30],#Notes[30] |table = ,Page,,"More" text,"Notes" text |tablerow = ,%%,%% |count = 5 }}

Using surrogate templates

Single surrogate template

Example:

{{#lsth:Examples/Parameter: table (example 3)|Example}}

Test in sandbox

View Result

Result:
{{#lsth:Examples/Parameter: table (example 3)|Result}}

Multiple surrogate templates

Multiple surrogates might be used only if you need to access parameter values from different templates used on the same page or set of pages; otherwise, it is generally better to use just one.

The below example selects pages in Category:Fruit examples, and the include statement uses two different surrogate (also known as phantom) templates to access values from two separate templates used on the result pages, and sets and formats the output for a single row (which is then re-applied to each row in the table). The first argument of the table statement sets the table styles, the next sets the name "Page" for the first column of values. (Remember, the first column of table output is automatically generated by DPL3 unless suppressed with - (in place of "Page"), it also can't be formatted unless suppressed; and, if omitted, the first surrogate template would need to supply and format the first column values.) After the "Page" table header in the example, the rest of the titles are set. The first surrogate template formats the first two columns of results (the "grows" and "image" parameters belong to the "Fruit-Infobox" template used on result pages), and the second surrogate formats the last column (the "color" value belongs to the "Color" template used on result pages).

Notes:

• {{{%PAGE%}}} can be used to display the page name (with namespace) in any surrogate template (these are always passed by DPL3).
• {{{%TITLE%}}} can be used to display the page name (without namespace) in any surrogate template (these are always passed by DPL3).
• See include for more information on surrogate templates.

Example-specific:

• {{{grows|}}} was used to display the "Fruit-Infobox" template "grows" (named) parameter value from the result pages (if it existed, left it blank if not).
• {{{image|}}} was used to display the "Fruit-Infobox" template "image" (named) parameter value from the result pages (if it existed, left it blank if not).
• {{{1|}}} was used to display the "Color" template (anonymous) parameter value from the result pages (if it existed, left it blank if not).
• Since the "Color" template was used more than once on some pages, it formats each instance more than once.

Example:

{{#dpl:
|category   = Fruit examples
|include    = {Fruit-Infobox}.templatevalues,{Color}.templatevalues
|table      = class="wikitable sortable",Page,Grows,Image,Color
|count      = 5
}}

Result:
{{#dpl: |category = Fruit examples |include = {Fruit-Infobox}.templatevalues,{Color}.templatevalues |table = class="wikitable sortable",Page,Grows,Image,Color |count = 5 }}

Combining parameter values, page sections, surrogates

Example:

{{#dpl:
|category   = Fruit examples
|include    = {Fruit-Infobox}:grows:image,#Notes[20 more...],#More[20 more...],{Color}.templatevalues
|table      = ,Page,Grows,Image name, Notes, More, Color
|tablerow   = <b>%%</b>,<i>%%</i>,%%,%%,%%
|count = 2
|debug=0
}}

Result:
{{#dpl: |category = Fruit examples |include = {Fruit-Infobox}:grows:image,#Notes[20 more...],#More[20 more...],{Color}.templatevalues |table = ,Page,Grows,Image name, Notes, More, Color |tablerow = %%,%%,%%,%% |count = 2 |debug=0 }}