June 17, 2007, at 09:28 PM
Site /

PageListTemplates

This page contains "templates" for PmWiki's (:pagelist:) directive.

Brief Syntax Explanation:

See also: PageLists, Page Variables, Conditional Markup, Cookbook:PagelistTemplateSamples

Use with page variables: 

   =   current item
   <   previous item
   >   next item

Conditionals used to structure pagelist output: 

   (:if equal {<$Group}:)               At beginning of list
   (:if equal {>$Group}:)               At end of list
   (:if ! equal {=$Group} {<$Group}:)   First item in group
   (:if ! equal {=$Group} {>$Group}:)   Last item in group

fmt=#default

The default template for pagelists when fmt= isn't specified. 

[[#default]]
(:if ! equal {=$Group} {<$Group}:)

:[[{=$Group}]] /:
(:if:)
: :[[{=$Group}/{=$Name}]]
[[#defaultend]]

fmt=#bygroup

Display pages by group/name. 

[[#bygroup]]
(:if ! equal {=$Group} {<$Group}:)

:[[{=$Group}]] /:
(:if:)
: :[[{=$Group}/{=$Name}]]
[[#bygroupend]]

fmt=#simple

A simple bullet list of page names. 

[[#simple]]
* [[{=$FullName}]]
[[#simpleend]]

fmt=#title

A simple bullet list of page titles. Use order=title to have them sorted by title (the default sort is by name). 

[[#title]]
* [[{=$FullName}|+]]
[[#titleend]]

fmt=#group

A bullet list of groups. 

[[#group]]
(:if ! equal {=$Group} {<$Group}:)
* [[{=$Group}]]
[[#groupend]]

fmt=#include

Concatenate the text of pages in the list. (Note, this can be an expensive operation!) 

[[#include]]
(:include {=$FullName} self=0:)
[[#includeend]]

fmt=#includefaq

Include just the #faq sections from pages in the list. (This can also be expensive,
especially if the list includes pages that don't have the [[#faq]] anchor!) 

[[#includefaq]]
!![[{=$FullName}|+]]
>>faq<<
(:include {=$FullName}#faq#faqend self=0:)
>><<
[[#includefaqend]]

fmt=#MRU

A MRU like pagelist format 

[[#MRU]]
[[{=$FullName}]]
[[#MRUend]]

fmt=#logbook

Perfect for Logbook and making PmWiki more of a bliki. 

[[#logbook]]
----
!![[Logbook/{=$Name}]]
(:include {=$FullName} self=0:)
[[#logbookend]]

fmt=#lnews

For the display of the latest news on the home page 

[[#lnews]]
!!{=$Name}
(:include {=$FullName} self=0 lines=3:)

%right% [[{=$FullName} | ... more ...]]
[[#lnewsend]]