Down Gilead Lane Wiki - User contributions [en]

Help:DPL/Parameters: Controlling output volume

2024-08-23T03:05:13Z

Scientific Guy:

{{DPL manual|section=Parameters|subsection=Controlling output volume|sort=P4}}

Per default, DynamicPageList3 will show the name of each article, including its namespace. The name will serve as a link to the article.
By setting the '''output control parameters''' of DPL you can

* show the number of articles found
* suppress the namespace part of the articles' names
* cut off the articles' names at a certain length
* add meta data (size, author, last edited by, date of last change, ..)
* add access date (frequency, date of last access)
* add the articles' contents or parts of it

Furthermore, you can add a heading '''if there are some articles''' to display.

And you can define an alternate text which will be shown '''if there are no articles''' to display.
{{TOC right}}
==Defining header and footer for the result==
===resultsheader===
{{DPL parameter
|name = resultsheader
|purpose= output a headline if there is at least one article to display.
}}

Syntax: <code>resultsheader=''some wiki text''</code>

Notes:
* The symbol %PAGES% will be replaced by the number of pages found. If your query result is limited (by system settings or by the {{DPL|count}} parameter) %PAGES% will only show the upper limit.
* The symbol %TOTALPAGES% will be replaced by the number of pages found - regardless of count limits. This may consume extra resources.
* %VERSION% will be replaced by the current DPL version.
* The symbol '\n' will be converted to a newline symbol. This is useful if you want to use wiki markup which needs to start at the begin of a line. You may need to add \n if the wiki parser requires a linefeed to understand your wikitext.
* If 'oneresultheader' is specified as well, the latter will be used in case there is exactly one entry in the DPL result set. Then 'resultsheader' will only be used if there are '''two or more''' entries in the result set.

Example:

<pre><nowiki>
{{#dpl:
|category=Africa
|mode=userformat
|resultsheader=There are %PAGES% pages on Africa.
}}
</nowiki></pre>

With "mode=userformat" we get complete control over the output.
We do not specify "listseparators=" - so nothing will be displayed except the results header.
The only thing we will get is a message about the existing number of articles.

===resultsfooter===
{{DPL parameter
|name = resultsfooter
|purpose= output a summary 'footline' if there is at least one article to display.
}}

Syntax: <code>resultsfooter=''some wiki text''</code>

Note: The rules of <code>[[#resultsheader]]</code> apply here as well.

Example:

<pre><nowiki>
{{#dpl:
|category=Africa
|mode=userformat
|resultsfooter=\n===There are %PAGES% pages on Africa.===\n
}}
</nowiki></pre>

With "mode=userformat" we get complete control over the output.
We do not specify "listseparators=" - so nothing will be displayed except the results footer.
The only thing we will get is a message about the existing number of articles. We used '\n' to make sure that our headline syntax will really be recognized by the wikitext parser.

See also [[Help:DPL/Parameters: Controlling output volume#resultsheader]].

===oneresultheader===
{{DPL parameter
|name = oneresultheader
|purpose= output a headline if there is exactly one article to display.
}}

Syntax: <code>oneresultheader=''some wiki text''</code>

Note: The symbol '\n' will be converted to a newline symbol. %VERSION% will be replaced by the current DPL version. This is useful if you want to use wiki markup which needs to start at the begin of a line. You may need to add \n if the wiki parser requires a linefeed to understand your wikitext.

===oneresultfooter===
{{DPL parameter
|name = oneresultfooter
|purpose= output a footline if there is exactly one article to display.
}}

Syntax: <code>oneresultfooter=''some wiki text''</code>

Note: The symbol '\n' will be converted to a newline symbol. %VERSION% will be replaced by the current DPL version. This is useful if you want to use wiki markup which needs to start at the begin of a line.

===noresultsheader===
{{DPL parameter
|name = noresultsheader
|purpose= output a headline if there is no article to display (empty result).
}}

Syntax: <code>noresultsheader=''some wiki text''</code>

Note:

Setting <code>noresultsheader</code> to a single blank or to a newline character ("<code>noresultsheader=&nbsp;</code>" or "<code>noresultsheader=\n</code>") will suppress the warning message from DPL which is normally issued if no articles were found.
Example:

<pre>
A)
{{#dpl:
|titlematch=nosuchArticle
}}

B)
{{#dpl:
|noresultsheader=&nbsp;
|titlematch=nosuchArticle
}}
</pre>

<u>This produces:</u>

A)
{{#dpl:
|titlematch=nosuchArticle
}}

B)
{{#dpl:
|noresultsheader= 
|titlematch=nosuchArticle
}}

===suppresserrors (DEPRECATED)===
This parameter is deprecated and is left in the code as a null parameter to give people time to remove it from their queries. It will be fully removed in a future release of DPL.

{{DPL parameter
|name = suppresserrors
|purpose= suppress the warning message if no matching article was found.
}}

Syntax: <code>suppresserrors=true</code>

See also: <code>[[Help:DPL/Parameters: Other parameters#debug]]</code>

Note: Setting <code>suppresserrors</code> to true has the same effect as setting noresultsheader to a single space character. The command is provided for downward compatibility reasons with older DPL versions.

===noresultsfooter===
{{DPL parameter
|name = noresultsfooter
|purpose= output a footline if there is no article to display (empty result).
}}

Syntax: <code>noresultsfooter=''some wiki text''</code>

Note: <code>noresultsfooter</code> is essentially the same as <code>noresultsheader</code>. If there is no output to display the difference between header and footer becomes incredibly marginal ..

==Adding meta data to the output==
===addcategories===
{{DPL parameter
|name = addcategories
|purpose= Shows all categories to which an article belongs as a small text line after the article name.
}}

Example:

<pre><nowiki>
{{#dpl:
|category = DPL3
|addcategories = true
}}
</nowiki></pre>
{{#dpl:
|category = DPL3
|addcategories = true
}}

This will show all DPL pages together with a list of categories per article. Of course "DPL" will be present in each entry of the list.

Note: in 'mode=userformat' the category list can also be referenced as a built-in variable.

===addpagecounter===
{{DPL parameter
|name = addpagecounter
|purpose= Shows number of times the page has been viewed according to the definition of the 'page_counter' field on [[mw:Page_table|Page_table]].
}}

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|ordermethod = counter
|order = descending
|addpagecounter = true
|count = 5
}}
</nowiki></pre>

This will show the 5 most popular articles about Africa.

Note: in 'mode=userformat' the access counter can also be referenced as a built-in variable.

===addpagesize===
{{DPL parameter
|name = addpagesize
|purpose= Shows the size of the page.
}}

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|ordermethod = size
|order = descending
|addpagesize = true
|counter = 5
}}
</nowiki></pre>

This will show the 5 biggest articles about Africa.

Note: in 'mode=userformat' the size can also be referenced as a built-in variable.

===addcontribution===
{{DPL parameter
|name = addcontribution
|purpose= shows how much a user contributed to an article.
}}

Syntax:

<code>addcontribution=true</code>

If omitted, the default is ''false''.

Using this parameter will restrict your output to articles which were edited recently (This is usually one week or one month, according to the setup of your wiki).

You will get a link to the contributor and an "asterisk bar" which indicates how many bytes in the article were changed by that user.

You will also have the built-in [[Help:DPL format variables|variables]] %CONTRIBUTOR%, %CONTRIB% and %CONTRIBUTION% available to be used in your own {{DPL|format}}</code> statement.

===adduser===
{{DPL parameter
|name = adduser
|purpose= Requires ordermethod=[...,]firstedit or ordermethod=[...,]lastedit (where the [...,] signifies a complex ordermethod with extra parameters). If firstedit (lastedit), 'adduser=true' displays the user who made the first (last) revision of the page. In this way the parameter is equivelent to the {{DPL|addauthor}} ({{DPL|addlasteditor}}) parameter (see below).
}}

Syntax:

<code>adduser=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|ordermethod = lastedit
|adduser = true
}}
</nowiki></pre>

This will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, prepending each result with the author of the last revision.

Note: if '{{DPL|mode}}={{DPL|userformat}}' the user can be referenced as the built-in variable {{DPL|format|%USER%}}.

===addauthor===
{{DPL parameter
|name = addauthor
|purpose= show the user who created the article
}}

Syntax:

<code>addauthor=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|addauthor = true
}}
</nowiki></pre>

This will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, which shows the user who edited the initial revision of that page.

Note: addauthor and addlasteditor '''cannot be used within the same DPL query'''

===addlasteditor===
{{DPL parameter
|name = addlasteditor
|purpose= show the user who edited the most recent revision of a page
}}

Syntax:

<code>addlasteditor=true</code>

If omitted, the default is ''false''.

Note: addauthor and addlasteditor '''cannot be used within the same DPL query'''

===addpagetoucheddate===
{{DPL parameter
|name = addpagetoucheddate
|purpose= Shows date/time of last change to the page according to the definition of the 'page_touched' field on [[mw:Page_table|Page_table]].

Requires ordermethod=[...,]pagetouched or ordermethod=[...,]title. ([...,] means complex ordermethods with extra param before are allowed.)
}}

Example:

<code>addpagetoucheddate=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category=Africa
|ordermethod=pagetouched
|addpagetoucheddate=true
}}
</nowiki></pre>

This list will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, prepending each result with the date of last change (formatted according to your local mediawiki date display preferences or the user's preferences if logged in).

Note: in 'mode=userformat' this date can also be referenced as a built-in variable %DATE%. The formatting of the date can be influenced using [[Help:DPL/Parameters:_Controlling_output_format#userdateformat|userdateformat]]. The date is translated to your local time zone (if defined in your preferences) or to the server's time zone.

===addeditdate===
{{DPL parameter
|name = addeditdate
|purpose= Requires ordermethod=[...,]firstedit or ordermethod=[...,]lastedit. ([...,] means complex ordermethods with extra param before firstedit|lastedit are allowed.)

Conflicts with other "add*date" (addpagetoucheddate, etc.) parameters.
}}

Purpose:

If firstedit (resp. lastedit), 'addeditdate=true' shows the date of the first revision/creation (resp. last revision) of the page.

Example:

<code>addeditdate=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category=Africa
|ordermethod=lastedit
|addeditdate=true
}}
</nowiki></pre>

This list will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, prepending each result with the date of last revision (formatted according to your local mediawiki date display preferences or the user's preferences if logged in).

Note: in 'mode=userformat' this date can also be referenced as a built-in variable %DATE%. The formatting of the date can be influenced using [[Help:DPL/Parameters:_Controlling_output_format#userdateformat|userdateformat]]. The date is translated to your local time zone (if defined in your preferences) or to the server's time zone.

===addexternallink===
{{DPL parameter
|name = addexternallink
|purpose= add the URL of an external link to the output list.
}}

Purpose:

Allows to display external links found in articles.

Example:

<code>addexternallink=true</code>

If omitted, the default is ''false''.

Note: The command makes only sense in combination with {{DPL|linkstoexternal}}.

===addfirstcategorydate===
{{DPL parameter
|name = addfirstcategorydate
|purpose= Shows the date/time the article got added to one of the listed include categories. If there are more than one categories listed and an article belongs to more than one of them, the result is ambiguous.

From a logical point of view it is recommended to include one category only with 'category' parameter or to make sure that each of the article in the result belongs to only one of the categories listed.
Conflicts with other "add*date" (addeditdate, etc.) parameters to avoid confusion.
}}

Example:

<code>addfirstcategorydate=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|addfirstcategorydate = true
}}
</nowiki></pre>

This list will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, prepending each result with the time and date (formatted according to your local mediawiki date display preferences or the user preferences if user logged in).

Note: in 'mode=userformat' this date can also be referenced as a built-in variable %DATE%. The formatting of the date can be influenced using [[Help:DPL/Parameters:_Controlling_output_format#userdateformat|userdateformat]]. The date is translated to your local time zone (if defined in your preferences) or to the server's time zone.

===showcurid===
{{DPL parameter
|name = showcurid
|purpose= page links will contain the current page id
}}

Example:

<code>showcurid=true</code>

If omitted, the default is ''false''.

Example:

<pre><nowiki>
{{#dpl:
|category = Africa
|showcurid = true
}}
</nowiki></pre>

This DPL command will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>; the hyperlinks to these pages look normal, but they have an additional parameter named 'curid' which contains the numeric id of the linked page. Using this type of link may be somewhat faster than using the title only. This kind of link is useful for some web spiders (e.g. google spider needs a unique id within the pagelink) and it works even if the title has moved.

<code>showcurid=true</code> cannot be used together with <code>openreferences=true</code>.

==Include contents from the articles in the result set==
===include===
{{DPL parameter
|name = include
|purpose= include pages (whole content) or include certain sections of articles or template parameters.
''This functionality is based on the ideas and work of Steve Sanbeg and his extension [[mw:Extension:Labeled_Section_Transclusion|Labeled Section Transclusion]]. DPL comes with a modified version of Sanbeg´s source, so there is no need for additional installation.''
}}

With <code>include</code> you can incorporate one or more of the following
* the whole article as it is
* a certain chapter -- identified by its headline
* a certain chapter -- identified by its position (sequence number, regardless of level)
* parameter(s) used in template calls
* the output of a surrogate template (phantom template) which is used instead of the original template
* pieces of text which are marked by special section markers

There is a close correlation between the output of the <code>include</code> statement and {{DPL|table}} and {{DPL|tablerow}}. You should understand those statements if you want to create tabular output from included content.

Syntax:

====include whole article====
To include a '''whole page''', use a wildcard:

:<code>include=*</code>
:you can use <code>includemaxlength=[n]</code> to restrict the included text to a portion of the article. The text is truncated in a way which will not spoil tag structures or bracket nestings. It will be cut at a word boundary if possible.

====include chapters====
To include '''sections (chapters) by a reference to their heading''': use the heading name with a "#" as prefix. This will include text from the first occurrence of the heading 'heading1' (resp. 'heading2') until the next heading of the same or lower level. (Refer to [[mw:Extension:Labeled_Section_Transclusion#Transcluding_visual_headings|Transcluding visual headings]].). Specifying a single "#" will include the text up to the first heading. Note that the text comparison is ''case insensitive''.

* Note that this functionality is also available as a separate parser function (called [[Help:DPL/Dplchapter]]).

* Normally your text pattern will be compared ''literally'' and it must match the whole headline of the chapter. If you use a ''double hash sign'' ('''##'''), however, the text will be taken as a regular expression. It will automatically be enclosed within slashes and the matching will be case insensitive and will refer to the headline as a whole (^regexp$). So if you only want to match part of the text you must add ".*" around your pattern. It is your responsibility to provide correct regexp syntax. Otherwise you may see runtime errors, get no output etc.
:<code>include = ##.*omethin.*</code>
:The above will match a Headline like "This is something old" or "That Was Something Old".
* Instead of the #-sign the @-sign can be used (the # lead to problems in certain cases); @@ will act as a regexp comparison just as ## does.
*Add one or more optional filter expressions, a character limit and/or an optional link text in square brackets to shape the included portion of text : <code>[filter 1~...~filter n~limit text]</code>.
** the filters will be applied before calculating the length of the text; they simply throw away the matching part of the contents.
** If the remaining text is longer than the limit, it will be cut and a link will appear which points directly to the chapter which was included. Using "1" as a limit will only show the link (if the corresponding chapter in the article is not empty), "0" will not show anything, not even the link. When truncating included text portions care is taken ''not to spoil wiki syntax'' (i.e. maintain a symmetry of brackets and braces, make sure that ''nowiki'' and ''pre'' tags are balanced). Therefore, the size of the included text can deviate from what you specified.

*If there is no chapter with the specified heading the output will be empty.
:<code>include = #heading1,#heading2[filter~limit linktext],....</code>

''linktext'' can be
:: plain text
::: then this text will be used as a link
:: text starting with "img="
::: then the link will appear as an image link (you must provide the image in a suitable size; no scaling will happen); note that image linking only works if there is another mediawiki extension installed ('''LinkedImages''').
:: a text containing %SECTION%";
::: this symbol will be replaced by "article#heading". It is up to you to create a link from this text using normal wiki syntax if you wish.

* To include sections (chapters) by a reference to their '''position in the text''': use a simple number with a "%" as prefix. "%0" will include the text BEFORE the first chapter, "%1" will include the first chapter, %6 the sixth and so on. Chapters are counted regardless of their level. No nesting logic is applied. "%-1" is a special value which refers to the '''last''' chapter of an article (%-2 will ''not'' work, however). "%2[30]" will include the first 30 characters of the second chapter. %SECTION% will contain the heading of the selected chapter. See [http://web.archive.org/web/20160530125613/http://semeb.com/dpldemo/index.php?title=Test_include_sections_by_number Test include sections by number].

:<code>include = %1[100]</code>
includes the first 100 characters of the first chapter

====include contents related to templates====
* You can include '''the result of a template call''' by specifying the template name within curly braces. So, <code>include={my template}</code> will display the result of the template call with the original parameters used on the selected article page.
Note that you need a space char or a line break after this statement before ending the #dpl parser function call because otherwise the MW parser may be fooled by three successive closing curly braces.

* MediaWiki treats spaces like underscores. Therefore ''{my template}'' will also match a template invocation like <nowiki>{{My_template|...}}</nowiki>.

* MediaWiki searches for template calls in the template namespace. Specifying ''{my template}'' will also match a template invocation like <nowiki>{{Template:My_template|...}}</nowiki>.
* Using a different namespace also works: ''{Xyz:my template}'' will match a template invocation in namespace Xyz. ''{:my template}'' will match a template invocation in the main namespace like <nowiki>{{:my template|...}}</nowiki>.

* You can include '''one or more parameters of a template call''' by specifying a list of names or position numbers separated by colons (and optional white space). Names are use for named parameters, numbers for positional parameters.

:<code> include={animal}:age:size:1</code>
:This will include the values of the two parameters named 'age' and 'size' and the value of the first unnamed parameter in all calls of the template "animal".

It is even possible to use expressions which contain a % symbol as pseudo parameters:
:<code> include={animal}:age:%PAGE%:size:1</code>
:This will output the page name after the 'age'; this is useful in combination with the {{DPL|table}} statement when using a '-' symbol as the second argument for 'table'. This combination makes it possible to produce a list where the link to the article need not be in the first column; enclosing the %PAGE% in double square brackets would create a link, see the second example in [http://web.archive.org/web/20160306041047/http://semeb.com/dpldemo/index.php?title=Test_table Test table]

* Instead of collecting parameter values you can '''include the output of a 'surrogate' template''' (also called a 'phantom template'). DPL calls this template instead of the original template with the identical parameter list (plus the two additional parameters %PAGE% and %TITLE%). You will get the output of the surrogate template. To make this happen you specify the name of a template within single curly braces and add a suffix. As said before, the template name ''including the suffix'' will be '''called instead of the original template''', with the same parameters, and the result will contain just the output of your alternate template (see [http://web.archive.org/web/20160310132723/http://semeb.com/dpldemo/index.php?title=Examples_of_including_a_template example]). Note that we pass five additional parameters to each template, called
** %PAGE%
** %TITLE%
** %DATE%
** %USER%
** %CATLIST%
They allow the template to produce a link to the source file from where it was included, show the date from the DPL query (e.g. lasteditdate) and show the user from the query (e.g. the user who made the last edit).<br>
If a page listed in your result '''does not use the specified template''' you will get the possibility to react properly as the DPL engine will call a template with the additional suffix ".default".

:Example: includepage={myTemplate}.dpl
:If a page does not contain a reference to "Template:myTemplate" then "Template:myTemplate.dpl.default" will be invoked with %PAGE% and %TITLE% as parameters.

* There is an alternate syntax to specify a surrogate template. It has the advantage that the surrogate template may reside in a different namespace than the original template. Also, the surrogate template's name can be completely different from the original template name: <code>{template¦surrogate template}</code>. For example, you may specify something like <code>{my template¦Help:Substitution for my template}</code>.

==== include parser function calls ====
* if you specify a pattern like <code>{#pfunc}.list</code> DPL will look for calls of the parser function 'pfunc'. DPL will pass the parameters of this parser function to a template which you have to provide under the name of 'Template:pfunc.list'. Instead of '.list' you can use your own suffix. The Template will receive the parser function name as %PFUNC% and all parameters under their normal name or number. Instead of specifying a single parser function you can also use a generic pattern. See [http://followthescore.org/dpldemo/index.php?title=DPL_Example_026 DPL Example 026]. Note that this function is not very robust. It cannot handle nested parser functions properly.

====include parser extension calls====
* if you specify a pattern like <code>{~func}.list</code> DPL will look for calls of the parser extension with the tag name <func>. DPL will pass the body of the tag structure to a template which you have to provide under the name of 'Template:func.list'. Instead of '.list' you can use your own suffix. The Template will receive the function name as %TAG% and the body will be named %TAGBODY%. See [http://web.archive.org/web/20160310133416/http://semeb.com/dpldemo/index.php?title=DPL_Example_028 DPL Example 028]. Note that this function is not very robust. It cannot handle nested tags properly.

====include specially labeled text portions====
* To include '''sections which are labeled''' with special tags you just mention the tag name. Refer to [[mw:Extension:Labeled_Section_Transclusion|Labeled Section Transclusion]] for details on how to label sections in your pages accordingly:

:<code>include=sec1,sec2,...</code>

If the section name starts with a '*' the asterisk will be cut off and the rest of the text will be taken as a regular expression. If the section name is '**' it will match all section names. In both cases the tag name will precede the output, separated by '::'.

See [http://web.archive.org/web/20160310132821/http://semeb.com/dpldemo/index.php?title=Test:Section_inclusion Test:section inclusion]

====include nothing====
* To '''include nothing''' from the page (no inclusion), leave blank (this is '''default'''):
:<code>include=</code>
* A single '-' sign has the same effect; such a dummy parameter can be useful if you want to put content into columns of the output table which is not derived from the include statement

====combinations of the above possibilities====
All of the above can be combined, you can even refer to the same template or heading more than once.

:<code>include = {template1}suffix1,{template1}:p1:p2:2,#headline,marker,....</code>

----

Example: <code>include = foo,#bar[200 ..more..],#bang[0 img=my.gif],{boo}.dpl</code>

This will include
* a text portion which is marked by special tags named "foo"
* the contents of a chapter named "bar"; only the first 200 characters of wiki text will be shown; if the chapter is larger than that, a link with the text "..more.." will point to the source
* an image link based on "my.gif" to the chapter "bang" in the article - if there is such a chapter and it is not empty
* the output of template "boo.dpl" being called with the same parameters that were used to call template "boo" in the original page.

Note: See also [[Help:DPL/Parameters: Criteria for page selection#includematch]].

===includepage===
{{DPL parameter
|name = includepage
|purpose= this can be used as a longer name for {{DPL|include}}.
}}

===includemaxlength===
{{DPL parameter
|name = includemaxlength
|purpose= Delimit the size of an included article to a maximum of [n] characters of wiki source text or less.
Care is taken to respect pairs of braces and brackets as far as possible. Otherwise we might confuse the result by half-cut syntax elements of transcluded sections. Therefore the output might be shorter or even larger than [n] characters.
}}

Syntax:
:<code>includemaxlength=[n]</code>

Note: this parameter is only used in combination with <code>includepage=*</code>; truncation of included chapter contents is specified by adding a limit in sqauare brackets within the 'includepage=' statement.

===includetrim===
{{DPL parameter
|name = includetrim
|purpose= removes all leading and trailing whitespace from transcluded contents.
}}

Syntax:
:<code>includetrim=true</code> (default is ''false'')

Note: this parameter is only useful in combination with <code>include=</code>.

Help:DPL/Parameters: Controlling output format

2024-08-23T02:58:58Z

Scientific Guy:

{{DPL manual|section=Parameters|subsection=Controlling output format|sort=P3}}
<div id="dpl">
{{TOC right}}
You can select one of several default formats or define your own format ({{DPL|mode|=userformat}}); 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 {{DPL|titlematch}}, {{DPL|nottitlematch}}, {{DPL|count}}, and {{DPL|includesubpages|=false}}.

== 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 {{DPL|userformat}} 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 {{DPL|userformat}} 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 {{tt|x}} and {{tt|y}} with varying arguments; while {{tt|x}} is being used once within each document, {{tt|y}} is used several times. In very short notation the structure might look as follows:
<pre style="padding-left:5px; width:30%">
A: x(a) y(3) y(5)
B: x(b) y(4) y(1) y(2)</pre>

The following DPL parameters are used to define a set of tags which are used to construct the output:
* {{DPL|listseparators}} = ''liststart'',''itemstart'',''itemend'',''listend''
* {{DPL|secseparators}} = ''sec-1-start'',''sec-1-end'',''sec-2-start'',''sec-2-end'', .. , ..
* {{DPL|multisecseparators}} = ''multi-sep''
The arguments of the above statements can contain '''references to {{DPL|VARIABLES|%VARIABLES%}}'''. So ''sec-1-start'' might contain a reference like {{tt|%PAGE%}} to output the page name. See {{DPL|format}} for more details on variable substitution.

Now think of the following page inclusion statement:
<pre style="padding-left:5px; width:30%">
includepage={x}.dpl,{y}.dpl</pre>

The output will then look like this:
<pre style="padding-left:5px; width:30%">
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</pre>

Assuming that the tags ({{tt|liststart}}, {{tt|itemstart}}, etc.) contain wiki syntax for table definitions and {{tt|multi-sep}} defines a horizontal line, the output might look like this:
<pre style="padding-left:5px; width:30%">
+------+---------------------+
| | | y.dpl(3) |
| A | x.dpl(a) | ---- |
| | | y.dpl(5) |
+------+----------+----------+
| | | y.dpl(4) |
| | | ---- |
| B | x.dpl(b) | y.dpl(1) |
| | | ---- |
| | | y.dpl(2) |
+------+----------+----------+</pre>

In some situations, however, you may want to create an output table where each of the calls of template {{tt|y}} is used to create a separate output row. Using a sortable table you could then easily rearrange the output.
<pre style="padding-left:5px; width:700px">
+------+---------------------+ +------+---------------------+
| 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) |
+------+---------------------+ +------+---------------------+</pre>

There is a special parameter called {{DPL|dominantsection}} which you can use to mark one section of your {{DPL|includepage}} statement as "dominant" (in our example: {{DPL|dominantsection|=2}} as {{tt|{y}.dpl}} is the second argument of our {{DPL|includepage}} 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 ({{DPL|table}}, {{DPL|tablerow}}) which make it fairly easy to create tabular output.

== Setting the basic output mode ==

===mode===

{{DPL parameter
|name = mode
|purpose= Provide basic control over the output of DPL.
}}

Syntax:

{{DPL syntax|mode=''modename''}}

<u>''modename'' can be one of:</u>

;''unordered'': outputs an unordered list — HTML tag {{tt|ul}} — '''(default)'''
;''ordered'': outputs an ordered list — HTML tag {{tt|ol}}
;''none'': outputs a list using newlines and HTML tags {{tt|br/}} to separate each item
;''inline'': outputs a list using symbols defined by the {{DPL|inlinetext}} parameter to separate items
;''category'': outputs resulting articles in a way category-pages are shown ('''you must use {{DPL|ordermethod| = title / titlewithoutnamespace / category,title / user,title}} with this option!''')

;''userformat'': will leave output control completely to the user; <br/> see parameters {{DPL|listseparators}} and {{DPL|secseparators}}; in this mode DPL offers built-in variables which must be referenced in the output format description provided by the user. '''{{DPL|mode|=userformat}}''' is quite important to have complete control over the output.

For advanced use of DPL it is important to understand {{DPL|mode|=userformat}}. Note that this mode is '''automatically implied''' when {{DPL|listseparators|=}} or {{DPL|format|=}} are used.

==== mode 'ordered', 'unordered', 'none' (Example1) ====
These create abbreviated lists of [[:Category:DPL]] pages:

{| style="border-spacing: 10px 0;"
| align=center| In an <code><nowiki><ol>...</ol></nowiki></code> list: || align=center| In a <code><nowiki><ul>...</ul></nowiki></code> list: || align=center| In a <code><nowiki><br></nowiki></code> list:
|- style="vertical-align:middle;"
|<pre><nowiki>
<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=ordered
</dpl>
</nowiki></pre>
|<pre><nowiki>
<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=unordered
</dpl>
</nowiki></pre>
|<pre><nowiki>
<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=none
</dpl>
</nowiki></pre>
|-
|<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=ordered
</dpl>
|<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=unordered
</dpl>
|<dpl>
category=DPL
titlematch=%o%
nottitlematch=%nt%|%ow%|%ec%
mode=none
</dpl>
|}

==== mode 'category' (Example2) ====

<pre><nowiki>
<dpl>
titlematch=%Help%
includesubpages=false
mode=category
ordermethod=titlewithoutnamespace
</dpl>
</nowiki></pre>

This list will output pages that have 'Help' in their name; pages will be ordered by their name regardless of category, the output will be shown in category style (i.e. with chapter capitals).
<dpl>
titlematch=%Help%
includesubpages=false
mode=category
ordermethod=titlewithoutnamespace
</dpl>

Related configuration option (see [https://www.mediawiki.org/wiki/Extension:DynamicPageList3 Extension:DynamicPageList3 on MediaWiki Wiki]: <code>$wgDPL2CategoryStyleListCutoff</code>.

==== mode 'inline' ====

=====inlinetext=====

{{DPL parameter
|name = inlinetext
|purpose= To define the inline text used in {{DPL|mode|=inline}}.
}}

Syntax:

{{DPL syntax|inlinetext=''wikitext''}}, with ''wikitext'' as some wiki text;
'''default is <code>&nbsp;-&nbsp;</code>''' except for {{DPL|mode|=userformat}} where {{DPL|inlinetext}} is empty by default.

If you want normal "breaking spaces" (and not the NON-breaking spaces) you should use <code>&#32-&#32</code>.

Extra whitespaces are stripped by DPL from the beginning and end of ''wikitext''. If you want to show one or multiple spaces, use one or multiple <code>&nbsp;</code>, or use 'nowiki' tags <code><nowiki> - </nowiki></code> which has the same effect as <code>&nbsp;-&nbsp;</code>.

Bullets can be displayed with either <code>&bull;</code> or {{tl|*}}.

Example:

<pre><nowiki>
<dpl>
category = Help
includesubpages= false
count = 10
mode = inline
inlinetext = &nbsp; &bull; &nbsp;
</dpl>
</nowiki></pre>

This list outputs pages that have [[:Category:Help]] shown like Item1 • Item2 • Item3 • ...

<dpl>
category = Help
includesubpages = false
count = 10
mode = inline
inlinetext =   •  
</dpl>

==== <span id="{{anchorencode:userformat}}"></span>mode 'userformat' ====

=====listseparators=====
{{DPL parameter
|name = listseparators
|purpose= (alias for format) see the {{DPL|format}} parameter. Implicitly sets {{DPL|mode|=userformat}}.
}}

=====format=====

{{DPL parameter
|name = format
|purpose= customize the output format completely. Implicitly sets {{DPL|mode|=userformat}}. Uses variable references like {{tt|%PAGE%}} to describe the output format. See also the {{DPL|secseparators}} parameter.
}}

Note1: {{DPL|listseparators}} is an alias for {{DPL|format}}.

Note2: the {{DPL|format}} command is very flexible but somewhat complicated. If you want to create tabular output, you should have a look at the {{DPL|table}} command.

Syntax:

{{DPL syntax|format=''Startall'',''Start'',''End'',''Endall''}}

''Startall'', ''Start'', ''End'' and ''Endall'' are wiki tags used to separate the list items.
* ''Startall'' and ''Endall'' define an outer frame for the whole list.
* ''Start'' and ''End'' build an inner frame for each article item.

Because wiki syntax depends on newline characters, {{code|\n}} or {{code|¶}} must be used to explicitly insert newline characters into the output.

As we want to be able to control output completely, we reference article names and other possible output by special {{DPL|VARIABLES|%VARIABLES%}}:
<span id="{{anchorencode:VARIABLES}}"></span>
* {{tt|%NR%}} = the current article sequence number (starting from 1)
* {{tt|%PAGE%}} = the name of the article (including namespace)
* {{tt|%PAGEID%}} = the internal unique numeric ID of the arFticle page
* {{tt|%IMAGE%}} = the physical path to an image (based on hash values, e.g. ''5/5d/myImage.jpg'')
* {{tt|%PAGESEL%}} = the name of a page which was used within the selection criteria (only applies to {{DPL|linksfrom}} and {{DPL|linksto}})
* {{tt|%IMAGESEL%}} = the name of an image which was used within the selection criteria (only applies to {{DPL|imageused}})
----
* {{tt|%TITLE%}} = the title of the page (without the namespace)
* {{tt|%NAMESPACE%}} = the namespace of the page
----
* {{tt|%SIZE%}} = the article size (requires {{DPL|addpagesize|=true}})
* {{tt|%SIZEFS%}} = a font size number which is based on the article size (logarithm of square root of counter)
* {{tt|%COUNT%}} = the usage counter (requires {{DPL|addpagecounter|=true}}) [[Help:DPL/Hit counters removed|<span style="color:#FF0000;">Removed in MediaWiki 1.25</span>]]
* {{tt|%COUNTFS%}} = a font size number which is based on the usage counter (currently this is the logarithm of the usage counter) [[Help:DPL/Hit counters removed|<span style="color:#FF0000;">Removed in MediaWiki 1.25</span>]]
* {{tt|%COUNTFS2%}} = similar to {{tt|%COUNTFS%}}, but based on the logarithm of the square root of the usage counter [[Help:DPL/Hit counters removed|<span style="color:#FF0000;">Removed in MediaWiki 1.25</span>]]
----
* {{tt|%DATE%}} = the date selected, eg. {{tt|lastedit}}; requires {{DPL|addeditdate|=true}} or similar; the formatting of the date can be influenced using {{DPL|userdateformat|=}}
* {{tt|%USER%}} = the user who changed the document last; requires {{DPL|adduser|=true}}
----
* {{tt|%CONTRIBUTOR%}} = the user who made a contribution; requires {{DPL|addcontribution|=true}}
* {{tt|%CONTRIBUTION%}} = the number of bytes changed; requires {{DPL|addcontribution|=true}}
* {{tt|%CONTRIB%}} = an asterisk bar to indicate the amount of change; requires {{DPL|addcontribution|=true}}
----
* {{tt|%CATLIST%}} = a pipe-separated list of links to all categories to which the article belongs (requires {{DPL|addcategories|=true}})
* {{tt|%CATBULLETS%}} = a bullet point list of links to all categories to which the article belongs (requires {{DPL|addcategories|=true}})
* {{tt|%CATNAMES%}} = a comma-separated list of all categories to which the article belongs (requires {{DPL|addcategories|=true}})
----
* {{tt|%REVISION%}} = the name of the revision of the article; only accessible if the DPL query is based on {{DPL|REVISION|revisions}}
* {{tt|%EDITSUMMARY%}} = the change log message of a revision; only accessible if the DPL query is based on {{DPL|REVISION|revisions}}
----
* {{tt|%EXTERNALLINK%}} = the external hyperlink found as a consequence of the {{DPL|linkstoexternal}} statement
----

These variables will be replaced by the corresponding values if they occur within ''Start'' or ''End'' or within the corresponding tags of the {{DPL|secseparators|=}} parameter.

----

In addition there are some symbolic variables which can ONLY be used in {{DPL|resultsheader}} and {{DPL|resultsfooter}}:
* {{tt|%PAGES%}} = number of articles in the result set
* {{tt|%TOTALPAGES%}} = total number of articles in the result set, regardless of count limits; will only be calculated if used
* {{tt|%VERSION%}} = the current DPL version
----
* {{tt|%DPLTIME%}} = contains the amount of time (in seconds + milliseconds) spent within DPL; this can be helpful if you observe slow response times for wiki pages that contain DPL statements. Example: ''2 (2009/06/13 09:27:43)'' would mean that DPL spent two seconds of the whole response time, starting at the time given in brackets.
----
* {{tt|%FIRSTNAMESPACE%}}, {{tt|%FIRSTTITLE%}}, {{tt|%LASTNAMESPACE%}}, {{tt|%LASTTITLE%}} = namespace and title of the first / last article in the result set; the information is intended to be used for page scrolling
* {{tt|%SCROLLDIR%}} = set by the URL parameter {{tt|DPL_scrollDir}}; it is passed to the scroll helper template which uses it to produce its links for scrolling

----

For example, the classical default output of DPL can also be produced with the following statements:


{| style="border-spacing: 10px 0;"
| align=center| default || align=center| formatted
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
titlematch = %Help%
nottitlematch = %o%
includesubpages = false
count = 10
</dpl>
</nowiki></pre>
|<pre><nowiki>
<dpl>
titlematch = %Help%
nottitlematch = %o%
includesubpages = false
format = ,\n* [[%PAGE%]],,
count = 10
</dpl>
</nowiki></pre>
|-
|<dpl>
titlematch = %Help%
nottitlematch = %o%
includesubpages = false
count = 10
</dpl>
|<dpl>
titlematch = %Help%
nottitlematch = %o%
includesubpages = false
format = ,\n* [[%PAGE%]],,
count = 10
</dpl>
|}
Note that a bullet point list in wiki syntax is defined by a {{code|*}} at the ''beginning of a line'' — therefore we have to use a special symbol {{code|\n}} or {{code|¶}} to refer to the beginning of a new line of wiki text. Replace the {{code|*}} with a {{code|#}} and you will get a numbered list. {{tt|Startall}} and {{tt|Endall}} are empty (note that we start with a comma, note the two commas at the end), the {{tt|Start}} tag is used to create a new line with an initial <code>* </code> followed by the page name, written as a link. That's all.

Creating a top-five hitlist with access rates and bold article names of varying size could be done like this:
<pre><nowiki>
<dpl>
category = Help
ordermethod = counter
order = descending
addpagecounter = true
count = 5
format = ,\n%COUNT% --- <font size="%COUNTFS%">'''[[%PAGE%]]'''</font>,<br/>,
</dpl>
</nowiki></pre>
However, {{DPL|addpagecounter}}, {{DPL|ordermethod|=counter}}, {{tt|%COUNT%}}, and {{tt|%COUNTFS%}} were removed in MediaWiki 1.25.<br/>
Below is an example of how to use {{tt|%NR%}} to set the font size.
<pre><nowiki>
<dpl>
category = Help
order = descending
addpagecounter = true
count = 4
format = ,\n<font size="%NR%">'''[[%PAGE%]]'''</font>,<br/>,
</dpl>
</nowiki></pre>
<dpl>
category = Help
order = descending
addpagecounter = true
count = 4
format = ,\n<font size="%NR%">'''[[%PAGE%]]'''</font>,<br/>,
</dpl>

You can also use HTML syntax for the tags, although this is discouraged.
<pre><nowiki>
<dpl>
linksto = DPL
format = <ul type="disc">,<li>[[%PAGE%]],</li>,</ul>
</dpl>
</nowiki></pre>
<dpl>
linksto = DPL
format = <ul type="disc">,<li>[[%PAGE%]],</li>,</ul>
</dpl>

Now let us create a table using wiki syntax:
<pre><nowiki>
<dpl>
linksto = DPL
format = {| class="wikitable"¶!pages found,¶|-¶|[[%PAGE%]],,¶|}
</dpl>
</nowiki></pre>
We use {{tt|Startall}} to define the table header and {{tt|Endall}} for the footer.
Each article is presented in a table row using wiki syntax for table layout.
<dpl>
linksto = DPL
format = {| class="wikitable"¶!pages found,¶|-¶|[[%PAGE%]],,¶|}
</dpl>

We could also produce image galleries:
<pre><nowiki>
<dpl>
namespace = File
category = Hydra images|Template images
count = 6
format = <gallery widths=20px heights=20px>,%PAGE%\n,,</gallery>
</dpl>
</nowiki></pre>
<dpl>
namespace = File
category = Hydra images|Template images
count = 6
format = <gallery widths=20px heights=20px>,%PAGE%\n,,</gallery>
</dpl>

=====secseparators=====
{{DPL parameter
|name = secseparators
|purpose= customize the output format of included sections. Can be used with standard output modes and with {{DPL|mode|=userformat}}.
}}

Syntax:

{{DPL syntax|secseparators=''Start1'',''End1'',''Start2'',''End2'',..,..}}

or

{{DPL syntax|secseparators=''Start''}}

''Please note that the semantics of this parameter '''have changed with version 0.9.6!'''. When upgrading to 0.9.6 it will probably be necessary to change the {{DPL|secseparators}} statements.

In the first syntax variant, specify ''pairs of tags'' which correspond to the {{DPL|includepage}} statement. {{tt|StartN}} and {{tt|EndN}} are HTML strings or wiki tags which will be put around each transcluded section (see {{DPL|includepage|=name1,name2,...}}).

In the second syntax variant, specify just one element which will then be used as {{tt|StartN}} for all sections; in this case the second tag ({{tt|EndN}}) will be empty for all transcluded sections.

Symbolic replacements of {{tt|%PAGE%}} etc. take place as described in {{DPL|listseparators}}. In addition, the variable {{tt|%SECTION%}} can be used to refer to the section found (works only for chapter headings).

If the same section occurs more than once in an article (or an article includes the same template more than once) all such occurrences will be transcluded as a block and the {{DPL|secseparators}} tags will only be put once around the whole block (but see {{DPL|dominantsection}}).

======Example======

<pre><nowiki>
<dpl>
titlematch = DPL3/d%
ignorecase = true
linksto = Extension:DPL3/Manual
listseparators = {|class="dpl secsep"¶!Pages found¶!Syntax¶!Example,¶|-¶|[[%PAGE%|%TITLE%]],,¶|}
includepage = #Syntax,##Example.*
secseparators = ¶|,,¶|,,
count = 2
</dpl>
</nowiki></pre>
<dpl>
titlematch = DPL3/d%
ignorecase = true
linksto = Extension:DPL3/Manual
listseparators = {|class="dpl secsep"¶!Pages found¶!Syntax¶!Example,¶|-¶|[[%PAGE%|%TITLE%]],,¶|}
includepage = #Syntax,##Example.*
secseparators = ¶|,,¶|,,
count = 2
</dpl>
Use {{DPL|listseparators}} to define a table with three columns and put a link to the article in the first column of each row. Use {{DPL|secseparators}} to add more columns for each section found. There are two pairs for each transcluded section; the first element of each pair is a linefeed and a pipe (which define a new column in the table) and the second element of each pair is empty. Have a careful look at the {{code|¶}} symbols ({{code|\n}} can be used as an alternative). They always appear before a wiki syntax element which must be placed at the beginning of a new line. Thus, make sure that the wiki parser will understand them. Note: if an article does not contain a section named "Example", it will result in an empty cell in the table.

As mentioned above, a single element can be used in the {{DPL|secseparators}} statement in order to apply this as a start tag to all transcluded sections; so it could have also been written:

======Example 2======

<pre><nowiki>
<dpl>
titlematch = DPL3/d%
ignorecase = true
linksto = Extension:DPL3/Manual
listseparators = {|class="dpl secsep"\n!Pages found\n!Syntax\n!Example,\n|-\n|[[%PAGE%|%TITLE%]],,\n|}
includepage = #Syntax[84],##Example.*[180 more..]
secseparators = \n|
count = 3
</dpl>
</nowiki></pre>
Assuming that the chapters on ''Syntax'' and ''Example'' contain long texts, they can be truncated (eg. to 84 or 180 characters). A link which refers directly to those chapters will be generated automatically if needed. Be aware that truncating with {{code|[ ]}}can break text formatted with wikitext or tags such as <code><nowiki><nowiki></nowiki></code>.
<dpl>
titlematch = DPL3/d%
ignorecase = true
linksto = Extension:DPL3/Manual
listseparators = {|class="dpl secsep"\n!Pages found\n!Syntax\n!Example,\n|-\n|[[%PAGE%|%TITLE%]],,\n|}
includepage = #Syntax[84],##Example.*[180 more..]
secseparators = \n|
count = 3
</dpl>

=====multisecseparators=====

{{DPL parameter
|name = multisecseparators
|purpose= put a tag between multiple transcluded parts which refer to the same template or chapter.
}}

Syntax:

{{DPL syntax|multisecseparators=''sep1'',''sep2'',...}}

The tags correspond to the transcluded section (see {{DPL|includepage|=name1,name2,...}}).

Symbolic replacements of {{tt|%PAGE%}} etc. take place as described in {{DPL|listseparators}}. In addition, the variable {{tt|%SECTION%}} can be used to refer to the section found (works only for chapter headings). It will give you the precise name of each heading even if you used a regular expression (double ##) in the include statement.

If an article uses the same template more than once you will get all references with {{tt|sepN}} as a separator.

Example:
{| class="dpl multisec"
|- class="dpl pre"
|colspan=2|<pre><nowiki>
<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:[[%PAGE%|%TITLE%]],{dpl parameter}:name:purpose[50]
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Fields cannot be formatted within the include¶|-¶!Page ¶!Name ¶!Purpose,¶|-,¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ¶|,,¶|class="dpl dark-background"|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
</nowiki></pre>
|-
|colspan=2|
{|
|<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:[[%PAGE%|%TITLE%]],{dpl parameter}:name:purpose[50]
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Fields cannot be formatted within the include¶|-¶!Page ¶!Name ¶!Purpose,¶|-,¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ¶|,,¶|class="dpl dark-background"|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
|}
|-
|colspan=2|Values cannot be formatted within {{DPL|include}}, as formatting can only occur in formatting statements (in these examples {{DPL|listseparators}}, {{DPL|secseparators}}, and {{DPL|multisecseparators}}). {{tt|%VARIABLES%}} can be omitted from the {{DPL|include}}, and instead be placed in these formatting statements, for further formatting.<br/>
We can achieve some field formatting by changing some of the above dpl statements:
|- class="dpl cols2 pre"
|
include = {dpl manual}:{{code|%TITLE%|class="dpl light-background"}},{dpl parameter}:name:purpose[50]
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Fields... secseparators¶|-¶!Page ¶!Name ¶!Purpose,¶|-,¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ¶|{{code|<nowiki>[[%PAGE%|{{#explode:,|:|1}}]]</nowiki>|class="dpl light-background"}},¶|class="dpl dark-background"|,
|
include = {dpl manual}:{{code||class="dpl light-background"}},{dpl parameter}:name:purpose[50]
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|%VARIABLES%... listseparators¶|-¶!Page ¶!Name ¶!Purpose,¶|-{{code|<nowiki>¶|[[%PAGE%|{{#explode:%TITLE%|:|1}}]]</nowiki>|class="dpl light-background"}},¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = {{code||class="dpl light-background"}},,¶|class="dpl dark-background"|,{{code|<nowiki>,¶|,</nowiki>|class="dpl light-background"}}
|- class="dpl cols2"
|<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:%TITLE%,{dpl parameter}:name:purpose[50]
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|These fields are formatted within secseparators¶|-¶!Page ¶!Name ¶!Purpose,¶|-,¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ¶|[[%PAGE%|{{#explode:,|:|1}}]],¶|class="dpl dark-background"|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
|<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:,{dpl parameter}:name:purpose[50]
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|%TITLE% is added and formatted within listseparators¶|-¶!Page ¶!Name ¶!Purpose,¶|-¶|[[%PAGE%|{{#explode:%TITLE%|:|1}}]],¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ,,¶|class="dpl dark-background"|,,¶|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
|-
|colspan=2|Formatting handled by a phantom template (eg. [[Template:DPL_parameter/dpl]]) will apply to both {{DPL|secseparators}} and {{DPL|multisecseparators}}.<br/>If separate formatting is required, it needs to be assigned to their respective parameters (as shown below).
|-
|colspan=2|To prevent truncated words, see [[Template:DPL_parameter_dpl.nowordbreak]] (which uses [[Template:nowordbreak]]).
|-
|colspan=2|<pre><nowiki>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:,{DPL parameter} dpl
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Includes a phantom template¶|-¶!Page ¶!Name ¶!Purpose,¶|-¶|[[%PAGE%|{{#explode:%TITLE%|:|1}}]],¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ,,¶|class="dpl dark-background"|,,¶|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</nowiki></pre>
|- class="dpl cols2"
|<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include = {dpl manual}:,{DPL parameter} dpl
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Includes a phantom template¶|-¶!Page ¶!Name ¶!Purpose,¶|-¶|[[%PAGE%|{{#explode:%TITLE%|:|1}}]],¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ,,¶|class="dpl dark-background"|,,¶|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
|<dpl>
titlematch = DPL%
nottitlematch = %volume%|%page selection%
uses = Template:DPL Parameter
include={dpl manual}:,{DPL parameter} dpl.nowordbreak
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶!colspan=3|Includes a phantom template with Template:nowordbreak¶|-¶!Page ¶!Name ¶!Purpose,¶|-¶|[[%PAGE%|{{#explode:%TITLE%|:|1}}]],¶|-¶|class="dpl blue-background" colspan=3|¶|-,¶|}
secseparators = ,,¶|class="dpl dark-background"|,,¶|,
multisecseparators= ,\n|-¶|¶|class="dpl light-background"|
</dpl>
|}

As you can see, the results resemble the list generated on the [[Help:DPL|title page]] of this manual, whose dpl is as follows:
<pre><nowiki>
<dpl>
nottitlematch=%volume%|%page selection%
namespace = Help
uses = Template:DPL parameter
mode = userformat
replaceintitle = @DPL Manual/@,
include = {DPL Manual}:[[%PAGE%|%TITLE%]],{DPL parameter}/dpl
listseparators={|class=wikitable,\n|-\n|,,\n|}
secseparators=,,\n|\n{|class="wikitable sortable" width=100%\n!width=140px|name\n!purpose\n|-\n|,\n|}
multisecseparators=,\n|-\n|
allowcachedresults = true
</dpl>
</nowiki></pre>
<dpl>
nottitlematch=%volume%|%page selection%
namespace = Help
uses = Template:DPL parameter
mode = userformat
replaceintitle = @DPL Manual/@,
include = {DPL Manual}:[[%PAGE%|%TITLE%]],{DPL parameter}/dpl
listseparators={|class=wikitable,\n|-\n|,,\n|}
secseparators=,,\n|\n{|class="wikitable sortable" width=100%\n!width=140px|name\n!purpose\n|-\n|,\n|}
multisecseparators=,\n|-\n|
allowcachedresults = true
</dpl>

See also {{DPL|Test article structure}}.

=====dominantsection=====

{{DPL parameter
|name = dominantsection
|purpose= define a section with multiple occurrences as dominant, i.e. each piece of contents of this section (which is associated with a template call or a chapter within the original document) will create a separate output line.
}}

Syntax:

{{DPL syntax|dominantsection=''number''}} between 1 and the number of arguments in your {{DPL|includepage|=}} statement

If there is only 0 or 1 piece of contents for the dominant section you will see no difference from normal DPL behaviour.

Example:

See the explanations at the [[#General approach to output formatting|top of this document]] to understand the meaning of dominantsection.

Note:
Using {{DPL|dominantsection}} together with {{DPL|table}} may lead to strange result formatting.

== Generating tabular output ==

===table===

{{DPL parameter
|name = table
|purpose= a simple syntax to create standard tabular output; see also {{DPL|tablerow}}
}}

Syntax:

{{DPL syntax|table=''tableatr'', ''linkheader'', (column headlines) ..}}

The {{DPL|table}} statement is a shortcut which implicitly sets certain values for other DPL parameters, namely {{DPL|mode}}, {{DPL|listseparators}} / {{DPL|format}}, {{DPL|secseparators}}, and {{DPL|multisecseparators}}.

The layout is less flexible than the individual use of all of the above parameters but will probably be sufficient in many cases, especially when used together with {{DPL|tablerow}}.

If you use {{DPL|table}} in a DPL statement, it does not make sense to use one of the other options mentioned because their values will be overwritten without notice. There is one exception of this rule: It can make sense to specify the THIRD argument for {{DPL|format}} in combination with {{DPL|table}}. Therefore this parameter is NOT overwritten by the {{DPL|table}} command. The third argument can be used to output meta data like {{tt|%COUNT%}}, {{tt|%USER%}} etc. as columns in an output table. If you want to do so, the third parameter must contain wiki syntax for output columns like this:
include = {some template}:parm1,#some heading
table =,,tplparm,chapter,#hits
format =,,\n%COUNT%
Do not forget to escape the '|' symbol if your DPL statement uses parser function syntax. You will get a table which contains template parameters, chapter contents and the usage counter as a third column. Meta data can only be placed AFTER normal contents as we use the THIRD parameter of the {{DPL|format}} statement.

The use of {{DPL|table}} requires an {{DPL|include}} statement which should, for reasons of readability, directly precede the {{DPL|table}} statement). Each argument of the {{DPL|include}} statement will produce one or more columns in the output table described in the {{DPL|table}} statement.

'''{{DPL|table}} expects a comma-separated list of parameters''':

* The first parameter will be used to describe general parameters for the table
** it is recommended to make a CSS reference here, using something like {{tt|<nowiki>class=wikitable</nowiki>}} or {{tt|<nowiki>class=mytable</nowiki>}} if ''mytable'' is defined in the [[Mediawiki:Common.css]] document.
** {{tt|<nowiki>class=wikitable</nowiki>}} is the '''default value'''. Use double-quotes to specify multiple classes, e.g., {{tt|<nowiki>class="wikitable sortable"</nowiki>}}.

* The '''second parameter''' is the headline for the first column.
** The first column will automatically contain a reference to the article, so something like ''Article'' should be o.k.
** {{tt|Article}} is the '''default value'''.
** if you use a single {{tt|-}} (dash), the column with the hyperlink to the article will be ''suppressed''. You can supply a hyperlink to the article in any other column if you use {{tt|<nowiki>[[{{{%PAGE%}}}|{{{%TITLE%}}}]]</nowiki>}} within a phantom template.

* All subsequent parameters are column headings which correspond to the arguments of the {{DPL|include}} parameter. Note that if you call a ''phantom template'' (like {{tt|{Some Template}.dpl}}) in the include statement, you will have to provide as many headlines as the ''phantom template'' produces columns.

* {{DPL|mode}} will be set to ''userformat''

* {{DPL|listseparators}} will be configured to produce wiki syntax which defines a table

* {{DPL|secseparators}} will be configured to produce wiki syntax which creates a table row. The first column will always contain a hyperlink to the article of the query result (except you set the link header to '-' as described above.

* {{DPL|multisecseparators}} will be configured to produce wiki syntax which creates another table row for multiple occurences of the ''first'' {{DPL|include}} argument. For all other arguments a linebreak will be used if we are dealing with template parameters and a horizontal separation line will be used when dealing with chapter contents. The background for this is the following: If you have an article which calls the same template several times, you may want to have a table where each template invocation becomes a row in your table.

When using ''phantom templates'' (i.e. templates which are called during DPL execution instead of the original template) they must be written to produce output according to wiki table syntax. When entering such a template we are already at the beginning of a column (i.e. a preceding line with a {{tt|{{!}}}} has already been put into the output stream). So start directly with the contents of the first column. To add more columns use a {{tt|{{!}}}} in a separate line. Example:

<pre><nowiki>
some output for the first column: {{{1|}}}
|
some output for the next column: {{{2|}}}
|
some output for the next column: {{{3|}}}
</nowiki></pre>

It may sound complicated, but is a ''huge'' improvement compared to the native use of {{DPL|mode}}, {{DPL|listseparators}}, {{DPL|secseparators}} and {{DPL|multisecseparators}}.

A typical DPL statement using the {{DPL|table}} parameter would contain:
include = #Chapter X,{T1}:parm1,#Chapter Y,{T2}.dpl
table = class=sortable, Article, X , t-p , Y , T2-a, T2-b

Note that we have written the above statement in a way to show the correspondence between {{DPL|include}} and {{DPL|table}}. You can see the first two parameters which define the table characteristics and a headline for the hyperlink to the article. Then follow headlines for each argument of {{DPL|include}}. Note that there are TWO headlines which correspond to the last argument of the {{DPL|include}} statement (assuming that Template:T2.dpl outputs TWO columns). ''Template:T2'' itself might have more or less than 2 arguments -- it only matters how many columns are output by ''Template:T2.dpl'').

Now look at the {{DPL|Test table|examples}}

===tablerow===

{{DPL parameter
|name = tablerow
|purpose= a simple syntax to create customized tabular output; see also {{DPL|table}}
}}

Syntax:

{{DPL syntax|tablerow=''coldef'', ..}}

Where ''coldef'' contains wiki code which uses the symbol '%%' to refer to the corresponding element of an {{DPL|include}} statement.

The {{DPL|table}} statement (which '''must''' be used as a prerequisite for {{DPL|tablerow}}) cares for the basics of table generation. So, when you define a column definition, you only need to specify the code for the field contents itself. You can start with field attributes like "bgcolor" or skip them. You can add a leading {{code|\n}} or {{code|¶}} to make sure that the field contents are displayed correctly if it contains wiki syntax that depends on linebreaks (e.g. enumeration list).
You must specify all columns. i.e. you must have as many entries in the {{DPL|tablerow}} statement as there are columns in your table. Skipping a column would suppress output for that column completely.

The {{DPL|tablerow}} command is best explained by an example:
<pre><nowiki>
<dpl>
category=Help
titlematch=DPL%
count=4
includepage ={DPL Manual}:section,%-1[25]
table =,Title,Sub Title,Last Section (25 chars)
tablerow =style="text-align:center;background-color:lightyellow;"|%%,|%%,
</dpl>
</nowiki></pre>
<dpl>
category=Help
titlematch=DPL%
count=4
includepage ={DPL Manual}:section,%-1[25]
table =,Title,Sub Title,Last Section (25 chars)
tablerow =style="text-align:center;background-color:lightyellow;"|%%,|%%,
</dpl>
The following example includes the use of {{DPL|addpagecounter}} and {{tt|%COUNT%}}, both of which were removed in MediaWiki 1.25.
<pre><nowiki>
<dpl>
category=African Union member states
nottitlematch=Sudan
addpagecounter=true
includepage ={Infobox Country or territory}:area:population_estimate,%0[100]
format =,,\n|style="text-align:right;"|²{#ifexpr:%COUNT%>300¦<big>'''%COUNT%'''</big>¦%COUNT%}²,
table =,Country,Area,Population,Text,#hits
tablerow =style="text-align:right;"|%%,style="text-align:right;"|%%,style="background-color:lightyellow;"|<small>%%</small>,\n|style="text-align:right;"|%%
</dpl>
</nowiki></pre>
* We select some African countries, we exclude Sudan
* We acquire a piece of meta data about the articles we will find (in our case the usage counter)
* We include two named parameters from a template call, <nowiki>{{Infobox Country or territory}}</nowiki>
* We include a short text passage from the text before the first chapter
* We use the third parameter of {{DPL|format}} to output the usage counter (we could even highlight values above 100 here, for example)
* We highlight usage values above 300
* We define a standard wiki table with the article name in the first column (named "Country")
* We define column headers for transcluded contents and for the usage counter
* We care for right alignment of the numerical values and define a bgcolor for the text

===tablesortcol===

{{DPL parameter
|name = tablesortcol
|purpose= define a column to be used as sort key (see also {{DPL|table}} )
}}

Syntax:

{{DPL syntax|tablesortcol=''number''}}

''number'' is the position of the column that shall be used as sortkey when the result is initially displayed.
* column numbering starts with ''1'';
* ''tablesortcol = 0'' means ''do not sort''; this is the default.
* Negative numbers are used to sort in descending order; e.g. ''-3'' would sort according to the third column in descending order.
* Note that the rest of the row after the selected column will also be part of the sortkey; so the contents of successive columns may serve as a secondary sort criterion if there are identical values in the selected column.
* Also note that the whole column contents is taken; this may include hidden contents or markup sequences if you used column formatting commands. For the same reason you cannot expect numeric contents to be sorted 'numerically' - sorting will always be alphabetical.
* you can of course use something like 'class=sortable' together with {{DPL|tablesortcol}}. The difference is that ..
** interactive sorting only works after the article has been initially displayed
** interactive sorting tries to guess the content type of a column and sorts according to that (date, number, string)
* If you do not use {{DPL|tablesortcol}} the output order of your table rows will depend on the sort order by which the articles were analysed. That order depends on other DPL commands like {{DPL|ordermethod}}. The default is "alphabetically by title". So, without {{DPL|tablesortcol}} you get the tablerows in alphabetical sequence of the article names where they come from. With {{DPL|tablesortcol}} you can order them by the column contents itself.

== Heading mode ==

===headingmode===

{{DPL parameter
|name = headingmode
|purpose= To control the output of the headings in a DPL with complex/multi-parameter {{DPL|ordermethod}}. (No effect with single-param ordermethods.) For {{DPL|ordermethod|=''method1,method2,...''}}, ''method1'' is used for headings. E.g. {{DPL|headingmode}} affects category headings in {{DPL|ordermethod|=category,title}} (2-param ordermethod). See also {{DPL|headingcount}}
}}

Syntax:

{{DPL syntax|headingmode=''modename''}}

''modename'' can be one of:
* ''none'' — headings are not displayed, no heading — '''(default)'''
* ''unordered'' — outputs an unordered list — HTML tag {{tt|ul}}
* ''ordered'' — outputs an ordered list — HTML tag {{tt|ol}}
* ''definition'' — outputs a definition list — HTML tag {{tt|dl}}
* ''H2'' — outputs sections — HTML tags {{tt|H2}} <span style="color:#FF0000;">Currently broken</span>
* ''H3'' — outputs sections — HTML tags {{tt|H3}} <span style="color:#FF0000;">Currently broken</span>
* ''H4'' — outputs sections — HTML tags {{tt|H4}} <span style="color:#FF0000;">Currently broken</span>

Example:

<pre><nowiki>
<dpl>
category=Terraria Wiki|Community
notcategory=Games
nottitlematch=%d%|Disambiguations
count=7
ordermethod=category,title
headingmode=definition
mode=ordered
</dpl>
</nowiki></pre>
This list will output pages that belong to one of the categories Terraria Wiki, Community in a list similar to this (HTML source). The categories are listed in sorted order, and the titles are replaced with the appropriate links ({{DPL|nottitlematch}} and {{DPL|count}} are simply used to reduce the output size):
{|
! '''(HTML) Output''' !! '''Actual Output'''
|- style="vertical-align:top;"
|<pre><nowiki>
<dl>
<dt>Category</dt>
<dd>
<ol>
<li>Page1</li>
<li>Page2</li>
</ol>
</dd>
</dl>
</nowiki></pre>
|
<dpl>
category=Terraria Wiki|Community
notcategory=Games
nottitlematch=%d%|Disambiguations
count=7
ordermethod=category,title
headingmode=definition
mode=ordered
</dpl>
|}

Headingmode can be used with multi-column output but the length of the columns may in this case vary more than you would expect.

===headingcount===

{{DPL parameter
|name = headingcount
|purpose= In combination with {{DPL|headingmode}} this parameter decides whether we show a text line with the number of articles per group or not.
}}

Syntax:

{{DPL syntax|headingcount=''true''}}

default is <code>headingcount=false</code>

=== listattr ===

{{DPL parameter
|name = listattr
|purpose= Adds attributes to HTML list elements, depending on {{DPL|mode}} (HTML element is {{tt|ol}} for ordered, {{tt|ul}} for unordered, {{tt|div}} for others). Can be used with '''pseudo''' {{DPL|mode|=inline}} where inline text contains one or more {{tt|<nowiki><br/></nowiki>}}.
Only applicable to {{DPL|mode|=ordered}} or {{DPL|mode|=unordered}}.

Not applicable to {{DPL|mode|=category}} or {{DPL|mode|=inline}} (with no {{tt|<nowiki><br/></nowiki>}} in inline text).
}}

Syntax:

{{DPL syntax|listattr= attribute1="val1" attribute2="val2" ...}}

Examples:
{|
! '''Input''' !! '''(HTML) Output''' !! '''Actual Output'''
|- style="vertical-align:top;"
|width=30%|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=none
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style= "font-style: italic;"
</dpl>
</nowiki></pre>
|<pre><nowiki>
<ol>
<li class="submenul" class="dpl light-background"> Cat1 (link)
<div class="submenul">
<span class="submenuli" style="font-style: italic;"> Page1_1 </span> <br/>
<span class="submenuli" style="font-style: italic;"> Page1_2 </span>
</div>
</li>
<li class="submenul" class="dpl light-background"> Cat2 (link)
<div class="submenul">
<span class="submenuli" style="font-style: italic;"> Page2_1 </span> <br/>
<span class="submenuli" style="font-style: italic;"> Page2_2 </span>
</div>
</li>
</ol>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=none
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style="font-style: italic;"
</dpl>
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style= "font-style: italic;"
</dpl>
</nowiki></pre>
|<pre><nowiki>
<ol>
<li> Cat1 (link)
<ul class="submenul" class="dpl light-background">
<li class="submenuli" style="font-style: italic;"> Page1_1 </li>
<li class="submenuli" style="font-style: italic;"> Page1_2 </li>
</ul>
</li>
<li> Cat2 (link)
<ul class="submenul" class="dpl light-background">
<li class="submenuli" style="font-style: italic;"> Page2_1 </li>
<li class="submenuli" style="font-style: italic;"> Page2_2 </li>
</ul>
</li>
</ol>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style="font-style: italic;"
</dpl>
|}

=== itemattr ===

{{DPL parameter
|name = itemattr
|purpose= Adds attributes to HTML list items, depending on {{DPL|mode}} (element is {{tt|li}} for ordered/unordered, {{tt|span}} for others).

Not applicable to {{DPL|mode|=category}}.
}}

Syntax:

{{DPL syntax|itemattr= attribute1="val1" attribute2="val2" ...}}

=== hlistattr ===

{{DPL parameter
|name = hlistattr
|purpose= Adds attributes to the HTML list element at the heading/top level, depending on {{DPL|headingmode}} (HTML element would be {{tt|ol}} for ordered, {{tt|ul}} for unordered, {{tt|dl}} for definition, {{tt|div}} for others)

Not yet applicable to {{DPL|headingmode|=none}}.
}}

Syntax:

{{DPL syntax|hlistattr= attribute1="val1" attribute2="val2" ...}}

Example:
{|
! '''Input''' !! '''(HTML) Output''' !! '''Actual Output'''
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,pagetouched
headingmode=definition
mode=ordered
hlistattr= class="topmenul" id="dmenu" style= "font-size:17px;"
</dpl>
</nowiki></pre>
|<pre><nowiki>
<div class="topmenul" id="dmenu" style="font-size:17px;">
<li> Category 2 (link) </li>
<ol>
<li>Page1_1</li>
<li>Page1_2</li>
</ol>
<li> Category 2 (link) </li>
<ol>
<li>Page2_1</li>
</ol>
</div>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,pagetouched
headingmode=definition
mode=ordered
hlistattr= class="topmenul" id="dmenu" style="font-size:17px;"
</dpl>
|}
These examples compare {{DPL|listattr}}, {{DPL|itemattr}}, and {{DPL|hlistattr}}
{|
! '''Input''' !! '''Actual Output'''
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style= "font-style: italic;"
</dpl>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul" class="dpl light-background"
itemattr= class="submenuli" style="font-style: italic;"
</dpl>
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul"
itemattr= class="submenuli" class="dpl light-background" style= "font-style: italic;"
</dpl>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
listattr= class="submenul"
itemattr= class="submenuli" class="dpl light-background" style="font-style: italic;"
</dpl>
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
hlistattr= class="topmenul" id="dmenu" class="dpl light-background"
listattr= class="submenul"
itemattr= class="submenuli" style="font-style: italic;"
</dpl>
</nowiki></pre>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=definition
mode=unordered
hlistattr= class="topmenul" id="dmenu" class="dpl light-background"
listattr= class="submenul"
itemattr= class="submenuli" style="font-style: italic;"
</dpl>
|}

See also {{DPL|hitemattr}}.

=== hitemattr ===

{{DPL parameter
|name = hitemattr
|purpose= Adds attributes to HTML list items (headings) at the heading level, depending on {{DPL|headingmode}} (HTML element would be {{tt|li}} for ordered/unordered, {{tt|div}} for others).

To be used with {{DPL|headingmode|=}}'unordered' or 'ordered'. (Not yet applicable for others.)
}}

Syntax:

{{DPL syntax|hitemattr= attribute1="val1" attribute2="val2" ...}}

Example:
{|
! '''Input''' !! '''(HTML) Output''' !! '''Intended Output''' !! '''Actual Output'''
|- style="vertical-align:top;"
|<pre><nowiki>
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=unordered
mode=ordered
hlistattr= class="topmenul" id="dmenu"
hitemattr= class="topmenuli" class="dpl light-background"
</dpl>
</nowiki></pre>
|<pre><nowiki>
<ul class="topmenul" id="dmenu">
<li class="topmenuli" class="dpl light-background"> Category 1 (link)
<ol>
<li>Page1_1</li>
<li>Page1_2</li>
</ol>
</li>
<li class="topmenuli" class="dpl light-background"> Category 2 (link)
<ol>
<li>Page2_1</li>
</ol>
</li>
</ul>
</nowiki></pre>
|
<ul class="topmenul" id="dmenu">
<li class="topmenuli" class="dpl light-background"> Category 1 (link)
<ol>
<li>Page1_1</li>
<li>Page1_2</li>
</ol>
</li>
<li class="topmenuli" class="dpl light-background"> Category 2 (link)
<ol>
<li>Page2_1</li>
</ol>
</li>
</ul>
|
<dpl>
category=Community
nottitlematch=%Forums%|Admin%
ordermethod=category,title
headingmode=unordered
mode=ordered
hlistattr= class="topmenul" id="dmenu"
hitemattr= class="topmenuli" class="dpl light-background"
</dpl>
|}

===userdateformat===

{{DPL parameter
|name = userdateformat
|purpose= Define a special layout for date formatting.
}}

Syntax:

{{DPL syntax|userdateformat=''formatstring''}}

The ''formatstring'' may contain letters like "y,Y,m,M,d,D,h,H,i,I,s" for year, month day. Other characters are printed as they are. See the documentation for php function date() for more details [http://www.php.net/manual/en/function.date.php]. The ''userdateformat'' applies to all date/time fields, see the parameters: {{DPL|addeditdate}},{{DPL|addpagetoucheddate}},{{DPL|addfirstcategorydate}}.

Example:

userdateformat=Y-m-d (D)

Default:

By default DPL uses "Y-m-d H:i:s" to display date and time. Note that MediaWiki stores all dates/times in UTC format. When displaying a time stamp DPL will translate it according to
# the timezone preference (difference to UTC/GMT) given by the user in his user settings.
# if no preference is given and for all anonymous users the local time on the server will be used.

So you will either see a time based on your local time (browser based) or based on the timezone in which the wiki server is running.

The same kind of translation applies to dates you specify when selecting articles by revsion date/time.

== Control the way article names are displayed ==

===shownamespace===

{{DPL parameter
|name = shownamespace
|purpose= To restrict the appearance of the namespace name of a page before the page. As the switch is ''true'' by default it should be set to ''false'' if you want to avoid namespaces to be shown in the output.
}}

Syntax:

{{DPL syntax|shownamespace=false}}

Example:

<pre><nowiki>
<dpl>
category = Help
namespace = Help_talk
shownamespace = false
</dpl>
</nowiki></pre>

This list will output all Talk pages in [[:Category:Help]], listed without the 'Help talk:' prepended to page names.<br/>
The namespace 'Talk' refers to talk pages within the main namespace; all other talk namespaces, such as 'Help' or 'Guide' talk pages, would need the format '''namespace''_talk'.<br/>
Only talk pages that have been added to the category (by placing <nowiki>[[Category:Help]]</nowiki> on the talk page) will be listed.

<dpl>
category = Help
namespace = Help_talk
shownamespace = false
</dpl>

Note that in {{DPL|mode|=userformat}} there is a different way to decide whether you want to output the title with or without namespace. In {{DPL|mode|=userformat}} two built-in variables are provided which contain the page name including the namespace ({{tt|%PAGE%}}) and the base title name ({{tt|%TITLE%}}).

===escapelinks===

{{DPL parameter
|name = escapelinks
|purpose= Regarding ''images'' and ''categories'' this parameter allows you to decide whether
* you want to see a link to the image or to the category page ({{DPL|escapelinks|=true}}, this is the default)
* you want to see the image or make the page which contains the DPL statement part of the categories which are returned by DPL ({{DPL|escapelinks|=false}})
}}

Syntax:

{{DPL syntax|escapelinks=false}}

Note: You can use this parameter to show images; another way to do this is to use the gallery extension in combination with DPL; there is an {{DPL|Test escapelinks|example}} for this on the dpldemo website.

===titlemaxlength===

{{DPL parameter
|name = titlemaxlength
|purpose= To limit the number of characters of the title to display. If the page title (this does not include the namespace or any other prefix before the title) is bigger than the {{DPL|titlemaxlength}} value, the title is truncated and ended by '...'.
}}

Syntax:

{{DPL syntax|titlemaxlength=''number of characters''}}

===replaceintitle===

{{DPL parameter
|name = replaceintitle
|purpose= execute a string replacement operation on the {{tt|%TITLE%}} var
}}

Syntax:

{{DPL syntax|replaceintitle=''search for,replacement''}}

The ''search for'' argument must be an expression which can be used in a php preg_replace() function call.

Example:

to remove the string "demo" in article names, you must write
: <code>replaceintitle=/demo/,</code>

Note that standard regexp rules apply. The regexp must start with a non-alphanumeric character -- but not with a backslash!
It is good habit to use a '/' if this character is not needed within the regexp itself. Read the php manual to understand the details of regular expressions.

== Arranging article lists in columns and rows ==

===columns===

{{DPL parameter
|name = columns
|purpose= Define a column layout for the output.
}}

Syntax:

{{DPL syntax|columns=''ncols''}}

'''Example:'''

<pre><nowiki>
<dpl></nowiki>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = width=100%
count = 6
</dpl>
</pre>

Simply displays non-DPL articles and subcategories in [[:Category:Help]] in 3 columns ({{DPL|rowcolformat}} is used to make the table width 100%).
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = width=100%
count = 6
</dpl>
Note: {{DPL|columns}} is currently bugged (possible combatibility issue between [[mw:MediaWiki 1.31|Mediawiki 1.31.2]] and DPL3 v3.3.3) ([https://gitlab.com/hydrawiki/extensions/DynamicPageList/issues/81 see here]).<br/>
For a 3-column dpl, css can be used to achieve the desired results:
<pre><nowiki>
<div style="-webkit-column-count:3;column-count:3;">
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = width=100%
count = 6
</dpl></div></nowiki></pre>
<div style="-webkit-column-count:3;column-count:3;">
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = width=100%
count = 6
</dpl></div>

'''More complex example:'''

In {{DPL|mode|=userformat}} the outer tags from {{DPL|listseparators}} will be repeated for each column.

<pre><nowiki>
<div style="-webkit-column-count:3;column-count:3;">
<dpl></nowiki>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
columns = 2
count = 6
</dpl></div>
</pre>

This output contains a list of the largest non-DPL articles in [[:Category:Help]]. Each column consists of a table which has itself three columns: rank, article name and size.

<div style="-webkit-column-count:3;column-count:3;">
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
columns = 2
count = 6
</dpl></div>

===rows===
{{DPL parameter
|name = rows
|purpose= Define a row layout for the output. A "row" is a group of output lines for which the heading is repeated. If you do not know how big your result will be, it may be better to use the {{DPL|rowsize}} parameter.
}}

Syntax:

{{DPL syntax|rows=''nrows''}}

In {{DPL|mode|=userformat}}, the outer tags from {{DPL|listseparators}} will be repeated for each column. Thus you can create long lists where the table heading is repeated from time to time.

Example:

<pre><nowiki>
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
rows = 2
count = 6
</dpl>
</nowiki></pre>

The output will contain a list of the largest non-DPL articles in [[:Category:Help]], arranged in two rows (dividing the list of lines equally into 2). Each row consists of a table which has itself three columns: rank, article name, and size.

<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
rows = 2
count = 6
</dpl>

===rowsize===

{{DPL parameter
|name = rowsize
|purpose= Define a row layout for the output. A "row" is a group of n output lines for which the heading will be repeated.
}}

Syntax:

{{DPL syntax|rowsize=''nrowsize''}}

In {{DPL|mode|=userformat}} the outer tags from {{DPL|listseparators}} will be repeated after each group of {{DPL|rowsize}} output lines.
Thus you can create long lists where the table heading is repeated in regular intervals.

Example:

<pre><nowiki>
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!width=200px|Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
rowsize = 3
count = 6
</dpl>
</nowiki></pre>

The output will contain a list of all non-DPL articles in [[:Category:Help]]. After each group of 3 entries (article names) the table heading will be repeated. It may be useful to set the width of the column with the article names explicitly, so that the tables in each row have equal width.
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
addpagesize = true
ordermethod = size
listseparators = {|class=sortablewikitable id=2\n!Rank\n!width=200px|Article\n!Bytes\n|-,\n|%NR%.\n|[[%PAGE%]]\n|style="text-align:right;"|%SIZE%,\n|-,\n|}
rowsize = 3
count = 6
</dpl>

===rowcolformat===

{{DPL parameter
|name = rowcolformat
|purpose= Defines layout properties (using [[w:wikibooks:HTML_Programming/Tables|HTML table tag parameters]]) for the row/column grid.
}}

Syntax:

{{DPL syntax|rowcolformat=''html tags''}}

Example:

<pre><nowiki>
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = cellspacing=20
count = 6
</dpl>
</nowiki></pre>

There will be more space around the columns than normal. See {{DPL|columns}} above for another example.
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = cellspacing=20
count = 6
</dpl>

The ideal way to use {{DPL|rowcolformat}} is to assign a CSS class to your DPL table which has been defined in your ''mediawiki:Common.css'' article.

Example:

<pre><nowiki>
<dpl>
category = Help
nottitlematch = %DPL%
includesubpages = false
columns = 3
rowcolformat = class=dpl3columns
count = 6
</dpl>
</nowiki></pre>

In your ''Common.css'' article you might have written something like

table.dpl3columns td {
background: #f2f2f2;
padding: 0.5em;
border: 3px;
width: 33%;
}

Help:DPL/General usage and invocation syntax

2024-08-23T02:45:15Z

Scientific Guy:

{{DPL manual|section=General usage and invocation syntax}}

'''DynamicPageList3 (DPL3)''' can be used as a '''parser extension''' (<small><code><nowiki><DPL> .... </DPL></nowiki></code></small>) or as a '''parser function''' (<small><code><nowiki>{{#dpl: .... }}</nowiki></code></small>). There is no general rule which one is better. If in doubt, you may want to use the parser function syntax as it is more powerful.

;Sample output
Both of the following examples, which illustrate the difference between using DPL as a parser extension and using it as a parser function, will produce a list of all articles which belong to ''cat1'' or ''cat2'' and which contain a reference to ''myPage''. The output of these DPL calls would be something like:

:* [[Page 1]]
:* [[Page 2]]
:* [[Another Page]]
{{TOC right}}
==Parser extension method==
The following example would probably be used directly on an article page, but could also be included as part of a template. Parser extensions define a specific tag (in this case <code><nowiki><DPL></nowiki></code>) and a corresponding end tag (<code><nowiki></DPL></nowiki></code>). '''The text between these tags is handed over to the extension module ''just as it is''.'''

;Example syntax
<blockquote><pre><nowiki>
<DPL>
category = cat1|cat2
# only pages which contain a link to myPage
linksto = myPage
</DPL>
</nowiki></pre></blockquote>

;Parsing procedure
Wiki markup expansion ''does not take place'' before the commands are handed over to the extension module.
* This may be useful if you want to pass wiki syntax elements to DPL3 as arguments (see the {{DPL|format}} option, for example).
* [[mw:Magic words|Magic words]] like <code><nowiki>{{PAGENAME}}</nowiki></code> or <code><nowiki>{{CURRENTDAY}}</nowiki></code> '''cannot''' be used.
* Template calls like <code><nowiki>{{some template}}</nowiki></code>, cannot be used as parameters.
* Parser function calls like <code><nowiki>{{#if:...|...|...}}</nowiki></code> cannot be used within arguments.
* To pass wiki syntax elements to DPL as parameters, it is sometimes necessary to enforce a line break. The reason is that wiki syntax depends on line breaks. Instead, use <code>\n</code> or <code>¶</code> for that purpose.

;Syntax features
* Every parameter assignment (<code>=command</code>) has to be on a separate line.
* Lines starting with a # will be ignored (comment).
* Generally the syntax looks fairly simple and intuitive as it doesn't contain special characters (except for the two embracing tags).
* Tag case doesn't matter, so it can also be written <code><nowiki><dpl></nowiki></code>.
* In many cases, there is no need to have macro expansion within the parameter list. Note that in the example above, the pipe character (which is used to define a logical OR between the two categories) can be written as it is. The name of the page (''myPage''), however, must be a hard-coded constant.

==Parser function method==
This example would be used inside a template, and uses the variable <code><nowiki>{{{1}}}</nowiki></code> passed to the template. Parser functions look like templates which start with a hash character (#). They are more closely integrated with the wiki system. They are more powerful but their syntax looks a bit more complicated. '''The text between these tags is pre-parsed to expand wiki mark-up ''before'' being handed over to the extension module.'''

;Example syntax
<blockquote><pre><nowiki>
{{#dpl: category = cat1{{!}}cat2 | linksto = {{{1}}} }}
</nowiki></pre></blockquote>
or
<blockquote><pre><nowiki>
{{#dpl:
|category = cat1¦cat2
|linksto = {{{1}}}
}}
</nowiki></pre></blockquote>

;Parsing procedure
Wiki markup expansions (not the final conversion to HTML) take place before the commands are handed over to the extension module.
* Magic words like <code><nowiki>{{PAGENAME}}</nowiki></code> or <code><nowiki>{{CURRENTDAY}}</nowiki></code> '''can''' be used.
* Template calls like <code><nowiki>{{some template}}</nowiki></code>, can be used as parameters.
* Parser function calls like <code><nowiki>{{#if:...|...|...}}</nowiki></code> can be used within arguments.

;Syntax features
* To use wiki characters as arguments, escape them.
** It is possible to define a special template like <code><nowiki>{{!}}</nowiki></code> which contains a single | symbol as its contents.
** With DPL it is also possible to use the symbol ¦ instead of |; this is very intuitive and maybe it could be adopted by MediaWiki in general...but be <u>careful</u>: it must be inserted by copy-and-paste from here (or from a HTML symbol or extended ASCII table like Windows' ''Character Map'') as normally a keyboard will not have it available (even worse: on some keyboards the standard pipe character is printed in a way that it looks more like the "broken pipe").
* The text can (but needs not) be written in one line of text, parameters are separated by pipe characters.
* What was said before regarding explicit line breaks also holds true for parser function syntax, i.e. the special symbols <code>\n</code> or <code>¶</code> must be used to insert an explicit linefeed character into the wiki output stream if wiki symbols are used which must stand at the beginning of a line.

Note: The pipe character, which is used to define a logical OR for the two categories, must be represented as a call of a special template (which would typically be called "Template:!") which has a single pipe character as its contents. The same kind of trick is also found outside DPL in other templates. The second example shows that the <code>¦</code> character acts as an alternative to this somewhat awkward notation.

The second example is not literally equivalent to the first one as there is an additional pipe character before the first parameter. Technically, this creates an additional empty parameter, but as empty parameters are silently ignored by DPL it makes no difference.

===#dplchapter===
Besides '''#dpl''' there is another parser function which you can use in your wiki text. It is called '''[[#dplchapter]]''' and extracts the body of a chapter from some arbitrary wiki text which it receives as a parameter.

==Characters with special meaning==
Sometimes it is necessary to use a character as "plain data" at a place where it normally has a syntactical meaning. Mediawiki is not very clean at character escaping in general. So we had to define our own way in the jungle of "character escaping":

{| class="wikitable"
|-
! DPL escape character !! Mediawiki character!! Typical use
|-
| align=center | <code>'''»'''</code> || align=center | > || rowspan=2 | Call another MediaWiki extension into a parameter of a DPL call
|-
| align=center | <code>'''«'''</code> || align=center | <
|-
| align=center | <code>'''²{'''</code> || align=center | <nowiki>{{</nowiki> || rowspan=3 | Call a template within the 'article loop' of DPL. This is especially useful for nesting DPL calls (''DPL recursion'')
|-
| align=center | <code>'''}²'''</code> || align=center | <nowiki>}}</nowiki>
|-
| align=center | <code>'''¦'''</code> || align=center | <nowiki>|</nowiki>
|-
| align=center | <code>'''¶'''</code> || align=center | newline || rowspan=2 | Inserts a line break into DPL's wikitext output, to allow proper parsing of first-character syntax (such as <code>* # : ;</code>)
|-
| align=center | <code>'''\n'''</code> || align=center | newline
|}

DPL's mechanism of replacing <code>%xx%</code> variables then can be used to modify the arguments of that call '''before''' it will be resolved. Most DPL users will not need this, but for some advanced uses of DPL it is a real help.

==Built-in variables==
Within a DPL statement you can use some {{DPL|format|variables}} which are implicitly set by DPL.
Example: %TITLE%, %PAGE%

Some {{DPL|format|variables}} can only be used in the header or footer, like e.g. %PAGES%, %TOTALPAGES%

==URL parameters==
DPL understands a couple of parameters which can be passed via an URL specification. These URL-parameters all start with DPL_:
* DPL_count: influences the {{DPL|count}} parameter (in fact it overwrites the value specified within the DPL statement)
* DPL_offset: influences the {{DPL|offset}} parameter (in fact it overwrites the value specified within the DPL statement)
* DPL_refresh: if used with a value of 'yes' this will clear the DPL cache
* DPL_fromTitle: restrict the selection to articles with a page title greater or equal to the specified value
* DPL_toTitle: restrict the selection to articles with a page title less or equal to the specified value
* DPL_arg1, DPL_arg2, .. DPL_arg5: these are generic parameters that can be used freely to influence a DPL statement

The command

<pre><nowiki> http://mywebsite/mywiki/index.php?title=MyPage&DPL_offset=20 </nowiki></pre>

would display ''MyPage'' and set the offset parameter to a value of ''20''.

Within the DPL statement you can access URL parameters via
{%DPL_xxx%}
If a parameter is not set in the URL, DPL will assume an empty string. Instead you can define a default value by using a colon:
{%DPL_xxx:yyy%}
In this case DPL will use 'yyy' if the parameter DPL_xxx is not specified on the URL command line.

Note: There is a template called [https://followthescore.org/dpldemo/index.php?title=Template:Extension_DPL_scroll Template:Extension DPL scroll] which uses DPL_offset and DPL_count to provide a generic page scrolling method for huge result sets.

==Syntax used in this manual==
If we give complete examples we will typically use the tag based parser extension syntax in this manual. Except when we want to make use of variable expansion.

Most of the manual deals with the explanation of individual parameters. This is independent of the choice between the two variants described above. So, if you read something like
* parameter = value
you should have in mind that you must either place DPL tags around (using a separate line for each parameter) or use the parser function syntax and separate parameters by pipe characters.

==Time stamps==
DPL queries which return date/time information (e.g. date of last edit of a page) will display this information according to your local timezone (if this is correctly set in your user preferences).

==Interaction between your wiki text and DPL3 output==
As mentioned before DPL3 will insert its output exactly at the position where you placed the DPL3 call. This means that you can put wiki syntax around your DPL call, like e.g.:
<pre><nowiki>
{| class=wikitable
|a table field
|<DPL>
linksto=myPage
</DPL>
|-
|another table field
|...
|}
</nowiki></pre>

You could also use html syntax to surround DPL output as in the following example:
<pre><nowiki>
<ul>
<li>Item1</li>
<li>Item2
<DPL>
...parameters...
</DPL>
</li>
</ul>
</nowiki></pre>

==Special note on ''Self References''==
In principle a DPL query could be written in a way that the page containing the query (or the page including a template which contains the query) would be part of the result set. Experience in the past has shown that in some cases this leads to unwanted effects. For instance the page containing the query from a MediaWiki point of view contains links to all pages it lists. If your DPL statement contains a "uses" clause you will be astonished to find your own page in all results. The same happens with categories... In addition there were technical problems with self referencing result sets (parser loop references which seemed very hard to solve). So it was decided to skip a self reference in the result set by default.

<center style="border:1px black solid"><big>'''''Normally DPL does not return its own page in the result.'''''</big></center>

* The parameter {{DPL|skipthispage}} gives you control over this behavior. By setting it to ''no'' you can allow self references in DPL result sets.
* You can suppress back references to a page containing a DPL query by using {{DPL|reset}} and/or {{DPL|eliminate}}.

==Symbol replacement in ''mode=userformat''==
When mode=userformat is selected, DPL will not output anything by default. Instead it will look for symbols in your input (''listseparators, secseparators, multisecseparators, tablerow'') which it will replace by their corresponding values. For example, <code>%TITLE%</code> will be replaced by the title of an article, <code>%PAGE%</code> will be replaced by the pagename. So, if you write something like <br><code><nowiki>[[%PAGE%|%TITLE%]]</nowiki></code>, DPL will create a hyperlink to an article.

'''See [[Help:DPL/Parameters: Controlling output format#format]] for a complete list of symbols.'''

The specification of <code>listseparators</code>, <code>secseparators</code>, and <code>multisecseparators</code> does only make sense in combination with <code>mode=userformat</code>. Therefore <code>mode=userformat</code> is automatically implied when <code>listseparators</code> is specified. To make the syntax even more comfortable the simple word <code>format</code> can be used as an alias for <code>listseparators</code>. So:
mode=userformat
listseparators=a,b,c,d
is exactly the same as:
format=a,b,c,d

==Use of boolean parameters==
A lot of DPL's parameters have type [http://en.wikipedia.org/wiki/boolean_datatype boolean]. The manual always assumes that 'true' and 'false' are used to set such parameters. As an alternative, you can also use 'yes' and 'no' or '1' and '0' or 'on' and 'off' as with the standard HTML form checkbox input type.

==Implicit link to [[:Template:Extension DPL]]==
Since version 1.7.9 DPL creates an implicit automatic link to <code>Template:Extension DPL</code>.
This means that every page containing a DPL statement will automatically create a link to [[:Template:Extension DPL]]. You should create this Template in your wiki. We suggest that you copy the source code from [[:Template:Extension DPL|our version]]. The idea is that via this connection you can easily find out which pages in a wiki contain DPL calls.

Note that the template does NOT produce any output - so it is practically invisible to the user. If you forget to create the template, however, the user will see a red link to the template.

==Debugging a DPL statement==
If you want to write a DPL query which produces wiki tables a lot of imagination is required because you must produce correct wiki syntax as the result of your query. And that syntax heavily depends on newlines, escaping of pipe symbols and other nice little things which are easy to get wrong ;-)

We recommend to use the following parameters to find out what syntax your DPL statement produces:

resultsheader=«pre»«nowiki»
resultsfooter=«/nowiki»«/pre»

The same effect can be achieved with {{DPL|debug}}=5.

==Table output==
We'd also like to point out that there are two special commands named {{DPL|table}} and {{DPL|tablerow}} which make it quite easy to produce output in table form.

==Scrolling==
DPL supports efficient scrolling through huge result sets.

The command <code>scroll=yes</code> must be given to enable scrolling.

DPL can take certain URL parameters from the command line, like &DPL_fromTitle and &DPL_toTitle. If these arguments are given the commands <code>title></code> and <code>title<</code> will implicitly be set. Within the {{DPL|resultsheader}} and/or {{DPL|resultsfooter}} you can call a template which generates links to fetch the next / previous page.

Basically the idea of backward scrolling is that the SQL statement produces a DESCENDING order (with titles below the threshold). Internally DPL buffers the SQl result set and reverses its order. So the user will see a page of entries directly below the threshold, but in ascending order.

If scrolling is enabled, DPL 1.8.0 and later will take a couple of parameters from the URL command line, like <code>DPL_offset</code> for instance; these parameters can be accessed within DPL via a special syntax:
* <code>{%DPL_offset%}</code>.
or
* <code>{%DPL_offset:defaultvalue%}</code>.

The variables are:
* DPL_count
* DPL_offset
* DPL_refresh (a value of 'yes' will purge the DPL cache)
* DPL_fromTitle (will be passed to title< )
* DPL_toTitle (will be passed to title> )
* DPL_findTitle (will be passed to title>= )
* DPL_scrolldir (will be used to influence sort order, can be 'up' or 'down')

Thus you could write an article called 'MyPopularArticles' containing a DPL query like:

<pre><nowiki>
{{#dpl:execandexit=geturlargs}}
<dpl>
category = Country
count = {%DPL_count:100%}
scroll = yes
resultsheader = Showing {%DPL_count:100%} pages starting from page {{#expr:{%DPL_offset%} + 1}}:\n
</dpl>

</nowiki></pre>

Calling <code><nowiki>http://mywebsite/mywiki/index.php?title=MyPopularArticles</nowiki></code> will give you the first 100 articles in the category. Adding &DPL_offset=100 will give you the next one hundred articles. This mechanism can be used to create a generic page scroll feature - provided you can access the value of <code>DPL_offset</code> also in other templates outside DPL. And this is where the <code>execandexit</code> command comes in: it stores the URL parameters in a variable which can be accessed via #dplvar.

Help:DPL/Dplmatrix/test matrix

2024-08-23T02:33:52Z

Scientific Guy:

{|border=1 width=100% cellspacing=0
|style=padding-left:5px width=120px id=n-Test | '''Test'''
|style=padding-left:5px | matrix
|-
|}

===generating a matrix from an indented list ===
Input is:
one
oho
aha
two ~~ Two
ehem
three
four
aha
uhui ~~ UHU
two ~~ Two
uhui ~~ UHU

Output is:
{|class=wikitable
!normal
!flipped
|--
|<pre>{{#dplmatrix:a simple demo matrix||||
one
oho
aha
two ~~ Two
ehem
three
four
aha
uhui ~~ UHU
two ~~ Two
uhui ~~ UHU
}}</pre>
|<pre>{{#dplmatrix:a simple demo matrix|<big>•</big>|.|flip|
one
oho
aha
two ~~ Two
ehem
three
four
aha
uhui ~~ UHU
two ~~ Two
uhui ~~ UHU
}}</pre>
|--
|
{{#dplmatrix:a simple demo matrix||||
one
oho
aha
two ~~ Two
ehem
three
four
aha
uhui ~~ UHU
two ~~ Two
uhui ~~ UHU
}}
|
{{#dplmatrix:a simple demo matrix|<big>•</big>|.|flip|
one
oho
aha
two ~~ Two
ehem
three
four
aha
uhui ~~ UHU
two ~~ Two
uhui ~~ UHU
}}
|}
* "from" items ("source") start in col 1
* "to" items ("target") are indented by at least one space
* source appears in input sequence
* target is sorted by alphabet
* items are treated as pages and shown as a link
* the label can be defined by adding it after the iterm, separated by "~~"
* symbols for "yes" and "no" can be defined
* via the stylesheet in [[MediaWiki:Common.css]] you can control the layout (class=dplmatrix)

===Links to DPL Manual pages===
Now we use two nested DPL queries and what would be a separate page, Test matrix2, to generate the indented list:
<pre>
{{#dplmatrix:''links from articles to the DPL manual''|'''x'''|-|flip|
{{#dpl:
|debug=1
|category=DPL Manual
|format=,%PAGE% ~~ %TITLE%\n²{:Test matrix2¦page=%PAGE%¦category=DPL Manual¦namespace=}²,
}}
}}
</pre>
Contents of Test matrix2:
<pre>
{{#dpl:
|debug=1
|{{#if:{{{namespace|}}}|{{#ifeq:{{{namespace}}}|main|namespace=|namespace={{{namespace}}}|}}}}
|{{#if:{{{category|}}}|category={{{category}}}}}
|linksfrom={{{page}}}
|shownamespace=no
|format=, %PAGE% ~~ %TITLE%\n,
}}
</pre>

{{#dplmatrix:''links from articles to the DPL manual''|'''x'''|-|flip|
{{#dpl:
|debug=1
|category=DPL Manual
|format=,%PAGE% ~~ %TITLE%\n²{:Test matrix2¦page=%PAGE%¦category=DPL Manual¦namespace=}²,
}}
}}

Help:DPL/Example: Select by recently changed

2024-08-23T02:30:20Z

Scientific Guy:

{{DPL manual|section=Examples|subsection=Select by recently changed}}

==List Help pages which were edited recently==
The following example:

<pre>{{#dpl:
namespace=Help
|addeditdate=true
|ordermethod=lastedit
|order=descending
|count=10
}}</pre>

Would produce the last ten edited articles in the Help namespace:

{{#dpl:
namespace=Help
|addeditdate=true
|ordermethod=lastedit
|order=descending
|count=10
}}

==List DPL manual pages with the oldest last edit dates==
The following example:

<pre>{{#dpl:
namespace=Help
|titlematch=DPL%
|addeditdate=true
|ordermethod=lastedit
|order=ascending
|count=10
}}</pre>

Would produce the first ten edited articles in the Help namespace with the DPL prefix:

{{#dpl:
namespace=Help
|titlematch=DPL%
|addeditdate=true
|ordermethod=lastedit
|order=ascending
|count=10
}}

==List the last seven revisions of DPL manual pages which have an edit date later or equal to September 9, 2019==
The following example:

<pre>{{#dpl:
namespace=Help
|titlematch=DPL%
|addeditdate=true
|allrevisionssince=2019-09-09
|ordermethod=lastedit
|order=ascending
|count=7
}}</pre>

Would produce the last seven revision of articles in the Help namespace with the DPL prefix:

{{#dpl:
namespace=Help
|titlematch=DPL%
|addeditdate=true
|allrevisionssince=2019-09-09
|ordermethod=lastedit
|order=ascending
|count=7
}}

Help:DPL/Dplmatrix

2024-08-23T02:20:30Z

Scientific Guy:

{{DPL manual|section=dplmatrix}}

==Syntax==
<pre><nowiki>
{{#dplmatrix: name | yes | no | mode | '''indented_list''' }}
</nowiki></pre>

==Effect==
This function is a side entry into DPL.

You pass an indented list and you get a matrix view back. With copy/paste you can easily transfer such a matrix to Excel and do some polishing there like turning column texts to vertical, highlight interesting cells etc…)

There are five parameters which MUST be given in the order listed here:
# The name of the matrix. Appears in the upper left cell. Arbitrary wiki formatting (even images) are possible.
# The symbol for cells which symbolize a link. Default is "x".
# The symbol for cells which symbolize the absence of a link. Default is 'empty cell'.
# The mode ('normal' or 'flip'); default is 'normal'. When 'flip' is specified, rows and columns will be exchanged.
# The indented list.
#* source items must start in column 1
#* target items must be indented by at least one space
#* after the item name you can add ~~ and a 'label'. Row and column titles of the matrix will contain hyperlinks to the items. If labels are specified, they will be used instead of the item names.
#* lines which are empty or contain only spaces are silently ignored.
#* if a source line is not followed by one or more target lines an empty table row (or column in flip mode) will be shown.
#* if the same source line appears multiple times, the targets will be joined (added).

The idea is that you can generate the indented list by DPL statements. See the following example:

----

{{/test matrix}}

Help:DPL

2024-08-23T02:16:30Z

Scientific Guy:

{{DPL manual|section=|subsection=}}

'''DynamicPageList3''' (DPL/DPL3) is a powerful MediaWiki [[mw:Manual:Extensions|extension]] that can generate lists of pages, and/or certain data and statistics gathered from them, for display in a wiki page. DPL lists are automatically updated whenever said data changes.

As a basic example, DPL can be used to insert, in a wiki page, an always-current list of all pages of a particular [[mw:Help:Categories|category]]. The data displayed may be selected and sorted based on factors like author, namespace, date, name pattern, usage of templates, or references to other articles, with a variety of custom formatting possibilities.

This page and its subpages are the DynamicPageList3 (DPL) Manual. This version of the DPL Manual was imported from the [https://help.gamepedia.com/Extension:DPL3/Manual Gamepedia Help Wiki] (which apparently adapted it from [http://followthescore.org/dpldemo/index.php?title=DPL:Manual FollowTheScore]). The DPL Manual on the Gamepedia Help Wiki has since migrated to the [https://community.fandom.com/wiki/Help:DPL3/Manual Fandom Community Central]. Because of needed changes, the pages imported have been edited. For a list of all changes, see [[AIOWiki:Adventures in Odyssey Wiki:DPL Manual|AIOWiki:DPL Manual]].

== Usage ==
* [[Help:DPL/General usage and invocation syntax|General usage and invocation syntax]]

== Primary DPL module ==
These sections contain documentation on DPL's primary module, <code><nowiki>{{#dpl: ... }}</nowiki></code>. This is the DPL functionality used most often, and has a wide range of powerful coding options.
* [[Help:DPL/Parameters: Criteria for page selection|Criteria for page selection]]
* [[Help:DPL/Parameters: Controlling output format|Controlling output format]]
* [[Help:DPL/Parameters: Controlling output order|Controlling output order]]
* [[Help:DPL/Parameters: Controlling output volume|Controlling output volume]]
* [[Help:DPL/Parameters: Other parameters|Other parameters]]

== Complete DPL Manual Table of Contents ==
Below is the legacy Table of Contents provided as navigation in the original DPL documentation. It is an expansive, cross-referenced list of DPL parameters (which some find daunting and others find helpful). Its links can all be found via the pages listed above, however the table below may be useful to more easily find what you need, especially if you don't know which section your desired functionality might be located in (expand the table below and use your browser's Find In Page feature, usually <code>Ctrl-F</code>).

{{hidden|message=Click to reveal or hide legacy DPL Manual Table of Contents|
<DPL>
category = DPL
uses = Template:DPL parameter
mode = userformat
replaceintitle = @DPL/Parameters: @,
include = {DPL manual}:[[%PAGE%|%TITLE%]],{DPL parameter}/dpl
listseparators={|class=wikitable,\n|-\n|,,\n|}
secseparators=,,\n|\n{|class="wikitable sortable" width=100%\n!width=140px|name\n!purpose\n|-\n|,\n|}
multisecseparators=,\n|-\n|
allowcachedresults = true
ordermethod = sortkey
</DPL>
}}

== Other DPL modules ==
These sections detail some additional functions provided by the DPL extension.
* [[Help:DPL/Dplchapter|<nowiki>{{#dplchapter: ... }}</nowiki>]]
* [[Help:DPL/Dplvar|<nowiki>{{#dplvar: ... }}</nowiki>]]
* [[Help:DPL/Dplreplace|<nowiki>{{#dplreplace: ... }}</nowiki>]]
* [[Help:DPL/Dplnum|<nowiki>{{#dplnum: ... }}</nowiki>]]
* [[Help:DPL/Dplmatrix|<nowiki>{{#dplmatrix: ... }}</nowiki>]]

== Notes ==
* [[Help:DPL/Compatibility|Compatibility with previous versions]]
* [[Help:DPL/Hit counters removed|Hit counters removed]]

== Examples ==
=== Selecting articles ===
* [[Help:DPL/Example: Select by category|By category]]
* [[Help:DPL/Example: Select by recently changed|By recently changed]]

=== Show article's context or contents ===
* [[Help:DPL/Example: Related to article|Pages, templates, images, or categories related to an article]]
* [[Help:DPL/Example: Display images used|Display all images used in an article]]

=== Controlling output ===
* [[Help:DPL/Example: Show templates parameters from an article|Show templates parameters from an article]]
* [[Help:DPL/Example: Show sections from an article|Show sections from an article]]

Template:DPL parameter/dpl

2024-08-23T02:03:59Z

Scientific Guy: Created page with "<span style="font:120% Courier, monospace;">{{{name}}}</span> |{{{purpose}}} |-"

<span style="font:120% Courier, monospace;">[[{{{%PAGE%}}}#{{{name}}}|{{{name}}}]]</span>
|{{{purpose}}}
|-

Family Camp

2024-08-23T01:56:17Z

Scientific Guy:

{{Infobox Episode
| ep_num = 151
| mp3 = 26:00
| cd = 26:00
| s_num = S-17
| collection = It’s a Trip!
| spc_ep_num = 6
| airdate = June 20, 2009
| theme = Making time for the ones you love
| writer = Kathy Buchanan
| director = Steve O’Dell
| post_producer = Joe Carol
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Roy Wallace
| add_recording = Rob Gunlee
| exec_producer = Terre Ritchie
| kfk = 45410829697325
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Miss Rhubarb

2024-08-23T01:56:07Z

Scientific Guy:

{{Infobox Episode
| ep_num = 150
| mp3 = 24:01
| cd = 24:01
| s_num = S-16
| collection = It’s a Trip!
| spc_ep_num = 5
| airdate = May 9, 2009
| theme = Supporting those you love
| writer = Kathy Buchanan
| director = Steve O’Dell
| post_producer = Cal Olsen
| post_producer2 = Joe Carol
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Roy Wallace
| add_recording = Rob Gunlee
| exec_producer = Terre Ritchie
| kfk = 45410829730093
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

The Greatest of These

2024-08-23T01:55:46Z

Scientific Guy:

{{Infobox Episode
| ep_num = 125
| mp3 = 23:31
| cd = 23:31
| s_num = S-15
| collection = It’s a Trip!
| spc_ep_num = 4
| airdate = February 15, 2008
| theme = The true meaning of love
| writer = John Fornof
| writer2 = Lori Twichell
| director = Steve O’Dell
| post_producer = Glen West
| post_producer2 = Todd Busteed
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Roy Wallace
| rec_engineer2 = Bryan Papera
| add_recording = Rob Gunlee
| exec_producer = Terre Ritchie
| kfk = 45410829664557
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Putting the Christmas Back in Hope

2024-08-23T01:55:34Z

Scientific Guy:

{{Infobox Episode
| ep_num = 124
| mp3 = 29:35
| cd = 29:35
| s_num = S-14
| collection = Holiday Heart and Hope
| spc_ep_num = 4
| airdate = December 22, 2007
| theme = Christmas: traditions
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Bryan Papera
| add_recording = Rob Gunlee
| exec_producer = Terre Ritchie
| kfk = 45410829631789
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Table Talk

2024-08-23T01:55:22Z

Scientific Guy:

{{Infobox Episode
| ep_num = 123
| mp3 = 32:59
| cd = 33:01
| s_num = S-13
| collection = Holiday Heart and Hope
| spc_ep_num = 3
| airdate = November 17, 2007
| theme = Thanksgiving
| writer = John Fornof
| director = Steve O’Dell
| post_producer = Cal Olsen
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Bryan Papera
| add_recording = Rob Gunlee
| exec_producer = Terre Ritchie
| kfk = 45410829599021
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

The Hope That Heals

2024-08-23T01:55:10Z

Scientific Guy:

{{Infobox Episode
| ep_num = 110
| mp3 = 28:24
| cd = 28:24
| s_num = S-12
| collection = The Hope That Heals (Collection)
| spc_ep_num = 4
| airdate = April 7, 2007
| theme = The true source for hope and healing
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer and Sound Designer
| composer = John Campbell
| rec_engineer = Roy Wallace
| exec_producer = Terre Ritchie
| kfk = 45410829566253
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Christmas Heirlooms

2024-08-23T01:54:55Z

Scientific Guy:

{{Infobox Episode
| ep_num = 103
| mp3 = 25:07
| cd = 25:07
| s_num = S-11
| collection = The Hope That Heals (Collection)
| spc_ep_num = 2
| airdate = December 23, 2006
| theme = When Jesus is all we have, is He enough?
| writer = John Fornof
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer and Sound Designer
| composer = John Campbell
| rec_engineer = Roy Wallace
| exec_producer = Terre Ritchie
| kfk = 45410829533485
}}

== Summary ==
The hustle and bustle of the Morrisons’ Christmas festivities is interrupted by a sudden tragedy.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

O Little Town of Coleraine

2024-08-23T01:54:41Z

Scientific Guy:

{{Infobox Episode
| ep_num = 084
| mp3 = 29:32
| cd = 29:34
| s_num = S-10
| collection = The Hope That Heals (Collection)
| spc_ep_num = 1
| airdate = 2006
| theme = Christmas
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Unknown
| composer = John Campbell
| exec_producer = Terre Ritchie
| kfk = 45410829500717
}}

== Summary ==
It’s another Christmas in the Morrison household, and the family gathers together to celebrate… but not the Morrisons we know.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Heart and Soldier

2024-08-23T01:54:27Z

Scientific Guy:

{{Infobox Episode
| ep_num = 059
| mp3 = 24:27
| cd = 24:27
| s_num = S-9
| collection = Holiday Heart and Hope
| spc_ep_num = 2
| airdate = May 29, 2004
| theme = Only God brings peace
| writer = Sarah Osinsky
| director = Beth Culp
| post_producer = Lee Nordean
| post_credit = Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| swdgl = 27
| kfk = 45410829467949
}}

== Summary ==
While helping Mr. Key clean out his attic, Haley finds a box of letters between him and a future Mrs. Key from World War II.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Spring Broke, Part 2

2024-08-23T01:54:12Z

Scientific Guy:

{{Infobox Episode
| ep_num = 058
| mp3 = 26:18
| cd = 26:18
| s_num = S-8b
| collection = It’s a Trip!
| spc_ep_num = 2
| airdate = 2004
| theme = Helping those in need
| writer = Beth Culp
| writer2 = Sarah Osinsky
| director = Beth Culp
| director2 = Sarah Osinsky
| post_producer = Andrew Bee
| post_credit = Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829435181
}}

== Summary ==
As the Morrisons’ trip at the Capitol continues, John and Mary wonder how to reach out to the Vaughn family while Justin struggles with all the changes to his plans.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Spring Broke, Part 1

2024-08-23T01:53:59Z

Scientific Guy:

{{Infobox Episode
| ep_num = 057
| mp3 = 23:32
| cd = 23:32
| s_num = S-8a
| collection = It’s a Trip!
| spc_ep_num = 1
| airdate = 2004
| theme = Helping those in need
| writer = Beth Culp
| writer2 = Sarah Osinsky
| director = Beth Culp
| director2 = Sarah Osinsky
| post_producer = Lee Nordean
| post_credit = Editor and Post-Producer
| composer = John Campbell
| exec_producer = Randy Hekman
| swdgl = 12
| kfk = 45410829402413
}}

== Summary ==
The Morrisons have a decision to make on their spring break trip to Washington, DC when they cross paths with a family in need.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

The Best Christmas on Record

2024-08-23T01:53:45Z

Scientific Guy:

{{Infobox Episode
| ep_num = 044
| mp3 = 48:53
| cd = 48:53
| s_num = S-7
| collection = To Grandmother’s House We Go! (Collection)
| spc_ep_num = 4
| airdate = December 21, 2002
| theme = Christmas: Extending forgiveness and grace
| writer = Beth Culp
| director = Beth Culp
| post_producer = Steve O’Dell
| post_producer2 = Andrew Bee
| post_producer3 = Lee Nordean
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829369645
}}

== Summary ==
John and Mary tell their kids the story of their first Christmas together, which took place during the Richters’ preparations for a classic Christmas competition.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

To Grandmother’s House We Go

2024-08-23T01:53:34Z

Scientific Guy:

{{Infobox Episode
| ep_num = 043
| mp3 = 23:53
| cd = 23:53
| s_num = S-6
| collection = To Grandmother’s House We Go! (Collection)
| spc_ep_num = 2
| airdate = November 23, 2002
| theme = Thanksgiving: appreciating family
| writer = Beth Culp
| director = Steve O’Dell
| post_producer = Steve O’Dell
| post_credit = Producer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829336877
}}

== Summary ==
On a long trip to Mary’s mother’s house for Thanksgiving, cooped up in one car, Timmy’s enthusiasm about the trip starts to wear on everyone.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Summer Camp Blues

2024-08-23T01:53:22Z

Scientific Guy:

{{Infobox Episode
| ep_num = 042
| mp3 = 24:36
| cd = 24:35
| s_num = S-5
| collection = It’s a Trip!
| spc_ep_num = 3
| airdate = 2002
| theme = Overcoming obstacles
| writer = Sarah Osinsky
| director = Sarah Osinsky
| post_producer = Scott Hekman
| post_producer2 = Steve O’Dell
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| swdgl = 26
| kfk = 45410829304109
}}

== Summary ==
The Morrison kids spend a very active week at summer camp, and Michael, Haley, and Timmy each have unique obstacles to overcome.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Dressed for Sacrifice

2024-08-23T01:53:01Z

Scientific Guy:

{{Infobox Episode
| ep_num = 029
| mp3 = 24:01
| cd = 24:03
| s_num = S-4
| collection = The Hope That Heals (Collection)
| spc_ep_num = 3
| airdate = March 30, 2002
| theme = Having a sacrificial heart
| writer = Beth Culp
| writer2 = Leah Gartner
| director = Beth Culp
| post_producer = Scott Hekman
| post_producer2 = Steve O’Dell
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| swdgl = 14
| kfk = 45410829271341
}}

== Summary ==
The Morrison family volunteers to rebuild the town’s Easter set after it is destroyed by a storm. Meanwhile, Maya struggles to get along with her mom and sister amid the Easter festivities.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

The Girl Who Assumed Too Much

2024-08-23T01:52:49Z

Scientific Guy:

{{Infobox Episode
| ep_num = 028
| mp3 = 25:43
| cd = 25:45
| s_num = S-3
| collection = Holiday Heart and Hope
| spc_ep_num = 1
| airdate = January 19, 2002
| theme = Appreciating differences in others
| writer = Leah Gartner
| director = Beth Culp
| post_producer = Scott Hekman
| post_producer2 = Steve O’Dell
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829238573
}}

== Summary ==
When Haley decides to rearrange the furniture in Grace’s house to make it look better, Grace tells her the biblical story of Naaman and his servant girl.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

From Mary, with Love

2024-08-23T01:52:38Z

Scientific Guy:

{{Infobox Episode
| ep_num = 027
| mp3 = 25:32
| cd = 25:32
| s_num = S-2
| collection = To Grandmother’s House We Go! (Collection)
| spc_ep_num = 3
| airdate = December 22, 2001
| theme = Christmas: Being content with God’s plan
| writer = Beth Culp
| director = Beth Culp
| post_producer = Steve O’Dell
| post_producer2 = Scott Hekman
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829205805
}}

== Summary ==
Brooke writes a letter from the perspective of Mary, the mother of Jesus, about what her thoughts might have been on that silent night.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Peas and Thank You

2024-08-23T01:52:21Z

Scientific Guy:

{{Infobox Episode
| ep_num = 026
| mp3 = 28:15
| cd = 24:00
| s_num = S-1
| collection = To Grandmother’s House We Go! (Collection)
| spc_ep_num = 1
| airdate = November 17, 2001
| theme = Thanksgiving and traditions: thankfulness
| writer = Beth Culp
| director = Beth Culp
| post_producer = Steve O’Dell
| post_credit = Production Engineer
| composer = John Campbell
| exec_producer = Randy Hekman
| kfk = 45410829173037
}}

== Summary ==
When the Morrisons’ relatives can’t make it for Thanksgiving dinner, the kids invite Grace, Mr. Key, and the Taylors for the big meal.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Template:Infobox Episode

2024-08-23T01:52:06Z

Scientific Guy:

{{#vardefine:ep|{{{name|{{PAGENAME}}}}}}}{{#vardefine:s|{{#explode:{{{s_num}}}|-|0}}}}<div class="prevnext" style="padding: 1px 6px; font-size:10px; border: 1px solid #778FE1; width: 70%;{{radius|10}} background-color:#eaecf0;">
<div style="float:left;text-align:left;"><span class="prevLink">{{#ifeq:{{#var:ep}}|Meet the Morrisons|'''First Episode'''|[[{{#dpl:category=Episodes|ordermethod=sortkey|count=1|format=,%TITLE%|skipthispage=no|offset={{#expr:{{#replace:{{{ep_num}}}|L|83+}}-2{{#ifexpr:{{#replace:{{{ep_num}}}|L|0}}>=85|+3}}}}}}]]}}</span></div>
<div style="float:center;text-align:center;"><span class="thisPage">{{#var:ep}}</span><span class="thisBullet" style="visibility:hidden;">{{·}}</span>
<div style="float:right;text-align:right;"><span class="nextLink">{{#switch:{{#var:ep}}|And So It Goes='''Final Episode'''|Reuben Get Your Gun, Part 2=[[Bridges, Part 1]]|#default=[[{{#dpl:category=Episodes|ordermethod=sortkey|count=1|format=,%TITLE%|skipthispage=no|offset={{#expr:{{#replace:{{{ep_num}}}|L|83+}}{{#ifexpr:{{#replace:{{{ep_num}}}|L|0}}>=83|+3}}}}}}]]}}</span></div></div>
</div><div class="infobox" style="float:right;max-width:250px !important;clear:right;margin:5px 0 1em 1em;border:2px solid MediumSeaGreen;background:#eaecf0;{{radius|10}} padding:10px;">
<div style="text-align:center;font-size:16px;line-height:1.5em;">
'''#{{Trim Leading 0|{{{ep_num}}}}} ({{{s_num}}}): “{{#loop:i|0|{{#count:{{#var:ep}}| }}|{{#explode:{{#var:ep}}| |{{#var:i}}}} {{#ifexpr:{{#var:i}}+1<{{#count:{{#var:ep}}| }}|<nowiki />}}}} {{#explode:{{#var:ep}}| |{{#count:{{#var:ep}}| }}}}”'''<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid MediumSeaGreen;"></div>
<div style="height:6px"></div>
[[File:{{{collection_image|{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|01|{{#ifeq:{{#var:s}}|S|S{{#dpl:title={{{collection}}}|format=,|include={Infobox Collection}:spc}}|{{padleft:{{#var:s}}|2}}}}}}.jpg}}}|center|250px|link={{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|Lost episodes|{{{collection|Season {{#var:s}}}}}}}]]
</div>
<div style="clear:left;font-size:10px;text-align:center;border-top:9px solid #eaecf0;"></div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:50px;float:left;text-align:left;">Collection</div>
<div style="width:200px;float:right;text-align:right;">{{#if:{{{collection|}}}|''[[{{{collection}}}|{{#replace:{{{collection}}}| (Collection)|}}]]''|{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|[[Lost episodes]]|[[Season {{#var:s}}]]}}}}{{#ifeq:{{#var:s}}|S|<br>[[Special episodes]]}}{{#if:{{{collection2|}}}|<br>''[[{{{collection2}}}]]''}}</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Time</div>
<div style="width:125px;float:right;text-align:right;">MP3: {{{mp3}}}{{#if:{{{cd|h}}}|<br>CD: {{{cd}}}}}</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Original Airdate</div>
<div style="width:125px;float:right;text-align:right;">{{{airdate}}}</div>
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Theme</div>
<div style="width:125px;float:right;text-align:right;">{{{theme}}}</div>{{-}}
</div>{{#if:{{{arc|}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Arc</div>
<div style="width:125px;float:right;text-align:right;">[[:Category:{{{arc}}} Episodes|{{{arc}}}]]</div>{{-}}
</div>}}<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid MediumSeaGreen;"></div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Writer</div>
<div style="width:125px;float:right;text-align:right;">[[{{{writer}}}]]{{#if:{{{writer2|}}}|<br>[[{{{writer2}}}]]}}
</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Director</div>
<div style="width:125px;float:right;text-align:right;">[[{{{director}}}]]{{#if:{{{director2|}}}|<br>[[{{{director2}}}]]}}
</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">{{{post_credit|Post-Producer}}}</div>
<div style="width:125px;float:right;text-align:right;">[[{{{post_producer}}}]]{{#if:{{{post_producer2|}}}|<br>[[{{{post_producer2}}}]]}}{{#if:{{{post_producer3|}}}|<br>[[{{{post_producer3}}}]]}}
</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Composer</div>
<div style="width:125px;float:right;text-align:right;">[[{{{composer}}}]]</div>
</div>{{#if:{{{rec_engineer|}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Recording Engineer</div>
<div style="width:125px;float:right;text-align:right;">[[{{{rec_engineer}}}]]{{#if:{{{rec_engineer2|}}}|<br>[[{{{rec_engineer2}}}]]}}{{#if:{{{rec_engineer3|}}}|<br>[[{{{rec_engineer3}}}]]}}
</div>{{-}}
</div>}}{{#if:{{{add_recording|}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Additional Recording</div>
<div style="width:125px;float:right;text-align:right;">[[{{{add_recording}}}]]
</div>
</div>}}<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Executive Producer</div>
<div style="width:125px;float:right;text-align:right;">[[{{{exec_producer}}}]]
</div>
</div>{{#if:{{{kfk|}}}{{#dpl:format=,|include={Infobox Collection}/purchase|title={{{collection|{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|Lost episodes|Season {{#var:s}}}}}}}}}{{{swdgl|}}}{{RTG|{{{ep_num}}}}}{{{bts|}}}|<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid MediumSeaGreen;padding:5px 0px 0px 0px"></div>}}{{#if:{{{kfk|}}}{{#dpl:format=,|include={Infobox Collection}/purchase|title={{{collection|{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|Lost episodes|Season {{#var:s}}}}}}}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:85px;float:left;text-align:left;">Purchase episode</div>
<div class="plainlinks" style="width:165px;float:right;text-align:right;">{{#if:{{{kfk|}}}|[https://shop.keysforkids.org/products/specials?variant={{{kfk}}} Keys for Kids (MP3 Single) ][[File:KFK icon.png|14px|link=https://shop.keysforkids.org/products/specials?variant={{{kfk}}}]]<br>}}{{#dpl:format=,|include={Infobox Collection}/purchase|title={{{collection|{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|Lost episodes|Season {{#var:s}}}}}}}}}
</div>{{-}}
</div>}}{{#if:{{{swdgl|}}}{{RTG|{{{ep_num}}}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:80px;float:left;text-align:left;">Podcast Review{{#if:{{{swdgl|}}}|{{#if:{{RTG|{{{ep_num}}}}}|s}}}}</div>
<div style="width:170px;float:right;text-align:right;">{{#if:{{{swdgl|}}}|[[Slow Walk DGL Episode {{{swdgl}}}]]<br>}}{{#if:{{RTG|{{{ep_num}}}}}|[[Return to Gilead Episode {{RTG|{{{ep_num}}}}}]]<br>}}
</div>{{-}}
</div>}}{{#if:{{{bts|}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:85px;float:left;text-align:left;">Behind-the-scenes</div>
<div style="width:165px;float:right;text-align:right;">[[{{{bts}}}]]
</div>
</div>}}</div>'''“{{#var:ep}}”''' is episode #{{Trim Leading 0|{{{ep_num|}}}}} of [[Down Gilead Lane|{{#ifexpr:{{#replace:{{{ep_num|0}}}|L|9}}<84|Down Gilead Lane|Beyond Gilead}}]], episode #{{#explode:{{{s_num}}}|-|1}} of {{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|the [[lost episodes]]|{{#ifeq:{{#var:s}}|S|the [[special episodes]], released on CD in ''[[{{{collection}}}]]''|[[Season {{#var:s}}]]}}}}{{#ifeq:{{#sub:{{{collection}}}|-1}}|!||.}} It was written by [[{{{writer}}}]]{{#if:{{{writer2|}}}| and [[{{{writer2}}}]]}} and originally aired {{#ifeq:{{#len:{{{airdate}}}}}|4|in|on}} {{{airdate}}}.
<includeonly>__NOTOC__{{DEFAULTSORT:{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|083.{{#sub:{{{ep_num}}}|1}}|{{{ep_num}}}}}}}[[Category:Episodes]]{{#ifeq:{{#sub:{{{ep_num}}}|0|1}}|L|[[Category:Lost episodes]]|{{#ifeq:{{#var:s}}|S|[[Category:Special episodes]]|[[Category:Episodes in Season {{#var:s}}]]}}}}{{#if:{{{collection|}}}|[[Category:Episodes in {{{collection}}}|{{{spc_ep_num}}}]]}}{{#ifexpr:{{#replace:{{{mp3}}}-({{{cd}}})|:|*60+}}>=58|[[Category:Extended episodes]]}}{{#if:{{{arc|}}}|[[Category:{{{arc}}} Episodes]]}}[[Category:Episodes written by {{{writer}}}]]{{#if:{{{writer2|}}}|[[Category:Episodes written by {{{writer2}}}]]}}</includeonly>

Template:Infobox Collection/purchase

2024-08-23T01:51:17Z

Scientific Guy:

{{#if:{{{kfkcd|}}}{{{kfkmp3|}}}{{{amz|}}}{{{aud|}}}{{{apb|}}}|{{#if:{{{kfkcd|}}}|[https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkcd}}} Keys for Kids (CD Season) ][[File:CD icon.svg|14px|link=https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkcd}}}]]<br>}}{{#if:{{{kfkmp3|}}}|[https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkmp3}}} Keys for Kids (MP3 Season) ][[File:Download icon.svg|14px|link=https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkmp3}}}]]<br>}}{{#if:{{{spc|}}}|[https://shop.keysforkids.org/products/collections?variant={{#vardefineecho:special|{{#dpl:title=Special episodes|format=,|include={Infobox Collection}:kfkmp3}}}} Keys for Kids (All Specials) ][[File:Download icon.svg|14px|link=https://shop.keysforkids.org/products/collections/{{#var:special}}]]<br>}}{{#if:{{{amz|}}}|[https://www.amazon.com/dp/{{{amz}}} Amazon (CD Season) ][[File:Amazon icon.svg|14px|link=https://www.amazon.com/dp/{{{amz}}}]]<br>}}{{#if:{{{aud|}}}|[https://www.audible.com/pd/{{{aud}}} Audible (Audiobook Season) ][[File:Audible icon.svg|14px|link=https://www.audible.com/pd/{{{aud}}}]]<br>}}}}

Special episodes

2024-08-23T01:40:19Z

Scientific Guy:

{{Infobox Collection
| kfkmp3 = 45411251847469
| prefix = collections
| lead_section = The '''special episodes''' of [[Down Gilead Lane]] are episodes that were not released in any regular season, usually as holiday or seasonal specials. They were written by all 6 main writers (excluding [[W. Mark Whitlock]]), and were released from the end of [[Season 2]] to the beginning of [[Season 12]].
}}

== Description ==
{{Quote|Get all 18 special episodes of the hit family radio drama ''Down Gilead Lane'' (and ''Beyond Gilead''). This audio download set is packed with extended scenes and lots of great adventure from your favorite town and your favorite characters.|Keys for Kids}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

== Chronology ==
The following list attempts to place the special episodes of ''Gilead'' in a proper chronological order with the rest of the series. This list is incomplete, is based on conjectures made on [[Return to Gilead]], and may be inaccurate.

;Year 1
*[[Season 1|1-1 - 1-13]]
*[[Season 2|2-1 - 2-12]]
*{{ep|Peas and Thank You}}
*{{ep|From Mary, with Love}}
*{{ep|The Best Christmas on Record}} ''(Option 1)''
;Year 2
*{{ep|The Girl Who Assumed Too Much}}
*[[Season 3|3-1 - 3-12]]
*{{ep|Dressed for Sacrifice}}
*{{ep|Spring Broke, Part 1}}
*{{ep|Spring Broke, Part 2}}
*[[Season 4|4-1 - 4-7]]
*{{ep|Summer Camp Blues}}
*[[Season 4|4-8 - 4-12]]
*[[Season 5|5-1 - 5-3]]
*{{ep|To Grandmother’s House We Go}}
*[[Season 5|5-4 - 5-5]]
*{{ep|The Best Christmas on Record}} ''(Option 2)''
;Year 3
*[[Season 5|5-6 - 5-12]]
*[[Season 6|6-1 - 6-7]]
;Year 4
*[[Season 6|6-8 - 6-12]]

To Grandmother’s House We Go! (Collection)

2024-08-23T01:39:37Z

Scientific Guy:

{{Infobox Collection
| name = To Grandmother’s House We Go!
| spc = 1
| rel_date = 2004
| kfkcd = 45411251749165
| prefix = collections
| amz = B004XM4NPY
}}

Season 12

2024-08-23T01:38:58Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141480749
| kfkmp3 = 45387141513517
| amz = B004XM4NPO
| aud = B003VPI22Y
| apb = 382967959
}}

== Description ==
{{quote|Everything comes together…

Since we first heard from the Morrison family on a quiet road in a small town, we’ve come a long way. Kids have grown up, graduated, and moved away from home. New members have joined the family. This season, find out who’s behind Peace of Heaven, how Monica Richter can get herself out of the mess she’s in, and what significant life choices are made. Find out what happens when the pieces of the puzzle ultimately fall into place in Coleraine.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 11

2024-08-23T01:38:35Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141415213
| kfkmp3 = 45387141447981
| amz = B004XM4NSG
| aud = B003VPJZP2
| apb = 382968380
}}

== Description ==
{{quote|Opposing forces clash…

With the growing presence of the Peace of Heaven group in Coleraine, lots of new people are moving to town. Some citizens are excited about the promised growth, but others are skeptical. It seems everybody is taking sides. What will become of the idyllic little town of Coleraine — especially Gilead Lane? Will the Morrisons be stretched to their limits? And are the Richters in over their heads?|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 10

2024-08-23T01:38:11Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141349677
| kfkmp3 = 45387141382445
| amz = B004XM4NQI
| aud = B003VPETIK
| apb = 382733258
}}

== Description ==
{{quote|Hope in the midst of turmoil…

What happened to Mr. Key’s house? Who’s moving in? And who are all those new people in town? Find out the answers to all of those questions and more in season 10 of the hit family radio drama ''Beyond Gilead.'' Packed with extended scenes and lots of great adventure from your favorite town and your favorite characters, it’s a season you won’t want to miss!|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 9

2024-08-23T01:37:46Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141284141
| kfkmp3 = 45387141316909
| amz = B004XM4NQ8
| aud = B003VPE3QS
| apb = 382968049
}}

== Description ==
{{quote|Change is in the air…

College life for Brooke, a new addition to the family, and the office of mayor for John — all situations that can bring stress, discomfort … and opportunities to trust God. The Morrisons learn to turn to Him for answers in the midst of all these changes and more in 12 compelling episodes.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 8

2024-08-23T01:37:16Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141218605
| kfkmp3 = 45387141251373
| amz = B004XM4NQS
| aud = B003VP2VSA
| apb = 382968910
}}

== Description ==
{{quote|Our plans are not God’s plans. A lesson to be learned…

When things seem to be spinning out of our control, it can be hard to remember that God always has a plan — and that we can trust Him no matter what! It’s an important lesson the Morrisons will learn in this exciting season of ''Beyond Gilead.''|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 7

2024-08-23T01:35:40Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141153069
| kfkmp3 = 45387141185837
| amz = B004XM4NR2
| aud = B003VPKPBA
| apb = 382969211
}}

== Description ==
{{quote|Hearts and lives will change…

The winds of change are sweeping through Coleraine, and the Morrison family is right in the center of it all! Who will leave, and who will make a complete turnaround? How will the Morrison kids react to all the changes?|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 6

2024-08-23T01:34:53Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141087533
| kfkmp3 = 45387141120301
| amz = B004WO10HW
| aud = B003VPETYO
| apb = 382968911
}}

== Description ==
{{quote|An unexpected someone finds hope…

When a new star quarterback comes to town, the Richters feel threatened — and they’ll do just about anything to get Caleb back on the field. But what they don’t see coming is an unlikely friendship that turns the threat into an answered prayer. Through the real-to-life stories, this season will teach you how to live out the Beatitudes in every situation you tackle!|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 5

2024-08-23T01:34:31Z

Scientific Guy:

{{Infobox Collection
| kfkcd = 45387141021997
| kfkmp3 = 45387141054765
| amz = B004WO10HC
| aud = B003UH4UYM
| apb = 380811778
}}

== Description ==
{{quote|A broken family discovers the healing Balm of Gilead…

Becca and Luke’s mom walked out on them when they were kids. Now they’re teenagers and starting to figure life out on their own. So why has Joan Taylor come back? With the Morrisons standing close to this hurting family, this season will stretch everyone’s faith and trust like no other time in their young lives, and lead them to discover God’s overwhelming peace.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 4

2024-08-23T01:34:04Z

Scientific Guy:

{{Infobox Collection
| subtitle = The End of the Beginning
| kfkcd = 45387140956461
| kfkmp3 = 45387140989229
| amz = B004WO10I6
| aud = B003UH6OXC
| apb = 380586814
}}

== Description ==
{{quote|Operation Lemonade starts to unravel the secret…

Now the town’s biggest mystery is about to be uncovered: What happened the night that Grace Andrews became blind and orphaned? And who is behind the cover-up? As the Morrisons grow in their faith and understanding of true forgiveness, you’ll learn about God’s unchanging truths in these 12 powerful episodes.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 3

2024-08-23T01:33:38Z

Scientific Guy:

{{Infobox Collection
| subtitle = Cosmic Confusion
| kfkcd = 45387140890925
| kfkmp3 = 45387140923693
| amz = B004XM4NPE
| aud = B003UH0RVC
| apb = 380807163
}}

== Description ==
{{quote|The deepening mystery of Grace…

Maya Richter’s new faith is put to the ultimate test when her family aims to keep her far away from her new Christian friends. But why doesn’t Tom Richter want his daughter spending time with Grace Andrews and the Morrisons? That’s just one of the questions that leads the kids on their search for answers to Coleraine’s biggest secret.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 2

2024-08-23T01:33:06Z

Scientific Guy:

{{Infobox Collection
| subtitle = When Push Comes to Love
| kfkcd = 45387140825389
| kfkmp3 = 45387140858157
| amz = B004UR8OUC
| aud = B003UH4V8M
| apb = 380812456
}}

== Description ==
{{quote|Meet Maya Richter — the meanest girl in the whole school! In fact, her whole family seems to enjoy pushing their way to the top and letting everyone else know about it. But why don’t the Richters want anyone to get to know Grace Andrews? That’s what the Morrison kids want to find out as they try to introduce God’s love to this hurting family.

In these 12 episodes, you’ll learn more about the secret that many people in Coleraine want to keep hidden. And you’ll discover how Grace’s physical blindness gives her amazing insight into our need for God's mercy.|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Season 1

2024-08-23T01:32:37Z

Scientific Guy:

{{Infobox Collection
| subtitle = Crazy Grace
| kfkcd = 45387140759853
| kfkmp3 = 45387140792621
| amz = 9613122664
| aud = B003UGV6VI
| apb = 380805595
}}

== Description ==
{{quote|There’s something strange happening on Gilead Lane!

A mysterious new neighbor has everyone talking! But what’s the real story behind the rumors? It’s the town’s biggest mystery, and the Morrison kids want to know the truth about Crazy Grace.

The Morrisons are a family trying to live by God’s Word while dealing with life’s everyday challenges. When Brooke stresses out about her first day in high school, or when Michael tries to be nice to the meanest girl in school, how does God help them through it all?|Official summary}}

== Version Differences ==
{{Collection Differences}}

== Writers ==
{{Collection Writers}}

== Episodes ==
{{Episode list}}

Template:Infobox Collection

2024-08-23T01:32:05Z

Scientific Guy:

{{#vardefine:col|{{{name|{{PAGENAME}}}}}}}{{#if:{{{spc|}}}|{{DISPLAYTITLE:''{{PAGENAME}}''}}}}<div class="prevnext" style="padding: 1px 6px; font-size:10px; border: 1px solid #778FE1; width: 70%;{{radius|10}} background-color:#eaecf0;">
<div style="float:left;text-align:left;"><span class="prevLink">{{#ifeq:{{PAGENAME}}|Season 1|'''First Collection'''|[[{{#dpl:category=Collections|ordermethod=sortkey|count=1|format=,|include={Infobox Collection}/subtitle|skipthispage=no|offset={{#expr:{{#switch:{{#explode:{{PAGENAME}}| |0}}|Season={{#explode:{{PAGENAME}}| |1}}{{#ifexpr:{{#explode:{{PAGENAME}}| |1}}>=8|+1}}|Special=18|Lost=7|#default={{{spc}}}+13}}-2}}}}]]}}</span></div>
<div style="float:center;text-align:center;"><span class="thisPage">{{#switch:{{#explode:{{#var:col}}| |0}}|Season={{#var:col}}{{#if:{{{subtitle|}}}|: ''{{{subtitle}}}''}}|Special|Lost={{#var:col}}|#default=''{{#var:col}}''}}</span><span class="thisBullet" style="visibility:hidden;">{{·}}</span>
<div style="float:right;text-align:right;"><span class="nextLink">{{#switch:{{PAGENAME}}|Special episodes='''Final Collection'''|Lost episodes=[[Unproduced episodes]]|#default=[[{{#dpl:category=Collections|ordermethod=sortkey|count=1|format=,|include={Infobox Collection}/subtitle|skipthispage=no|offset={{#expr:{{#switch:{{#explode:{{PAGENAME}}| |0}}|Season={{#explode:{{PAGENAME}}| |1}}{{#ifexpr:{{#explode:{{PAGENAME}}| |1}}>=6|+1}}|Special=18|Lost=7|#default={{{spc}}}+13}}}}}}]]}}</span></div></div>
</div><div class="infobox" style="float:right;max-width:250px !important;clear:right;margin:5px 0 1em 1em;border:2px solid Crimson;background:#eaecf0;{{radius|10}} padding:10px;">
<div style="text-align:center;font-size:16px;line-height:1.5em;">
'''{{#switch:{{#explode:{{#var:col}}| |0}}|Season={{#var:col}}{{#if:{{{subtitle|}}}|: ''{{{subtitle}}}''}}|Special|Lost={{#var:col}}|#default=Collection {{{spc}}}: ''{{#var:col}}''}}'''<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid Crimson;"></div>
<div style="height:6px"></div>
[[File:{{{collection_image|{{#switch:{{#explode:{{PAGENAME}}| |0}}|Season={{padleft:{{#explode:{{PAGENAME}}| |1}}|2}}|Special=12|Lost=01|#default=S{{{spc}}}}}}}}.jpg|center|250px]]
</div>
{{#if:{{{caption|}}}|<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid #eaecf0;">
<span style="font-size: 95%; line-height:1.5em;">{{{caption}}}</span></div>
<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid Crimson;margin-top:5px;"></div>|<div style="clear:left;font-size:10px;text-align:center;border-top:9px solid #eaecf0;"></div>}}<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Number of Episodes</div>
<div style="width:125px;float:right;text-align:right;">[[:Category:{{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}|{{PAGESINCAT:{{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}}}]]</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Total Time</div>
<div style="width:125px;float:right;text-align:right;">MP3: <includeonly>{{SecToTime|{{SecInCat}}}}</includeonly>{{#switch:{{PAGENAME}}|Special episodes|Lost episodes=|#default=<includeonly><br>CD: {{SecToTime|{{SecInCat|type=cd}}}}</includeonly>}}</div>{{-}}
</div><div style="clear:left;font-size:10px;text-align:center;">
<div style="width:125px;float:left;text-align:left;">Original Release</div>
<div style="width:125px;float:right;text-align:right;">{{{rel_date|{{#sub:{{#dpl:category={{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}|ordermethod=sortkey|order=descending|count=1|format=,|include={Infobox Episode}:airdate}}|-4}}}}}</div>
</div>{{#if:{{{kfk|}}}{{{kfkcd|}}}{{{kfkmp3|}}}{{{amz|}}}{{{aud|}}}|<div style="clear:left;font-size:10px;text-align:center;border-top:2px solid Crimson;padding:5px 0px 0px 0px"></div>}}{{#if:{{{kfkcd|}}}{{{kfkmp3|}}}{{{amz|}}}{{{aud|}}}{{{apb|}}}|<div style="clear:left;font-size:10px;text-align:center;">
<div style="width:90px;float:left;text-align:left;">Purchase collection</div>
<div class="plainlinks" style="width:160px;float:right;text-align:right;">{{#if:{{{kfkcd|}}}|[https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkcd}}} Keys for Kids (CD) ][[File:CD icon.svg|14px|link=https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkcd}}}]]<br>}}{{#if:{{{kfkmp3|}}}|[https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkmp3}}} Keys for Kids (MP3) ][[File:Download icon.svg|14px|link=https://shop.keysforkids.org/products/{{{prefix|seasons}}}?variant={{{kfkmp3}}}]]<br>}}{{#if:{{{amz|}}}|[https://www.amazon.com/dp/{{{amz}}} Amazon (CD) ][[File:Amazon icon.svg|14px|link=https://www.amazon.com/dp/{{{amz}}}]]<br>}}{{#if:{{{aud|}}}|[https://www.audible.com/pd/{{{aud}}} Audible ][[File:Audible icon.svg|14px|link=https://www.audible.com/pd/{{{aud}}}]]<br>}}{{#if:{{{aud|}}}|[https://books.apple.com/audiobook/id{{{apb}}} Apple Books ][[File:Apple Books icon.svg|14px|link=https://books.apple.com/audiobook/id{{{apb}}}]]<br>}}
</div>{{-}}
</div>}}</div>{{{lead_section|{{#if:{{{spc|{{#ifeq:{{#explode:{{#var:col}}| |0}}|Season|Y}}}}}|'''{{#ifeq:{{#explode:{{#var:col}}| |0}}|Season|{{#var:col}}{{#if:{{{subtitle|}}}|: ''{{{subtitle}}}''}}|''{{#var:col}}''}}''' is the {{Ordinal|{{{spc|{{#explode:{{#var:col}}| |1}}}}}}} {{#if:{{{spc|}}}|collection of [[special episodes]] from [[Down Gilead Lane]]{{#ifeq:{{{spc|}}}|1|| and [[Beyond Gilead]]}}|regular season of [[{{#ifexpr:{{#explode:{{#var:col}}| |1}}<=6|Down Gilead Lane|Beyond Gilead}}]]}}.<nowiki /> Its episodes were written by {{#switch:{{#vardefineecho:numWriters|{{#dpl:titlematch={{#dpl:category=Episodes in {{PAGENAME}}|mode=userformat|include={Infobox Episode}:writer:writer2|format=,{{!}}}}|mode=userformat|resultsheader=%PAGES%}}}}|1={{#dpl:titlematch={{#dpl:category=Episodes in {{PAGENAME}}|mode=userformat|include={Infobox Episode}:writer|format=,{{!}}}}|format=,[[%TITLE%]]}}|2={{#dpl:titlematch={{#dpl:category=Episodes in {{PAGENAME}}|mode=userformat|include={Infobox Episode}:writer:writer2|format=,{{!}}}}|ordermethod=title|format=,[[%TITLE%]]|inlinetext=<nowiki /> and <nowiki />}}|#default={{#dpl:titlematch={{#dpl:category=Episodes in {{PAGENAME}}|mode=userformat|include={Infobox Episode}:writer:writer2|format=,{{!}}}}|ordermethod=title|format=,[[%TITLE%]], <nowiki />|count={{#expr:{{#var:numWriters}}-1}}}}and {{#dpl:titlematch={{#dpl:category=Episodes in {{PAGENAME}}|mode=userformat|include={Infobox Episode}:writer:writer2|format=,{{!}}}}|ordermethod=title|format=,[[%TITLE%]]|count=1|offset={{#expr:{{#var:numWriters}}-1}}}}}}{{#vardefine:airFirst|{{#dpl:category=Episodes|category={{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}|{{PAGESINCAT:{{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}}}|ordermethod=sortkey|count=1|mode=userformat|include={Infobox Episode}:airdate}}}}{{#vardefine:airLast|{{#dpl:category=Episodes|category={{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}|{{PAGESINCAT:{{#switch:{{PAGENAME}}|Special episodes=Special episodes|Lost episodes=Lost episodes|#default=Episodes in {{PAGENAME}}}}}}|ordermethod=sortkey|count=1|mode=userformat|include={Infobox Episode}:airdate|order=descending}}}}{{#ifeq:{{#var:airFirst}}|{{#var:airLast}}|<nowiki /> and aired on the radio in {{#var:airFirst}}|, began airing on the radio {{#ifeq:{{#len:{{#var:airFirst}}}}|4|in|on}} {{#var:airFirst}}, and finished airing {{#ifeq:{{#len:{{#var:airLast}}}}|4|in|on}} {{#var:airLast}}}}.}}}}}<includeonly>{{DEFAULTSORT:{{#switch:{{#explode:{{PAGENAME}}| |0}}|Season={{padleft:{{#explode:{{PAGENAME}}| |1}}|2}}|Special=17|Lost=06.5|#default=12+{{{spc}}}}}}}[[Category:Collections]]</includeonly>

A Hope by Any Other Name

2023-08-15T21:10:05Z

Scientific Guy: Scientific Guy moved page A Hope By Any Other Name to A Hope by Any Other Name without leaving a redirect

{{Infobox Episode
| ep_num = 152
| mp3 = 27:15
| cd = 27:17
| s_num = 12-1
| airdate = August 29, 2009
| theme = Being who God made you to be
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Cal Olsen
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Roy Wallace
| add_recording = Austin Rustoffer
| exec_producer = Terre Ritchie
}}

== Summary ==

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Mayor May Not, Part 2

2023-07-03T00:47:10Z

Scientific Guy:

{{Infobox Episode
| ep_num = 109
| mp3 = 27:35
| cd = 24:30
| s_num = 8-12
| airdate = 2007
| theme = Making sacrifices for a family member in need
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer and Sound Designer
| composer = John Campbell
| rec_engineer = Joel McCarter
| exec_producer = Terre Ritchie
}}

== Summary ==
As the Coleraine mayoral race comes to an end, John and Mary Morrison are left to pick up the pieces of their crumbling family.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

Mayor May Not, Part 1

2023-07-03T00:46:57Z

Scientific Guy:

{{Infobox Episode
| ep_num = 108
| mp3 = 23:59
| cd = 24:01
| s_num = 8-11
| airdate = 2007
| theme = The importance of sticking to priorities
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Joel McCarter
| exec_producer = Terre Ritchie
}}

== Summary ==
John, Mary, and Brooke have a revelation about Justin that may drastically change their entire family.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

A Steady Up

2023-07-03T00:46:38Z

Scientific Guy:

{{Infobox Episode
| ep_num = 107
| mp3 = 28:27
| cd = 28:29
| s_num = 8-10
| airdate = 2007
| theme = Putting hope in God alone
| writer = John Fornof
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Post-Producer
| composer = John Campbell
| rec_engineer = Joel McCarter
| exec_producer = Terre Ritchie
}}

== Summary ==
The ups and downs of the Morrisons’ campaign for mayor weigh heavily on the whole family, especially Justin.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

God Had a Plan, Part 2

2023-07-03T00:46:14Z

Scientific Guy:

{{Infobox Episode
| ep_num = 106
| mp3 = 23:44
| cd = 23:44
| s_num = 8-9
| airdate = 2007
| theme = Trusting God in tragedy
| writer = John Fornof
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Production Assistant
| composer = Steve Wick
| rec_engineer = Roy Wallace
| exec_producer = Terre Ritchie
}}

== Summary ==
Memories are flooding back for Tim Morrison as he comes to terms with his last moments with Mr. Key.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

God Had a Plan, Part 1

2023-07-03T00:45:58Z

Scientific Guy:

{{Infobox Episode
| ep_num = 105
| mp3 = 25:22
| cd = 25:24
| s_num = 8-8
| airdate = 2007
| theme = Seeing God’s hand in everything
| writer = John Fornof
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Production Assistant
| composer = Steve Wick
| rec_engineer = Roy Wallace
| exec_producer = Terre Ritchie
}}

== Summary ==
Confined to a hospital and his memory fading, Mr. Key has some unfinished business with Tom Richter… and with God.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==

It’s the Little Things

2023-07-03T00:45:39Z

Scientific Guy:

{{Infobox Episode
| ep_num = 104
| mp3 = 27:15
| cd = 27:17
| s_num = 8-7
| airdate = 2006
| theme = Doing your best to please the Lord
| writer = Lori Twichell
| director = Steve O’Dell
| post_producer = Elizabeth Bollman
| post_credit = Production Assistant
| composer = Forrest Wakeman
| rec_engineer = Roy Wallace
| exec_producer = Terre Ritchie
}}

== Summary ==
As Monica Richter’s campaign for mayor begins, the Morrison family starts to feel pressure from their opposition.

== Plot ==
{{Expand Plot}}

== Cast ==
{{NoCast}}

== Notes ==