amarok/doc/amarok.txt

0001 For the details on how to convert UserBase pages into Amarok offline manual please refer to the following page:
0002
0003 http://userbase.kde.org/How_To_Convert_a_UserBase_Manual_to_Docbook
0004
0005 Below is a short instruction on how to update the manual in this folder.
0006
0007 1. Prerequisites.
0008    a. Python 2.x (x>5).
0009    b. wget to download images.
0010    c. grep to find images in UserBase archives.
0011    d. ImageMagick to convert and scale downloaded images.
0012    e. advpng to compress images losslessly.
0013
0014 2. The list of pages.
0015
0016 Below is the list of Amarok pages on UserBase. Copy and paste this list to the export field of http://userbase.kde.org/Special:Export to obtain raw XML document (Manual.xml).
0017
0018 Amarok/Manual/Introduction
0019 Amarok/QuickStartGuide
0020 Amarok/QuickStartGuide/GettingStarted
0021 Amarok/QuickStartGuide/TheAmarokWindow
0022 Amarok/QuickStartGuide/TheMusicCollection
0023 Amarok/QuickStartGuide/Playlists
0024 Amarok/QuickStartGuide/TheContextView
0025 Amarok/QuickStartGuide/HowToDealWithProblems
0026 Amarok/QuickStartGuide/Glossary
0027 Amarok/Manual/AmarokWindow
0028 Amarok/Manual/AmarokWindow/Toolbar
0029 Amarok/Manual/AmarokWindow/MediaSources
0030 Amarok/Manual/AmarokWindow/ContextPane
0031 Amarok/Manual/AmarokWindow/PlaylistPane
0032 Amarok/Manual/ConfiguringAmarok
0033 Amarok/Manual/ConfiguringAmarok/ChangingLayout
0034 Amarok/Manual/Organization
0035 Amarok/Manual/Organization/Collection
0036 Amarok/Manual/Organization/CollectionScanning
0037 Amarok/Manual/Organization/Collection/SearchInCollection
0038 Amarok/Manual/Organization/Collection/OrganizeCollection
0039 Amarok/Manual/Organization/Collection/StatisticsSynchronization
0040 Amarok/Manual/Organization/Collection/RemoteCollections
0041 Amarok/Manual/Organization/Collection/RemoteCollections/Ampache
0042 Amarok/Manual/Organization/Collection/RemoteCollections/DAAP
0043 Amarok/Manual/Organization/Collection/RemoteCollections/Samba
0044 Amarok/Manual/Organization/Collection/RemoteCollections/UPnP
0045 Amarok/Manual/Organization/Collection/ExternalDatabase
0046 Amarok/Manual/Organization/Collection/WorkingWithMediaDevices
0047 Amarok/Manual/Organization/CoverManager
0048 Amarok/Manual/Organization/TagEditor
0049 Amarok/Manual/Organization/Transcoding
0050 Amarok/Manual/Organization/ScriptManager
0051 Amarok/Manual/Playlist
0052 Amarok/Manual/Playlist/SavedPlaylists
0053 Amarok/Manual/Playlist/PlaylistFiltering
0054 Amarok/Manual/Playlist/QueueManager
0055 Amarok/Manual/Playlist/DynamicPlaylists
0056 Amarok/Manual/Playlist/AutomaticPlaylistGenerator
0057 Amarok/Manual/Various
0058 Amarok/Manual/Various/Moodbar
0059 Amarok/Manual/Various/ReplayGain
0060 Amarok/Manual/Various/AmarokOnOtherPlatforms
0061 Amarok/Manual/Various/AmarokOnOtherPlatforms/NonKDE Desktops
0062 Amarok/Manual/Various/AmarokOnOtherPlatforms/Windows
0063 Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX
0064 Amarok/Manual/Various/TroubleshootingAndCommonProblems
0065 Amarok/Manual/Various/FAQ
0066 Amarok/Manual/References
0067 Amarok/Manual/References/MenuAndCommandReference
0068 Amarok/Manual/References/MenuAndCommandReference/AmarokMenu
0069 Amarok/Manual/References/MenuAndCommandReference/ViewMenu
0070 Amarok/Manual/References/MenuAndCommandReference/Playlist
0071 Amarok/Manual/References/MenuAndCommandReference/Tools
0072 Amarok/Manual/References/MenuAndCommandReference/Settings
0073 Amarok/Manual/References/MenuAndCommandReference/Help
0074 Amarok/Manual/References/KeybindingReference
0075 Amarok/Manual/References/KeybindingReference/GlobalShortcuts
0076 Amarok/Manual/References/KeybindingReference/AmarokShortcuts
0077 Amarok/Manual/References/Credits and License
0078
0079 3. Script to convert.
0080
0081 The latest version of script can be downloaded by the following address:
0082
0083 http://websvn.kde.org/*checkout*/branches/work/doc/wiki2docbook.py
0084
0085 4. Update.
0086
0087 Run
0088
0089 python wiki2docbook.py -r index.docbook Manual.xml
0090
0091  if you want to download all screenshots (it takes some time to download all images from UserBase), or
0092
0093 python wiki2docbook.py -s -r index.docbook Manual.xml
0094
0095  if you need not to download images.
0096
0097 5. Check the docbook.
0098
0099 checkXML index.docbook.new.docbook
0100
0101 6. Replace the old docbook.
0102
0103 Fix the date and version of Amarok release in index.docbook.new.docbook, run
0104
0105 mv -f index.docbook.new.docbook index.docbook
0106
0107 7. Commit.
0108
0109 git commit -m "Update docs with new data from UserBase." -a
0110 git push