Ecrire un manuel d'application

Jump to: navigation, search
This page is a translated version of the page Writing an Application Manual and the translation is 100% complete.

Other languages:
català • ‎dansk • ‎English • ‎français • ‎русский • ‎українська

Notes

Les manuels seront inclus comme des sous-pages de la page principale de l'application. Pour faire court, je parlerai de cette page principale comme Appname. La structure, devra en conséquence avoir la forme suivante :

  • Appname
    • Appname/Trucs et astuces
  • Appname/Manuel # Page de description du contenu
    • Appname/Manuel/Introduction sur Appname
    • Appname/Manuel/Choix de configurations
    • Appname/Manuel/Première utilisation de Appname
    • Appname/Manuel/section 1
    • Appname/Manuel/section xxx
    • Appname/Manuel/Trucs et astuces
    • Appname/Manuel/Disfonctionnements
    • Appname/Manuel/Déclarer les bogues
    • Appname/Manuel/Contribuer #lien vers techbase etc

Si certaines de vos sections grossissent trop, vous pouvez mettre les sous-sections sur des pages séparées. Ce qui pourrait ressembler à :

  • Appname/Manual # Votre page Table des matières
    • Appname/Manual/Une introduction à Appname
    • Appname/Manual/Choix des configurations
    • Appname/Manual/La première fois que vous utilisez Appname
    • Appname/Manual/section 1
      • Appname/Manual/section 1/sous-section 1
      • Appname/Manual/section 1/sous-section 2

et ainsi de suite.

Dialog-information.png
 
Information
Les noms de pages n'ont pas à suivre à la lettre la structure du document ! Dans l'exemple ci-dessus, vous pouvez simplement utiliser Appname/Manual/sous-section 2 au lieu de Appname/Manual/section 1/sous-section 2 et de la même manière pour les sous-sections (tant que cette méthode ne génère pas de doublons Face-smile.png).


Flag-red.png
 
À noter
Essayez d'avoir des noms courts pour les pages et évitez d'avoir les chemins trops longs. Les noms de pages trop longs sont fastidieux à taper lorsque vous les reliez, et ils ne sont pas beaux sur les pages wiki. Et rappelez-vous toujours: Les noms de pages et leur structure n'ont aucune influence sur le manuel fini ! Il est entièrement déterminé par les titres dans le texte actuel.


Pour que le Docbook généré automatiquement ait la même page de contenu que celle que vous avez créée sur UserBase et pour que les liens fonctionnent dans le Docbook, il y a quelques règles à suivre :

  • La table des matières de Docbook répertorie toutes les sections et sous-sections, qu'elles possèdent ou non une page. D'un autre côté, les sous-sous-sections ne seront pas listées dans la table des matières Docbook même si elles ont leur propre page.
  • Toutes les pages doivent avoir une entête tout en haut, ou bien une section (== ... ==), ou une sous-section (=== ... ===), ou encore une sous-sous-section (==== ... ====), sinon la structure du Docbook sera perturbée.
  • Le titre de la section/sous-section doit être le même que le nom de la page, sinon les liens Docbook ne fonctionneront pas.
  • Les titres des sous-sections doivent être écrits comme ceci : === titre ===, même s'il s'agit du niveau principal d'une page. Sinon cela perturbera la structure Docbook. De la même manière, si vous avez une section très longue avec des sous-sous-sections sur des pages ces pages doivent avoir leur titre écrit comme ceci : ==== titre ==== .
  • Les sous-sections qui ne doivent pas apparaître dans la table des matières ni individuellement sur une page du Docbook, doivent être de niveau quatre ou inférieur c'est à dire ==== ou plus.
  • Les liens vers les pages du manuel doivent correspondre exactement au nom de la page name (c'est à dire pas de liens par redirection !)
  • Si vous créez un lien vers une sous-section d'une page, vous devez avoir défini une ancre à l'emplacement cible. Si ce n'est pas le cas, cela perturbera les liens Docbook ainsi que les traductions.
Note-box-icon.png
 
Remarque
Chaque sous-section (===) reçoit d'elle-même une page dans le Docbook, même si elle fait partie d'une page plus longue dans UserBase. Cela signifie qu'une section (==) qui n'est composée que d'un nombre de sous-sections, et sans texte avec la première sous-section, reçoit une page Docbook qui ne contient rien d'autre que des liens vers les sous-sections.


Flag-red.png
 
À noter
Si à un moment donné, vous décidez de changer le titre de la section/sous-section principale d'une page (c'est à dire le premier titre), il est important de changer en même temps le nom de la page, et aussi celui de tous les liens qui pointent vers cette page pour qu'ils puissent utiliser le nouveau nom.


Flag-red.png
 
À noter
Veillez à n'utiliser aucune forme de ponctuation dans le nom des pages — les signes de ponctuation, comme le point d'interrogation, ou la virgule génèrent de graves problèmes à l'intérieur du logiciel wiki, en particulier dans le système de traduction.


Vous aurez besoin d'un brouillon pour expérimenter les titres des sections et des pages. Vous pouvez utiliser soit votre page de discussion utilisateur, ou la page de discussion attachée au domaine dans lequel vous travaillez. Il est utile d'enlever le superflu, une fois que le travail est terminé.

Réaliser un manuel

Pendant que vous rédigez votre manuel il est préférable de le tenir séparé du contenu courant de UserBase. Certains préfèrent écrire leurs brouillons en tant que sous-pages de leur page utilisateur de discussion. Il existe aussi un espace de noms Draft: pour cela.

Pour créer le sommaire de votre manuel, écrivez simplement http://userbase.kde.org/Draft:Appname/Manuel sur la ligne d'adresse de votre explorateur, ou placez le lien [[Draft:Appname/Manual]] sur une page et cliquez dessus. Dans les deux cas vos serez dirigés vers une page qui vous dira que la page n'existe pas, mais que vous pourrez créer en cliquant sur un lien.

Contenu

  • Une fois que vous avez pris les décisions (ce qui peut prendre du temps), créez les liens appropriés vers la page de la table des matières. Il est bien sûr possible d'insérer une section ultérieurement dans le cas où vous auriez oublié quelque chose.

Concevoir votre manuel

  • Utilisez les liens rouges pour créer les pages, et écrivez une section à la fois.
  • Notez sur la page de discussion tout ce à quoi vous aurez besoin de faire référence ultérieurement, comme des liens qui ne peuvent pas encore être créés.
Flag-red.png
 
À noter
Il est important d'être cohérent, particulièrement pour les manuels, il existe donc quelques règles générales :
  • Attention aux niveaux des entêtes - nous commençons au niveau deux (Médiawiki utilise le niveau un pour les noms de pages), en utilisant ==
  • Vérifiez que toutes les cellules des tableaux aient un espace après la barre verticale. Cette règle se conforme au formatage wiki traditionnel.
  • Faire en sorte que les noms d'applications aient un format cohérent (évitez d'utiliser Amaroks, mais préférez Amarok's).
  • Vérifiez bien que toutes les images sont au format PNG (vous pouvez aussi utiliser le JPEG, mais dans ce cas elles devraient être converties en PNG par le script). Sauvegardez le travail en les convertissant avant de démarrer 16px.
  • Enlever dans les noms d'images, tous les caractères non imprimables.


Considérations de mise en forme

Afin que votre manuel soit traductible en format Docbook il existe quelques restrictions que vous devriez observer concernant la mise en forme.

  • Les notes et avertissements ne supportent pas les titres alternatifs dans Docbook. N'écrivez donc pas quelque chose comme
    {{Remember/fr|2=N'oubliez pas ceci!|1=Vous pouvez utiliser...}}
    La partie 2=... n'a pas de sens dans Docbook et le programme qui transforme la page wiki en Docbook peut devenir incohérent. Ecrivez simplement
    {{Remember/fr|1=Vous pouvez utiliser...}}
  • Inclure une vidéo comporte certaines limitations dans l'implémentation actuelle : seulement YouTube et Vimeo sont supportés et seulement une valeur (l'identité de la vidéo) peut être passé comme argument.

Chercher dans votre manuel

A un certain moment, vous pourriez avoir besoin de rechercher quelque chose que vous avez écrit précédemment, mais vous ne savez plus où. L'utilisation de la boîte de recherche de wiki peut ne pas être idéale à moins que la chaîne que vous recherchez est très spécifique. Vous pouvez avoir un meilleur contrôle sur les recherches en utilisant l'extension DPL. Par exemple, pour trouver les pages de votre manuel qui contiennent une chaîne donnée, vous pouvez ajouter ceci a n'importe quelle page:

<DPL>
  titlematch = %Appname/Manual%
 nottitleregexp = .*((/[a-z][a-z](.|-..)?)|([ _][(][a-z][a-z](...)?[)]))$
  namespace = | Draft
  include = *
  includematch = /chaîne à rechercher/
  includemaxlength = 0
  resultsheader = Manual Pages:
  format = ,\n* [[%PAGE%|%TITLE%]]\n,,
</DPL>

Vous trouverez d'autres exemples utilisant DPL sur User:Claus_chr/DPL.

Note-box-icon.png
 
Remarque
Si vous travaillez sur le manuel de Amarok, soyez conscient que certaines pages s'écartent de la convention de nommage standard. Pour retrouver la correspondance sur toutes les pages du manuel Amarok, utilisez
titlematch = %Amarok/QuickStartGuide%|%Amarok/Manual%
(Notez qu'il ne doit y avoir aucun espace de chaque côté du caractère '|' )


Préparer le manuel pour la traduction

  • Les étapes pour réaliser le marquage peuvent être consultées sur Modifier le marquage des pages. Veuillez suivre les indications de ce guide, parce que l'ancienne manière de faire le marquage peut ne plus être significative.

Produire un manuel DocBook

Une fois que votre manuel est écrit vous pouvez le convertir en manuel DocBook, afin que votre travail soit utilisable comme n'importe quel manuel KDE ordinaire. La procédure est décrite sur cette page.


This page was last modified on 29 August 2018, at 13:59. Content is available under Creative Commons License SA 4.0 unless otherwise noted.