Ce que la Documentation contient déjà

Le Manuel de Programmation de KDevelop: Le Manuel de l'Utilisateur pour la Conception d'Applications C++ pour l'Environnement de Bureau KDE avec l'EDI KDevelop, Version 1.2
Précédent | Chapitre 9. Extension de la Documentation avec SGML | Suivant

# 9.2. Ce que la Documentation contient déjà

Lors de la création d'un projet KDevelop, le répertoire `docs/en` contient déjà le fichier de documentation en anglais `index.sgml` et les fichiers résultant de la génération au format HTML. Ceux-ci sont déjà inclus dans le projet et l'emplacement d'installation est prédéfini au répertoire HTML de KDE. La documentation est déjà adaptée au nom de votre projet, son numéro de version et les informations sur le programmeur. En plus, la sortie génère le fichier index.html qui contient la table des matières (qui est ouverte par l'Aide de KDE quand l'utilisateur demande de l'aide) ; une introduction à l'installation et des informations sur le copyright en relation avec la Licence GPL sont incluses.

Par conséquent, lorsque vous étendez la documentation, vous devez seulement ajouter les informations qui sont spécifiques à votre projet. Notez que pour les projets KDE, vous devez exécuter "Construire le manuel d'utilisation" dans le menu "Projet" après la création du projet. Le fichier index.sgml est à nouveau traité par `ksgml2html` et le style KDE est ajouté à la sortie HTML. Ouvrez le dossier `docs/en` dans l'onglet RFV et ajoutez le fichier `logotp3.gif` au projet via le menu contextuel ; définissez ensuite correctement les propriétés du fichier afin qu'il s'installe au même endroit que les fichier HTML - dans `$(kde&_;htmldir)/en/&<;votre&_;projet&>;/logotp3.gif`.

Précédent | Sommaire | Suivant
Extension de la Documentation avec SGML | Niveau supérieur | Écrire de la Documentation SGML