Pagelist Plugin

The Pagelist Plugin does – as its name says – list wiki pages in a nice way. Besides its function as a stand-alone syntax plugin, it serves as helper plugin for the Blog, Discussion, Editor, Tag, Task and Dir plugins.

Just wrap a regular unordered list of internal links with the <pagelist> tag:

<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>

<pagelist&header&comments>
...
</pagelist>

This will show a list of pages with a header line and a comments column (if the Discussion Plugin is installed).

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 = array(
    array('id' => 'wiki:dokuwiki'),
    array('id' => 'wiki:syntax'),
  );
  $pagelist =& plugin_load('helper', 'pagelist');
  if (!$pagelist) return false; // failed to load plugin
  $pagelist->startList();
  foreach ($pages as $page){
    $pagelist->addPage($page);
  }
  $renderer->doc .= $pagelist->finishList();

You can try this plugin here. (link broken)

Please report bugs or feature requests at the Bug tracker.

• Git Repository
• Bug Tracker

• Merge pull request #22 from lupo49/master (2011/12/26 13:03)
• added option to reverse sort pages by pagename (2011/12/26 13:01)
• Merge HEAD, branch 'master' of github.com:lupo49/plugin-pagelist (2011/12/26 12:54)
• added option to revsere sort the pages (2011/12/26 12:52)
• helper.php: added some comments (2011/07/29 20:21)
• Merge pull request #17 from lupo49/master (2011/07/17 12:45)
• Specify always a new page title (Issue 13 tag plugin) (2011/07/17 12:42)
• Merge pull request #16 from lupo49/master (2011/05/10 13:10)

This is a place for general plugin discussion. Please submit bugs and feature requests to bug tracker linked on this page.

Is it correct that I need to comment out the renderer if I want to prevent a “create this page” under the commentlist? ¹⁾

            // show form to start a new discussion thread?
            if ($perm_create && ($this->getConf('threads_formposition') == 'bottom'))
//                $renderer->doc .= $this->_newThreadForm($ns);
            return true;

You should set the configuration option threads_formposition to off instead. — Phil 2010/01/29 16:05

I want to add two columns for a plugin. But the function addColumn only support one column for one plugin. How can I do this?

need the same, very important!! — alfiox 2010-12-22

Also need. If the “list” layout used html “list” syntax instead of being buried inside a table with invisible lines, I think it could interact with the wrap plugin to make columns. — Ashtagon 2011-07-28

That is quite complicated with the current layout of the plugin. The data storage isn't built to fetch multiple columns of another plugin. — M. S.M. S.
lupo49

DE / NRW / Sauerland 2011/07/29 20:32

If the pagelist plugin (or more important for my needs, teh tag plugin, which I think uses the same engine) had an option to return an actual list rather than a table that contains cells which are rendered to look like a list, the problem could then be solved by passing this plugin's output through the wrap plugin's <div col3>{{topic>your flags here}}</div> syntax. — AshtagonAshtagon

London, UK 2011/08/20 12:00

I went through the code. Inserting between 4 and 5 if statements that cause it to use an unordered list when $this→style == 'list' fixed it for me. I also had to ensure that it was only adding things when it should. But, overall, it wasn't that big of a deal. EDIT: I figured you guys would want to see it. Also, I am using the wrap plugin, so I edited helper.php to be compatible with that, it doesn't natively allow you to use multiple columns. http://pastebin.com/1HDytYdh WARNING: I only tested it using just the page name; I didn't use date or user or anything as I am using pagelist and tag to simulate the mediawiki category pages. YMMV and it might not work with other configs. Good luck! — serenewafflesserenewaffles

2012/01/07 22:18
I commented on the open bug on the tracker with explanation and pastebin — serenewafflesserenewaffles

2012/01/07 22:27
https://github.com/dokufreaks/plugin-pagelist/issues/15

Thanks for sharing your experiences. Could you please use the option “Minor Changes” when editing multiple times in a row, otherwise it generates a mail for every saving process. — M. S.M. S.
lupo49

DE / NRW / Sauerland 2012/01/07 22:58

How to show the “edit summary” of the latest edit? — Flavius

changes — M. S.M. S.
lupo49

DE / NRW / Sauerland 2011/02/15 19:03

I would like to use pagelist together with “changes”-plugin to list those changes (within a namespace) that have been made on a specific date (e.g. 2011/01/13). How can i tell pagelist to do that? Thanks for help in advance! — Peter