How To Convert a UserBase Manual to Docbook/fi: Difference between revisions
Centerlink (talk | contribs) (Created page with "* Korjaa sovellusnimi KDE-kokonaisuusluettelon mukaisesti.") |
Centerlink (talk | contribs) (Created page with "* 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-dokumentin UserBas...") |
||
| Line 151: | Line 151: | ||
* Korjaa sovellusnimi KDE-kokonaisuusluettelon mukaisesti. | * Korjaa sovellusnimi KDE-kokonaisuusluettelon mukaisesti. | ||
* | * 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 | [[File:K3b_docs.png|350px|center|thumb|K3b-dokumentin UserBase-sivut Opera-selaimessa ja muunnetut sivut Konqueror-selaimessa.]] | ||
[[Category:Translator_Help]] | [[Category:Translator_Help]] | ||
Latest revision as of 14:46, 27 August 2011
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 . Järjestä luettelo uudelleen käsikirjasi sisällysluettelon mukaan.
- Siirry vientisivulle.
- Liitä sivuluettelo tekstikenttään.
- Napsauta kohdetta .
- 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), taipython 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.
