Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Interface

Utiliser la recherche globale

Ouvrir la barre de recherche avec Ctrl+K, trouver un document, une liste, une page ou un rapport, et lancer la recherche globale avec Ctrl+G.

Utiliser la recherche globale

Dodock a deux outils de recherche :

  • la barre de recherche (Ctrl+K) : elle trouve un type de document, une liste, une page, un rapport ou un document récent, et exécute quelques commandes ;
  • la recherche globale (Ctrl+G) : elle cherche un texte dans le contenu des documents indexés.

Ouvrir la barre de recherche

  1. Cliquez sur Rechercher dans le dock ou dans la barre latérale, ou appuyez sur Ctrl+K (⌘K sur Mac).
  2. Saisissez au moins deux caractères dans le champ « Rechercher ou saisir une commande ».
  3. Choisissez un résultat avec les flèches, puis appuyez sur Entrée.

Sans texte saisi, la barre propose vos pages récentes et vos liens fréquents. Les résultats sont aussi classés selon vos visites passées.

Ce que la barre de recherche propose

SaisieRésultat
Nom d'un type de document, d'une page ou d'un rapportUn lien direct vers la liste, la page ou le rapport.
Un texte saisi depuis une vue listeTrouver … dans … : la liste ouverte, filtrée sur son champ titre.
Un calcul, par exemple 12*3Le résultat du calcul.
N'importe quel texteChercher … : lance la recherche globale sur ce texte.

Lancer la recherche globale

Appuyez sur Ctrl+G (⌘G sur Mac), ou choisissez Chercher … dans la barre de recherche. La recherche globale parcourt les champs indexés des documents. Pour choisir ces champs, voir Configurer les champs de la recherche globale.

Résultats ajoutés par une application

Cette section s'adresse aux développeurs.

Une application peut ajouter des résultats à la barre de recherche avec le hook awesomebar_search dans son hooks.py :

awesomebar_search = ["mon_app.search.awesomebar_results"]

La méthode reçoit le texte saisi et renvoie une liste de dictionnaires :

CléRôle
label (ou value)Titre affiché. Obligatoire.
routeObligatoire. Route du bureau (["List", "ToDo"]), chemin (/desk/...) ou URL http(s)://, qui s'ouvre dans un nouvel onglet.
descriptionTexte sous le titre.
indexScore de tri. Plus il est élevé, plus le résultat monte.
route_optionsOptions passées à la route.

Dodock garde au plus 20 résultats par méthode. Une méthode en erreur est ignorée et l'erreur est écrite dans le journal awesomebar.