DynamicPageList: Difference between revisions
Content deleted Content added
MarcoAurelio (talk | contribs) m Reverted changes by WhatAWonderfullWorld (talk) to last version by Tegel Tag: Rollback |
|||
(30 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 works also on Meta. 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 |
|||
==Page selection== |
|||
===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=Demo |
|||
category=Demo 1 |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
category=Demo 1 |
|||
</DynamicPageList> |
|||
This list will output pages that are in ''both'' [[:Category:Demo]] and [[:Category:Demo 1]]. |
|||
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=Demo |
|||
notcategory=Demo 1 |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
notcategory=Demo 1 |
|||
</DynamicPageList> |
|||
(list of pages that are in [[:Category:Demo]] but not in [[:Category:Demo 1]]). |
|||
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=Demo |
|||
namespace=Help |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
namespace=Help |
|||
</DynamicPageList> |
|||
(list of pages that are in the Help namespace and belong to [[:Category:Demo]]). |
|||
===redirects=== |
|||
Purpose: |
|||
Controls the inclusion or exclusion of redirect pages in lists. |
|||
Format: |
|||
<code>redirects=<i>criteria</i></code> |
|||
''criteria'' can be one of: |
|||
* ''exclude'' — excludes redirect pages from lists — '''(default)''' |
|||
* ''include'' — allows redirect pages to appear in lists |
|||
* ''only'' — lists ''only'' redirect pages in lists |
|||
Example: |
|||
Example: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
redirects=only |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
redirects=only |
|||
</DynamicPageList> |
|||
(list of redirect pages in [[:Category:Demo]]). |
|||
===count=== |
|||
Purpose: |
|||
Restricts the number of results that are shown. |
|||
Format: |
|||
<code>count=<i>number of results</i></code> |
|||
Example: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
count=2 |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
count=2 |
|||
</DynamicPageList> |
|||
(list of the two most recent pages in [[:Category:Demo]]). |
|||
Notes: |
|||
There is a maximum allowed number of results, controlled by a setting in the extension. |
|||
==Details displayed== |
|||
===shownamespace=== |
|||
Purpose: |
|||
Specify whether to display the namespace names of the pages (default=true). |
|||
Example: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
shownamespace=false |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
shownamespace=false |
|||
</DynamicPageList> |
|||
===addfirstcategorydate=== |
|||
Purpose: |
|||
Shows the date the article got added to the first listed include category. The linked page names are prepended with "DD Month YYYY: " (formatted according to your local mediawiki date display preferences). |
|||
Example: |
|||
<code>addfirstcategorydate=true</code> |
|||
If omitted, the default is ''false''. |
|||
Example: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
addfirstcategorydate=true |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
addfirstcategorydate=true |
|||
</DynamicPageList> |
|||
===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'' — outputs an unordered list — HTML tag "ul" — '''(default)''' |
|||
* ''ordered'' — outputs an ordered list — HTML tag "ol" |
|||
* ''none'' — outputs a list using newlines and HTML tags "br" to separate each item |
|||
Examples: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
mode=ordered |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
mode=ordered |
|||
</DynamicPageList> |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Demo |
|||
mode=none |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Demo |
|||
mode=none |
|||
</DynamicPageList> |
|||
===suppresserrors=== |
|||
Purpose: |
|||
Allows warnings about empty lists to be suppressed. |
|||
Format: |
|||
<code>suppresserrors=true</code> |
|||
(default is ''false''). |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Dem |
|||
suppresserrors=true |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Dem |
|||
suppresserrors=true |
|||
</DynamicPageList> |
|||
Compare: |
|||
<pre> |
|||
<DynamicPageList> |
|||
category=Dem |
|||
</DynamicPageList> |
|||
</pre> |
|||
gives |
|||
<DynamicPageList> |
|||
category=Dem |
|||
</DynamicPageList> |
|||
==Order== |
|||
===ordermethod=== |
|||
Purpose: |
|||
Determines what date is used for ordering the list. |
|||
Example: |
|||
<code>ordermethod=<i>method</i></code> |
|||
''method'' can be one of: |
|||
* ''categoryadd'' — outputs list based on most recent addition to the first category — '''(default)''' |
|||
* ''lastedit'' — 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'' — outputs list from most recent to least recent — '''(default)''' |
|||
* ''ascending'' — 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. |
|||
[[Category:MediaWiki extensions]] |
Latest revision as of 20:09, 16 October 2019
This page has been moved to Extension:DynamicPageList (Wikimedia) on mediawiki.org.
Any modifications or additions to this page should be made on mediawiki.org instead. |