Manuals will be included as sub-pages of the main application page. For brevity, I will refer to that main page as Appname. The structure, therefore would be something like:
If some of your sections grow too large, you can place subsections on separate pages. It might look like this:
and so on.
|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 ).|
|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.|
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:
===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:
|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.|
|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.|
|Please do not use any kind of punctuation in your page names — punctuation like question marks or periods creates serious problems for the wiki software, in particular for the translation system.|
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.
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.
|It's important to be consistent, particularly in Manuals, so here are some general rules:
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>
You can find more examples on using DPL on User:Claus_chr/DPL.
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.