How To Convert a UserBase Manual to Docbook/ca: Difference between revisions

From KDE UserBase Wiki
(Created page with "* Prepareu la llista de pàgines (elimineu les adreces de UserBase <nowiki>http://userbase.kde.org</nowiki>). Exemple per a '''Amarok''':")
No edit summary
 
(76 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />
<languages />
<span id="Preface"></span>
==Prefaci==
==Prefaci==


Line 6: Line 8:
Si voleu millorar el procediment, teniu bones habilitats amb Python, i coneixeu els principis d'autoria de docbook, podeu millorar el procediment. Si us plau, poseu-vos en contacte amb [[User:Yurchor|Yurchor]] si sou capaç d'ajudar.
Si voleu millorar el procediment, teniu bones habilitats amb Python, i coneixeu els principis d'autoria de docbook, podeu millorar el procediment. Si us plau, poseu-vos en contacte amb [[User:Yurchor|Yurchor]] si sou capaç d'ajudar.


<span id="Preparing_Pages_for_Conversion"></span>
==Preparar les pàgines per a la conversió==
==Preparar les pàgines per a la conversió==


Line 38: Line 41:
* Comproveu si totes les cel tenen espai després del caràcter de canonada. Aquesta norma s'ajusta al [http://en.wikipedia.org/wiki/Help:Table format wiki tradicional].
* Comproveu si totes les cel tenen espai després del caràcter de canonada. Aquesta norma s'ajusta al [http://en.wikipedia.org/wiki/Help:Table format wiki tradicional].


* Feu que el nom de l'aplicació tingui un format consistent (eviteu l'ús de '''Amarok'''s, feu '''Amarok's''').
* Feu que el nom de l'aplicació tingui un format compatible (eviteu l'ús de '''Amarok'''s, feu '''Amarok's''').


* Assegureu-vos que ''totes'' les imatges estan en format PNG.
* Assegureu-vos que ''totes'' les imatges estan en format PNG.


* Elimineu tots els caràcters no imprimibles dels noms d'imatge.
* Elimineu tots els caràcters no imprimibles dels noms d'imatge.
 
<span id="Export"></span>
<span id="Export"></span>
===Exportar===
===Exportar===


* Prepareu la llista de pàgines (elimineu les adreces de UserBase <nowiki>http://userbase.kde.org</nowiki>). Exemple per a '''Amarok''':
* Prepareu la llista de pàgines (elimineu les adreces de UserBase <nowiki>http://userbase.kde.org</nowiki>). Exemple per a '''Amarok''':


{{Input|1=Amarok
{{Input|1=Amarok/Manual/Introduction
Amarok/QuickStartGuide
Amarok/QuickStartGuide
Amarok/QuickStartGuide/GettingStarted
Amarok/QuickStartGuide/GettingStarted
Line 63: Line 67:
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/AdvancedFeatures
Amarok/Manual/ConfiguringAmarok/ChangingLayout
Amarok/Manual/AdvancedFeatures/CollectionScanning
Amarok/Manual/Organization
Amarok/Manual/AdvancedFeatures/CoverManager
Amarok/Manual/Organization/Collection
Amarok/Manual/AdvancedFeatures/DynamicPlaylists
Amarok/Manual/Organization/CollectionScanning
Amarok/Manual/AdvancedFeatures/AutomaticPlaylistGenerator
Amarok/Manual/Organization/Collection/SearchInCollection
Amarok/Manual/AdvancedFeatures/ExternalDatabase
Amarok/Manual/Organization/Collection/OrganizeCollection
Amarok/Manual/AdvancedFeatures/AFT
Amarok/Manual/Organization/Collection/RemoteCollections
Amarok/Manual/AdvancedFeatures/Moodbar
Amarok/Manual/Organization/Collection/RemoteCollections/Ampache
Amarok/Manual/AdvancedFeatures/WorkingWithMediaDevices
Amarok/Manual/Organization/Collection/RemoteCollections/DAAP
Amarok/Manual/AdvancedFeatures/SavedPlaylists
Amarok/Manual/Organization/Collection/RemoteCollections/Samba
Amarok/Manual/AdvancedFeatures/PlaylistFiltering
Amarok/Manual/Organization/Collection/RemoteCollections/UPnP
Amarok/Manual/AdvancedFeatures/QueueManager
Amarok/Manual/Organization/Collection/ExternalDatabase
Amarok/Manual/AdvancedFeatures/SearchInCollection
Amarok/Manual/Organization/Collection/WorkingWithMediaDevices
Amarok/Manual/AdvancedFeatures/TagEditor
Amarok/Manual/Organization/CoverManager
Amarok/Manual/AdvancedFeatures/OrganizeCollection
Amarok/Manual/Organization/TagEditor
Amarok/Manual/AdvancedFeatures/Transcoding
Amarok/Manual/Organization/Transcoding
Amarok/Manual/AdvancedFeatures/ScriptManager
Amarok/Manual/Organization/ScriptManager
Amarok/Manual/AdvancedFeatures/RemoteCollections
Amarok/Manual/Playlist
Amarok/Manual/AdvancedFeatures/RemoteCollections/Ampache
Amarok/Manual/Playlist/SavedPlaylists
Amarok/Manual/AdvancedFeatures/RemoteCollections/DAAP
Amarok/Manual/Playlist/PlaylistFiltering
Amarok/Manual/AdvancedFeatures/RemoteCollections/Samba
Amarok/Manual/Playlist/QueueManager
Amarok/Manual/AdvancedFeatures/RemoteCollections/UPnP
Amarok/Manual/Playlist/DynamicPlaylists
Amarok/Manual/MenuAndCommandReference/AmarokMenu
Amarok/Manual/Playlist/AutomaticPlaylistGenerator
Amarok/Manual/MenuAndCommandReference/ViewMenu
Amarok/Manual/Various
Amarok/Manual/MenuAndCommandReference/Playlist
Amarok/Manual/Various/Moodbar
Amarok/Manual/MenuAndCommandReference/Tools
Amarok/Manual/Various/AmarokOnOtherPlatforms
Amarok/Manual/MenuAndCommandReference/Settings
Amarok/Manual/Various/AmarokOnOtherPlatforms/NonKDE Desktops
Amarok/Manual/MenuAndCommandReference/Help
Amarok/Manual/Various/AmarokOnOtherPlatforms/Windows
Amarok/Manual/KeybindingReference
Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX
Amarok/Manual/KeybindingReference/GlobalShortcuts
Amarok/Manual/Various/TroubleshootingAndCommonProblems
Amarok/Manual/KeybindingReference/AmarokShortcuts
Amarok/Manual/Various/FAQ
Amarok/Manual/TroubleshootingAndCommonProblems
Amarok/Manual/References
Amarok/Manual/AmarokOnOtherPlatforms/Non-KDE Desktops
Amarok/Manual/References/MenuAndCommandReference
Amarok/Manual/AmarokOnOtherPlatforms/Windows
Amarok/Manual/References/MenuAndCommandReference/AmarokMenu
Amarok/Manual/AmarokOnOtherPlatforms/OSX
Amarok/Manual/References/MenuAndCommandReference/ViewMenu
Amarok/Manual/FAQ
Amarok/Manual/References/MenuAndCommandReference/Playlist
Amarok/Manual/Credits_and_License}}
Amarok/Manual/References/MenuAndCommandReference/Tools
Amarok/Manual/References/MenuAndCommandReference/Settings
Amarok/Manual/References/MenuAndCommandReference/Help
Amarok/Manual/References/KeybindingReference
Amarok/Manual/References/KeybindingReference/GlobalShortcuts
Amarok/Manual/References/KeybindingReference/AmarokShortcuts
Amarok/Manual/References/Credits and License}}


{{Tip|1=You can obtain the full list of pages for your application with the following script:<!--}}-->
{{Tip/ca|1=Podeu obtenir la llista completa de les pàgines per a la vostra aplicació amb el següent script:<!--}}-->


<div class="mw-translate-fuzzy">
{{Input|1=<nowiki><DPL>
{{Input|1=<nowiki><DPL>
   nottitlematch = %/__|%/zh-%|%(%)
   nottitlematch = %/__|%/zh-%|%(%)
Line 110: Line 121:
   format = ,\n* [[%PAGE%|%TITLE%]],,
   format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL></nowiki>}}
</DPL></nowiki>}}
</div>


<!--{{-->Replace '''''Amarok''''' with the name of your application, put it on your user page, and click on <menuchoice>Preview</menuchoice>. Rearrange the list according to the ToC of your manual.
<!--{{-->Substituïu '''''Amarok''''' amb el nom de la vostra aplicació, poseu-ho a la vostra pàgina d'usuari, i feu clic a <menuchoice>Vista prèvia</menuchoice>. Es reordenarà la llista d'acord amb l'índex de continguts del manual.
}}
}}


* Go to the [[Special:Export|export page]].
{{Note|1=If You are working with the Amarok manual be aware that it does not fully conform to manual page naming conventions. You can use
{{Input|1= titlematch = Amarok/Manual%{{!}}Amarok/QuickStartGuide%}}
(Note: No space characters in title pattern!)
}}


* Paste the page list into the <menuchoice>bigger</menuchoice> text field.
* Aneu a la pàgina [[Special:Export|Exporta les pàgines]].


* Click on <menuchoice>Export</menuchoice>.
* Enganxeu la llista de pàgines al camp de text <menuchoice>més gran</menuchoice>.
[[File:XML_export.png|350px|center|thumb|Export of Amarok manual pages]]


* Save the file. The saved file will be called <tt>Manual.xml</tt> in what follows.
* Feu clic a <menuchoice>Exporta</menuchoice>.
[[File:XML_export.png|350px|center|thumb|S'exportaran les pàgines de manual de Amarok.]]


* Deseu el fitxer. El fitxer desat s'anomenarà <tt>Manual.xml</tt> en el que segueix.
<span id="Conversion"></span>
===Convertir===
===Convertir===


* Install Subversion package for your system.
* Instal·leu el paquet Subversion pel vostre sistema.
 
* Obteniu l'última versió de l'script de la conversió: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}


* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
* Copieu <tt>Manual.xml</tt> a la carpeta de l'script.


* Copy <tt>Manual.xml</tt> to the script folder.
* Executeu {{Input|1=python wiki2docbook.py Manual.xml}} si voleu descarregar totes les captures de pantalla (es necessita algun temps per a descarregar totes les imatges des de UserBase, grep i wget han d'estar instal·lats), o {{Input|1=python wiki2docbook.py -s Manual.xml}} si no necessiteu descarregar les imatges.


* Run {{Input|1=python wiki2docbook.py Manual.xml}} if you want to download all screenshots (it takes some time to download all images from UserBase, grep and wget should be installed), or {{Input|1=python wiki2docbook.py -s Manual.xml}} if you need not to download images.
{{Warning|1=At some point in the past it became necessary to add a line containing <br /><code>144.76.227.197 userbase.kde.org</code><br /> to <tt>/etc/hosts</tt> in order to access UserBase from the script. This is no longer the case. If you already added such a line to your <tt>/etc/hosts</tt>, then you should remove it again.}}


<span id="Post-processing"></span>
===Post-processament===
===Post-processament===


* Rename <tt>Manual.xml.docbook</tt> to <tt>index.docbook</tt>.
* Canvieu el nom de <tt>Manual.xml.docbook</tt> a <tt>index.docbook</tt>.
 
* Comproveu si la conversió s'ha realitzat correctament: {{Input|1=checkXML index.docbook}}
 
* Corregiu els errors (millor sobre les pàgines de UserBase).
 
* Convertir docbook a HTML: {{Input|1=meinproc4 index.docbook}}
 
* Comproveu les pàgines HTML (totes les imatges han de ser visibles, els enllaços no han de donar lloc a pàgines 404).
 
* Substituïu les imatges grans per miniatures usant '''convert''' de '''ImageMagick'''.
 
* Arrangeu els enllaços a docbook, de manera que portin a la secció de docbook, no pàgines de UserBase.
 
* Arrangeu el nom de l'aplicació d'acord amb la llista d'entitats del KDE.
 
* Copieu <tt>index.docbook</tt> i les imatges a la vostra carpeta <tt>/doc</tt> i publiqueu-ho (commit) al repositori.
[[File:K3b_docs.png|350px|center|thumb|La documentació de K3b a UserBase en Opera i la pàgina convertida en el Konqueror.]]
 
<span id="Updating_Your_DocBook_from_UserBase"></span>
== Actualitzar els DocBook des de UserBase ==
 
Per actualitzar els vostres docbook convertits si us plau utilitzeu el següent procediment:
 
* Feu una exportació XML des de UserBase. Veure la secció [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook#Export|Exportar]].
 
* Utilitzeu l'script per actualitzar el contingut (les capçaleres de resum, paraules clau i el peu es mantindrà): {{Input|1= python wiki2docbook.py -r index.docbook Manual.xml}}
 
* Comproveu el docbook, reanomeneu el fitxer a index.docbook i publiqueu-lo amb les captures de pantalla al vostre repositori.
 
<span id="Converting_DocBook_into_Other_Format"></span>
== Convertir els DocBook a un altre format ==
 
<span id="Converting_into_PDF"></span>
=== Convertir-los a PDF ===
 
En general, no hi ha necessitat de convertir els DocBook de forma manual. Podeu descarregar el PDF convertit des del lloc [http://docs.kde.org/ de documentació del KDE].
 
En cas de necessitar cap personalització addicional, feu el següent:
 
* Assegureu-vos que teniu alguna distribució de '''LaTeX''' instal·lada (normalment, TeXLive).
 
* Creeu el següent script (anomenat <tt>buildpdf.sh</tt>) al directori dels DocBook:
{{Input|1=
<syntaxhighlight lang="bash">#!/bin/bash
 
export SGML_CATALOG_FILES=/usr/share/sgml/docbook/sqml-dtd-4.5/catalog:/usr/share/kf5/kdoctools/customization/catalog.xml:/usr/share/sgml/docbook/xml-dtd-4.5/docbook
# add -d to command below to keep the /tmp folder, so you can examine the generated tex.
./dblatex-cvs-install/bin/dblatex -d -b pdftex --style \
kdestyle\
-o $(pwd | awk -F/ '{ print $NF }').pdf \
-P latex.output.revhistory=0  -P newtbl.use=1 \
-P imagedata.default.scale=pagebound \
-P literal.width.ignore=1 \
-I $KDEDIR/share/doc/HTML/en/ \
-X \
        $1</syntaxhighlight>}}
* Descarregueu els estils de KDE:
{{Input|1=<nowiki>git clone git://anongit.kde.org/websites/docs-kde-org.git</nowiki>}}
 
* Ajusteu <tt>dblatex-cvs-install/bin/dblatex</tt> com segueix
 
<!--}}-->{{Input|1=
<syntaxhighlight lang="bash">#!/bin/sh
 
TEXINPUTS=:/camí/al/vostre/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS
 
/camí/al/vostre/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*</syntaxhighlight>}}<!--{{-->
 
(Canvieu '''''/camí/al/vostre/''''' segons el cas).
 
* Copieu els estils KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) a algun directori TeX on es trobi la instal·lació de '''LaTeX''' (jo els he copiat a <tt>/usr/share/texmf-dist/tex/latex/kde</tt>).
 
* Actualitzeu els camins amb <code>mktexlsr</code> des de l'arrel.
 
<div class="mw-translate-fuzzy">
* Executeu <code>./buildpdf.sh index.docbook</code>.
</div>
 
* Copieu tots els fitxers des de <tt>/tmp/tpb-'''''usuari'''''-'''''digits'''''</tt> al directori de treball.
 
* Personalitzeu i editeu el fitxer <tt>tex</tt> en [[Special:myLanguage/Kile|Kile]], segons correspongui.
 
* Compileu el fitxer PDF amb <keycap>Alt + 6</keycap>.
 
<span id="Converting_into_EPUB"></span>
=== Convertir-los a EPUB ===
 
* Assegureu-vos que '''Calibre''' està instal·lat al vostre sistema.


* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
* Convertiu en primer lloc els vostres DocBook a HTML. Per a fer-ho utilitzeu <code>meinproc4 index.docbook</code>.


* Fix the errors (better on UserBase pages).
* Inicieu el '''Calibre''' i escolliu <menuchoice>Afegeix llibres</menuchoice>.


* Convert docbook to HTML: {{Input|1=meinproc4 index.docbook}}
* Seleccioneu <tt>index.html</tt> a la carpeta de DocBook. Espereu fins que el llibre estigui carregat.


* Check HTML pages (all images should be visible, links should not lead to 404-pages).
* Escolliu <menuchoice>Converteix llibres</menuchoice>.


* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
* Ompliu els camps de metadades segons correspongui.


* Fix links in docbook, so they lead to docbook section, not UserBase pages.
[[File:calibre.png|350px|center|thumb|Pàgina de configuració de la conversió a Calibre.]]


* Fix application name according to KDE entity list.
* Premeu <menuchoice>Bé</menuchoice> i espereu fins que el treball estigui fet.


* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
* Copieu el llibre des de la <tt>~/Biblioteca del calibre</tt> al vostre lector de llibres electrònics.
[[File:K3b_docs.png|350px|center|thumb|K3b docs on UserBase in Opera and converted page in Konqueror.]]


[[Category:Col·laboració/ca]]
[[Category:Col·laboració/ca]]

Latest revision as of 08:30, 10 August 2023

Prefaci

El procediment actual no està polit, el codi de l'script és lleig, no prou intel·ligent, etc. L'única excusa és que funciona d'alguna manera .

Si voleu millorar el procediment, teniu bones habilitats amb Python, i coneixeu els principis d'autoria de docbook, podeu millorar el procediment. Si us plau, poseu-vos en contacte amb Yurchor si sou capaç d'ajudar.

Preparar les pàgines per a la conversió

  • Comproveu si cada pàgina conté la seva capçalera en funció al nivell d'aquesta pàgina a la taula de continguts.
Taula de referència
UserBase Docbook Comentari
==Secció== <capítol>
===Secció=== <secció1>
====Secció==== <secció2>
=====Secció===== <secció3>
======Secció====== <secció4> No utilitzeu aquest últim nivell, si és posible.
  • Comproveu si totes les cel tenen espai després del caràcter de canonada. Aquesta norma s'ajusta al format wiki tradicional.
  • Feu que el nom de l'aplicació tingui un format compatible (eviteu l'ús de Amaroks, feu Amarok's).
  • Assegureu-vos que totes les imatges estan en format PNG.
  • Elimineu tots els caràcters no imprimibles dels noms d'imatge.

Exportar

  • Prepareu la llista de pàgines (elimineu les adreces de UserBase http://userbase.kde.org). Exemple per a Amarok:
Amarok/Manual/Introduction
Amarok/QuickStartGuide
Amarok/QuickStartGuide/GettingStarted
Amarok/QuickStartGuide/TheAmarokWindow
Amarok/QuickStartGuide/TheMusicCollection
Amarok/QuickStartGuide/Playlists
Amarok/QuickStartGuide/TheContextView
Amarok/QuickStartGuide/HowToDealWithProblems
Amarok/QuickStartGuide/Glossary
Amarok/Manual/AmarokWindow
Amarok/Manual/AmarokWindow/Toolbar
Amarok/Manual/AmarokWindow/MediaSources
Amarok/Manual/AmarokWindow/ContextPane
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/ConfiguringAmarok/ChangingLayout
Amarok/Manual/Organization
Amarok/Manual/Organization/Collection
Amarok/Manual/Organization/CollectionScanning
Amarok/Manual/Organization/Collection/SearchInCollection
Amarok/Manual/Organization/Collection/OrganizeCollection
Amarok/Manual/Organization/Collection/RemoteCollections
Amarok/Manual/Organization/Collection/RemoteCollections/Ampache
Amarok/Manual/Organization/Collection/RemoteCollections/DAAP
Amarok/Manual/Organization/Collection/RemoteCollections/Samba
Amarok/Manual/Organization/Collection/RemoteCollections/UPnP
Amarok/Manual/Organization/Collection/ExternalDatabase
Amarok/Manual/Organization/Collection/WorkingWithMediaDevices
Amarok/Manual/Organization/CoverManager
Amarok/Manual/Organization/TagEditor
Amarok/Manual/Organization/Transcoding
Amarok/Manual/Organization/ScriptManager
Amarok/Manual/Playlist
Amarok/Manual/Playlist/SavedPlaylists
Amarok/Manual/Playlist/PlaylistFiltering
Amarok/Manual/Playlist/QueueManager
Amarok/Manual/Playlist/DynamicPlaylists
Amarok/Manual/Playlist/AutomaticPlaylistGenerator
Amarok/Manual/Various
Amarok/Manual/Various/Moodbar
Amarok/Manual/Various/AmarokOnOtherPlatforms
Amarok/Manual/Various/AmarokOnOtherPlatforms/NonKDE Desktops
Amarok/Manual/Various/AmarokOnOtherPlatforms/Windows
Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX
Amarok/Manual/Various/TroubleshootingAndCommonProblems
Amarok/Manual/Various/FAQ
Amarok/Manual/References
Amarok/Manual/References/MenuAndCommandReference
Amarok/Manual/References/MenuAndCommandReference/AmarokMenu
Amarok/Manual/References/MenuAndCommandReference/ViewMenu
Amarok/Manual/References/MenuAndCommandReference/Playlist
Amarok/Manual/References/MenuAndCommandReference/Tools
Amarok/Manual/References/MenuAndCommandReference/Settings
Amarok/Manual/References/MenuAndCommandReference/Help
Amarok/Manual/References/KeybindingReference
Amarok/Manual/References/KeybindingReference/GlobalShortcuts
Amarok/Manual/References/KeybindingReference/AmarokShortcuts
Amarok/Manual/References/Credits and License

Consell

Podeu obtenir la llista completa de les pàgines per a la vostra aplicació amb el següent script:
<DPL>
  nottitlematch = %/__|%/zh-%|%(%)
  titlematch = Amarok%
  namespace = Main
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>
Substituïu Amarok amb el nom de la vostra aplicació, poseu-ho a la vostra pàgina d'usuari, i feu clic a Vista prèvia. Es reordenarà la llista d'acord amb l'índex de continguts del manual.


Note

If You are working with the Amarok manual be aware that it does not fully conform to manual page naming conventions. You can use
titlematch = Amarok/Manual%|Amarok/QuickStartGuide%
(Note: No space characters in title pattern!)


  • Enganxeu la llista de pàgines al camp de text més gran.
  • Feu clic a Exporta.
S'exportaran les pàgines de manual de Amarok.
  • Deseu el fitxer. El fitxer desat s'anomenarà Manual.xml en el que segueix.

Convertir

  • Instal·leu el paquet Subversion pel vostre sistema.
  • Obteniu l'última versió de l'script de la conversió:
    svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/
  • Copieu Manual.xml a la carpeta de l'script.
  • Executeu
    python wiki2docbook.py Manual.xml
    si voleu descarregar totes les captures de pantalla (es necessita algun temps per a descarregar totes les imatges des de UserBase, grep i wget han d'estar instal·lats), o
    python wiki2docbook.py -s Manual.xml
    si no necessiteu descarregar les imatges.

Warning

At some point in the past it became necessary to add a line containing
144.76.227.197 userbase.kde.org
to /etc/hosts in order to access UserBase from the script. This is no longer the case. If you already added such a line to your /etc/hosts, then you should remove it again.


Post-processament

  • Canvieu el nom de Manual.xml.docbook a index.docbook.
  • Comproveu si la conversió s'ha realitzat correctament:
    checkXML index.docbook
  • Corregiu els errors (millor sobre les pàgines de UserBase).
  • Convertir docbook a HTML:
    meinproc4 index.docbook
  • Comproveu les pàgines HTML (totes les imatges han de ser visibles, els enllaços no han de donar lloc a pàgines 404).
  • Substituïu les imatges grans per miniatures usant convert de ImageMagick.
  • Arrangeu els enllaços a docbook, de manera que portin a la secció de docbook, no pàgines de UserBase.
  • Arrangeu el nom de l'aplicació d'acord amb la llista d'entitats del KDE.
  • Copieu index.docbook i les imatges a la vostra carpeta /doc i publiqueu-ho (commit) al repositori.
La documentació de K3b a UserBase en Opera i la pàgina convertida en el Konqueror.

Actualitzar els DocBook des de UserBase

Per actualitzar els vostres docbook convertits si us plau utilitzeu el següent procediment:

  • Feu una exportació XML des de UserBase. Veure la secció Exportar.
  • Utilitzeu l'script per actualitzar el contingut (les capçaleres de resum, paraules clau i el peu es mantindrà):
    python wiki2docbook.py -r index.docbook Manual.xml
  • Comproveu el docbook, reanomeneu el fitxer a index.docbook i publiqueu-lo amb les captures de pantalla al vostre repositori.

Convertir els DocBook a un altre format

Convertir-los a PDF

En general, no hi ha necessitat de convertir els DocBook de forma manual. Podeu descarregar el PDF convertit des del lloc de documentació del KDE.

En cas de necessitar cap personalització addicional, feu el següent:

  • Assegureu-vos que teniu alguna distribució de LaTeX instal·lada (normalment, TeXLive).
  • Creeu el següent script (anomenat buildpdf.sh) al directori dels DocBook:
#!/bin/bash

export SGML_CATALOG_FILES=/usr/share/sgml/docbook/sqml-dtd-4.5/catalog:/usr/share/kf5/kdoctools/customization/catalog.xml:/usr/share/sgml/docbook/xml-dtd-4.5/docbook
# add -d to command below to keep the /tmp folder, so you can examine the generated tex.
./dblatex-cvs-install/bin/dblatex -d -b pdftex --style \
	kdestyle\
	-o $(pwd | awk -F/ '{ print $NF }').pdf \
	-P latex.output.revhistory=0  -P newtbl.use=1 \
	-P imagedata.default.scale=pagebound \
	-P literal.width.ignore=1 \
	-I $KDEDIR/share/doc/HTML/en/ \
	-X \
        $1
  • Descarregueu els estils de KDE:
git clone git://anongit.kde.org/websites/docs-kde-org.git
  • Ajusteu dblatex-cvs-install/bin/dblatex com segueix
#!/bin/sh

TEXINPUTS=:/camí/al/vostre/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS

/camí/al/vostre/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*

(Canvieu /camí/al/vostre/ segons el cas).

  • Copieu els estils KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) a algun directori TeX on es trobi la instal·lació de LaTeX (jo els he copiat a /usr/share/texmf-dist/tex/latex/kde).
  • Actualitzeu els camins amb mktexlsr des de l'arrel.
  • Executeu ./buildpdf.sh index.docbook.
  • Copieu tots els fitxers des de /tmp/tpb-usuari-digits al directori de treball.
  • Personalitzeu i editeu el fitxer tex en Kile, segons correspongui.
  • Compileu el fitxer PDF amb Alt + 6.

Convertir-los a EPUB

  • Assegureu-vos que Calibre està instal·lat al vostre sistema.
  • Convertiu en primer lloc els vostres DocBook a HTML. Per a fer-ho utilitzeu meinproc4 index.docbook.
  • Inicieu el Calibre i escolliu Afegeix llibres.
  • Seleccioneu index.html a la carpeta de DocBook. Espereu fins que el llibre estigui carregat.
  • Escolliu Converteix llibres.
  • Ompliu els camps de metadades segons correspongui.
Pàgina de configuració de la conversió a Calibre.
  • Premeu i espereu fins que el treball estigui fet.
  • Copieu el llibre des de la ~/Biblioteca del calibre al vostre lector de llibres electrònics.