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

From KDE UserBase Wiki
(Importing a new version from external source)
No edit summary
 
(81 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />
<languages />
== Forord ==
== Forord ==


Line 10: Line 11:
* Tjek, at manualsiden følger [[Special:myLanguage/Tasks_and_Tools|UserBases retningslinjer for forfattere]] og de [[Special:myLanguage/Typographical_Guidelines|typograpfiske retningslinjer]].
* Tjek, at manualsiden følger [[Special:myLanguage/Tasks_and_Tools|UserBases retningslinjer for forfattere]] og de [[Special:myLanguage/Typographical_Guidelines|typograpfiske retningslinjer]].


* Check if every page has its header according to the level of this page in table of contents.
* Tjek, at hver side har en overskrift svarende til sidens niveau i indholdsfortegnelsen.


:{|
:{|
|+Reference table
|+Referencetabel
|-
|-
! UserBase
! UserBase
! Docbook
! Docbook
! Comment
! Kommentar
|-
|-
| ==Section==
| ==Section==
Line 33: Line 34:
| ======Section======
| ======Section======
| <sect4>
| <sect4>
| ''Avoid using this last level if possible''
| ''Undgå så vidt muligt at bruge dette sidste niveau''
|}
|}


* 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].
* Tjek, at alle tabelceller har mellemrum efter 'pipe'-tegnet. Denne regel er i overensstemmelse med [http://en.wikipedia.org/wiki/Help:Table traditionel wiki-formattering].


* Make application name formatting consistent (avoid using '''Amarok'''s, do use '''Amarok's''').
* Sørg for, at formatteringen af programnavne er konsistent (undgå at bruge '''Amarok'''s, brug '''Amarok's''' &mdash; i danske oversættelser skal apostroffen dog normalt ikke være der).


* Ensure that ''all'' images are in PNG format.
* Sørg for, at ''alle'' billeder er i PNG-format.


* Remove all non-printable characters from image names.
* Fjern alle ikke-printbare tegn fra billednavne.
<span id="Export"></span>
=== Eksport ===


===Export===
* Forbered sidelisten (fjern UserBase-adressedelen <nowiki>http://userbase.kde.org</nowiki>). Eksempel for '''Amarok''':


* Prepare the page list (strip from UserBase addresses <nowiki>http://userbase.kde.org</nowiki>). Example for '''Amarok''':
{{Input|1=Amarok/Manual/Introduction
 
{{Input|1=Amarok
Amarok/QuickStartGuide
Amarok/QuickStartGuide
Amarok/QuickStartGuide/GettingStarted
Amarok/QuickStartGuide/GettingStarted
Line 63: Line 64:
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/da|1=Du kan få  din manuals fulde sideliste med følgende skript:<!--}}-->


{{Input|1=<nowiki><DPL>
{{Input|1=<nowiki><DPL>
   nottitlematch = %/__|%/zh-%|%(%)
   nottitlematch = %/__|%/zh-%|%pt-%|%(%)
   titlematch = Amarok%
   titlematch = Appname/Manual%
   namespace = Main
   namespace =  
   columns = 1
   columns = 1
   format = ,\n* [[%PAGE%|%TITLE%]],,
   format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL></nowiki>}}
</DPL></nowiki>}}


<!--{{-->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.
<!--{{-->Erstat '''''Amarok''''' med navnet på dit program, Skriv det ind på din brugerside og klik på <menuchoice>Forhåndsvisning</menuchoice>. Arrangér listen på samme måde som i manualens indholdsfortegnelse.
}}
}}


* Go to the [[Special:Export|export page]].
{{Note/da|1=Hvis du arbejder på Amarok-manualen, så vær opmærksom på, at den ikke følger konventionerne for navngivning af sider helt. Du kan bruge
{{Input|1= titlematch = Amarok/Manual%{{!}}Amarok/QuickStartGuide%}}
(Bemærk: Ingen mellemrumstegn i titelmønsteret!)
}}
 
* Gå til [[Special:Export|eksportsiden]].
 
* Kopiér sidelisten ind i det <menuchoice>store</menuchoice> tekstfelt.
 
* Klik på <menuchoice>Eksporter</menuchoice>.
[[File:XML_export.png|350px|center|thumb|Eksport af Amaroks manualsider]]
 
* Gem filen. Den gemte fil vil blive kaldt <tt>Manual.xml</tt> i det følgende.
 
=== Konvertering ===
 
* Installér pakken Subversion på dit system.
 
* For at udtjekke den seneste udgave af konverteringsskriptet kører du: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
 
* Kopiér <tt>Manual.xml</tt> til skriptmappen.
 
* Kør {{Input|1=python wiki2docbook.py Manual.xml}} hvis du ønsker at downloade alle skærmbilleder (det tager nogen tid at hente alle billeder fra UserBase; du skal have grep og wget installeret), eller {{Input|1=python wiki2docbook.py -s Manual.xml}} hvis du ikke behøver at downloade billederne.
 
{{Warning/da|1=På et tidspunkt blev det nædvendigt at føje en linje med <br /><code>144.76.227.197 userbase.kde.org</code><br /> til <tt>/etc/hosts</tt> for at kunne tilgå UserBase fra script'et. Dette er ikke længere tilfældet. Hvis du allerede har føjet sådan en linje til din <tt>/ext/hosts</tt>, så bør du fjerne den igen.}}
 
=== Efterbehandling ===
 
* Omdøb <tt>Manual.xml.docbook</tt> til <tt>index.docbook</tt>.
 
* Tjek, at konverteringen er foretaget korrekt: {{Input|1=checkXML index.docbook}}
 
* Ret fejlene (det er bedst at gøre det på UserBase siderne).
 
* Konvertér docbook til HTML: {{Input|1=meinproc4 index.docbook}}
 
* Tjek HTML-siderne (alle billeder skal kunne ses, links må ikke føre til 404-sider).
 
* Erstat store billeder med miniaturer ved at bruge '''convert''' fra '''ImageMagic'''
 
* Ret links i docbook'en, sådan at de fører til afsnit i docbook'en, ikke til UserBase-sider.
 
* Ret programnavnet så det stemmer overens med KDE's "entity list".
 
* Kopiér <tt>index.docbook</tt> og billeder til din <tt>/doc</tt>-mappe og commit dem til arkivet.
[[File:K3b_docs.png|350px|center|thumb|Dokumentation for K3b på UserBase i Opera og den konverterede side i Konqueror.]]
 
== Opdatering af din DocBook fra UserBase ==
 
For at opdatere din konverterede docbook skal du følge denne procedure:
 
* Geneksportér XML fra UserBAse. Se afsnittet [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook#Export|Eksport]].
 
* Brug scriptet til at opdatere indholdet (headere med sammenfatning, nøgleord og sidefod vil blive bevaret): {{Input|1= python wiki2docbook.py -r index.docbook Manual.xml}}
 
* Check dockbook'en, omdøb filen til index.docbooc og commit dem med skærmbilleder til dit arkiv.
 
== Konvertér DocBook til andre formater ==
 
=== Konvertering til PDF ===
 
Det er som regel ikke nødvendigt at konvertete DocBook manuelt. Du kan downloade de konverterede PDF'er fra [http://docs.kde.org/ KDE's dokumentationssite]
 
Skulle du have brug for yderligere tilpasning, så gør således:
 
* Sørg for at du har en '''LaTeX'''-distribution installeret (som regel TeXLive).
 
* Lav følgende scriptfil (med navnet <tt>buildpdm.sh</tt>) i din DocBook-mappe:
{{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>}}
* Download KDE-stilene:
{{Input|1=<nowiki>git clone git://anongit.kde.org/websites/docs-kde-org.git</nowiki>}}
 
* Tilpas <tt>dblatex-cvs-install/bin/dblatex</tt> således
 
<!--}}-->{{Input|1=
<syntaxhighlight lang="bash">#!/bin/sh
 
TEXINPUTS=:/path/to/your/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS


* Paste the page list into the <menuchoice>bigger</menuchoice> text field.
/path/to/your/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*</syntaxhighlight>}}<!--{{-->


* Click on <menuchoice>Export</menuchoice>.
(Ændr '''''/path/to/your/''''' passende)
[[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.
* Kopiér KDE-stilene (/dblatex-cvs-install/share/dblatex/latex/contrib/) til en TeX-mappe, hvor den kan findes af '''LaTeX'''-installationen (jeg har kopieret dem til <tt>/usr/share/texmf-dist/tex/latex/kde</tt>).


===Conversion===
* Opdatér stierne med <code>mktexlsr</code> fra root.


* Install Subversion package for your system.
* Kør <code>./buildpdf.sh index.docbook</code>. Dette skulle give dig en PDF fil klar til brug.  


* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
* Kopiér alle filer fra <tt>/tmp/tpb-'''''din_bruger'''''-'''''cifre'''''</tt> til arbejdsmappen.


* Copy <tt>Manual.xml</tt> to the script folder.
* Tilpas og redigér <tt>tex</tt>-filen med [[Special:MyLanguage/Kile|Kile]] efter behov.


* 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.
* Kompilér PDF-filen med <keycap>Alt + 6</keycap>.


===Post-processing===
=== Konvertering til EPUB ===


* Rename <tt>Manual.xml.docbook</tt> to <tt>index.docbook</tt>.
* Sørg for at '''Calibre''' er installeret på din maskine.


* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
* Konvertér først din DocBook til HTML. Brug <code>meinproc4 index.docbook</code> til dette.


* Fix the errors (better on UserBase pages).
* Start '''Calibre''' og vælg <menuchoice>Tilføj bøger</menuchoice>.


* Convert docbook to HTML: {{Input|1=meinproc4 index.docbook}}
* Vælg <tt>index.html</tt> i din DocBook-mappe. Vent til bogen er indlæst.


* Check HTML pages (all images should be visible, links should not lead to 404-pages).
* Vælg <menuchoice>Konvertér bøger</menuchoice>.


* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
* Udfyld metadata-felterne.


* Fix links in docbook, so they lead to docbook section, not UserBase pages.
[[File:calibre.png|350px|center|thumb|Indstillingsdialog til Calibre-konvertering.]]


* Fix application name according to KDE entity list.
* Klik <menuchoice>OK</menuchoice> og vent til arbejdet er gjort.


* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
* Kopiér bogen fra <tt>~/Calibre Library</tt> på din ebogslæser.
[[File:K3b_docs.png|350px|center|thumb|K3b docs on UserBase in Opera and converted page in Konqueror.]]


[[Category:Contributing]]
[[Category:Bidrag/da]]

Latest revision as of 12:58, 6 April 2020

Forord

Den aktuelle proces er ikke finslebet, skriptkoden er grim og ikke intelligent nok osv. Den eneste undskyldning er, at det kræver noget arbejde .

Hvis du ønsker at forbedre processen, er vel bekendt med Python og kender principperne for at skrive docbook-dokumenter, så kan du forbedre proceduren. Kontakt Yurchor, hvis du kan hjælpe.

Forbered en side for konvertering

  • Tjek, at hver side har en overskrift svarende til sidens niveau i indholdsfortegnelsen.
Referencetabel
UserBase Docbook Kommentar
==Section== <chapter>
===Section=== <sect1>
====Section==== <sect2>
=====Section===== <sect3>
======Section====== <sect4> Undgå så vidt muligt at bruge dette sidste niveau
  • Sørg for, at formatteringen af programnavne er konsistent (undgå at bruge Amaroks, brug Amarok's — i danske oversættelser skal apostroffen dog normalt ikke være der).
  • Sørg for, at alle billeder er i PNG-format.
  • Fjern alle ikke-printbare tegn fra billednavne.

Eksport

  • Forbered sidelisten (fjern UserBase-adressedelen http://userbase.kde.org). Eksempel for 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

Tip

Du kan få din manuals fulde sideliste med følgende skript:
<DPL>
  nottitlematch = %/__|%/zh-%|%pt-%|%(%)
  titlematch = Appname/Manual%
  namespace = 
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>
Erstat Amarok med navnet på dit program, Skriv det ind på din brugerside og klik på Forhåndsvisning. Arrangér listen på samme måde som i manualens indholdsfortegnelse.


Note

Hvis du arbejder på Amarok-manualen, så vær opmærksom på, at den ikke følger konventionerne for navngivning af sider helt. Du kan bruge
titlematch = Amarok/Manual%|Amarok/QuickStartGuide%
(Bemærk: Ingen mellemrumstegn i titelmønsteret!)


  • Kopiér sidelisten ind i det store tekstfelt.
  • Klik på Eksporter.
Eksport af Amaroks manualsider
  • Gem filen. Den gemte fil vil blive kaldt Manual.xml i det følgende.

Konvertering

  • Installér pakken Subversion på dit system.
  • For at udtjekke den seneste udgave af konverteringsskriptet kører du:
    svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/
  • Kopiér Manual.xml til skriptmappen.
  • Kør
    python wiki2docbook.py Manual.xml
    hvis du ønsker at downloade alle skærmbilleder (det tager nogen tid at hente alle billeder fra UserBase; du skal have grep og wget installeret), eller
    python wiki2docbook.py -s Manual.xml
    hvis du ikke behøver at downloade billederne.

Advarsel

På et tidspunkt blev det nædvendigt at føje en linje med
144.76.227.197 userbase.kde.org
til /etc/hosts for at kunne tilgå UserBase fra script'et. Dette er ikke længere tilfældet. Hvis du allerede har føjet sådan en linje til din /ext/hosts, så bør du fjerne den igen.


Efterbehandling

  • Omdøb Manual.xml.docbook til index.docbook.
  • Tjek, at konverteringen er foretaget korrekt:
    checkXML index.docbook
  • Ret fejlene (det er bedst at gøre det på UserBase siderne).
  • Konvertér docbook til HTML:
    meinproc4 index.docbook
  • Tjek HTML-siderne (alle billeder skal kunne ses, links må ikke føre til 404-sider).
  • Erstat store billeder med miniaturer ved at bruge convert fra ImageMagic
  • Ret links i docbook'en, sådan at de fører til afsnit i docbook'en, ikke til UserBase-sider.
  • Ret programnavnet så det stemmer overens med KDE's "entity list".
  • Kopiér index.docbook og billeder til din /doc-mappe og commit dem til arkivet.
Dokumentation for K3b på UserBase i Opera og den konverterede side i Konqueror.

Opdatering af din DocBook fra UserBase

For at opdatere din konverterede docbook skal du følge denne procedure:

  • Geneksportér XML fra UserBAse. Se afsnittet Eksport.
  • Brug scriptet til at opdatere indholdet (headere med sammenfatning, nøgleord og sidefod vil blive bevaret):
    python wiki2docbook.py -r index.docbook Manual.xml
  • Check dockbook'en, omdøb filen til index.docbooc og commit dem med skærmbilleder til dit arkiv.

Konvertér DocBook til andre formater

Konvertering til PDF

Det er som regel ikke nødvendigt at konvertete DocBook manuelt. Du kan downloade de konverterede PDF'er fra KDE's dokumentationssite

Skulle du have brug for yderligere tilpasning, så gør således:

  • Sørg for at du har en LaTeX-distribution installeret (som regel TeXLive).
  • Lav følgende scriptfil (med navnet buildpdm.sh) i din DocBook-mappe:
#!/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
  • Download KDE-stilene:
git clone git://anongit.kde.org/websites/docs-kde-org.git
  • Tilpas dblatex-cvs-install/bin/dblatex således
#!/bin/sh

TEXINPUTS=:/path/to/your/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS

/path/to/your/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*

(Ændr /path/to/your/ passende)

  • Kopiér KDE-stilene (/dblatex-cvs-install/share/dblatex/latex/contrib/) til en TeX-mappe, hvor den kan findes af LaTeX-installationen (jeg har kopieret dem til /usr/share/texmf-dist/tex/latex/kde).
  • Opdatér stierne med mktexlsr fra root.
  • Kør ./buildpdf.sh index.docbook. Dette skulle give dig en PDF fil klar til brug.
  • Kopiér alle filer fra /tmp/tpb-din_bruger-cifre til arbejdsmappen.
  • Tilpas og redigér tex-filen med Kile efter behov.
  • Kompilér PDF-filen med Alt + 6.

Konvertering til EPUB

  • Sørg for at Calibre er installeret på din maskine.
  • Konvertér først din DocBook til HTML. Brug meinproc4 index.docbook til dette.
  • Start Calibre og vælg Tilføj bøger.
  • Vælg index.html i din DocBook-mappe. Vent til bogen er indlæst.
  • Vælg Konvertér bøger.
  • Udfyld metadata-felterne.
Indstillingsdialog til Calibre-konvertering.
  • Klik OK og vent til arbejdet er gjort.
  • Kopiér bogen fra ~/Calibre Library på din ebogslæser.