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 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.
(:pagelist:)
(:pagelist group=ab name=cd 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=1 req=1 :)
(:searchbox value=abc size=99 target=def label="label":)
(:searchresults:)
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
(:pagelist trail=PmWiki.DocumentationIndex list=normal apple -pie:)
lists all "normal" pages listed in the Documentation Index trail that contain the word "apple" but not "pie".
You can also use page text variables as a key to list pages according to the existence of a page text variable. Eg :
(:pagelist $:pagetextvar=avalue:)
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 :
(:pagelist $:apagetextvar=t*,-test:)
lists pages having $:apagetextvar like 't*' but not 'test'.
Examples:
| PTV is set (is not empty): | (:pagelist $:MyPageTextVariable=- :) |
| PTV is empty or not set: (ie, is not set to one char followed by 0 or more chars) | (:pagelist $:MyPageTextVariable=-?* :) |
| PTV is not VALUE: | (:pagelist $:MyPageTextVariable=-VALUE :) |
| PTV is set and not YES: | (:pagelist $:MyPageTextVariable=?*,-YES :) |
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.
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.
The "group=" and "name=" parameters limit results to pages in a specific group or with a specific name:
| All pages in the Pmwiki group: | (:pagelist group=PmWiki :)
|
| All pages except those in the PmWiki or Site groups: | (:pagelist group=-PmWiki,-Site :)
|
| All RecentChanges pages | (:pagelist name=RecentChanges :)
|
| All pages except RecentChanges | (:pagelist name=-RecentChanges :)
|
Name and group parameters can contain wildcard characters that display only pages matching a given pattern:
Examples:
| All pages in any group beginning with "PmWiki" | (:pagelist group=PmWiki* :)
|
| All pages in any group beginning with "PmWiki", except for Chinese | (:pagelist group=PmWiki*,-PmWikiZh :)
|
| All pages in the PmCal group with names starting with "2005": | (:pagelist name=PmCal.2005* :)
|
| All Cookbooks with names beginning with a A and a B letter
note the different separators used for the same result
| (:pagelist group=Cookbook name=A*,B* :) (:pagelist group=Cookbook name="A* B*" :) (:pagelist group=Cookbook name=[AB]* :) (:pagelist group=Cookbook, name=[AB]* :) |
If you want to use multiples conditions in name you need to use quotes or commas to delimit the string.
The "trail=" option obtains the list of pages to be displayed from a WikiTrail:
(:pagelist trail=PmWiki.DocumentationIndex order=-time:)
(:pagelist trail=RecentChanges count=5:)
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.
$SearchPatterns array (see Cookbook:SearchResults).
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=#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!)
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).
The "link=" option implements "backlinks" -- i.e., it returns a list of pages with a link to the target. It's especially useful for category pages and finding related pages.
(:pagelist link=PmWiki.DocumentationIndex:)
(:pagelist link={$FullName}:)
(:pagelist link=Category.Skins:)
The "count=" option provides the ability to
| A simple bullet list of ten most recently modified pages |
|
| Display the first ten pages of a list |
|
| Negative numbers specify pages to be displayed from the end of the list: |
|
| Ranges may be specified using '..', thus: |
count=1..10 # first ten pages of list count=5..10 # 5th through 10th pages of list |
| Negative numbers in ranges count from the end of the list: |
|
| Omitting the start or end of the range uses the start or end of the 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 |
| Ranges can be reversed, indicating that the order of pages in the output should likewise be reversed: |
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 |
| "Reverse sequence" here refers to the sequence after any sorting has taken place. Therefore the three directives to the right are equivalent: |
(:pagelist order=-name count=10:) (:pagelist order=-name count=1..10:) (:pagelist order=name count=-1..-10:) |
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).
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.
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.
The req=1 parameter makes the pagelist execute only when the search terms are posted (that is, when the user presses "search" on a search form). 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.
The "passwd" option returns only those pages that have some sort of password attribute on them.
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}'" :)
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=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
order=$pagevarname - alphabetically by page variable value
Also, the order= option allows custom ordering functions to be written.
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.
You can also specify variable values inline with the pagelist statement, and refer to the variables in the template using the {$$variable1} format:
(:pagelist fmt=#pagelist variable1="value" variable2="value2":)
This assumes that a site has $EnableRelativePageVars enabled, which is recommended in PmWiki 2.2.0 -- but disabled by default to help people upgrading from 2.1.x.
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:) | Hi, Sam, how are you today? Hi, Sally, how are you today? Hi, Simon, how are you today? |
See also $EnableUndefinedTemplateVars.
Include the contents of a random page from the Banners group:
(:pagelist group=Banners order=random count=1 fmt=#include list=normal:)
Display a simple list of the last ten recently changed pages:
(:pagelist trail=Site.AllRecentChanges count=10 fmt=#simple:)
Display the "top twenty" biggest cookbook pages:
(:pagelist group=Cookbook order=-size count=20 :)
The (:searchbox:) directive generally accepts the same parameters as (:pagelist:) and (:input text:) directives:
value='search string'. That search string is displayed in the input text and can be modified by when the search is run.
value='', to the markup for each searchbox will prevent a search string for one box from populating all of the other boxes.
target=GroupName.PageName. The default is the current page.
(: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":)
The (:searchresults:) directive generally accepts the same parameters as (:pagelist:) and (:input text:) directives.
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>");
(:input text:) markup, which applies to (:searchbox:)