Arbeiten mit DPL3
Basics of DynamicPageList3 (23.07.2025)
DynamicPageList3 generates lists of pages, page properties (metadata), and/or template parameter values, for display in other articles.
Manual: https://dpl3.wikitide.org/wiki/Main_Page
Basic use of DPL3 works similar to that of Templates / Parser Functions:
{{#dpl:
|parameter1 = xy
|parameter2 = yx
}}
The different parameters structure which pages are included, what content from these pages is included, and how the output is formatted.
Inclusion Criteria: Page Selection
DPL3 needs criteria for what to include in the list it generates. Some possible choices are:
- category OR notcategory
- (category=Illustration)
- namespace
- (namespace=Template)
- links
- (linksfrom=Projektseite)
- (linksto=Arbeiten mit DPL3)
- use of templates
- (uses=Template:ImageMetadata)
- title (Select one single page by its (namespace and) title, requires additional parameters)
- (title=Projektseite |include=#Temporäre Hilfe-Seiten)
- contents
Restricting the output to a certain number of results can be done with "count" (count=2).
Example:
The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function).
Result of the function call:
- File:Hf 1885 kmb ch001 ill1.jpg
- File:Hf 1885 kmb ch001 ill2.jpg
- File:Hf 1885 kmb ch001 ill3.jpg
- File:Hf 1885 kmb ch001 ill4.jpg
Inclusion Criteria: Output Volume
The default list view only includes the page name as a link in a basic list format (unordered list). Other data can be included from each page to:
- Specify a header/footer to show when results are found or not found
- Show the number of articles in the result set
- Add metadata (size, author, last edited by, date of last change, etc.) to the output (not discussed below, refer to the manual)
- Include contents from articles (text, template variables, etc.)
- Cut off the articles' content at a certain length
Some possible parameters are:
- resultsheader / oneresultheader / noresultheader
- resultsfooter / onersultfooter / noresultfooter
- (resultsheader = There are %PAGES% entries.)
- include
- (include=*)
- (include=%0[200])
- (include={ImageMetadata}:work-title:year:%PAGE%)
Example:
The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function). Some include statements only make sense in combination with specific page selection criteria.
Result of the function call:
There are 4 entries.
- File:Hf 1885 kmb ch001 ill1.jpgAdventures of Huckleberry Finn |1885 |:File:Hf 1885 kmb ch001 ill1.jpg
- File:Hf 1885 kmb ch001 ill2.jpgAdventures of Huckleberry Finn |1885 |:File:Hf 1885 kmb ch001 ill2.jpg
- File:Hf 1885 kmb ch001 ill3.jpgAdventures of Huckleberry Finn |1885 |:File:Hf 1885 kmb ch001 ill3.jpg
- File:Hf 1885 kmb ch001 ill4.jpgAdventures of Huckleberry Finn |1885 |:File:Hf 1885 kmb ch001 ill4.jpg
Output Format
The Basic output format of DPL3 functions is a list. Without styling, additional text that is included via Output Volume appears directly next to the page name link.
There are some predefined styling options with many options for adjustment. Basic formatting includes the "mode" parameter:
- (mode=unordered) (default)
- (mode=ordered)
- (mode=none)
- (mode=inline)
- (inlinetext= • )
- (mode=category) (requires "ordermethod" with one of the values: title; titlewithoutnamespace; category,title; or user,title).
- (mode=userformat)
OR the "table" parameter:
- (include={ImageMetadata}:work-title:year |table=class="wikitable imageTable", Image, Work Title, Year)
Example:
The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function). Some include statements only make sense in combination with specific page selection criteria.
Result of the function call:
| Image | Work Title | Year |
|---|---|---|
| Hf 1885 kmb ch001 ill1.jpg | Adventures of Huckleberry Finn | 1885 |
| Hf 1885 kmb ch001 ill2.jpg | Adventures of Huckleberry Finn | 1885 |
| Hf 1885 kmb ch001 ill3.jpg | Adventures of Huckleberry Finn | 1885 |
| Hf 1885 kmb ch001 ill4.jpg | Adventures of Huckleberry Finn | 1885 |
Userformat Output
"Userformat" mode makes the output fully flexible, enabling formatting with wikitext and supported html elements. This mode has a system of three tags which are used to enclose (a) the whole output, (b) each item, (c) each transcluded section of an item; they can also contain variables:
- listseparators
- (listseparators = <Outputstart>,<Itemstart>,<Itemend>,<Outputend>)
- (listseparators = \n Start of the List \n,~ , \n,\n End of the List)
- secseparators
- (secseparators=1a,1b,2a,2b,3a,3b)
Example:
The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function).
Result of the function call: AB1aAdventures of Huckleberry Finn1b2a18852b3ahf_1885_kmb_ch001_ill13bCB1aAdventures of Huckleberry Finn1b2a18852b3ahf_1885_kmb_ch001_ill23bCB1aAdventures of Huckleberry Finn1b2a18852b3ahf_1885_kmb_ch001_ill33bCB1aAdventures of Huckleberry Finn1b2a18852b3ahf_1885_kmb_ch001_ill43bCD
Result of the function call:
A
- B Hf 1885 kmb ch001 ill1.jpg a Adventures of Huckleberry Finn b c (1885) d e hf_1885_kmb_ch001_ill1 f C
- B Hf 1885 kmb ch001 ill2.jpg a Adventures of Huckleberry Finn b c (1885) d e hf_1885_kmb_ch001_ill2 f C
- B Hf 1885 kmb ch001 ill3.jpg a Adventures of Huckleberry Finn b c (1885) d e hf_1885_kmb_ch001_ill3 f C
- B Hf 1885 kmb ch001 ill4.jpg a Adventures of Huckleberry Finn b c (1885) d e hf_1885_kmb_ch001_ill4 f C
D
The parameter "format" implicitly sets "mode=userformat" and enables similar styling to the "listseperator" parameter.
- (format=A,B,C,D,E)
- (format=,\n%PAGE%, \n ,)
- (|uses=Template:ImageMetadata |format = «gallery mode="packed" widths="80px" heights="80px"»,%PAGE%\n,,«/gallery»)
Example:
The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function).
Result of the function call:
File:Hf 1885 kmb ch001 ill1.jpgAdventures of Huckleberry Finn1885hf_1885_kmb_ch001_ill1
File:Hf 1885 kmb ch001 ill2.jpgAdventures of Huckleberry Finn1885hf_1885_kmb_ch001_ill2
File:Hf 1885 kmb ch001 ill3.jpgAdventures of Huckleberry Finn1885hf_1885_kmb_ch001_ill3
File:Hf 1885 kmb ch001 ill4.jpgAdventures of Huckleberry Finn1885hf_1885_kmb_ch001_ill4
Table Output
The "table" parameter creates a standard wikitable in wikitext syntax. If no class attribute is specified, the default class is "wikitable". Relevant parameters are:
- table
- (table= ,Header1,Header2,Header3,Header4,Header5)
- (table= class="imageTable wikitable" style="color:seagreen; font-weight:600;", File, Title, Work Title, Year, Chapter)
- tablerow
- (tablerow=%%,%%,%%,%%,%%)
- (|include={ImageMetadata}:%TITLE%:ill-title:work-title:year:chapt |table= ,-,Image,Title,Book Title,Year of Publication,Chapter |tablerow=File:%%,%%,%%,%%,%%)
- tablesortcol (number starting at 1)
Example: The example can be changed to see how the different parameters work in real time (using the Preview all changes can be observed while working on the parser function).
Result of the function call:
| Image | Title | Book Title | Year of Publication | Chapter |
|---|---|---|---|---|
| Hf 1885 kmb ch001 ill1.jpg | The Widow's | Adventures of Huckleberry Finn | 1885 | 1 |
| Hf 1885 kmb ch001 ill2.jpg | Learning about Moses and the "Bulrushers" | Adventures of Huckleberry Finn | 1885 | 1 |
| Hf 1885 kmb ch001 ill3.jpg | Miss Watson | Adventures of Huckleberry Finn | 1885 | 1 |
| Hf 1885 kmb ch001 ill4.jpg | Huck Stealing Away | Adventures of Huckleberry Finn | 1885 | 1 |