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

Latest revision as of 14:46, 27 August 2011

Other languages:

Esipuhe

Nykyinen prosessi ei ole viimeistelty, skripti on ruma, ei ollenkaan älykäs, jne... Ainoa anteeksipyyntö on, että jotenkin toimii

.

Jos haluat parantaa prosessia ja sinulla on hyvät Python-taidot, ja tiedät docbook-kirjoittamisen periaatteet, voit parantaa proseduuria. Ota yhteyttä Yurchorin, jos kykenet auttamaan.

Valmistellaan sivut muuntamista varten

Tarkista, että käsikirjasi sivut noudattavat UserBase-kirjoittamisen ohjeita ja typograafisia ohjeita.

Tarkista, että jokaisella sivulla on otsake, joka on sisällysluettelon tason mukainen.

Viitetaulukko
UserBase	Docbook	Kommentti
==Luku==	<kappale>
===Luku===	<luku1>
====Luku====	<luku2>
=====Luku=====	<luku3>
======Luku======	<luku4>	Vältä tämän viimeisen tason käyttöä, mikäli mahdollista

Tarkista, että taulukon kaikissa soluissa on välilyönti putkimerkin jälkeen. Tämä sääntö noudattaa -perinteistä wiki-muotoilua.

Tee sovellusnimimuotoilusta johdonmukainen (vältä käyttämästä Amaroks, käytä Amarok's).

Varmista, että kaikki kuvat ovat PNG-muotoa.

Poista kaikki ei-tulostettavat merkit tiedostonimistä.

Vienti

Valmistele sivuluettelo (riisu UserBase-osoitteista http://userbase.kde.org). Esimerkiksi ohjelmalle Amarok:

Amarok
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/AdvancedFeatures
Amarok/Manual/AdvancedFeatures/CollectionScanning
Amarok/Manual/AdvancedFeatures/CoverManager
Amarok/Manual/AdvancedFeatures/DynamicPlaylists
Amarok/Manual/AdvancedFeatures/AutomaticPlaylistGenerator
Amarok/Manual/AdvancedFeatures/ExternalDatabase
Amarok/Manual/AdvancedFeatures/AFT
Amarok/Manual/AdvancedFeatures/Moodbar
Amarok/Manual/AdvancedFeatures/WorkingWithMediaDevices
Amarok/Manual/AdvancedFeatures/SavedPlaylists
Amarok/Manual/AdvancedFeatures/PlaylistFiltering
Amarok/Manual/AdvancedFeatures/QueueManager
Amarok/Manual/AdvancedFeatures/SearchInCollection
Amarok/Manual/AdvancedFeatures/TagEditor
Amarok/Manual/AdvancedFeatures/OrganizeCollection
Amarok/Manual/AdvancedFeatures/Transcoding
Amarok/Manual/AdvancedFeatures/ScriptManager
Amarok/Manual/AdvancedFeatures/RemoteCollections
Amarok/Manual/AdvancedFeatures/RemoteCollections/Ampache
Amarok/Manual/AdvancedFeatures/RemoteCollections/DAAP
Amarok/Manual/AdvancedFeatures/RemoteCollections/Samba
Amarok/Manual/AdvancedFeatures/RemoteCollections/UPnP
Amarok/Manual/MenuAndCommandReference/AmarokMenu
Amarok/Manual/MenuAndCommandReference/ViewMenu
Amarok/Manual/MenuAndCommandReference/Playlist
Amarok/Manual/MenuAndCommandReference/Tools
Amarok/Manual/MenuAndCommandReference/Settings
Amarok/Manual/MenuAndCommandReference/Help
Amarok/Manual/KeybindingReference
Amarok/Manual/KeybindingReference/GlobalShortcuts
Amarok/Manual/KeybindingReference/AmarokShortcuts
Amarok/Manual/TroubleshootingAndCommonProblems
Amarok/Manual/AmarokOnOtherPlatforms/Non-KDE Desktops
Amarok/Manual/AmarokOnOtherPlatforms/Windows
Amarok/Manual/AmarokOnOtherPlatforms/OSX
Amarok/Manual/FAQ
Amarok/Manual/Credits_and_License

Tip

Saat täydellisen luettelon sivuistasi seuraavalla skriptillä:

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

Korvaa Amarok sovelluksesi nimellä, laita se käyttäjäsivullesi, ja napsauta kohdetta Esikatselu. Järjestä luettelo uudelleen käsikirjasi sisällysluettelon mukaan.

Siirry vientisivulle.

Liitä sivuluettelo suurempaan tekstikenttään.

Napsauta kohdetta Vienti.

Tallenna tiedosto. Tallennettua tiedostoa kutsutaan nimellä Manual.xml siinä mikä seuraa.

Muunnos

Asenna Subversion-paketti järjestelmääsi.

Tarkista muunnosskriptin viimeisin versio:

svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/

Kopioi Manual.xml skriptikansioon.

Suorita
```
python wiki2docbook.py Manual.xml
```
, jos haluat ladata kaikki näyttökaappaukset (kaikkien kuvien lataaminen UserBase-tietokannasta kestää jonkin aikaa, grep ja wget pitäisi olla asennettuna), tai
```
python wiki2docbook.py -s Manual.xml
```
, jos et halua ladata kuvia.

Jälkikäsittely

Nimeä Manual.xml.docbook uudelleen nimellä index.docbook.

Tarkista, että muunnos tehtiin oikein:
```
 checkXML index.docbook
```

Korjaa virheet (paremmin UserBase-sivuilla).

Muunna docbook HTML-muotoon:
```
 meinproc4 index.docbook
```

Tarkista HTML-sivut (kaikkien kuvien pitäisi olla näkyviä, linkit eivät saa johtaa 404-sivuille).

Korvaa suuret kuvat pienoiskuvilla käyttäen convert-toimintoa ImageMagick-ohjelmasta

Korjaa linkit docbook-muodossa, jotta ne johtavat docbook-lukuun, ei UserBase-sivuille.

Korjaa sovellusnimi KDE-kokonaisuusluettelon mukaisesti.

Kopioi index.docbook ja kuvat omaan /doc-kansioon ja siirrä ne commit-toiminnolla tietokantaan.

@@ Line 42: / Line 42: @@
 * Varmista, että ''kaikki'' kuvat ovat PNG-muotoa.
-* Remove all non-printable characters from image names.
+* Poista kaikki ei-tulostettavat merkit tiedostonimistä.
-===Export===
+=== Vienti ===
-* Prepare the page list (strip from UserBase addresses <nowiki>http://userbase.kde.org</nowiki>). Example for '''Amarok''':
+* Valmistele sivuluettelo (riisu UserBase-osoitteista <nowiki>http://userbase.kde.org</nowiki>). Esimerkiksi ohjelmalle '''Amarok''':
 {{Input|1=Amarok
@@ Line 101: / Line 101: @@
 Amarok/Manual/Credits_and_License}}
-{{Tip|1=You can obtain the full list of pages for your application with the following script:<!--}}-->
+{{Tip|3=Vihje| Saat täydellisen luettelon sivuistasi seuraavalla skriptillä:<!--}}-->
-{{Input|1=<nowiki><DPL>
+{{Input|3=Syöte| <nowiki><DPL>
    nottitlematch = %/__|%/zh-%|%(%)
    titlematch = Amarok%
@@ Line 111: / Line 111: @@
 </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.
+<!--{{-->Korvaa '''''Amarok''''' sovelluksesi nimellä, laita se käyttäjäsivullesi, ja napsauta kohdetta <menuchoice>Esikatselu</menuchoice>. Järjestä luettelo uudelleen käsikirjasi sisällysluettelon mukaan.
 }}
-* Go to the [[Special:Export|export page]].
+* Siirry [[Special:Export|vientisivulle]].
-* Paste the page list into the <menuchoice>bigger</menuchoice> text field.
+* Liitä sivuluettelo <menuchoice>suurempaan</menuchoice> tekstikenttään.
-* Click on <menuchoice>Export</menuchoice>.
+* Napsauta kohdetta <menuchoice>Vienti</menuchoice>.
-[[File:XML_export.png|350px|center|thumb|Export of Amarok manual pages]]
+[[File:XML_export.png|350px|center|thumb|Vie Amarok-käsikirjan sivut]]
-* Save the file. The saved file will be called <tt>Manual.xml</tt> in what follows.
+* Tallenna tiedosto. Tallennettua tiedostoa kutsutaan nimellä <tt>Manual.xml</tt> siinä mikä seuraa.
-===Conversion===
+=== Muunnos ===
-* Install Subversion package for your system.
+Asenna Subversion-paketti järjestelmääsi.
-* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
+* Tarkista muunnosskriptin viimeisin versio: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
-* Copy <tt>Manual.xml</tt> to the script folder.
+* Kopioi <tt>Manual.xml</tt> skriptikansioon.
-* 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.
+* Suorita {{Input|1=python wiki2docbook.py Manual.xml}}, jos haluat ladata kaikki näyttökaappaukset (kaikkien kuvien lataaminen UserBase-tietokannasta kestää jonkin aikaa, grep ja wget pitäisi olla asennettuna), tai {{Input|1=python wiki2docbook.py -s Manual.xml}}, jos et halua ladata kuvia.
-===Post-processing===
+=== Jälkikäsittely ===
-* Rename <tt>Manual.xml.docbook</tt> to <tt>index.docbook</tt>.
+* Nimeä <tt>Manual.xml.docbook</tt> uudelleen nimellä <tt>index.docbook</tt>.
-* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
+* Tarkista, että muunnos tehtiin oikein: {{Input|3=Syöte| checkXML index.docbook}}
-* Fix the errors (better on UserBase pages).
+* Korjaa virheet (paremmin UserBase-sivuilla).
-* Convert docbook to HTML: {{Input|1=meinproc4 index.docbook}}
+* Muunna docbook HTML-muotoon: {{Input|3=Syöte| meinproc4 index.docbook}}
-* Check HTML pages (all images should be visible, links should not lead to 404-pages).
+* Tarkista HTML-sivut (kaikkien kuvien pitäisi olla näkyviä, linkit eivät saa johtaa 404-sivuille).
-* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
+* Korvaa suuret kuvat pienoiskuvilla käyttäen '''convert'''-toimintoa '''ImageMagick'''-ohjelmasta
-* Fix links in docbook, so they lead to docbook section, not UserBase pages.
+* Korjaa linkit docbook-muodossa, jotta ne johtavat docbook-lukuun, ei UserBase-sivuille.
-* Fix application name according to KDE entity list.
+* Korjaa sovellusnimi KDE-kokonaisuusluettelon mukaisesti.
-* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
+* Kopioi <tt>index.docbook</tt> ja kuvat omaan <tt>/doc</tt>-kansioon ja siirrä ne commit-toiminnolla tietokantaan.
-[[File:K3b_docs.png|350px|center|thumb|K3b docs on UserBase in Opera and converted page in Konqueror.]]
+[[File:K3b_docs.png|350px|center|thumb|K3b-dokumentin UserBase-sivut Opera-selaimessa ja muunnetut sivut Konqueror-selaimessa.]]
 [[Category:Translator_Help]]