DPL3/Parameters: Controlling output format

Template:DPL manual

You can select one of several default formats or define your own format (Template:Dpl3); output can be grouped in columns or rows.

In the examples that follow, the DPL output has been kept small to reduce page load time and page size, most notably using Template:Dpl3, Template:Dpl3, Template:Dpl3, and Template:Dpl3.

General approach to output formatting

The general approach to output formatting is two-fold:

There are a couple of simple predefined output formats which generate lists of articles.
You will understand their meaning directly from reading.
There is a mode called Template:Dpl3 which puts complete control into your hands.
This is somewhat complicated.

While the standard output formats are meant to be used for fast generation of simple page lists, the Template:Dpl3 approach aims at transcluding contents from other pages and requires some effort to understand. There is a system of three tags which are used to enclose (a) the whole output, (b) each item, (c) each transcluded section of an item. A fourth tag is used to separate values between items of one section which occur more than once.

We assume that we have two documents which use templates Template:Tt and Template:Tt with varying arguments; while Template:Tt is being used once within each document, Template:Tt is used several times. In very short notation the structure might look as follows:

 A: x(a) y(3) y(5)
 B: x(b) y(4) y(1) y(2)

The following DPL parameters are used to define a set of tags which are used to construct the output:

Template:Dpl3 = liststart,itemstart,itemend,listend
Template:Dpl3 = sec-1-start,sec-1-end,sec-2-start,sec-2-end, .. , ..
Template:Dpl3 = multi-sep

The arguments of the above statements can contain references to Template:Dpl3. So sec-1-start might contain a reference like Template:Tt to output the page name. See Template:Dpl3 for more details on variable substitution.

Now think of the following page inclusion statement:

  includepage={x}.dpl,{y}.dpl

The output will then look like this:

  liststart
     itemstart
        sec-1-start
           x.dpl(a)
        sec-1-end
        sec-2-start
           y.dpl(3)
           multi-sep
           y.dpl(5)
        sec-2-end
     itemend
     itemstart
        sec-1-start
           x.dpl(b)
        sec-1-end
        sec-2-start
           y.dpl(4)
           multi-sep
           y.dpl(1)
           multi-sep
           y.dpl(2)
        sec-2-end
     itemend
  listend

Assuming that the tags (Template:Tt, Template:Tt, etc.) contain wiki syntax for table definitions and Template:Tt defines a horizontal line, the output might look like this:

  +------+---------------------+
  |      |          | y.dpl(3) |
  |  A   | x.dpl(a) |  ----    |
  |      |          | y.dpl(5) |
  +------+----------+----------+
  |      |          | y.dpl(4) |
  |      |          |  ----    |
  |  B   | x.dpl(b) | y.dpl(1) |
  |      |          |  ----    |
  |      |          | y.dpl(2) |
  +------+----------+----------+

In some situations, however, you may want to create an output table where each of the calls of template Template:Tt is used to create a separate output row. Using a sortable table you could then easily rearrange the output.

  +------+---------------------+       +------+---------------------+
  |  A   | x.dpl(a) | y.dpl(1) |       |  B   | x.dpl(b) | y.dpl(1) |
  +------+---------------------+       +------+---------------------+
  |  A   | x.dpl(a) | y.dpl(2) |       |  B   | x.dpl(b) | y.dpl(2) |
  +------+---------------------+       +------+---------------------+
  |  B   | x.dpl(b) | y.dpl(3) |       |  A   | x.dpl(a) | y.dpl(3) |
  +------+---------------------+       +------+---------------------+
  |  B   | x.dpl(b) | y.dpl(4) |       |  A   | x.dpl(a) | y.dpl(4) |
  +------+---------------------+       +------+---------------------+
  |  B   | x.dpl(b) | y.dpl(5  |       |  B   | x.dpl(b) | y.dpl(5) |
  +------+---------------------+       +------+---------------------+

There is a special parameter called Template:Dpl3 which you can use to mark one section of your Template:Dpl3 statement as "dominant" (in our example: Template:Dpl3 as Template:Tt is the second argument of our Template:Dpl3 statement). You can only have one dominant section in a DPL statement. Marking a section as "dominant" only makes sense if you have multiple calls of the same template (or multiple chapters with the same heading) in your documents. Each piece of content in the dominant section will generate an individual output row with the values of all other columns being repeated.

As all of the above is not very easy to understand there are additional DPL commands (Template:Dpl3, Template:Dpl3) which make it fairly easy to create tabular output.

default	formatted
<dpl> titlematch = %Help% nottitlematch = %o% includesubpages = false </dpl>	<dpl> titlematch = %Help% nottitlematch = %o% includesubpages = false format = ,\n* [[%PAGE%]],, </dpl>

Anonymous

Search

DPL3/Parameters: Controlling output format

General approach to output formatting

Setting the basic output mode

mode

mode 'ordered', 'unordered', 'none' (Example1)

mode 'category' (Example2)

mode 'inline'

inlinetext

Script error: No such module "anchor".mode 'userformat'

listseparators

format

secseparators

Example

Example 2

multisecseparators

dominantsection

Generating tabular output

table

tablerow

tablesortcol

Heading mode

headingmode

headingcount

listattr

itemattr

hlistattr

hitemattr

userdateformat

Control the way article names are displayed

shownamespace

escapelinks

titlemaxlength

replaceintitle

Arranging article lists in columns and rows

columns

rows

rowsize

rowcolformat

References

Navigation

Wiki tools

Page tools

Categories