Template:Scroll list phantom.default

Purpose

DPL tranform (phantom) templates are used to create a transform layer for DPL extension calls.

DPL passes all arguments supplied to a defined template to the transform template, allowing access to those values as well as to provide an opportunity to add logic to calculate new values to then feed back to the caller.

Output of the phantom template is designed to be consumed directly by the DPL extension in the caller to generate table rows. Phantom templates like this one are not for normal use: they are employed by DPL queries to mix, remix and format parameters from its "parent" template and possibly some metadata.

• For the theory, see DPL:Manual - DPL parameters: Controlling output volume - include.
• For the practice, use the search facility on the DPL wiki to search for "phantom".

Usage

Usage of transform (phantom) templates inside a dpl extension call are handled by calling the "include" argument with a specific syntax. All values/arguments that are sent to <EXISTING TEMPLATE> will be sent to <TRANSFORM TEMPLATE> for data processing.

{{#dpl:
    ...
    | include = {<EXISTING TEMPLATE>{{!}}<TRANSFORM TEMPLATE>}
    ...
}}

• This template (.default) is triggered for every page that matches the callers DPL filter criteria (namespace/category/uses)
• But does not contain the specified template identified by the include argument
• If the parent has identified specific filter criteria, and wants that processed in a certain way, data processing by a default template is generally undesired
• In this case, we send back zero output to the caller

Categorization

• This template does not inject categorization to any callers

Coding

The code in this section is "includeonly" transcluded onto the page.