Examples/Parameter: multisecseparators (example 3): Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
m (More tweaks for when this is used in other pages, that help explain what's going on here vs the other page)
imported>FrozenPlum
m (Moving away from "phantom" use because phantom suggests something that is not there/imaginary, where surrogate is the more accurate term, it caries, substitutes, and also formats the results.)
Line 6: Line 6:
==Example==
==Example==


This example uses a [[Template:DPL parameter.surrogateexample|surrogate/phantom template]] to format the second and third column of results. The first column is included in the <code>{{DPL|listseparators}}</code> statement, to prevent the page name from being repeated in every subsequent line. The second and third column, formatted in the surrogate, creates a link to the page's parameter name section, and then display the "purpose" text using [[mw:Help:Extension:ParserFunctions|Parser Functions]]. This combination of formatting the page name in a "separators" format statement '''and''' a surrogate template, results in templates used multiple times on a page to be separated into separate table rows under the parent page name (normally repeat templates used on a page are combined into a single row). This example is advanced, for more simple examples of surrogate template use see the [[Controlling output volume#include contents related to templates|include]] parameter as related to including contents from templates, see the <code>{{DPL|table}}</code> and <code>{{DPL|tablerow}}</code> parameters for straightforward table examples.
This example uses a [[Template:DPL parameter.surrogateexample|surrogate (also known as phantom) template]] to format the second and third column of results. The first column is included in the <code>{{DPL|listseparators}}</code> statement, to prevent the page name from being repeated in every subsequent line. The second and third column, formatted in the surrogate, creates a link to the page's parameter name section, and then display the "purpose" text using [[mw:Help:Extension:ParserFunctions|Parser Functions]]. This combination of formatting the page name in a "separators" format statement '''and''' a surrogate template, results in templates used multiple times on a page to be separated into separate table rows under the parent page name (normally repeat templates used on a page are combined into a single row). This example is advanced, for more simple examples of surrogate template use see the [[Controlling output volume#include contents related to templates|include]] parameter as related to including contents from templates, see the <code>{{DPL|table}}</code> and <code>{{DPL|tablerow}}</code> parameters for straightforward table examples.


<pre>
<pre>
Line 15: Line 15:
|include = {dpl manual}:,{DPL parameter}.surrogateexample
|include = {dpl manual}:,{DPL parameter}.surrogateexample
|mode = userformat
|mode = userformat
|listseparators = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a phantom template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦[[%PAGE%]]¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦}
|listseparators = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a surrogate (phantom) template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦[[%PAGE%]]¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦}
|secseparators = ,¶¦class="dpl-orange-background"¦,
|secseparators = ,¶¦class="dpl-orange-background"¦,
|multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦
|multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦
Line 28: Line 28:
|include = {dpl manual}:,{DPL parameter}.surrogateexample
|include = {dpl manual}:,{DPL parameter}.surrogateexample
|mode = userformat
|mode = userformat
|listseparators = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a phantom template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦[[%PAGE%]]¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦}
|listseparators = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a surrogate (phantom) template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦[[%PAGE%]]¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦}
|secseparators = ,¶¦class="dpl-orange-background"¦,
|secseparators = ,¶¦class="dpl-orange-background"¦,
|multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦
|multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦

Revision as of 21:33, 14 April 2022

Please do not edit this page unless you're wanting to edit the manual itself, it is an example included in the manual.

Example

This example uses a surrogate (also known as phantom) template to format the second and third column of results. The first column is included in the listseparators statement, to prevent the page name from being repeated in every subsequent line. The second and third column, formatted in the surrogate, creates a link to the page's parameter name section, and then display the "purpose" text using Parser Functions. This combination of formatting the page name in a "separators" format statement and a surrogate template, results in templates used multiple times on a page to be separated into separate table rows under the parent page name (normally repeat templates used on a page are combined into a single row). This example is advanced, for more simple examples of surrogate template use see the include parameter as related to including contents from templates, see the table and tablerow parameters for straightforward table examples. 

{{#dpl:
|category           = Primary Module
|nottitlematch	    = %volume%¦%page selection%
|uses               = Template:DPL Parameter
|include            = {dpl manual}:,{DPL parameter}.surrogateexample
|mode               = userformat
|listseparators     = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a surrogate (phantom) template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦[[%PAGE%]]¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦}
|secseparators      = ,¶¦class="dpl-orange-background"¦,
|multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦
}}

Result

{{#dpl: |category = Primary Module |nottitlematch = %volume%¦%page selection% |uses = Template:DPL Parameter |include = {dpl manual}:,{DPL parameter}.surrogateexample |mode = userformat |listseparators = ¶{¦class="wikitable sortable" ¶!colspan=3¦Includes a surrogate (phantom) template¶¦-¶!Page ¶!Name ¶!Purpose,¶¦-¶¦%PAGE%¶,¶¦-¶¦class="dpl-dark-background" colspan=3¦,¶¦} |secseparators = ,¶¦class="dpl-orange-background"¦, |multisecseparators = ,¶¦-¶¦¶¦class="dpl-blue-background"¦ }}

Retrieved from "https://dpl3.wikitide.org/wiki/Examples/Parameter:_multisecseparators_(example_3)?oldid=2120"