Difference between revisions of "TemplatedPageList"

From Wiki4Intranet
Jump to: navigation, search
(Output)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{Extension4info
 +
|name=TemplatedPageList
 +
|description ru=Наше расширение для вывода списков вики-страниц. Похоже на DPL, поддерживает вывод по шаблону и имеет интерфейс на спецстранице.
 +
|description en=Page listing extension. Similar, but better in some ways than DPL & company. Supports template output and special page UI.
 +
|authors=[[User:VitaliyFilippov]]
 +
|created=2009-11-09
 +
|version=2012-12-12
 +
|included=2009-11-09
 +
|status=our
 +
|useful=likely
 +
}}
 +
{{ExtensionFromInfo|lang=en|name=TemplatedPageList}}
 +
 +
== Features ==
 +
 
This is Yet Another Page Listing extension. It is similar to DynamicPageList & company ([[mediawikiwiki:Extension:DynamicPageList (Wikimedia)|Intersection / Wikimedia’s DPL]], [[mediawikiwiki:Extension:DynamicPageList (third-party)|3rd party’s DPL]], [[mediawikiwiki:Extension:SubPageList|SubPageList]], [[mediawikiwiki:Extension:SubPageList2|SubPageList2]], [[mediawikiwiki:Extension:SubPageList2|SubPageList3]], etc), but the code is simpler and the functionality is more advanced.
 
This is Yet Another Page Listing extension. It is similar to DynamicPageList & company ([[mediawikiwiki:Extension:DynamicPageList (Wikimedia)|Intersection / Wikimedia’s DPL]], [[mediawikiwiki:Extension:DynamicPageList (third-party)|3rd party’s DPL]], [[mediawikiwiki:Extension:SubPageList|SubPageList]], [[mediawikiwiki:Extension:SubPageList2|SubPageList2]], [[mediawikiwiki:Extension:SubPageList2|SubPageList3]], etc), but the code is simpler and the functionality is more advanced.
  
Initially, it was just an improved [[mediawikiwiki:Extension:SubPageList2|SubPageList2]]. Then it survived several refactorings (previous authors probably were C-coders and big lovers of rounding integers (<tt>round(intval($options['count']))</tt>)) and feature additions.
+
Initially, it was just an improved [[mediawikiwiki:Extension:SubPageList2|SubPageList2]]. Then it survived several feature additions and refactorings (previous authors probably were C-coders and big lovers of rounding integers (<tt>round(intval($options['count']))</tt>)).
  
 
Features:
 
Features:
 
* (Main feature) '''&lt;subpagelist&gt;''' tag produces a simple or ''templated'' list of pages selected by dynamic conditions.
 
* (Main feature) '''&lt;subpagelist&gt;''' tag produces a simple or ''templated'' list of pages selected by dynamic conditions.
 +
* Special page with form interface to &lt;subpagelist&gt; ([[Special:TemplatedPageList]])
 
* <nowiki>{{#getsection|Title|section number}}</nowiki> parser function for extracting page sections by number.
 
* <nowiki>{{#getsection|Title|section number}}</nowiki> parser function for extracting page sections by number.
 
* Automatic AJAX display of subpages everywhere.
 
* Automatic AJAX display of subpages everywhere.
 
Details:
 
* Author: Vitaliy Filippov, 2009+
 
* License: GPLv2 or higher
 
* Code is part of [[MediaWiki4Intranet]] and lives on [http://code.google.com/p/mediawiki4intranet/source/browse/?name=mw4install#hg%2Fextensions%2FTemplatedPageList Google Code]
 
  
 
TODO:
 
TODO:
Line 33: Line 44:
  
 
Syntax is backwards compatible with [[mediawikiwiki:Extension:DynamicPageList_(Wikimedia)|Wikimedia’s DynamicPageList]] syntax,
 
Syntax is backwards compatible with [[mediawikiwiki:Extension:DynamicPageList_(Wikimedia)|Wikimedia’s DynamicPageList]] syntax,
except for 'firstcategorydate' related stuff. The text inside <tt>&lt;subpagelist></tt>
+
except for 'firstcategorydate' related stuff. The text inside <tt>&lt;subpagelist&gt;</tt>
 
is preprocessed, so you can use templates, magic words and parser functions
 
is preprocessed, so you can use templates, magic words and parser functions
 
inside it. Options are specified one per line.
 
inside it. Options are specified one per line.
  
=== Open tag ===
+
=== Open the tag or parser function ===
  
'''<tt>&lt;subpagelist&gt;</tt>''' (you can also use &lt;DynamicPageList&gt; or &lt;subpages&gt; for compatibility)
+
'''<tt>&lt;templatedpagelist&gt;</tt>''' (you can also use one of &lt;subpagelist&gt;, &lt;DynamicPageList&gt; or &lt;subpages&gt; for compatibility)
 +
 
 +
or
 +
 
 +
'''<tt><nowiki>{{#templatedpagelist:</nowiki></tt>'''
  
 
=== Page selection ===
 
=== Page selection ===
Line 62: Line 77:
  
 
;order|ordermethod = Y1 [asc|desc],Y2 [asc|desc],…: Sort pages by Y1,Y2,…, asc|desc can be specified right after Yi, each Yi is one of:
 
;order|ordermethod = Y1 [asc|desc],Y2 [asc|desc],…: Sort pages by Y1,Y2,…, asc|desc can be specified right after Yi, each Yi is one of:
:* title
+
:* title|fullpagename
:* titlewithoutnamespace
+
:* titlewithoutnamespace|pagename
 
:* lastedit
 
:* lastedit
 
:* user
 
:* user
Line 75: Line 90:
 
=== Output ===
 
=== Output ===
  
 +
;showtotal = yes|no: Show (or not) total count of found pages. Don't show by default.
 
;output = simple|column|template: Select output method.
 
;output = simple|column|template: Select output method.
 
:* Simple is just a bullet-list with page titles and links.
 
:* Simple is just a bullet-list with page titles and links.
Line 88: Line 104:
 
; suppresserrors|noerrors|silent = true: Suppress errors.
 
; suppresserrors|noerrors|silent = true: Suppress errors.
  
=== Close tag ===
+
=== Close tag / PF ===
 +
 
 +
'''<tt>&lt;/templatedpagelist&gt;</tt>'''
 +
 
 +
or
 +
 
 +
'''<tt><nowiki>}}</nowiki></tt>'''
 +
 
 +
== Installation ==
 +
 
 +
You just need to add the following to LocalSettings.php:
  
'''<tt>&lt;/subpagelist&gt;</tt>'''
+
<code-php>
 +
require_once "$IP/extensions/TemplatedPageList/TemplatedPageList.php";
 +
</code-php>

Latest revision as of 17:34, 17 April 2013

English

TemplatedPageList is a MediaWiki extension, designed for: Page listing extension. Similar, but better in some ways than DPL & company. Supports template output and special page UI.

Full description

Русский

TemplatedPageList — расширение MediaWiki, его назначение: Наше расширение для вывода списков вики-страниц. Похоже на DPL, поддерживает вывод по шаблону и имеет интерфейс на спецстранице.

Полная информацияTemplatedPageList is a MediaWiki extension.

Status for Mediawiki4Intranet distribution:

  • Inclusion date: 2009-11-09
  • Included version: newest available
  • Improvement status: Created by MediaWiki4Intranet project

Features

This is Yet Another Page Listing extension. It is similar to DynamicPageList & company (Intersection / Wikimedia’s DPL, 3rd party’s DPL, SubPageList, SubPageList2, SubPageList3, etc), but the code is simpler and the functionality is more advanced.

Initially, it was just an improved SubPageList2. Then it survived several feature additions and refactorings (previous authors probably were C-coders and big lovers of rounding integers (round(intval($options['count'])))).

Features:

  • (Main feature) <subpagelist> tag produces a simple or templated list of pages selected by dynamic conditions.
  • Special page with form interface to <subpagelist> (Special:TemplatedPageList)
  • {{#getsection|Title|section number}} parser function for extracting page sections by number.
  • Automatic AJAX display of subpages everywhere.

TODO:

  • Support «materialization» of lists in the DB, enable caching and support correct refreshing of parser cache by saving dependencies into database.

Automatic subpage listing

TemplatedPageList can add a simple link to each page, and when clicked, this link displays list of all subpages of current page.

$egSubpagelistAjaxNamespaces = array(NS_MAIN => true); setting enables this on namespaces specified.

$egSubpagelistAjaxDisableRE = "regexp"; is a regexp disables this on pages whose title match it.

{{#getsection}}

If you want to include first section of page, use the following instruction:

<includeonly>{{#getsection:0|{{:{{FULLPAGENAME}}|here|you|can|pass|parameters}}}}</includeonly>

<subpagelist> syntax

Syntax is backwards compatible with Wikimedia’s DynamicPageList syntax, except for 'firstcategorydate' related stuff. The text inside <subpagelist> is preprocessed, so you can use templates, magic words and parser functions inside it. Options are specified one per line.

Open the tag or parser function

<templatedpagelist> (you can also use one of <subpagelist>, <DynamicPageList> or <subpages> for compatibility)

or

{{#templatedpagelist:

Page selection

namespace = Main|Talk|…
Restrict list to some namespaces
category = A|B|C
category = D|E
Restrict page list to pages which are in one of these categories. This option may be specified multiple times, following occurrences will be appended as a conjunction, i.e., the resulting expression will be (A or B or C) & (D or E). This is compatible with Wikimedia’s DynamicPageList syntax, but allows more complex queries.
subcategory = F|G
Like previous, but recursively including all subcategories of F and G.
notcategory = A
Exclude pages which are in category A.
notsubcategory = B
Exclude pages from category B and all its subcategories.
parent = P
Restrict listing to subpages of P.
prefix = P
Restrict listing to pages whose title starts with P. I.e. parent=P is equivalent to prefix=P/.
level = L or MIN..MAX
Set wanted subpage nesting levels (i.e. number of '/' in title) it must be equal to L or be within MIN..MAX.
deepness = D or MIN..MAX
Set wanted subpage nesting levels, relative to parent.
ignore = L1|L2|…
Ignore pages which match L1 or L2 or … LIKE patterns:
  • '\_' and ' ' match single space.
  • '_' matches any single character.
  • '%' matches any substring.
  • '\%' matches single '%' character.
redirect = yes|no
restring listing to redirect or non-redirect pages.

Ordering

order|ordermethod = Y1 [asc|desc],Y2 [asc|desc],…
Sort pages by Y1,Y2,…, asc|desc can be specified right after Yi, each Yi is one of:
  • title|fullpagename
  • titlewithoutnamespace|pagename
  • lastedit
  • user
  • creation|firstedit
  • length|size
  • popularity|pagecounter
order = ASC or DESC
Ascending or descending sort order for all Yi (compatibility)
count|limit = N
Show at most N pages
offset = M
Skip first M pages

Output

showtotal = yes|no
Show (or not) total count of found pages. Don't show by default.
output = simple|column|template
Select output method.
  • Simple is just a bullet-list with page titles and links.
  • Column is a 3-column grouped view, just as on MediaWiki category pages.
  • Templated view uses template for display. See 'template' option.
template = X
Use template:X for output. The template will be preprocessed just like when included into listed article. I.e. all standard MediaWiki magic variables ({{PAGENAME}} {{REVISIONDAY}} etc) will generate values corresponding to listed articles. Additionally, the following parameters are passed to this template:
{{{index}}} 
list index, beginning at 0
{{{number}}} 
list index, beginning at 1
{{{odd}}} 
is {{{number}}} odd? (1 or 0)
{{{ns_N}}} 
N is namespace index, value is 1
{{{title}}} 
full title
{{{title_rel}}} 
title relative to parent specified in options
suppresserrors|noerrors|silent = true
Suppress errors.

Close tag / PF

</templatedpagelist>

or

}}

Installation

You just need to add the following to LocalSettings.php:

require_once "$IP/extensions/TemplatedPageList/TemplatedPageList.php";