====== Pagelist Plugin ======

---- plugin ----
description: Lists pages in a nice looking table or unordered list. (previous authors: Esther Brunner)
author     : Gina Häußge, Michael Klier
email      : dokuwiki@chimeric.de
type       : syntax, helper
lastupdate : 2010-01-07
compatible : 2009-12-25, 2009-02-14, 2008-05-05, rc2008-03-31, 2006-11-06
depends    : 
conflicts  :
similar    : 
tags       : formatting, list, tables, pages

downloadurl: http://cloud.github.com/downloads/dokufreaks/plugin-pagelist/plugin-pagelist.tgz
sourcerepo : http://github.com/dokufreaks/plugin-pagelist
bugtracker : http://github.com/dokufreaks/plugin-pagelist/issues
donationurl: 
----

===== Description =====

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.

===== Syntax =====

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]]
  </pagelist>

^ [flags] | flags can be used to alter the appearance of the pagelist, see [[#flags]] | optional |

==== Flags ====

^ Setting ^ Default ^^ Alternative ^^
| ''style'' ^ ''default'' | table with horizontal lines ^ ''table'' or ''list'' | standard DokuWiki table or list style |
| ''showheader'' ^ ''noheader'' | hide the heading row of the pagelist table ^ ''header'' | show the header |
| ''showdate'' ^ ''date'' | show the creation or last modification date ^ ''nodate'' | hide the date |
| ''showuser'' ^ ''user'' | show creator or contributors ^ ''nouser'' | hide the user |
| ''showdesc'' ^ ''nodesc'' | hide the description ^ ''desc'' | show the description (from metadata) |
| ''showcomments'' ^ ''nocomments'' | hide the number of comments ^ ''comments'' | show the number of comments (if [[discussion|Discussion Plugin]] is installed) |
| ''showtags'' ^ ''notags'' | hide the tags ^ ''tags'' | show the tags (if [[tag|Tag Plugin]] is installed) |
| ''showfirsthl'' ^ ''firsthl'' | show the first headline ^ ''nofirsthl'' | show the page name |

==== Example ====

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

This will show a list of pages with a header line and a comments column (if the [[plugin:discussion|Discussion Plugin]] is installed).

===== Configuration =====
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 [[plugin:blog]] plugin.

^ ''style'' | List style (default, list, table) |
^ ''showheader'' | Show table header |
^ ''showdate'' | Shows/hides the date column (hide, creation date, modification date) |
^ ''showuser'' | Shows/hides the user column (hide, creator, contributors) |
^ ''showdesc'' | Shows/hides a short description taken from the first paragraph of a page (hide, max. 160 characters, max. 500 characters) |
^ ''showcomments'' | Shows/hides comments of a page (requires the [[plugin:discussion]] plugin) |
^ ''showlinkbacks'' | Shows/hides linkbacks of a page (requires the [[http://foosel.org/snippets/dokuwiki/linkback|linkback]] plugin) |
^ ''showtags'' | Shows/hides tags of a page (requires the [[plugin:tag]] plugin) |

===== Helper Plugin =====

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

<code php>
  $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();
</code>


===== Demo =====

You can try this plugin [[http://chimeric.de/_demo/plugin:pagelist|here]].

===== Bugs / Feature Requests =====
Please report bugs or feature requests at the [[http://github.com/dokufreaks/plugin-pagelist/issues|Bug tracker]].

===== Further Resources =====
  * [[http://github.com/dokufreaks/plugin-pagelist/tree/master|Git Repository]]
  * [[http://github.com/dokufreaks/plugin-pagelist/issues|Bug Tracker]]

===== Changes =====

{{rss>http://github.com/feeds/dokufreaks/commits/plugin-pagelist/master}}

===== Discussion =====

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


==== Suppressing the new thread  ====

Is it correct that I need to comment out the renderer if I want to prevent a "create this page" under the commentlist? ((/lib/plugins/discussion/syntax/threads.php))
<code>
            // show form to start a new discussion thread?
            if ($perm_create && ($this->getConf('threads_formposition') == 'bottom'))
//                $renderer->doc .= $this->_newThreadForm($ns);
            return true;

</code>
You should set the configuration option ''threads_formposition'' to ''off'' instead.
--- //Phil 2010/01/29 16:05//

==== description conflict with table ====
If you have used the tale ^ in the content, the pagelist's description will catch the "array" in it.
you can see the result in www.tracesoftwarereview.com

How can I deal with this problem?