DynamicPageList: Difference between revisions

Add links
From Meta, a Wikimedia project coordination wiki
Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
→‎Using DynamicPageList: move section, to have two order sections together
m Reverted changes by WhatAWonderfullWorld (talk) to last version by Tegel
Tag: Rollback
 
(44 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{MovedToMediaWiki|Extension:DynamicPageList (Wikimedia)}}
This page in other languages:
* German translation of this page: [[DynamicPageList (de)]]
----
'''DynamicPageList''' is a Mediawiki 1.5 extension developed for use on [[n:en:Main Page|Wikinews]] (see [[n:Wikinews:DynamicPageList]] and e.g. [http://en.wikinews.org/w/index.php?title=Wikinews:2006/August/10&action=edit]), but can be installed on any wiki. It allows wiki users to create a list of pages that are listed in a set of categories.
'''An enhanced version of the extension is described at [[DynamicPageList2]]'''

The dynamic page list is in SVN at [http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/intersection/DynamicPageList.php mediawiki/trunk/extensions/intersection/DynamicPageList.php].
To install it, put the file in your <code>extensions/</code> directory, and add <code>include("extensions/DynamicPageList.php"); </code> to your LocalSettings.php file.

==Using DynamicPageList==

The Dynamic Page List (DPL) is a [[MediaWiki extensions|MediaWiki extension]]. To use it, use the following XML-like syntax on your wiki page:

<pre>
<DynamicPageList>
...parameters...
</DynamicPageList>
</pre>

The output of this would be something like:

* [[Page 1]]
* [[Page 2]]
* ...

where the list of pages being output, as well as the order and display mode of the list are set by the parameters specified.

The following lists parameters and their effects

===category===

Purpose:

DPL produces a list of all pages in the intersection of the specified categories (the pages which are in '''''all''''' of the listed categories).

Syntax:

<code>category=<i>category name</i></code>

Example:

<pre>
<DynamicPageList>
category=Africa
category=Politics and conflicts
</DynamicPageList>
</pre>

This list will output pages that have ''both'' the <nowiki>[[Category:Africa]] and [[Category:Politics and conflicts]]</nowiki> listed.

Notes:

At least one category parameter is '''required'''. There is a maximum number of category parameters allowed by the extension, configurable at installation time (see top of the extension file). You may use magic words like <nowiki>{{CURRENTMONTHNAME}}, {{CURRENTDAY}}, {{CURRENTYEAR}}</nowiki> etc in the category name.

===notcategory===

Purpose:

Restricts the list of pages specified above to those ''not'' in a particular category.

Syntax:

<code>notcategory=<i>category name</i></code>

Example:

<pre>
<DynamicPageList>
category=Africa
notcategory=Zimbabwe
</DynamicPageList>
</pre>

This list will output pages that have <nowiki>[[Category:Africa]]</nowiki> but ''do not'' have <nowiki>[[Category:Zimbabwe]]</nowiki> listed.

Notes: You may use magic words like <nowiki>{{CURRENTMONTHNAME}}, {{CURRENTDAY}}, {{CURRENTYEAR}}</nowiki> etc in the category name.

===namespace===

Purpose:

Restricts the list of pages specified above to those in a particular namespace.

Syntax:

<code>namespace=<i>namespaceid or name</i></code>

The namespaceid may be any positive integer or zero, assuming it represents a valid namespace in the system. The zero namespace is the main article namespace.

Instead of the number, you may also specify a name, for example Talk or Template or User_talk. Any invalid name is equivalent to the main article namespace.

Example:

<pre>
<DynamicPageList>
category=Policy
namespace=Wikinews
</DynamicPageList>
</pre>

This list will output pages that are in the ''Wikinews'' namespace and belong to <nowiki>[[Category:Policy]]</nowiki>.

===shownamespace===

Purpose:

Specify whether to display the namespace names of the pages (default=true).

With the code

<code>shownamespace=false</code>

instead of e.g. Template:Stub the listing would simply be Stub.

Example:

<pre>
<DynamicPageList>
category=Africa
namespace=Talk
shownamespace=false
</DynamicPageList>
</pre>

This list will output all Talk pages in <nowiki>[[Category:Africa]]</nowiki>, listed without the Talk: prepended to page names.

===mode===

Purpose:

To control the output of the DPL: with bullets, numbers, or nothing in front.

Syntax:

<code>mode=<i>modename</i></code>

''modename'' can be one of:
* ''unordered'' &mdash; outputs an unordered list &mdash; HTML tag "ul" &mdash; '''(default)'''
* ''ordered'' &mdash; outputs an ordered list &mdash; HTML tag "ol"
* ''none'' &mdash; outputs a list using newlines and HTML tags "br" to separate each item

Example:

<pre>
<DynamicPageList>
category=Africa
mode=ordered
</DynamicPageList>
</pre>

This list will output pages that have <nowiki>[[Category:Africa]]</nowiki> shown in an &lt;ol&gt;...&lt;/ol&gt; list.

===count===

Purpose:

Restricts the number of results that are shown.

Example:

<code>count=<i>number of results</i></code>

Example:

<pre>
<DynamicPageList>
category=Africa
count=2
</DynamicPageList>
</pre>

This list will output the two most recent pages that have <nowiki>[[Category:Africa]]</nowiki>.

Notes:

There is a maximum allowed number of results, controlled by a setting in the extension.

===ordermethod===

Purpose:

Determines what date is used for ordering the list.

Example:

<code>ordermethod=<i>method</i></code>

''method'' can be one of:
* ''categoryadd'' &mdash; outputs list based on most recent addition to the first category &mdash; '''(default)'''
* ''lastedit'' &mdash; outputs list based on most recent edit to the pages

Example:

<pre>
<DynamicPageList>
category=Africa
ordermethod=lastedit
</DynamicPageList>
</pre>

This list will output pages that have <nowiki>[[Category:Africa]]</nowiki> showing most recently edited articles at the top.

===order===

Purpose:

Controls the sort direction of the list.

Example:

<code>order=<i>orderdirection</i></code>

''orderdirection'' can be one of:
* ''descending'' &mdash; outputs list from most recent to least recent &mdash; '''(default)'''
* ''ascending'' &mdash; outputs list from least recent to most recent

Example:

<pre>
<DynamicPageList>
category=Africa
order=ascending
</DynamicPageList>
</pre>

This list will output pages that have <nowiki>[[Category:Africa]]</nowiki> shown ordered from oldest to newest.

===suppresserrors===

Purpose:

Allows warnings about empty lists to be suppressed.

Example:

<code>suppresserrors=true</code>

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

Example:

<pre>
<DynamicPageList>
category=Nonexistent
suppresserrors=true
</DynamicPageList>
</pre>

This list will output no pages since the category is non-existent, but will not show a warning saying the list is empty.

===redirects===

Purpose:

Controls the inclusion or exlusion of redirect pages in lists.

Example:

<code>redirects=<i>criteria</i></code>

''criteria'' can be one of:
* ''exclude'' &mdash; excludes redirect pages from lists &mdash; '''(default)'''
* ''include'' &mdash; allows redirect pages to appear in lists
* ''only'' &mdash; lists ''only'' redirect pages in lists


Example:

<pre>
<DynamicPageList>
category=Africa
redirects=include
</DynamicPageList>
</pre>

This list will content pages and redirect pages tagged with <nowiki>[[Category:Africa]]</nowiki>.

===addfirstcategorydate===

Purpose:

Shows the date the article got added to the first listed include category.

Example:

<code>addfirstcategorydate=true</code>

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

Example:

<pre>
<DynamicPageList>
category=Africa
addfirstcategorydate=true
</DynamicPageList>
</pre>

This list will output a list of pages belonging to <nowiki>[[Category:Africa]]</nowiki>, prepending each result with "DD Month YYYY: " (formatted according to your local mediawiki date display preferences).

[[Category:MediaWiki extensions]]

Latest revision as of 20:09, 16 October 2019

Retrieved from "https://meta.wikimedia.org/w/index.php?title=DynamicPageList&oldid=19464864"