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

From KDE TechBase
(Created page with "* Korjaa virheet (paremmin UserBase-sivuilla).")
(Created page with "* Muunna docbook HTML-muotoon: {{Input|3=Syöte| meinproc4 index.docbook}}")
Line 141: Line 141:
* Korjaa virheet (paremmin UserBase-sivuilla).
* 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).
* Check HTML pages (all images should be visible, links should not lead to 404-pages).

Revision as of 14:40, 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ä 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
  • 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.


  • Liitä sivuluettelo suurempaan tekstikenttään.
  • Napsauta kohdetta Vienti.
Vie Amarok-käsikirjan sivut
  • 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
  • Check HTML pages (all images should be visible, links should not lead to 404-pages).
  • Replace big images by thumbnails using convert from ImageMagick
  • Fix links in docbook, so they lead to docbook section, not UserBase pages.
  • Fix application name according to KDE entity list.
  • Copy index.docbook and images to your /doc folder and commit them to repository.
K3b docs on UserBase in Opera and converted page in Konqueror.
Retrieved from "https://techbase.kde.org/index.php?title=How_To_Convert_a_UserBase_Manual_to_Docbook/fi&oldid=64912"