Writing an Application Manual/fr: Difference between revisions

From KDE Wiki Sandbox
(Created page with "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,...")
No edit summary
 
(79 intermediate revisions by 2 users not shown)
Line 5: Line 5:


* Appname
* Appname
** Appname/Hints and Tips
** Appname/Trucs et astuces
* Appname/Manual # Your Contents page
* Appname/Manuel # Page de description du contenu
** Appname/Manual/An Introduction to Appname
** Appname/Manuel/Introduction sur Appname
** Appname/Manual/Configuration Choices
** Appname/Manuel/Choix de configurations
** Appname/Manual/The First Time you use Appname
** 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''
** Appname/Manual/''section xxx''
*** Appname/Manual/''section 1''/''sous-section 1''
** Appname/Manual/Hints and Tips
*** Appname/Manual/''section 1''/''sous-section 2''
** Appname/Manual/Troubleshooting
et ainsi de suite.
** Appname/Manual/Bug reports
 
** Appname/Manual/Get involved #link to techbase etc
{{Info/fr|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 {{Smiley}}).}}
 
{{Remember/fr|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.}}


If some of your sections grow too large, you can place subsections on separate pages. It might look like this:
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 :


* Appname/Manual # Your Contents page
* 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.
** 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 1''/''subsection 1''
*** Appname/Manual/''section 1''/''subsection 2''
and so on.


{{Info|The page names do not have to follow the structure of the document closely! In the above example you could simply use Appname/Manual/''subsection 2'' instead of Appname/Manual/''section 1''/''subsection 2'' and similarly for sub-subsections (as long as this procedure does not produce duplicate names {{Smiley}}).}}
* 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.


{{Remember|Try to keep page names short and avoid long paths. Overly long page names are cumbersome to type when you link to them, and they don't look good on the wiki pages. And always remember: The page names and their structure have no influence on the finished handbook whatsoever! It is entirely determined by the headings in the actual text.}}
* 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.


In order for the automatically generated Docbook to have the same contents page as the one you make on UserBase, and for links to work in the Docbook there are a couple or guidelines, that must be followed:
* Les titres des sous-sections doivent être écrits comme ceci : <code>==='' '''titre''' ''===</code>, 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 : <code>===='' '''titre''' ''====</code> .


* The Docbook Table of Contents will list all sections and subsections regardless of whether they have a page of their own. On the other hand, subsubsections won't be listed in the Docbook TOC even though they have a page of their own.
* 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.


* All pages should have a heading at the very top, either a section (== ... ==), a subsection (=== ... ===), or a subsubsection (==== ... ====), otherwise the Docbook structure will be messed up.
* Les liens vers les pages du manuel doivent correspondre exactement au nom de la page name (c'est à dire pas de liens par redirection !)


* The title of the section/subsection must exactly match the page name, otherwise Docbook links won't work.
* 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.


* Subsection titles must be written like this: <code>==='''''title'''''===</code>, even if it is the top level on a page. Otherwise the Docbook structure will be messed up. Similarly, if you have a very long subsection with subsubsections on pages of their own, these pages must have their titles written like this: <code>===='''''title'''''====</code>.
{{Note/fr|1=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.}}


* Subsubsections that should not appear in the contents page and should not appear on a page of its own in the Docbook must be level 4 or below, i.e ==== or more.
{{Remember/fr|1=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.}}


* Links to pages in the manual must exactly match the page name (i.e. no links via redirects!)
{{Remember/fr|1=<span  style="color:red;">Veillez à n'utiliser aucune forme de ponctuation dans le nom des pages </span> &mdash; 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.}}


* If you link to a subsection of a page, you must have an anchor at the target location. Failing that will mess up Docbook links as well as translations.
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é.


{{Note|1=Every subsection (===) gets a page of its own in the Docbook, even if it is part of a longer page on UserBase. This means that a section (==) that contain a number of subsections, but no text before the first subsection gets a Docbook page that contains nothing but links to the subsections.}}
== Réaliser un manuel ==


{{Remember|1=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.}}
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 <tt>Draft:</tt> pour cela.


{{Remember|1=<span style="color:red;">Please do not use any kind of punctuation in your page names</span> &mdash; punctuation like question marks or periods creates serious problems for the wiki software, in particular for the translation system.}}
Pour créer le sommaire de votre manuel, écrivez simplement <tt><nowiki>http://userbase.kde.org/Draft:</nowiki>'''''Appname/Manuel'''''</tt> sur la ligne d'adresse de votre explorateur, ou placez le lien <nowiki>[[Draft:Appname/Manual]]</nowiki> 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.


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.
=== Contenu ===


== Developing a Manual ==
* 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.


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 <tt>Draft:</tt> namespace for this purpose.
=== Concevoir votre manuel ===


To create the content page of your manual, simply write <tt><nowiki>http://userbase.kde.org/Draft:</nowiki>'''''Appname/Manual'''''</tt> in the address line of your browser, or place the <nowiki>[[Draft:Appname/Manual]]</nowiki> 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.
* Utilisez les liens rouges pour créer les pages, et écrivez une section à la fois.


===Contents===
* 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.


* 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.
{{Remember/fr|1=Il est important d'être cohérent, particulièrement pour les manuels, il existe donc quelques règles générales :<!--}}-->


===Building your Manual===
* 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 <nowiki>==</nowiki>


* Use the red links to create the page, and write up a section at a time.
* Assurez-vous de vous référer souvent à cette page, pour les  [[Special:myLanguage/Tasks_and_Tools|tâches et outils]] et pour les [[Special:myLanguage/Typographical_Guidelines|règles typographiques]]


* Note on the Discussion page anything you will need to refer to later, such as links that can't yet be created.
* Vérifiez que toutes les cellules des tableaux aient un espace après la barre verticale.  Cette règle se conforme au [http://en.wikipedia.org/wiki/Help:Table formatage wiki traditionnel].


{{Remember|1=It's important to be consistent, particularly in Manuals, so here are some general rules:<!--}}-->
* Faire en sorte que les noms d'applications aient un format cohérent (évitez d'utiliser '''Amarok'''s, mais préférez '''Amarok's''').


* Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using <nowiki>==</nowiki>
* 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 [[Image:Smiley.png|16px]].


* Make sure you refer frequently to this page, to [[Special:myLanguage/Tasks_and_Tools|Tasks and Tools]] and to [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]
<!--{{-->* Enlever dans les noms d'images, tous les caractères non imprimables.}}


* Check if all table cells have space after the pipe character. This rule conforms with [http://en.wikipedia.org/wiki/Help:Table traditional wiki formatting].
==== Considérations de mise en forme ====


* Make application name formatting consistent (avoid using '''Amarok'''s, do use '''Amarok's''').
Afin que votre manuel soit traductible en format Docbook il existe quelques restrictions que vous devriez observer concernant la mise en forme.  


* 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 [[Image:Smiley.png|16px]].
* Les [[Special:myLanguage/Toolbox#Notes and Warnings|notes et avertissements]] ne supportent pas les titres alternatifs dans Docbook. N'écrivez donc pas quelque chose comme <br /><code><nowiki>{{Remember/fr|2=N'oubliez pas ceci!|1=Vous pouvez utiliser...}}</nowiki></code><br />La partie <code>2=...</code> n'a pas de sens dans Docbook et le programme qui transforme la page wiki en Docbook peut devenir incohérent. Ecrivez simplement <br /><code><nowiki>{{Remember/fr|1=Vous pouvez utiliser...}}</nowiki></code>


<!--{{-->* Remove all non-printable characters from image names.}}
* [[Special:myLanguage/Toolbox#Embed a Video|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.


=== Searching your manual ===
=== 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:
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:


{{Input|1=<nowiki>
{{Input/fr|1=<nowiki>
<DPL>
<DPL>
   titlematch = %Appname/Manual%
   titlematch = %Appname/Manual%
   namespace = Draft
nottitleregexp = .*((/[a-z][a-z](.|-..)?)|([ _][(][a-z][a-z](...)?[)]))$
   namespace = | Draft
   include = *
   include = *
   includematch = /string to search for/
   includematch = /chaîne à rechercher/
  includemaxlength = 0
   resultsheader = Manual Pages:
   resultsheader = Manual Pages:
   format = ,\n* [[%PAGE%|%TITLE%]]\n,,
   format = ,\n* [[%PAGE%|%TITLE%]]\n,,
Line 101: Line 111:
</nowiki>}}
</nowiki>}}


You can find more examples on using DPL on [[User:Claus_chr/DPL]].
Vous trouverez d'autres exemples utilisant DPL sur [[User:Claus_chr/DPL]].
 
{{Note/fr|1=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
{{Input/fr|1=titlematch = %Amarok/QuickStartGuide%{{!}}%Amarok/Manual%}}
(Notez qu'il ne doit y avoir aucun espace de chaque côté du caractère '{{!}}' )
}}


==Preparing the Manual for Translation==
== Préparer le manuel pour la traduction ==


* The steps for markup editing can be found on [[Special:myLanguage/Edit Markup|Preparing a Page for Translation]].  Please adhere to that guide, since old markup styles may not still be relevant.
* Les étapes pour réaliser le marquage peuvent être consultées sur [[Special:myLanguage/Edit Markup|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.


== Producing a DocBook manual ==
== Produire un manuel DocBook ==


Once your manual is written you can have it transformed into a DocBook manual, so that your work can be used like an ordinary KDE handbook. The procedure is described in [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook|this page]].  
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 [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook|cette page]].  


[[Category:Contributing]]
[[Category:Contribuer/fr]]

Latest revision as of 13:59, 29 August 2018

Other languages:

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.

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.


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


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

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.

Retrieved from "https://wikisandbox.kde.org/index.php?title=Writing_an_Application_Manual/fr&oldid=399387"