Ecrire un manuel d'application

    From KDE UserBase Wiki
    Revision as of 17:45, 2 June 2018 by ChristianW (talk | contribs) (Created page with "Une fois que votre manuel est écrit vous pouvez le convertir en manuel DocBook, afin que votre travail soit utilisable comme m'importe quel manuel KDE ordinaire. La procédur...")

    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/Hints and Tips
    • Appname/Manual # Your Contents page
      • Appname/Manual/An Introduction to Appname
      • Appname/Manual/Configuration Choices
      • Appname/Manual/The First Time you use Appname
      • Appname/Manual/section 1
      • Appname/Manual/section xxx
      • Appname/Manual/Hints and Tips
      • Appname/Manual/Troubleshooting
      • Appname/Manual/Bug reports
      • Appname/Manual/Get involved #link to 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.

    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 ).


    À 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.

    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.


    Remember

    If at some point you decide to change the title of the main (sub)section of a page (the first headline), it is important that you also change the name of the page accordingly, and also that all links to that page are modified to match the new name.


    À 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.


    You will need a scratchpad to experiment with section headings/pages. You can use either your UserTalk page, or the discussion pages attached to the area where you are working. It's helpful if you remove anything no longer required, once the job is completed.

    Réaliser un manuel

    While developing your manual it is usually best to keep it separate from the regular UserBase content. Some prefer to edit their drafts as subpages of their Talk: page. We also have a special Draft: namespace for this purpose.

    To create the content page of your manual, simply write http://userbase.kde.org/Draft:Appname/Manual in the address line of your browser, or place the [[Draft:Appname/Manual]] link in a page and then click it. Either way you will be taken to a page telling you that the page does not exist, but that you can create it clicking a link.

    Contenu

    • Once you have made the decisions (that can be a lengthy procedure), create appropriate links on the Contents page. It is, of course, possible to insert a section later if you find you've missed something.

    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.

    À noter

    ) . 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).
    • Ensure that all images are in PNG format (you can use JPEG as well, but in this case they should be converted to PNG by the script). Save work by converting them before you start .
    • Enlever dans les noms d'images, tous les caractères non imprimables.


    Chercher dans votre manuel

    At some point, you may need to find something that you wrote earlier, but can't remember where. Using the wiki search box may not be ideal unless the string you search for is very specific. You can get much better control over searches using the DPL extension. For example, to find the pages in your manual containing a certain string, you can add the following to any page:

    <DPL>
      titlematch = %Appname/Manual%
      namespace = Draft
      include = *
      includematch = /string to search for/
      resultsheader = Manual Pages:
      format = ,\n* [[%PAGE%|%TITLE%]]\n,,
    </DPL>
    

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

    Préparer le manuel pour la traduction

    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 m'importe quel manuel KDE ordinaire. La procédure est décrite sur cette page.