Site»Page List Templates

Page List Templates

This page contains "templates" for PmWiki's (:pagelist:) directive. The Site.LocalTemplates? page can be created and used to store pagelist templates that are local to a site.

Page list template documentation

fmt=#default

The default template for pagelists when fmt= isn't specified (and note that on the PmWiki.org wiki, this template is over-ridden by the one on the Site.LocalTemplates? page).

⚠ (:markup class="horiz":) (:if false:) [[#default]] (:template first {=$Group}:) <:vspace> :[[{=$Group}/]] /: (:template each:) : :[[{=$Group}/{=$Name}]] [[#defaultend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#default count=6:) (:markupend:)

fmt=#bygroup

Display pages by group/name.

⚠ (:markup class="horiz":) (:if false:) [[#bygroup]] (:template first {=$Group}:) <:vspace> :[[{=$Group}/]] /: (:template each:) : :[[{=$Group}/{=$Name}]] [[#bygroupend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#bygroup count=6:) (:markupend:)

fmt=#simple

A simple bullet list of page names.

⚠ (:markup class="horiz":) (:if false:) [[#simple]] * [[{=$FullName}]] [[#simpleend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#simple count=5:) (:markupend:)

fmt=#title

A simple bullet list of page titles.

⚠ (:markup class="horiz":) (:if false:) [[#title]] (:template defaults order=title:) * [[{=$FullName}|+]] [[#titleend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#title count=5:) (:markupend:)

fmt=#titlespaced

Outputs wiki page titles with spaces between the words in the title.

⚠ (:markup class="horiz":) (:if false:) [[#titlespaced]] (:template defaults order=title:) * [[{=$FullName}|{=$Titlespaced}]] [[#titlespacedend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#titlespaced count=5:) (:markupend:)

fmt=#group

A bullet list of groups (will not work with count=...).

⚠ (:markup class=norender:) [[#group]] (:template first {=$Group}:) * [[{=$Group}/]] [[#groupend]] (:markupend:)

fmt=#grouphomes

An optimized bullet list of group home pages (will work with count=...), requires PmWiki 2.2.103.

⚠ (:markup class="horiz":) (:if false:) [[#grouphomes]] (:template default list=grouphomes:) * [[{=$Group}/]] [[#grouphomesend]] (:ifend:) <:vspace> (:pagelist group=p*,s* fmt=#grouphomes count=5:) (:markupend:)

fmt=#include

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

⚠ (:markup class=norender:) [[#include]] (:include {=$FullName} self=0:) [[#includeend]] (:markupend:)

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

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

fmt=#description

List pages and append the page's description if it exists. Creates dash by all names, but adding a nested loop to get rid of it causes markup problems (nested loops are not allowed).

⚠ (:markup class="horiz":) (:if false:) [[#description]] * [[{=$FullName}|+]] - {=$Description} [[#descriptionend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#description count=7:) (:markupend:)

fmt=#simplename

Simple bullet list of page names, without the Group name.

⚠ (:markup class="horiz":) (:if false:) [[#simplename]] * [[({=$Group}/){=$Name}]] [[#simplenameend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#simplename count=5:) (:markupend:)

fmt=#simplenamespaced

Simple bullet list of spaced page names, without the Group name.

⚠ (:markup class="horiz":) (:if false:) [[#simplenamespaced]] * [[({=$Group}/){=$Namespaced}]] [[#simplenamespacedend]] (:ifend:) <:vspace> (:pagelist group={$Group} fmt=#simplenamespaced count=5:) (:markupend:)

fmt=#titlesummary

A simple bullet list of page title and summary.

⚠ (:markup class=horiz:) (:if false:) [[#titlesummary]] * [[{=$FullName} | {=$Title}]] &nbsp; [-{=$:Summary}-] [[#titlesummaryend]] (:ifend:) <:vspace> (:pagelist group=Site fmt=#titlesummary list=normal count=8:) (:markupend:)

fmt=#count

Number of pages in a group, includes only "normal" pages

⚠ (:markup class="horiz":) (:if false:) [[#count]] (:template defaults wrap=inline list=normal :) (:template last:) {$$PageCount} [[#countend]] (:ifend:) <:vspace> Number of pages in the {$Group} group: (:pagelist group={$Group} fmt=#count :). <:vspace> Number of pages in the {$Group} group: (:pagelist group={$Group} fmt=count :). <:vspace> There are (:pagelist group=PmWiki fmt=#count wrap=html :) pages in the PmWiki group. (:markupend:)