[pmwiki-users] fmt=#headerinclude (was Further PmWiki Development)

Ben Wilson dausha at gmail.com
Tue May 23 18:14:27 CDT 2006

To be honest, Pagelist is among the more interesting/complex core
features. It should be exhaustively documented. Although, I agree that
there should be some revision in how it is presently documented.

On 5/23/06, christian.ridderstrom at gmail.com
<christian.ridderstrom at gmail.com> wrote:
> I'll answer that by first listing the current pages I could find that are
> related to pagelist. Here's the pages I found:
> * PmWiki/PageLists              - primary doc. page of (:pagelist:)
> * Pmwiki/Directives#pagelist    - gives syntax of (:pagelist:)
> * PmWiki/DocumentationIndex     - just refers to PmWiki/PageLists
> * PmWiki/MarkupMasterIndex      - some syntax of (:pagelist:)

These are "must haves," IMO.


> I also don't see why 'PagelistExplained' is in the cookbook. I think
> (:pagelist:) deserves a proper "advanced" documentation page. But maybe I
> don't get the purpose of the page.

PmWiki.Pagelist-Examples ?

IMO, the hyphen indicates a sub/related page and is a little clearer to read.

> My idea for PmWiki/PagelistExamples was that it would be a place to
> illustrate the result of the pagelist formats defined that are defined by
> *default* at Site.PageListTemplates. In other words, document how the
> formats that come with PmWiki work. One reason why I don't want to have
> this information on a cookbook page is that I'd like to be able to easily
> see how all the formats are affected when I modify the format definitions.

However, the Cookbook.Pagelist-Examples (c|sh)ould be used to show
_other than default_ pagelist examples. A good example is the
discussion last week about a different output for the searchlist from
the default. At least, this is my opinion based on the notion that the
Cookbook is the Community giving back to itself by offering "options
that work" but are not a part of the Core.

> However, assuming there's no performance penalty in adding documentation
> to Site.PageListTemplates about the formats supplied with PmWiki, maybe
> that documentation should simply go *with* the actual format definitions.


Ben Wilson
" Mundus vult decipi, ergo decipiatur"

More information about the pmwiki-users mailing list