Difference between revisions of "Example 1"

Revision as of 18:24, 31 January 2007

Our demo web site contains some articles on fictitious countries (this is also the name of their common category).

Extension:DynamicPageList (DPL), version 3.2.1: Warning: Unknown parameter 'inline' was ignored. Help: available parameters: addauthor, addcategories, addcontribution, addeditdate, addexternallink, addfirstcategorydate, addlasteditor, addpagecounter, addpagesize, addpagetoucheddate, adduser, allowcachedresults, allrevisionsbefore, allrevisionssince, articlecategory, cacheperiod, categoriesminmax, category, categorymatch, categoryregexp, columns, count, createdby, debug, distinct, dominantsection, eliminate, escapelinks, execandexit, firstrevisionsince, fixcategory, format, headingcount, headingmode, hiddencategories, hitemattr, hlistattr, ignorecase, imagecontainer, imageused, include, includematch, includematchparsed, includemaxlength, includenotmatch, includenotmatchparsed, includepage, includesubpages, includetrim, inlinetext, itemattr, lastmodifiedby, lastrevisionbefore, linksfrom, linksto, linkstoexternal, listattr, listseparators, maxrevisions, minoredits, minrevisions, mode, modifiedby, multisecseparators, namespace, noresultsfooter, noresultsheader, notcategory, notcategorymatch, notcategoryregexp, notcreatedby, notlastmodifiedby, notlinksfrom, notlinksto, notmodifiedby, notnamespace, nottitlematch, nottitleregexp, notuses, offset, oneresultfooter, oneresultheader, openreferences, order, ordercollation, ordermethod, qualitypages, randomcount, redirects, replaceintitle, reset, resultsfooter, resultsheader, rowcolformat, rows, rowsize, scroll, secseparators, showcurid, shownamespace, skipthispage, stablepages, suppresserrors, table, tablerow, tablesortcol, title, titlegt, titlelt, titlematch, titlemaxlength, titleregexp, usedby, userdateformat, uses.

They all use a template named "Country" which has parameters like capital. The template produces a small table and a link to the country list we want to generate. There are chapters on religion and history in most of the articles. We show how to create a sortable wikitable list of those articles which gives some excerpts of the contents. <javascript src="sorttable"/>

DPL can be used as a mediawiki parser extension, which means that a special DPL tag is used:

parser extension syntax

<DPL>
  category=Fictitious country
  includepage={Country} dpl,#History,#Religion[20]
  addpagecounter=true
  mode=userformat
  listseparators=\n{|class=sortablewikitable id=123 \n!Country \n!Official Name \n!Capital \n!Dial Code \n!History \n!Religion \n|-,\n|-\n|[[%PAGE%]] (%COUNT%)\n,\n,\n|}
  secseparators=,\n|,,
</DPL>

We select articles by category ("Fictitious Country") and explain that we want to see contents from the template "Country" and from two chapters. We truncate the text on religion to a maximum of 10 characters. We create a sortable table which contains the article name (as a link) and its access frequency in the first column and the content pieces in the other columns. Note that at the end of truncated contents you will find a small arrow which links directly to the chapter from where the contents was taken. The formatting for the template variables is done in a special template which is by convention named after the original tenmplate plus a suffix (Template:Country dpl in our case). This template is very simple; it only presents the values for name, capital and dial code as columns of a table.

country list

country list (2)

DPL can also be used as a mediawiki parser function, which is more powerful as it allows DPL to be used within templates, parameters being template calls or variable expansions. The disadvantage is that syntax looks less nice as the pipe character must be hidden in macros if used as a parameter contents. So the same example could also have been written as:

parser function syntax

{{#dpl:category=Fictitious country
  |includepage={Country} dpl,#History[50],#Religion
  |addpagecounter=true
  |mode=userformat
  |listseparators=\n{{(!}} class=sortablewikitable id=123
    \n!Country
    \n!Official Name
    \n!Capital
    \n!Dial Code
    \n!History
    \n!Religion
    \n{{!}}-,\n{{!-}}\n{{!}}[[%PAGE%]] (%COUNT%)\n,\n,\n{{!)}}
  |secseparators=,\n{{!}},,
}}

The result:

Have a look at a more realistic example ...