Index et recherches de pages

La gestion des index et des recherches 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, regroupés et/ou triés, en colonnes. 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 en plus 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 liste apparaisse. Vous pouvez avoir différentes listes pagequery dans la même page¹⁾.

Il peut s'agir d'une version simple :

{{pagequery>}}

Ou, plus compliquée :

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

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

{{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 alors 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 (:).

Quelques conseils pour trier et grouper avec succès : pagequery propose de très nombreuses options de tri, dont la plupart sont prévues pour pouvoir être regroupées. Donc si vous avez l'intention de grouper votre liste sur ses principaux en-têtes, il est plus intéressant de trier de la catégorie la plus large à la plus restreinte.

Par exemple : année ⇒ mois ⇒ nom. L'algorithme de tri va trier d'abord les pages par année, puis à l'intérieur de chaque année par mois, et enfin à l'intérieur de chaque mois par nom. Trier dans l'autre sens ne serait pas très intéressant, car tous les noms sont uniques : donc il n'y aurait pas de “groupes” !

Si vous regroupez le tri ci-dessus, vous obtiendrez le résultat suivant :

• Année
  • Mois
    • Nom
    • Nom
  • Mois2
    • Nom
    • Nom
    • etc…

La règle de base est : commencez par l'option la moins spécifique et progressez vers la plus précise.

J'ai ajouté de nouvelles pages, mais elles n'apparaissent pas dans ma mâââââgnifique nouvelle liste pagequery. Pourquoi ?I've added new pages but they do not show up in my nice new pagequery list. Why?

• Il faut désactiver les caches pour la page contenant la liste. Ajoutez

   ~~NOCACHE~~ 

  n'importe où dans la page, et vous devriez voir les mises à jour instantanément.

J'ai plein de pages 'start' que je ne veux pas voir quand je fait la liste du contenu des espaces de noms…

• Utilisez l'option hidestart. Et vérifiez que l'option start de votre configuration correspond bien aux noms de page start que vous utilisez !¹²⁾

Je préfère voir le titre des pages plutôt que leur nom. C'est possible ?

• Ajoutez l'option display=title quelque part dans votre pagequery.¹³⁾

J'ai migré le contenu de mon wiki sur une nouvelle version de DokuWiki, et pagequery ne me ramène aucune page, ou seulement après que j'aie modifié les pages.

• Utilisez le plugin SearchIndex pour reconstruire l'index de votre wiki, ou vérifiez que vous avez copié les index en même temps que le contenu.¹⁴⁾

• Afficher toutes les pages d'un espace de nom par ordre alphabétique :

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

Ou :

{{pagequery>@namespace *;sort=a,name;group;proper;cols=2}}    [version nom de page : permet l'utilisation de regex]

Ceci ramènera les résultats uniquement dans @namespace, et la liste sera triée alphabétiquement sur la première lettre ('sort=a'), puis alphabétiquement ('sort=name') à l'intérieur de chaque lettre. L'option group ne groupera que sur la première lettre (on ne peut pas grouper par nom, puisque chacun est unique).

• Pour voir le résultat sur 3 colonnes et avoir les liens en “Casse de phrase” sans soulignement :

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

• Grouper par année puis mois de création, et ensuite par nom, sur 2 colonnes, en affichant le vrai nom du mois, plus les liens en “Casse de phrase” sans soulignement, et pour couronner le tout : une bordure autour des colonnes du tableau :

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

• La même chose, mais en ne ramenant maintenant que les pages avec le mot “help” (NOTE : fulltext signifie qu'on cherche dans le contenu de la page, et pas seulement dans son nom) :

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

• Chercher toutes les pages de l'espace de nom “brouillon”, en ne ramenant que les fichiers dont le nom commence par un nombre, et triés par nom :

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

• Et si c'est dans l'espace de nom “happy:go:lucky”, en triant par année puis date de création, dans la jolie casse, sur 2 colonnes, et en affichant le titre de la page plutôt que le nom :

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