Extension - DPL3/Table Example
From Dragon Mania Legends (DML) Wiki
< Help:Extension - DPL3_Icon.png){kind=icon}
Creating a formatted table in DPL3 can be a bit challenging, fortunately a step-by step approach (with examples) can make it much easier.
Contents
Table Output[edit]
An example of creating a DPL auto-table (only Bureaucrats should work with DPL3) is page name here page.
Select Pages[edit]
First we need to select the right pages to list in the output, so we start simple there.
Note: Notice the difference in syntax between the two different DPL use methods!
First we'll start with just displaying the list of items for output to see if we're getting the pages we expect.
Caution: Always intentionally limit the number of possible results you can get with count=5to avoid an unintentional huge result set:
Code:
{{#dpl:
|category=Dragons
|notcategory=Clan Dragons
|notcategory=Boss Dragons
|count=5
}}
Result
First we'll start with just displaying the list of items for output to see if we're getting the pages we expect (intentionally limited via count=5 to avoid a huge result set):
Code:
<dpl> category=Dragons notcategory=Clan Dragons notcategory=Boss Dragons count=5 </dpl>
Result
OOPS! Nope, ↑ that (above) is not what we wanted, and why testing initial output before output is so important.
We wanted Dragons-only so we need a category that houses only Dragons (which Standard Dragons does):
First we'll start with just displaying the list of items for output to see if we're getting the pages we expect (intentionally limited via count=5 to avoid a huge result set):
Code:
{{#dpl:
|category=Standard Dragons
|notcategory=Clan Dragons
|notcategory=Boss Dragons
|count=5
}}
Result
First we'll start with just displaying the list of items for output to see if we're getting the pages we expect (intentionally limited via count=5 to avoid a huge result set):
Code:
<dpl> category=Standard Dragons notcategory=Clan Dragons notcategory=Boss Dragons count=5 </dpl>
Result
Include/Volume[edit]
Okay, so now that we're getting the pages listed in the output that we wanted/needed, lets include some template parameter values with it, we'll do page title, then cost. The "include" can be used to set parameter values to include in simple output (inline or table), separated by colons:
Simple List Include[edit]
By default the page name is already output into a simple list, so referencing the {template}:parameter will include a page's parameter value (or chain of them {template}:cost:base:second:third) followed by a comma. This lets us test that we're getting the parameter values from the template:
Code:
{{#dpl:
|category=Standard Dragons
|notcategory=Clan Dragons
|notcategory=Boss Dragons
|include = {DragonBox}:cost,
|count=5
}}
Result:
- Butterfly Dragon1,980
- Frankie Dragon1,820
- Stache Dragon4,000
- Pumpkin Dragon1,666
- Submarine Dragon1,080
Simple Table with Include[edit]
Okay, now that we're getting the output we want, we can look at formatting it into a table. Notice we have:
to set formatlistseparatorsto start the table, set its header, and end the table.secseparatorscustomize the output format of included sections.secseparators=Start1,End1,Start2,End2,..,..
{{#dpl:
|category = Uncommon (classification)
|notcategory = Clan Dragons
|notcategory = Boss Dragons
|include = {DragonBox}:[[%PAGE%|%TITLE%]]:cost,
|mode = userformat
|count=5
|listseparators = \n{¦class="wikitable sortable" \n¦-\n!Dragon \n!Cost ,\n¦-,\n¦-\n¦-,\n¦}
|secseparators = \n¦class="orange-box"¦,,\n¦,
}}
Result:
| Dragon | Cost |
|---|---|
| Armored Dragon | 400 |
| Assassin Dragon | 8 |
| Bee Dragon | 325 |
| Breeze Rock Dragon | 299 |
| Brick Dragon | 425 |
Note: Formatting is very limited in this simple table mode, for advanced formatting use a surrogate template.
<dpl>
category = Uncommon (classification)
notcategory = Clan Dragons
notcategory = Boss Dragons
include = {DragonBox}:[[%PAGE%|%TITLE%]]:cost,
mode = userformat
count = 5
listseparators = ¶{|class="wikitable sortable" ¶|-¶!Dragon ¶!Cost ,¶|-,¶|-¶|-,¶|}
secseparators = ¶|class="orange-box"|,,¶|,
</dpl>
Result:
| Dragon | Cost |
|---|---|
| Armored Dragon | 400 |
| Assassin Dragon | 8 |
| Bee Dragon | 325 |
| Breeze Rock Dragon | 299 |
| Brick Dragon | 425 |
Table w/Surrogate Template to Calculate[edit]
BUT, a plain unformatted table doesn't exactly accomplish what we're after, and we can't put code in include statements, it won't work... so we can choose to instead use a surrogate template to format the content of the table.
Info coming soon
Surrogate templates are templates that "chain" off of the template used to create the results on pages in your list. So for Dragons, this template is {{DragonBox}}. I create a new template with a suffix that describes what it is for (in this case Dragon Cost Compairison) which results in: {{DragonBox.dragoncostcomparison}}. Now that template formats the body of each line in the table. So the table already has a start and end, plus | separators at the very start and very end of each line. It's the content in-between that the surrogate template governs, and what it's content should prescribe, the lines that create the middle of the table (and can include parser functions, DPL variables, other templates etc.
includepage={TemplateName}.suffixcalls the template and tells DPL to use it to format each line.- The contents of the surrogate should only be for 1 line, DPL will apply it repeatedly to the rest.
- Use DPL variables to retrieve information, and use
{{{cost}}}parameters. - User parser functions to calculate stuff as usual.
Code:
{{#dpl:
|category=Standard Dragons
|notcategory=Clan Dragons
|notcategory=Boss Dragons
|count=20
|includepage={DragonBox}.dragoncostcomparison
|allowcachedresults = true
|mode = userformat
|listseparators = ¶{¦class="wikitable sortable" ¶¦-¶!Event ¶!Type ,¶¦-,¶¦-¶¦-,¶¦}
|secseparators = ¶¦,,¶¦class="dpl dark-background"¦,
}}
Result:
| Event | Type |
|---|---|
1,980 
| |
| 1,820
| |
| 4,000
| |
| 1,666
| |
| 1,080
| |
| 1,875
| |
| 1,600
| |
| 1,150
| |
| 962
| |
| 1,555
| |
| 1,611
| |
| 1,615
| |
| 1,808
| |
| 1,814
| |
| 1,695
| |
| 1,200
| |
| 1,010
| |
30 
| |
| 1,888
| |
| 995
|
Code:
<dpl>
category=Standard Dragons
notcategory=Clan Dragons
notcategory=Boss Dragons
count=20
includepage={DragonBox}.dragoncostcomparison
allowcachedresults = true
mode = userformat
listseparators = ¶{|class="wikitable sortable" ¶|-¶!Event ¶!Type ,¶|-,¶|-¶|-,¶|}
secseparators = ¶|,,¶|class="dpl dark-background"|,
</dpl>
Result:
| Event | Type |
|---|---|
| 1,980
| |
| 1,820
| |
| 4,000
| |
| 1,666
| |
| 1,080
| |
| 1,875
| |
| 1,600
| |
| 1,150
| |
| 962
| |
| 1,555
| |
| 1,611
| |
| 1,615
| |
| 1,808
| |
| 1,814
| |
| 1,695
| |
| 1,200
| |
| 1,010
| |
| 30
| |
| 1,888
| |
| 995
|