Anonymous user
Generating tabular output (examples): Difference between revisions
Generating tabular output (examples) (view source)
Revision as of 07:09, 12 April 2022
, 2 years agoFlesh out a whole bunch of these (not finished yet, but it's a good start)
imported>FrozenPlum m (16 revisions imported: Importing from https://followthescore.org/dpldemo/index.php?title=Test_table for adaptation and use on this wiki) |
imported>FrozenPlum m (Flesh out a whole bunch of these (not finished yet, but it's a good start)) |
||
Line 1:
The following tests explain how to use the {{DPL|table}} parameter.
== Include 1 template value==
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, which appears in the second column, if the article has a value for <code>grows=</code> on its page (otherwise this cell displays empty). The <code>table=</code> statement sets the table styles (if set) before the first comma, and then sets the header columns text. The <code>tablerow=</code> statement corresponds 1:1 with the position of the include statement ("grows" in the second column) so it colors the second column green and then displays the value carried down <code>%%</code>. The results are limited to a count of 5.
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows
|table = class="wikitable sortable",Page,The first parameter<br>of the Template Call
|tablerow = style="background:#eeffee;"¦%%
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows
|table = class="wikitable sortable",Page,The first parameter<br>of the Template Call
|tablerow = style="background:#eeffee;"¦%%
|count = 5
}}
==Omit (automatic) first column==
This selects articles in [[:Category:Fruit examples]], it includes the "grows" parameter value from "Fruit-Infobox" template. The <code>table</code> statement uses <code>,-,</code> in second position to omit the (automatic) page column, the "grows" value appears there instead. Since the <code>tablerow</code> value corresponds 1:1 to the include statement position, the ''first'' column is styled green, followed by the value carried down using <code>%%</code>.
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|count = 5
}}
==
This selects articles in [[:Category:Fruit examples]], it includes the "grows" parameter value from "Fruit-Infobox" template, and the page (with namespace) and title (without namespace) set as link text. The <code>table</code> statement uses <code>-</code> in second position to omit the (automatic) page column. Since the <code>tablerow</code> value corresponds 1:1 to the include statement position, the ''first'' column is styled green, followed by the value carried down using <code>%%</code>.
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows:[[%PAGE%|%TITLE%]]
|table = class="wikitable",-,The first parameter<br>of the Template Call,Page
|tablerow = style="background:#eeffee;"¦%%
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|count = 5
}}
==
This selects articles in [[:Category:Fruit examples]], it includes the "grows" parameter value from "Fruit-Infobox" template, and the page (with namespace). The <code>table</code> statement uses <code>-</code> in second position to omit the (automatic) page column. Since the <code>tablerow</code> value corresponds 1:1 to the include statement position, the ''first'' column is styled green, followed by the value carried down using <code>%%</code>, and then the formatted page title with a tilde <code>~</code> inserted before and after, and made bold.
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows:%PAGE%
|table = class="wikitable",-,The first parameter<br>of the Template Call,Page
|tablerow = %%,'''~[[%PAGE%|%TITLE%]]~'''
|count = 5
}}
== 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 <code>1</code> (unnamed parameter) value in the third column. The <code>table=</code> statement sets the table style and headings, the <code>tablerow=</code> statement's <code>%%</code> 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 (because the values are valid [https://www.w3schools.com/cssref/css_colors.asp css color names]) and to display the parameter value text itself.
'''Notes:'''
* <code>%%</code> values can be reused '''in the same column'''.
* Since <code>%%</code> caries the corresponding 1:1 column values down from the include statement, they can't be reused '''in other columns''', a {{DPL|#dplvar}} can be set in the original column then used elsewhere to move the values between columns.
* '''Templates used multiple times''' on a page are automatically grouped and listed under the same page (the [[Apple]] page uses the "<code><nowiki>{{Color}}</nowiki></code>" twice), since these are grouped under the same page result, the color value <code>%%</code> can only be used to set the style for text color once, which is why the "green" value is red and not green.
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|table = class="wikitable sortable",Page,Fruit-Infobox <br>template "grows" value, Color template "1" <br>(unnamed parameter) value
|count = 5
}}
</pre>
'''Result:'''<br>
{{#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;"¦%%,style="color:%%"¦%%
|count = 5
}}
{{note|This section and alternative examples are still being considered and may or may not be developed at a later date.}}
== Using a ''surrogate'' template ==
This example uses a surrogate (also known as a phantom) template to specify and/or format a single row of results, using named <code><nowiki>{{{grows|}}}</nowiki></code> or numbered <code><nowiki>{{{1|}}}</nowiki></code> parameters. See the source code of [[Template:Fruit-Infobox.templatevalues]].
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}.templatevalues
|count = 5
}}
== Using multiple ''surrogate'' templates ==
This example uses two surrogate (also known as a phantom) templates to specify and/or format a single row of results, using named <code><nowiki>{{{grows|}}}</nowiki></code> or numbered <code><nowiki>{{{1|}}}</nowiki></code> parameters. See the source code of [[Template:Fruit-Infobox.templatevalues]] and [[Template:Color.templatevalues]].
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}.templatevalues,{Color}.templatevalues
|table = ,Page,Fruit-Infobox<br><code>color=</code>,Fruit-Infobox<br><code>image=</code>,Color<br>(unnamed parameter whose value is specified <code>1</code>
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}.templatevalues,{Color}.templatevalues
|table = ,Page,Fruit-Infobox<br><code>color=</code>,Fruit-Infobox<br><code>image=</code>,Color<br>(unnamed parameter whose value is specified <code>1</code>
|count = 5
}}
== Get 1 section's contents ==
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 <code>tablesortcol</code> 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:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|tablerow = style="background:#eeffee;"¦%%
|tablesortcol = -1
|count = 3
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = #notes
|table = ,,Notes
|tablerow = style="background:#eeffee;"¦%%
|tablesortcol = -1
|count = 3
}}
== Get 2 section's contents ==
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 <code><nowiki>#More[15]</nowiki></code>. The <code>tablerow</code> statement has <code>%%</code> for each value that needs to be carried down to the its corresponding table row cell. 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:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|tablerow = %%,<i>%%</i>
|count = 3
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|tablerow = %%,<i>%%</i>
|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 [[#Get 1 section's contents|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 {{DPL|listseparators}} statement, the the other columns can then be formatted and appear normally using a surrogate/phantom template as can be seen in [[Controlling output format/Parameter: multisecseparators (example 3)|multisecseparators (example 3)]].
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|include = #dummy,#More,#Notes,
|table = ,Page,,''More'' text,''Notes'' text
|tablerow = ,<i><small>%%</small></i>,<small>%%</small>
|count = 5
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = #dummy,#more,#notes,
|table = ,Page,,"More" text,"Notes" text
|tablerow = ,<small>%%</small>,''<small>%%</small>''
|count = 5
}}
==Combination of parameters and sections ==
'''Example:'''<br>
<pre>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows:image,#Notes[20 more...],#More[20 more...]
|table = class="wikitable",Page,Grows,Image name, Notes, More
|tablerow = <b>%%</b>,<i>%%</i>,%%,%%,%%
|count = 2
|debug=0
}}
</pre>
'''Result:'''<br>
{{#dpl:
|category = Fruit examples
|include = {Fruit-Infobox}:grows:image,#Notes[20 more...],#More[20 more...]
|table = class="wikitable",Page,Grows,Image name, Notes, More
|tablerow = <b>%%</b>,<i>%%</i>,%%,%%,%%
|count = 2
|debug=0
}}
[[Category:Miscellaneous examples]]
|