Update note: In August 2023 the css styling is changed a bit. The specific styles for each cell are replaced by more general styles. Also all styles, except simplelist, got an additional class plgn__pglist to target better this plugin with your own styling.

The Pagelist Plugin takes a list of wiki pages and provides a nicely formatted table with information about them. The plug-in has a number of flags that can be used to control the information and format of the page list. The user can provide a list of specific page references as can some popular helper plugins such the Blog, Discussion, Editor, Tag, Task and Dir plugins.

Just wrap a regular unordered list of internal links with the <pagelist> tag. You may provide specific internal page references or have plug-ins supply them as in the example below:

<pagelist&[flags]>
  * [[..:blog:|Blog Plugin]]
  * [[..:discussion:|Discussion Plugin]]
  * [[..:editor:|Editor Plugin]]
  * [[..:tag:|Tag Plugin]]
  * [[..:wrap|Wrap Plugin|This is shown in the description cell]]
</pagelist>

The sortby=<property> flag uses the info directly from the data supplied (e.g. if used in another plugin), or tries to compile or retrieve it from metadata. It sorts default by id. Next to the column names as used internally in the provided data, you can use pagename for using only the pagename part of the id thus ignoring the namespace part, or ns for sorting pages before equal named namespaces. title uses the first headline of a page. Other property names are: date, user, desc, summary, and if the respectively plugin is available: comments, linkbacks, tags and image. If called in other plugins these can eventually add their own columns as well.

<pagelist&header&comments>
    //an unordered list of pages to display//
</pagelist>

In the example above, pagelist will display information about the provided pages in a table with a header line and a comments column (if the Discussion Plugin is installed). The user (or a plugin) must supply the specific pages to display in the list.

The plugin can be configured using the DokuWiki configuration manager available in the admin menu. The settings also apply to plugins which use the helper component of the pagelist plugin, like for example the archive component of the blog plugin.

You can easily use the functionality of the Pagelist Plugin in your own plugins. Here is a basic code snippet:

$pages = [
    ['id' => 'wiki:dokuwiki'],
    ['id' => 'wiki:syntax'],
];
$pagelist = $this->loadHelper('pagelist');
if (!$pagelist) return false; // failed to load plugin
$pagelist->startList();
foreach ($pages as $page){
    $pagelist->addPage($page);
}
$renderer->doc .= $pagelist->finishList();

Since release 2017-08-24 the function startList() has got an optional parameter to specify a CSS class for adding it to the class of the table element:

  $pagelist->startList('myclass');

For more details, see How to use Pagelist in your plugin.

Please report bugs or feature requests at the Bug tracker.

• Version upped by splitbrain (2023-08-27 23:50)
• Merge pull request #154 from dokufreaks/sort by Klap-in (2023-08-27 13:54)
• bit refactoring by Klap-in (2023-08-27 13:53)
• fix adding default class by Klap-in (2023-08-27 13:52)
• order config settings more logic by Klap-in (2023-08-27 12:46)
• Update plugin.info.txt by Klap-in (2023-08-26 23:31)
• Merge pull request #153 from dokufreaks/sort by Klap-in (2023-08-26 01:09)
• refactor css; generalize styling of td/th otherwise new columns are d… by Klap-in (2023-08-26 00:26)

Submit translation via the translation tool: https://translate.dokuwiki.org/plugin/pagelist