La gestion des index et recherche de pages se fait grâce au plugin pagequery : il s'agit d'un outil de navigation polyvalent pour créer des pages d'index, faire des recherches ou des filtres sur du texte ou des noms de page, et afficher les résultats en colonnes, regroupés, triés. Il propose même des info-bulles pour prévisualiser le contenu.

Comme pagequery a fait un usage éhonté des excellentes fonctions disponibles dans DokuWiki (en particulier search), il n'y a pas de nouvelle syntaxe à apprendre. Mais il apporte un petit quelque chose dans l'arrangement des puissantes options de tri et de regroupement.

Quelques utilisations possibles :

• Faire la liste de toutes les pages de votre wiki dans un bel index alphabétique, ou par année/mois
• Faire une liste des pages récemment modifiées
• Faire la liste des pages qui discutent d'un sujet particulier (grâce à la recherche dans le texte)
• Faire la liste des pages créées par un utilisateur donné

Insérer la mention pageguery dans le texte de la page là où vous voulez que la page apparaisse. Vous pouvez avoir différentes listes pagequery dans la même page¹⁾.

Il peut s'agir de la version simple :

{{pagequery>}}

Ou, plus compliqué :

{{pagequery>[query];fulltext;sort=key:direction,key2:direction;group;limit=10;cols=2;spelldate;proper}}

Ou alors à l'ancienne, et vraiment trop compliqué… :

{{pagequery>[query];fulltext;sort=key:direction,key2:direction;group;limit=100;cols=6;spelldate;proper;snippet=5;border=inside;hidestart;case;natsort}}

Remarque : la syntaxe peut être affichée sur plusieurs lignes pour améliorer la lisibilité. Les espaces sont tout simplement ignorés. Par exemple :

{{pagequery>query;
  fulltext;
  sort=key:direction,key2:direction;
  group;
  limit=100;
  cols=6;
  spelldate;
  proper;
  border=inside;
  hidestart;
  case;
  natsort
}}

La règle générale est que les options sont séparées par des points-virgules (;), les valeurs (par exemple dans un tri ou un filtre) sont séparées par une virgule (,), et les valeurs multi-parties par deux points (:).

A few pointers about sorting and grouping successfully. Pagequery offers many sorting options, most of which are designed to be grouped. So if you intend to group your list by its main headers then it makes the most sense to sort from the broadest category to the narrowest.

For example: year ⇒ month ⇒ name. The sorting algorithm will first sort the list of pages by year, then the pages within each year will be sorted by month, and finally the pages within each month will be sorted by name. Sorting the other way around would not make much sense, as all names are unique: hence there would be nothing to “group”!

If you grouped the above sort it would result in the following arrangement:

• Year
  • Month
    • Name
    • Name
  • Month2
    • Name
    • Name
    • etc…

The basic rule is: start with the least specific and work your way to the most specific options.

I've added new pages but they do not show up in my nice new pagequery list. Why?

• You need to turn off page caching for the page containing the list. Put

   ~~NOCACHE~~ 

  somewhere on the page and you should then see instant updates.

I have many default 'start' pages in my wiki and I don't want to see them when I list the contents of namespaces; how can I make them disappear?

• Just add the hidestart option. Make sure that the start option in your configuration corresponds to the start page name you are using!

I would much rather see the page title instead of the page name. How can I enable that?

• Put the display=title option somewhere in your pagequery markup

After migrating my wiki contents to a new dokuwiki version, pagequery doesn't list any pages. Only after editing the pages, they show up in pagequery again.

• Use the SearchIndex plugin to rebuild the index of your wiki, or make sure that you copy over the indexes as well as the content. This problem has nothing to do with pagequery itself.

For example, if you want to list all the pages in a certain namespace by A-Z, the following should do the trick:

{{pagequery>@namespace;fulltext;sort=a,name;group}}           [fulltext version]

Or:

{{pagequery>@namespace *;sort=a,name;group;proper;cols=2}}    [pagename version: allows regex's]

This would retrieve results from @namespace only (as there is no other search query you would get all the pages), and the list would be sorted by the first letter ('sort=a') then alphabetically ('sort=name') within each letter. The group option will then cause the list to be grouped by the first letter only (you cannot group by name as each one is unique).

If you wanted to see the results in 3 columns and to have the links in “Sentence Case” with no underscores, then add this:

{{pagequery>@namespace *;sort=a,name;group;cols=3;proper}}

Another example, grouping by year created, then month created, then by name, in 2 columns, and displaying the real month name, plus having the links in “Sentence Case” with no underscores, and to top it off: a border around the table columns:

{{pagequery>@namespace *;sort=cyear,cmonth,name;group;spelldate;proper;cols=2;border}}

The same query, but now searching for pages contenting the word “help” (NOTE: fulltext means search in the page “content” not just its “name”:

{{pagequery>@namespace help;fulltext;sort=cyear,cmonth,name;group;spelldate;proper;cols=2}}

Update: Namespaces are now supported when searching by pagename (pageid) only. Use the same syntax as fulltext search, i.e. @namespace|^namespace. I haven't provide support for relative namespaces yet. In addition, you can use regular expressions when searching by pagename.

E.g. Search for all pages in the “drafts” namespace, listing only files beginning with a number, sorted by name:

{{pagequery>@drafts [0-9]+.*;sort=name}}

Or, all files in the “happy:go:lucky” namespace, sorted by year, then date created, in proper case, in 2 columns, and display the page's title, not the name in the listing:

{{pagequery>@happy:go:lucky *;sort=cyear,cdate;group;proper;display={title};cols=2}}

Hopefully these examples will help to understand the workings of pagequery.