Writing an Application Manual/fr: Difference between revisions
ChristianW (talk | contribs) Created page with "Vous trouverez d'autres exemples utilisant DPL sur User:Claus_chr/DPL." |
ChristianW (talk | contribs) Created page with "* Les liens vers les pages du manuel doivent correspondre exactement au nom de la page name (c'est à dire pas de liens par redirection !)" |
||
Line 44: | Line 44: | ||
* 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. | * 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. | ||
* | * Les liens vers les pages du manuel doivent correspondre exactement au nom de la page name (c'est à dire pas de liens par redirection !) | ||
* 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. | * 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. |
Revision as of 14:36, 14 May 2018
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 # 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 1/subsection 1
- Appname/Manual/section 1/subsection 2
and so on.
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:
- 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.
- 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.
- The title of the section/subsection must exactly match the page name, otherwise Docbook links won't work.
- Subsection titles must be written like this:
===title===
, 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:====title====
.
- 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.
- Les liens vers les pages du manuel doivent correspondre exactement au nom de la page name (c'est à dire pas de liens par redirection !)
- 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.
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
- Use the red links to create the page, and write up a section at a time.
- Note on the Discussion page anything you will need to refer to later, such as links that can't yet be created.
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.
Preparer le manuel pour la traduction
- The steps for markup editing can be found on Preparing a Page for Translation. Please adhere to that guide, since old markup styles may not still be relevant.
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 this page.