Template:DPL parameter.dpl: Difference between revisions

m
Move docs here in case users import/export, then it doesn't take Template:Documentation docs with it, along with modules etc and create a mess. Move the template doc on-page instead.
imported>FrozenPlum
m (template docs format)
imported>FrozenPlum
m (Move docs here in case users import/export, then it doesn't take Template:Documentation docs with it, along with modules etc and create a mess. Move the template doc on-page instead.)
 
(One intermediate revision by the same user not shown)
Line 1:
<onlyinclude><includeonly>[[{{{%PAGE%}}}#{{{name}}}|{{{name}}}]] || {{#sub:{{{purpose|}}}|0|50}}</includeonly></onlyincludenoinclude>
 
{{<!-- Documentation}} here -->
This template is a surrogate template (also called a 'phantom template') example that formats one result/line of DPL output. DPL then reuses and applies the surrogate template's formatting to each result/line in the output.
 
Surrogate/phantom templates are used by setting the template name in <code>includepage = {templatename}.suffix</code> (changing the suffix to whatever is descriptive of template purpose).
 
Naming the surrogate/phantom template after the parent, and then adding [[Controlling output volume#Include contents related to templates|a descriptive suffix on the end]], ensures both the parent and surrogate are easily found, and their relationship to each other understood. This style of naming them is particularly useful when looking in the Templates category.
 
==See Also==
* [[{{NAMESPACE}}:{{#explode:{{BASEPAGENAME}}|.}}]] (the template this surrogate provides per-result output formatting for).
 
<!-- Template categories/interwikis here -->
[[Category:Templates]]
[[Category:Example templates]]
[[Category:Surrogate (phantom) templates]]
</noinclude>
Anonymous user