Escriure un manual d'aplicació
Notes
Els manuals s'inclouen com a sub-pàgines de la pàgina principal de l'aplicació. Per raons de brevetat, em referiré a la pàgina principal com Appname. L'estructura, per tant, seria com:
- 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 alguna de les seccions és massa gran, podeu col·locar les subseccions en pàgines separades. Podrien tenir aquest aspecte:
- 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/secció 1/subsecció 1
- Appname/Manual/secció 1/subsecció 2
i així successivament.
Per emprar els Docbook generats automàticament tenint el mateix contingut a la pàgina que feu a UserBase, i per a que els enllaços funcionin en el Docbook hi ha un parell de coses o directrius que s'han de seguir:
- La taula Docbook de continguts s'empra per llistar totes les seccions i subseccions, independentment de si tenen una pàgina pròpia. D'altra banda, les subseccions de la subsecció no seran llistades en el TOC del Docbook encara que tinguin una pàgina pròpia.
- Totes les pàgines han de tenir un títol a la part superior, bé una secció (== ... ==), una subsecció (=== ... ===), o una subsecció de la subsecció (==== ... ====), d'altra manera l'estructura Docbook estarà en un format incorrecte.
- El títol de la secció/subsecció haurà de coincidir exactament amb el nom de la pàgina, en cas contrari els enllaços en els Docbook no funcionaran.
- Els títols de les subseccions s'han d'escriure així:
===títol===, encara que es trobin en el nivell superior de la pàgina. En cas contrari l'estructura dels Docbook estarà en un format incorrecte. De la mateixa manera, si teniu una subsecció molt llarga, amb subseccions de la subsecció, aquestes pàgines hauran de tenir els seus títols escrits així:====títol====.
- Les subseccions de la subsecció no apareixeran a la pàgina de continguts i no apareixeran en una pàgina pròpia en el Docbook sent de nivell 4 o inferior, p.ex. ==== o més.
- Links to pages in the manual must exactly match the page name (i.e. no links via redirects!)
- 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.
Necessiteu un bloc de notes per experimentar amb seccions de capçaleres/pàgines. Podeu utilitzar la vostra pàgina UserTalk, o les pàgines de debat adjuntes a l'àrea on esteu treballant. És útil si es treu res que ja no és necessari, una vegada es completa el treball.
El desenvolupament d'un manual
Durant el desenvolupament del manual normalment és millor mantenir-lo separat dels continguts d'UserBase. Alguns prefereixen editar els esborranys com subpàgines de la seva pàgina de debat. També tenim un espai de nom Draft: per a aquest propòsit.
Per crear la pàgina de contingut del manual, només cal escriure http://userbase.kde.org/Draft:Appname/Manual a la barra d'adreces del navegador, o el lloc [[Draft:Appname/Manual]] com enllaç a una pàgina i fer-hi clic. De qualsevol manera us portarà a una pàgina que indica que la pàgina no existeix, però que es pot crear fent clic en un enllaç.
Contingut
- Un vegada preses les decisions (el que pot ser un procediment llarg), creeu els enllaços corresponents a la pàgina Contingut. Per descomptat, és possible inserir una secció més endavant, si trobeu que falta alguna cosa.
La construcció del vostre manual
- Utilitzeu els enllaços de color vermell per a crear la pàgina, i escriviu una secció cada vegada.
- Tingueu present la pàgina de debat per a qualsevol cosa a la que haureu de referir-vos més tard, com ara enllaços que encara no es poden crear.
- Aneu amb compte amb els nivells de les capçaleres: Hem de començar en el segon nivell (Mediawiki utilitza el nivell superior pel nom de la pàgina), amb ==.
- Assegureu-vos que us refereiu amb freqüència a aquesta pàgina, a Tasques i eines i a Directrius tipogràfiques.
- Comproveu si totes les cel·les d'una taula tenen espai després del caràcter de canonada. Aquesta regla és conforme amb traditional wiki formatting.
- Feu que el nom de l'aplicació tingui un format consistent (eviteu l'ús de Amaroks, feu Amarok's).
- Assegureu-vos que totes les imatges estan en format PNG (podeu usar JPEG, però en aquest cas serà necessari convertir-les a PNG amb l'script). Deseu el treball mitjançant la seva conversió abans de començar
.
- Elimineu tots els caràcters no imprimibles dels noms de les imatges.
Cercar al manual
En algun moment, potser haureu de trobar alguna cosa que vàreu escriure, però no podeu recordar on. Utilitzant la caixa de cerca del wiki pot no ser idoni, a menys que la cadena de cerca sigui molt específica. Podeu aconseguir un millor control sobre les cerques utilitzant l'extensió DPL. Per exemple, per trobar les pàgines del manual que continguin una determinada cadena, podeu afegir el següent a qualsevol pàgina:
<DPL> titlematch = %Appname/Manual% namespace = Draft include = * includematch = /cadena a cercar/ resultsheader = Manual Pages: format = ,\n* [[%PAGE%|%TITLE%]]\n,, </DPL>
Podeu trobar més exemples sobre l'ús de la DPL en User:Claus_chr/DPL.
Preparar el manual per a la traducció
- Els passos per a editar les marques es poden trobar a Preparar una pàgina per a la traducció. Si us plau, adheriu-vos a aquesta guia, ja que els estils de marcat antics encara no són rellevants.