Le système d'aide de KDE

Le système d'aide de KDE a été conçu pour permettre d'accéder simplement aux systèmes d'aide d'Unix (man et info), ainsi que pour permettre d'accéder à l'aide de KDE proprement dite (au format HTML).

Lancer l'aide de KDE

Le système d'aide de KDE peut être démarré en utilisant une URL pour désigner un fichier à afficher, par exemple :

kdehelp file:/usr/local/src/qt/html/index.html

De nouveaux types d'URLs ont été ajoutés pour les systèmes info et man, par exemple :

kdehelp info:"(gcc)G++ and GCC"

kdehelp man:strcpy

Si aucun paramètre n'est fourni sur la ligne de commande, un index est affiché (pour le moment il comprend uniquement des liens vers les répertoires des systèmes info et man, mais il pourrait afficher des liens vers l'aide des applications de KDE dans le futur). Par ailleurs, un fichier ou une URL peuvent être ouvertes en utilisant les menus ou par glisser-déposer depuis le gestionnaire de fichiers de KDE, kfm.

Naviguer dans l'aide

On peut naviguer dans le système d'aide grâce aux liens à l'intérieur des documents, en utilisant les options du menu Aller à, ainsi que grâce aux boutons de la barre d'outils.

Contenu

Si le système d'aide est démarrer sans spécifier d'emplacement de départ sur la ligne de commande, le sommaire est affiché. Sa première section comprend des informations générales sur le projet KDE. La deuxième section traite de la documentation d'applications et de commandes spécifiques. La section concernant la documentation d'applications et de commandes système comprend trois parties :

Liste des applications de KDE
La documentation des applications KDE proprement dites. Toutes les applications KDE ont une aide au format HTML. Cette section liste toutes les applications KDE avec une breève description et un lien vers la documentation de l'application proprement dite.
Manuel du système Unix
Les pages de manuel Unix (man pages) forment le système de documentation en ligne traditionnel des systèmes Unix. La plupart des programmes sur votre système ont une page de manuel. De plus, des pages de manuel existent pour les fonctions de programmation et les formats de fichier.
Pages d'information du projet GNU
Beaucoup d'applications GNU ont une documentation au format TeXinfo, y compris gcc (le compilateur C/C++), emacs, et bien d'autres.

À tout moment vous pouvez revenir au Sommaire en en choisissant Contenu dans le menu Aller à ou en utilisant la barre d'outils.

Document précédent et Document suivant

Ce sont les commandes liées à l'historique des pages visitées. Document précédent vous amène sur la page visitée en dernier, alors que Document suivant vous amène à la page suivante à avoir été visitée. L'historique permet pour le moment de retenir 50 pages, mais cela devrait pouvoir être modifié par réglage dans les prochaines versions.

Noeud précédent, Noeud suivant, Remonter d'un noeud, Premier noeud

Vous reconnaîtrez ces commandes si vous avez déjà utilisé le système info auparavant. Les documents info sont arrangés hiérarchiquement, chaque page étant appelée un "noeud". Tous les documents info ont un Premier noeud, la page de démarrage. Vous pouvez revenir au premier noeud d'un document info en appuyant sur "Premier noeud".

Noeud précédent et Noeud suivant sont utilisés pour se déplacer vers les pages précédente et suivante au niveau courant de la hiérarchie.

En cliquant sur un élément de menu au sein d'un document, vous descendez d'un niveau dans la hiérarchie. Vous pouvez remonter d'un niveau dans la hiérarchie en cliquant sur Remonter d'un noeud.

Le système man est traité de manière similaire au système info, l'index de section correspondant au premier noeud, et chaque page de manuel étant au niveau en-dessous.

Recherche

Vous pouvez chercher une chaîne de caractères dans la documentation en sélectionnant Rechercher dans le menu Fichier. La page de recherche apparaît alors et vous demande le texte à rechercher. Vous pouvez alors choisir de chercher dans l'un des trois systèmes d'aide : KDE, man, ou info. En cliquant sur Lancer la recherche on affiche la liste des termes trouvés dans chaque catégorie sélectionnée. Les occurences KDE sont listées de la meilleure correspondance à la plus mauvaise. Les pages de manuel sont listées comme la commande apropos les renvoie.

La recherche dans les documents info n'a pas encore été implémentée.