first commit

en/wiki/wikilib.d/PmWiki.PageLists

@@ -0,0 +1,10 @@
+version=pmwiki-2.2.71 ordered=1 urlencoded=1
+author=Daniel Julivert
+charset=UTF-8
+csum=Documented the titlespaced format
+ctime=1138643894
+name=PmWiki.PageLists
+rev=242
+targets=PmWiki.PageListTemplates,PmWiki.DocumentationIndex,PmWiki.PageTextVariables,PmWiki.MarkupExpressions,PmWiki.WikiTrails,Cookbook.SearchResults,Site.PageListTemplates,PmWiki.Categories,Cookbook.PageListMultiTargets,PmWiki.ConditionalMarkup,PmWiki.CustomPagelistSortOrder,PmWiki.PageVariables,PmWiki.PagelistVariables,PmWiki.Internationalizations,Cookbook.PagelistTemplateSamples,Cookbook.Forms,Cookbook.CustomPagelistSortOrderFunctions,PmWiki.PageLists,PmWiki.PageDirectives,PmWiki.Search
+text=(:Audience: authors, admins (intermediate) :)%0a(:Summary:Listing pages by multiple criteria with templated output:)%0aPmWiki 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.%0a%0aThe [@(: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 [[#searchbox|below]].%0a%0a!! Basic syntax%0a%0a* [@(:pagelist:)@] %0a->without any arguments shows a bulleted list of all pages, as links, ordered alphabetically and in groups.%0a* @@[=(:=]pagelist [[#pagelistgroup|group]]=''ab'' \%0a  [[#pagelistname|name]]=''cd'' \%0a  [[#pagelistfmt|fmt]]=''[[page list templates|template]]''  \%0a  [[#pagelistlist|list]]=''ef'' \%0a  [[#pagelistorder|order]]=''gh'' \%0a  [[#pagelistcount|count]]=''123'' \%0a  [[#pagelistlink|link]]=''ij'' \%0a  [[#pagelisttrail|trail]]=''kl''  \%0a  [[#pagelistwrap|wrap]]=''mn''  \%0a  [[#pagelistpasswd|passwd]]=''op''  \%0a  [[#pagelistif|if]]=''qr''  \%0a  [[#pagetextvariables|$:''ptv'']]=''st'' \%0a  [[#pagevariables|$''pv'']]=''uv'' \%0a  [[#pagelistcache|cache]]=0 \%0a  ''[[#pagelistarg|argument]]1'' -''[[#pagelistarg|argument]]2'' ''etc'' \%0a  [[#includevariable|variable]]=''value'' \%0a  [[#pagelistclass|class]]=''class'' \%0a  [[#pagelistrequest|''request=1'']] \%0a  [[#pagelistreq|''req=1'']] \%0a  :)@@ %0a->shows a pagelist according to the  parameters supplied. Parameters are optional.%0a* @@[=(:=][[#searchbox|searchbox]] value=''abc'' size=''99'' target=''def'' label="label":)@@%0a* @@[=(:=][[#searchresults|searchresults]]:)@@%0a%0a!! Parameters%0a[[#pagelistarg]]%0aAny 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.%0a%0aThe minus sign (-) can be used to indicate things that should be excluded. Thus%0a->[@(:pagelist trail=PmWiki.DocumentationIndex list=normal apple -pie:)@]%0alists all "normal" pages listed in the [[Documentation Index ]] trail that contain the word "apple" but not "pie".%0a%0a!!![[#pagetextvariables]]With page text variables%0aYou can also use [[page text variables]] as a ''key'' to list pages according to the existence of a page text variable. Eg : %0a->[@(:pagelist $:pagetextvar=avalue:)@]%0alists pages having ''$:pagetextvar'' set to ''avalue''.%0a[[%3c%3c]]%0aMinus sign (-), wildcards (?*) and a comma separated list of values also works when specifying a selection based on pagetextvariables. Eg :%0a->[@(:pagelist $:apagetextvar=t*,-test:)@]%0alists pages having $:apagetextvar like 't*' but not 'test'.%0a[[%3c%3c]]%0aExamples:%0a||width=* class="tabtable" rules=rows%0a||PTV is set (is not empty): ||[@(:pagelist $:MyPageTextVariable=- :)@]||%0a||PTV is empty or not set:[[%3c%3c]] (ie, is not set to one char followed by 0 or more chars) ||[@(:pagelist $:MyPageTextVariable=-?* :)@]||%0a||PTV is not VALUE:          ||[@(:pagelist $:MyPageTextVariable=-VALUE :)@]||%0a||PTV is set and not YES:    ||[@(:pagelist $:MyPageTextVariable=?*,-YES :)@]||%0aBe 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.%0a%0aNOTE: Pagelist does not evaluate [[PmWiki/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. ([[http://thread.gmane.org/gmane.comp.web.wiki.pmwiki.user/60968/focus=60970|source]])%0a%0a!!![[#pagevariables]]With page variables (PV)%0a%0aPage variables can be used within pagelists in the same way as page text variables.  See [[#pagetextvariables|Page Text Variables]] above for more details.  Simply use $var instead of $:var.%0a%0a!!![[#pagelistgroup]] groupLine truncated
+time=1421408157