Help & Man Pages
This page uses custom searches.
For regular searches, view another page.
PmWiki provides a basic search function. While it is not powered by a "search engine", it can be tweaked to produce results that are targeted and customized.
Searches can be targeted to restrict the search to certain pages. For example, a search can be restricted based on groups, where, for instance, "group=PmWiki" searches only the PmWiki group, and "group=-PmWiki" searches only pages that are not in the PmWiki group. In addition to groups, searches can be restricted based on page names ("name="), wiki trails ("trail="), backlinks ("link=") and other criteria (e.g. "list=normal") and capped at a maximum number ("count="). For documentation about each of these parameters, see page lists.
The display of search results can be customized to control the format, content and order of the returned results. Format and content are selected by using "fmt=" to specify a pagelist template that determines layout, such as list styles, and page elements, such as title and description. The "order=" option allows results to be sorted according to different criteria, such as name and title. For documentation about each of these parameters, see page lists. For examples of pagelist template formats see Site.Page List Templates, and Cookbook:Pagelist Template Samples.
Readers can create targeted and customized search results simply by typing the relevant parameters , e.g. "group=PmWiki", into search boxes together with their search string. Authors can predefine such targeted and customized searches by incorporating the parameters into pages using the
Try it: this page generates custom searches
Any search that is run from this page will automatically generate pre-defined sets of search results that: target different clusters of pages (documentation, cookbook and PITS, if available); use customized formats, content and ordering; and reveal the specific parameters used to generate each search result. Whether you use the search box below, or the regular search box that appears at the top of this page, any search that you run from this page will provide the customized results.