PageLists

PmWiki comes with two directives for generating lists of pages: (:pagelist:) and (:searchresults:). Both directives are basically the same and each accepts the parameters documented below. The primary difference between the two is that searchresults generates the "Results of search for ..." and "### pages found out of ### searched" messages around the results.

The (:searchbox:) directive generates a search form (input text search box) to submit search queries. The markup generally accepts the same parameters as (:pagelist:), which makes it possible to restrict, order and format searchresults in the same ways that are described below for a (:pagelist:). For more information about the (:searchbox:) directive, and the ways in which it differs from a (:pagelist:), skip to the section below.

Basic syntax

• (:pagelist:)

• (:pagelist group=ab name=cd category=tag fmt=template list=ef order=gh count=123 link=ij trail=kl wrap=mn passwd=op if=qr $:ptv=st $pv=uv cache=0 argument1 -argument2 etc variable=value class=class request=wx req=1 :)

• (:searchbox value=abc size=99 target=def label="label":)
• (:searchresults:)

Parameters

Any argument supplied within (:pagelist:) that isn't in the form 'key=value' is treated as text that either must (or must not) exist in the page text.

The minus sign (-) can be used to indicate things that should be excluded. Thus

lists all "normal" pages listed in the Documentation Index trail that contain the word "apple" but not "pie".

With page text variables

You can also use page text variables as a key to list pages according to the existence of a page text variable. Eg :

lists pages having $:pagetextvar set to avalue.
Minus sign (-), wildcards (?*) and a comma separated list of values also works when specifying a selection based on pagetextvariables. Eg :

lists pages having $:apagetextvar like 't*' but not 'test'.
Examples:

Be aware that if using (:pagelist $:MyPTV=$:YourPTV :) PTVs? include PmWiki formatting, so you may not get the matches you expect. Currently the only way around this is to use wild cards, so if the formatting is embedded you may be out of luck.

NOTE: Pagelist does not evaluate MarkupExpressions when working with PTVs?. So if your page text variables is defined using a markup expression to set the value, pagelist will see the literal values of the text of your markup expression rather than the result of your expression. (e.g., the PTV definition (:foo:{(substr abcdef 2 4)}:) will be seen by pagelist as an open-curly-brace followed by an open-paren followed by s-u-b-s-t-r, etc. rather than being seen as b-c-d-e) Any processing of the markup expression in the output of your pagelist occurs in subsequent rules (after pagelist) within the context of the current page and thus these values cannot be used for sorting or selecting pages. (source)

With page variables (PV)

Page variables can be used within pagelists in the same way as page text variables. See Page Text Variables above for more details. Simply use $var instead of $:var.

group= and name=

The "group=" and "name=" parameters limit results to pages in a specific group or with a specific name:

Wildcards

Name, group, link, and category parameters can contain wildcard characters that display only pages matching a given pattern:

• An asterisk (*) represents zero or more characters
• A question mark (?) represents exactly one character
• A set of characters enclosed in square brackets ([]) represents any one of the characters in the brackets
• A comma separates different specifiers, of which at least one should match.
• A minus sign before a specifier requires it to be absent.
• Only for link= and category=, a plus sign before a specifier requires it to be present.

Examples:

(:pagelist group=Cookbook name=A*,B*   :)
(:pagelist name=Cookbook.A*,Cookbook.B*   :)
(:pagelist group=Cookbook name=[AB]*   :)
(:pagelist name=Cookbook.[AB]*   :)

(:pagelist category=Media,Images  :)

(:pagelist category=+Media,+Images  :)

If you want to use multiples conditions you need to use commas to delimit the string. For example

trail=

The "trail=" option obtains the list of pages to be displayed from a trail index.

• Display pages in the documentation by modification time

• Display five most recently changed pages

list=

The "list=" option allows a search to include or exclude pages according to predefined patterns set by the administrator.

• "list=normal" is predefined, and which excludes things like AllRecentChanges?, RecentChanges, GroupHeader, GroupFooter, GroupAttributes?, and the like from being displayed in the list results. Note that list=normal also excludes the current page.
• "list=all" over-rides a "default" list that may be set by the wiki's administrator to exclude groups such as PmWiki or Site from regular search results.
• "list=grouphomes" only lists the home pages of every group on the wiki, either Group.Group, or Group.HomePage?, or other/localized, as defined in $DefaultName, and/or $PagePathFmt.

Wiki administrators can define custom lists via the $SearchPatterns array (see Cookbook:SearchResults).

fmt=

The "fmt=" option determines how the resulting list should be displayed. PmWiki predefines several formats:

• fmt=#bygroup - Display pages within groups (default format)
• fmt=#simple - Display a simple ordered list of pages in the form Group.Name
• fmt=#title - Display a list of pages by page title. Use "order=title" to have them sorted by title (default is to order by page name).
• fmt=#titlespaced - Display a list of pages by page title, like above, but with spaces between the words in the title.
• fmt=#group - Display a list of wikigroups (without listing the pages in the groups)
• fmt=#include - Display the contents of each page in the list (note, this could take a very long time for long lists!)
• fmt=#grouphomes - An optimized bullet list of group home pages (will work with count=...), requires PmWiki 2.2.103.
• 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!)
• 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).
• fmt=#simplename - Simple bullet list of page names, without the Group name.
• fmt=#simplenamespaced - Simple bullet list of spaced page names, without the Group name.
• fmt=#titlesummary - A simple bullet list of page title and summary, defined in page by (:title ttttt:) and (:Summary:sssss:) markup.

These formats are defined by page list templates, which can be customized.

This format is not predefined by a page list template:

• fmt=count - Display the number of pages in the list (note the absence of the "#"). In a trail, fmt=count counts existing and non-existing pages ; to limit count to existing pages, use : if="exists {=$FullName}" fmt=count (mailing list).

link= and category=

The "link=" and "category=" arguments implement "backlinks" -- i.e., it returns a list of pages with a link to the target, or declared in the category. It's especially useful for category pages and finding related pages.

The category=Name argument differs from link=Category.Name as it only lists pages declared in the category with the markup [[!Name]], and does not include pages simply linking to [[Category/Name]] (unless they also contain [[!Name]]).

• all pages with a link to PmWiki.DocumentationIndex

• all pages with links to the current page

• all pages in the "Skins" category

Since PmWiki 2.3.0, link= and category= accept multiple and negative targets and wildcard lists, see the section Wildcards.

Note, link= and category= will ignore the directives (:if...:), (:include...:), (:redirect...:), (:pagelist...:), and page text variable directives, while searching for links in a page. That means links in included pages will not be found, and links inside non-displayed conditional markup will be found. See PageTextVariables for ways to hide a link on a page while still allowing link= to find it.

Note: The new category= argument requires all pages containing [[!Category]] links to be reindexed. See the recipe Cookbook:ReindexCategories which can automate this.

count=

The "count=" option provides the ability to

• limit the pagelist to a specific number of pages
• subsets of a list
• return items from the end of a list, subsets of a list
• display pages in reverse sequence

count=1..10       # first ten pages of list
count=5..10       # 5th through 10th pages of list

count=10..        # skip first ten pages
count=..10        # 1st through 10th page of list
count=-10..       # last ten pages of list
count=..-10       # all but the last nine pages

count=5..10       # 5th through 10th pages of list
count=10..5       # same as 5..10 but in reverse sequence
count=-1..1       # all pages in reverse sequence

(:pagelist order=-name count=10:)
(:pagelist order=-name count=1..10:)
(:pagelist order=name count=-1..-10:) 

wrap=

The "wrap" option has the values, none and inline.

With "wrap=inline" and "wrap=none", the output from pagelist (markup or HTML) is directly embedded in a page's markup without any surrounding <div> class=...</div> tags.

With "wrap=inline", any surrounding <ul> is continued. Without "wrap=inline", the HTML output starts a new <ul>. This is important if you want to get a second level <ul> produced by the page list since starting a new <ul> with "**" doesn't yield a second level <ul> but <dl><dd><ul>...

"wrap=inline" likely has other effects since it suppresses the call to $FPLTemplateMarkupFunction (being MarkupToHTML? by default).

class=

By default, a pagelist has the 'fpltemplate' class. The 'bygroup', 'simple', 'group' and 'title' page list formats have specific class names fplbygroup, fplsimple etc. You can set any class using the class= parameter or by setting the $FPLFormatOpt array.

request=

With (:pagelist [other parameters] request=1:) you can override most pagelist parameters, by providing request parameters in the URL. For example, (:pagelist order=name request=1:) will normally sort the list by name. But if the page's URL contains ?order=time, the list will be sorted by time. If the URL contains ?order=, the list will be unordered. Note: In the URL, encode any "#"s that are in your parameters as "%23". Since this parameter gives users who don't have edit rights the ability to run a pagelist of their choosing, consider its security implications for your website before using it.

Since version 2.2.71, it is possible to explicitly allow only certain parameters that can be overridden, or to disallow some parameters to be overridden. If you need this, instead of 1, enter the parameter names.

(:pagelist request=1:)

(:pagelist request=order,count:)

(:pagelist request=-fmt,-trail:)

req=1

The req=1 parameter requires that search terms be posted (that is, that the user presses "search" on a search form, or follows a link with additional parameters like [[Page?q=terms&order=-name]]) before the pagelist is executed. Note that (:pagelist request=1 req=1:) works mostly like (:searchresults:) without the lines "Results of search for ..." and "X pages found out of Y pages searched". Both "request=1" and "req=1" are needed.

When a search is performed, either via a searchbox directive, or via the search form of the skin, if the page contains a "searchresults" directive, that page will be used to display the results of the search; if the page doesn't have a "searchresults" directive, the page Site.Search will be used to display the results.

passwd=

The "passwd" option returns only those pages that have some sort of password attribute on them.

if=

The "if" option allows a condition to be specified as part of the pagelist processing, rather than from within the page list template. Only those pages for which the condition is true are retrieved. Anything that could go within an (:if ...:) can be used as a condition. For example

  (:pagelist if="date {(ftime %GW%V {*$Name})} {=$Name}" :)

returns all of the pages where the name is in the same week as that of the current page.

If any arguments within the quotes could contain a space they must be quoted:

  (:pagelist if="date 2009-01-01..2009-12-31 '{=$:Mydate}'" :)

order=

The "order=" option allows the pages in the list to be sorted according to different criteria. Use a minus sign to indicate a reverse sort. Multiple sorting criteria can be specified using a comma, and you can create your own custom pagelist sort order:

• order=name - alphabetically by name (default order)
• order=$Name - alphabetically by name across groups
• order=title - alphabetically by title rather than names
• order=time - most recently changed pages last
• order=ctime - time of page creation (see note)
• order=group,title - by multiple criteria, in this instance sort by title within groups
• order=random - shuffle the pages into random sequence
• order=$:pagetextvarname - alphabetically by page text variable value (note no braces)
• order=$pagevarname - alphabetically by page variable value (note no braces)

Also, the order= option allows custom ordering functions to be written.

• Note: trail= preserves the order of the pages as they appear on the trail (unless you've specified order= explicitly or there is a default order in the page list template). So PmWiki's alphabetical default order does not apply when trail= is specified.
• Note: ctime was added to pages only from pmwiki 2.1.beta15 onwards, pages created by earlier versions don't carry a ctime attribute and can't be sorted that way.

cache=0

Pagelist has the capability to cache lists which greatly speeds up processing (when $PageListCacheDir is set). Every once in a while this caching can result in undesired results. Specifying cache=0 disables caching.

Specifying variables as parameters

You can also specify variable values inline with the pagelist statement, and refer to the variables in the template using the {$$variable1} format:

This assumes that a site has $EnableRelativePageVars enabled (default since 2.2.9).

For example, in the template:

>>comment<<
[[#tvars]]
(:template default count=1 ParamName=Simon:)
Hi, {$$ParamName}, how are you today?
[[#tvarsend]]
>><<

This gives:

(:pagelist fmt=#tvars ParamName="Sam":)

(:pagelist fmt=#tvars ParamName="Sally":)

(:pagelist fmt=#tvars:)

See also $EnableUndefinedTemplateVars.

Examples

Include the contents of a random page from the Banners group:

Display a simple list of the last ten recently changed pages:

The Searchbox Directive

The (:searchbox:) directive generally accepts the same parameters as (:pagelist:) and (:input search:) directives:

• Pagelist parameters can be added to the input text of a searchbox (or to the markup, or both)
• Input text box parameters can be added to the searchbox markup
  • An initial search string can be specified in the searchbox markup, but it must be in the form value='search string'. That search string is displayed in the input text and can be modified by when the search is run.
  • The default placeholder value is "Search" (localized in other languages), and can be modified in the form placeholder="Type search terms..." or removed with placeholder="". In recent browsers, this value appears gray in the search field when it is empty.
  • Optionally, you can add aria-label and other aria-* accessibility attributes that will be attached to the input text field.
  • The size of the text input field can be specified with the size parameter, where "size=40" would specify the current default value.
    • Tip: If more than one searchbox appears on a page, adding a blank initial value like this value='', to the markup for each searchbox will prevent a search string for one box from populating all of the other boxes.
• The target page for displaying searchbox results can be set with the parameter target=GroupName.PageName?. The default is the current page.
• The entire searchbox form can be overridden by defining the $SearchBoxFmt variable in one's configuration file. If $SearchBoxFmt is defined, then the parameters to (:searchbox:) are ignored, and the content of the $SearchBoxFmt variable are used instead.

The additional parameter label="Label" can be used to change the label of the associated submit button:

 (:searchbox label="Search this wiki":)

Use label="" to remove the submit button (users need to press "Enter" to search).

By default, the input field has the "text" type for compatibility with HTML/XHTML. Alternatively, you can set it to the "search" input type for HTML5?, see $SearchBoxInputType (some HTML5? skins already set this).

The Searchresults directive

The (:searchresults:) directive generally accepts the same parameters as (:pagelist:) and (:input search:) directives.

Customizing "Results of search for..." and "3 pages found out of..."

To change the text surrounding the search results, customize the following and add it to local/config.php or $FarmD/local/farmconfig.php. Note that 'en' should be changed to the localized language.

XLSDV('en', array(
        'SearchFor' => 'Results of search for <em>$Needle</em>:',
        'SearchFound' => 
                '$MatchCount pages found out of $MatchSearched pages searched.'
));

Alternatively, adjust the 'SearchFor?' and 'SearchFound?' phrases in your translation pages.

The $SearchResultsFmt variable can also be set in local/config.php or $FarmD/local/farmconfig.php.

SDV($SearchResultsFmt, "<div class='wikisearch'>\$[SearchFor]
  <div class='vspace'></div>\$MatchList
  <div class='vspace'></div>\$[SearchFound]</div>");

You can remove the lines above and below the generated list by adding this in config.php:

See Also

• Site.PageListTemplates - default pmwiki pagelist templates
• Cookbook:PagelistTemplateSamples - contributed pagelist template samples
• PageListTemplates - how to create custom pagelist templates for the fmt= option
• PagelistVariables - local/config.php customizations
• Cookbook:Forms - documentation for (:input text:) markup, which applies to (:searchbox:)
• CustomPagelistSortOrder - creating custom order sort functions
• Cookbook:CustomPagelistSortOrderFunctions -
• Cookbook:PageListMultiTargets -
• Cookbook:SearchResults -
• PageDirectives#attachlist - display a list of attachments
• PmWiki.Search - Targeting and customizing search results

FAQ