diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/Makefile.am | 3 | ||||
| -rw-r--r-- | doc/en/add_dynamic.png | bin | 0 -> 34586 bytes | |||
| -rw-r--r-- | doc/en/advanced.docbook | 1110 | ||||
| -rw-r--r-- | doc/en/amarok_playlist.png | bin | 0 -> 136228 bytes | |||
| -rw-r--r-- | doc/en/analyzer.png | bin | 0 -> 6711 bytes | |||
| -rw-r--r-- | doc/en/buttons.png | bin | 0 -> 8512 bytes | |||
| -rw-r--r-- | doc/en/collection.png | bin | 0 -> 8083 bytes | |||
| -rw-r--r-- | doc/en/config.docbook | 252 | ||||
| -rw-r--r-- | doc/en/config_appearance.png | bin | 0 -> 55097 bytes | |||
| -rw-r--r-- | doc/en/config_collection.png | bin | 0 -> 56076 bytes | |||
| -rw-r--r-- | doc/en/config_engine.png | bin | 0 -> 68505 bytes | |||
| -rw-r--r-- | doc/en/config_general.png | bin | 0 -> 57975 bytes | |||
| -rw-r--r-- | doc/en/config_osd.png | bin | 0 -> 56660 bytes | |||
| -rw-r--r-- | doc/en/config_playback.png | bin | 0 -> 42952 bytes | |||
| -rw-r--r-- | doc/en/config_scrobbler.png | bin | 0 -> 56180 bytes | |||
| -rw-r--r-- | doc/en/coverman.png | bin | 0 -> 206414 bytes | |||
| -rw-r--r-- | doc/en/dynamic_bar.png | bin | 0 -> 8013 bytes | |||
| -rw-r--r-- | doc/en/dynamic_settings.png | bin | 0 -> 15842 bytes | |||
| -rw-r--r-- | doc/en/equalizer.png | bin | 0 -> 12616 bytes | |||
| -rw-r--r-- | doc/en/faq.docbook | 1038 | ||||
| -rw-r--r-- | doc/en/file_browser.png | bin | 0 -> 19830 bytes | |||
| -rw-r--r-- | doc/en/index.docbook | 392 | ||||
| -rw-r--r-- | doc/en/logo.png | bin | 0 -> 3554 bytes | |||
| -rw-r--r-- | doc/en/media_device.png | bin | 0 -> 27339 bytes | |||
| -rw-r--r-- | doc/en/menubar.png | bin | 0 -> 2927 bytes | |||
| -rw-r--r-- | doc/en/musicbrainz.png | bin | 0 -> 1611 bytes | |||
| -rw-r--r-- | doc/en/pl_tip1.png | bin | 0 -> 8139 bytes | |||
| -rw-r--r-- | doc/en/play_list.png | bin | 0 -> 16391 bytes | |||
| -rw-r--r-- | doc/en/player_window.png | bin | 0 -> 11811 bytes | |||
| -rw-r--r-- | doc/en/playlist_browser.png | bin | 0 -> 27593 bytes | |||
| -rw-r--r-- | doc/en/playlist_window.png | bin | 0 -> 67451 bytes | |||
| -rw-r--r-- | doc/en/queue_manager.png | bin | 0 -> 16560 bytes | |||
| -rw-r--r-- | doc/en/quick.docbook | 85 | ||||
| -rw-r--r-- | doc/en/requirements.docbook | 40 | ||||
| -rw-r--r-- | doc/en/rmb_menu.png | bin | 0 -> 24242 bytes | |||
| -rw-r--r-- | doc/en/script_manager.png | bin | 0 -> 22626 bytes | |||
| -rw-r--r-- | doc/en/status_bar.png | bin | 0 -> 6710 bytes | |||
| -rw-r--r-- | doc/en/tab_lyrics.png | bin | 0 -> 17497 bytes | |||
| -rw-r--r-- | doc/en/tab_music.png | bin | 0 -> 86717 bytes | |||
| -rw-r--r-- | doc/en/tab_wiki.png | bin | 0 -> 141378 bytes | |||
| -rw-r--r-- | doc/en/using.docbook | 1270 | ||||
| -rw-r--r-- | doc/en/vis_window.png | bin | 0 -> 11669 bytes |
42 files changed, 4190 insertions, 0 deletions
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 00000000..5996bada --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_LANG_C = en +KDE_DOCS = AUTO diff --git a/doc/en/add_dynamic.png b/doc/en/add_dynamic.png Binary files differnew file mode 100644 index 00000000..2442e8b3 --- /dev/null +++ b/doc/en/add_dynamic.png diff --git a/doc/en/advanced.docbook b/doc/en/advanced.docbook new file mode 100644 index 00000000..9f0908eb --- /dev/null +++ b/doc/en/advanced.docbook @@ -0,0 +1,1110 @@ +<chapter id="advanced-features"> +<title>Advanced Amarok features</title> + + +<sect1 id="keybd-shortcuts"> +<title>Keyboard Shortcuts</title> + +<para>&amarok; uses keyboard shortcuts like most other applications, below is a listing of those shortcuts and there respective actions. The global shortcuts can be configured by right clicking the Player window and selecting <guimenuitem>Configure Global Shortcuts...</guimenuitem> The &amarok; shortcuts can be configured by right clicking the Player window and selecting <guimenuitem>Configure Shortcuts...</guimenuitem></para> + +<tip><para>You can assign you multimedia keys to work as &amarok; shortcuts making your keyboard an &amarok; control center.</para></tip> + +<para>The global shortcuts are:</para> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>Key Combination</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>X</keycap></keycombo></entry> +<entry>Play</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>C</keycap></keycombo></entry> +<entry>Pause</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>V</keycap></keycombo></entry> +<entry>Stop</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>B</keycap></keycombo></entry> +<entry>Next Track</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>Z</keycap></keycombo></entry> +<entry>Previous Track</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>KP_Add</keycap></keycombo></entry> +<entry>Increase Volume</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>KP_Subtract</keycap></keycombo></entry> +<entry>Decrease Volume</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>Shift</keycap><keycap>KP_Add</keycap></keycombo></entry> +<entry>Seek Forward</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>Shift</keycap><keycap>KP_Subtract</keycap></keycombo></entry> +<entry>Seek Backward</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>A</keycap></keycombo></entry> +<entry>Add Media</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>P</keycap></keycombo></entry> +<entry>Toggle Playlist</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>O</keycap></keycombo></entry> +<entry>Show OSD</entry> +</row> + +<row> +<entry><keycombo><keycap>Win</keycap><keycap>M</keycap></keycombo></entry> +<entry>Mute Volume</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +<para>The &amarok; shortcuts are:</para> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>Key Combination</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo></entry> +<entry>Copy</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>KP_Enter</keycap></keycombo></entry> +<entry>Goto Current</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo></entry> +<entry>Queue Selected Tracks</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo></entry> +<entry>Quit</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Z</keycap></keycombo></entry> +<entry>Redo</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo></entry> +<entry>Save Playlist</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo></entry> +<entry>Select All</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>M</keycap></keycombo></entry> +<entry>Show Menubar</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></entry> +<entry>Shuffle</entry> +</row> + +<row> +<entry><keycombo><keycap>Ctrl</keycap><keycap>Z</keycap></keycombo></entry> +<entry>Undo</entry> +</row> + + +</tbody> +</tgroup> +</informaltable> + + +<para>The Playlist Browser shortcuts are:</para> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>Key Combination</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry><keycap>Space</keycap></entry> +<entry>Load Playlist</entry> +</row> + +<row> +<entry><keycap>F2</keycap></entry> +<entry>Rename Playlist</entry> +</row> + +<row> +<entry><keycap>Backspace</keycap></entry> +<entry>Remove Playlist</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect1> + +<sect1 id="the-dcop-interface"> +<title>The DCOP Interface</title> + +<para>The Amarok DCOP interface provides you with an easy way to control Amarok with your own custom scripts.</para> + +<para>The DCOP interface for Amarok has many generic calls that may be found in other TDE applications. This section is divided into six tables and is intended to describe the DCOP calls of the collection, contextbrowser, player, playlist, playlistbrowser and scripts. An example of the <quote>pause</quote> dcop call would look like:</para> + +<para><prompt>%</prompt>dcop amarok player pause</para> + +<sect2 id="dcop-collection"> +<title>dcop amarok collection</title> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>int totalAlbums()</entry> +<entry>Returns the total of albums in the collection.</entry> +</row> + +<row> +<entry>int totalArtists()</entry> +<entry>Returns the total of artists in the collection.</entry> +</row> + +<row> +<entry>int totalCompilations()</entry> +<entry>Returns the total of compilations in the collection.</entry> +</row> + +<row> +<entry>int totalGenres()</entry> +<entry>Returns the total of genres in the collection.</entry> +</row> + +<row> +<entry>int totalTracks()</entry> +<entry>Returns the total of tracks in the collection.</entry> +</row> + +<row> +<entry>QString query( QString sql)</entry> +<entry>Queries the database via SQL.</entry> +</row> + +<row> +<entry>QStringList similarArtists( int artists )</entry> +<entry>Return similar artists of the current tracks, limit to int artists.</entry> +</row> + +<row> +<entry>void migrateFile( QString oldURL, QString newURL )</entry> +<entry>Move a file in the collection, keeping stats intact.</entry> +</row> + +<row> +<entry>void scanCollection()</entry> +<entry>Scan the collection.</entry> +</row> + +<row> +<entry>void scanCollectionChanges()</entry> +<entry>Scan the collection for changes only.</entry> +</row> + + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="dcop-context"> +<title>dcop amarok contextbrowser</title> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>void showCurrentTrack()</entry> +<entry>Show the current track in the context browser.</entry> +</row> + +<row> +<entry>void showLyrics()</entry> +<entry>Show the lyrics tab in the context browser.</entry> +</row> + +<row> +<entry>void showWiki()</entry> +<entry>Show the wikipedia tab in the context browser.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="dcop-player"> +<title>dcop amarok player</title> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>bool dynamicModeStatus()</entry> +<entry>Return dynamic mode status.</entry> +</row> + +<row> +<entry>bool equalizerEnabled()</entry> +<entry>Return the equalizer status.</entry> +</row> + +<row> +<entry>bool isPlaying()</entry> +<entry>Return true if something is playing now.</entry> +</row> + +<row> +<entry>bool randomModeStatus()</entry> +<entry>Return random mode status.</entry> +</row> + +<row> +<entry>bool repeatPlaylistStatus()</entry> +<entry>Return repeat playlist status.</entry> +</row> + +<row> +<entry>bool repeatTrackStatus()</entry> +<entry>Return repeat track status.</entry> +</row> + +<row> +<entry>int getVolume()</entry> +<entry>Return volume in range 0-100%.</entry> +</row> + +<row> +<entry>int sampleRate()</entry> +<entry>Return the sample rate of the currently playing track.</entry> +</row> + +<row> +<entry>int score()</entry> +<entry>Return the score of the currently playing track.</entry> +</row> + +<row> +<entry>int status()</entry> +<entry>Return playback status: 0 - stopped, 1 - paused, 2 - playing.</entry> +</row> + +<row> +<entry>int trackCurrentTime()</entry> +<entry>Return current play position in seconds.</entry> +</row> + +<row> +<entry>int trackPlayCounter()</entry> +<entry>Return play counter for current song.</entry> +</row> + +<row> +<entry>int trackTotalTime()</entry> +<entry>Return track length in seconds.</entry> +</row> + +<row> +<entry>QString album()</entry> +<entry>Return the album of the currently playing track.</entry> +</row> + +<row> +<entry>QString artist()</entry> +<entry>Return the artist of the currently playing track.</entry> +</row> + +<row> +<entry>QString bitrate()</entry> +<entry>Return the bitrate of the currently playing track (XX kbps).</entry> +</row> + +<row> +<entry>QString comment()</entry> +<entry>Return the comment of the currently playing track.</entry> +</row> + +<row> +<entry>QString coverImage()</entry> +<entry>Return the encoded URL of the current track's cover image </entry> +</row> + +<row> +<entry>QString currentTime()</entry> +<entry>Return the position of the currently playing track ([h:]mm:ss format).</entry> +</row> + +<row> +<entry>QString encodedURL()</entry> +<entry>Return the encoded URL of the currently playing track.</entry> +</row> + +<row> +<entry>QString engine()</entry> +<entry>Return the current sound engine.</entry> +</row> + +<row> +<entry>QString genre()</entry> +<entry>Return the genre of the currently playing track.</entry> +</row> + +<row> +<entry>QString lyrics()</entry> +<entry>Return the lyrics of the currently playing track.</entry> +</row> + +<row> +<entry>QString lyricsByPath( QString path )</entry> +<entry>Return the lyrics of a track by path.</entry> +</row> + +<row> +<entry>QString nowPlaying()</entry> +<entry>The title of now playing media.</entry> +</row> + +<row> +<entry>QString path()</entry> +<entry>Return the unencoded path of the currently playing track.</entry> +</row> + +<row> +<entry>QString setContextStyle( QString )</entry> +<entry>Set the CSS style for the context browser.</entry> +</row> + +<row> +<entry>QString title()</entry> +<entry>Return the title of the currently playing track.</entry> +</row> + +<row> +<entry>QString totalTime()</entry> +<entry>Return the total length of the currently playing track ([h:]mm:ss format).</entry> +</row> + +<row> +<entry>QString track()</entry> +<entry>Return the track number.</entry> +</row> + +<row> +<entry>QString type()</entry> +<entry>Return the file type.</entry> +</row> + +<row> +<entry>QString year()</entry> +<entry>Return the year of the currently playing track.</entry> +</row> + +<row> +<entry>void configEqualizer()</entry> +<entry>Toggle equalizer config dialog.</entry> +</row> + +<row> +<entry>void enableDynamicMode(bool enable)</entry> +<entry>Switch Dynamic Mode on or off.</entry> +</row> + +<row> +<entry>void enableOSD(bool enable)</entry> +<entry>Switch OSD display on or off.</entry> +</row> + +<row> +<entry>void enableRandomMode(bool enable)</entry> +<entry>Switch Random Mode on or off.</entry> +</row> + +<row> +<entry>void enableRepeatPlaylist(bool enable)</entry> +<entry>Switch Repeat Playlist on or off.</entry> +</row> + +<row> +<entry>void enableRepeatTrack(bool enable)</entry> +<entry>Switch Repeat Track on or off.</entry> +</row> + +<row> +<entry>void mediaDeviceMount()</entry> +<entry>Sets the command used for mounting media device.</entry> +</row> + +<row> +<entry>void mediaDeviceUmount()</entry> +<entry>Sets the comment used for umounting media device.</entry> +</row> + +<row> +<entry>void mute()</entry> +<entry>Toggle mute.</entry> +</row> + +<row> +<entry>void next()</entry> +<entry>Equivalent to pressing "Next" button.</entry> +</row> + +<row> +<entry>void pause()</entry> +<entry>Equivalent to pressing "Pause" button.</entry> +</row> + +<row> +<entry>void play()</entry> +<entry>Equivalent to pressing "Play" button.</entry> +</row> + +<row> +<entry>void playPause()</entry> +<entry>Toggle play/pause state (good for mm keyboard users) </entry> +</row> + +<row> +<entry>void prev()</entry> +<entry>Equivalent to pressing "Prev" button.</entry> +</row> + +<row> +<entry>void queueForTransfer( KURL url )</entry> +<entry>Queue file for transfer to Media Device.</entry> +</row> + +<row> +<entry>void seek(int s)</entry> +<entry>Seek track to seconds position.</entry> +</row> + +<row> +<entry>void seekRelative(int s)</entry> +<entry>Seek to a position relative to the current track position.</entry> +</row> + +<row> +<entry>void setEqualizer(int, int, int, int, int, int, int, int, int, int, int)</entry> +<entry>Set the equalizer bands </entry> +</row> + +<row> +<entry>void setEqualizerEnabled( bool active )</entry> +<entry>Toggle equalizer.</entry> +</row> + +<row> +<entry>void setEqualizerPreset( QString name )</entry> +<entry>Set the equalizer preset </entry> +</row> + +<row> +<entry>void setLyricsByPath( QString url, QString lyrics )</entry> +<entry>Set the lyrics of a track by it's path.</entry> +</row> + +<row> +<entry>void setScore( int score )</entry> +<entry>Set the score of the currently playing track.</entry> +</row> + +<row> +<entry>void setScoreByPath( QString url, int score )</entry> +<entry>Set the score of a track by it's path.</entry> +</row> + +<row> +<entry>void setVolume(int volume)</entry> +<entry>Set volume in range 0-100%.</entry> +</row> + +<row> +<entry>void showBrowser( QString browser )</entry> +<entry>Shows browsers in the playlist window</entry> +</row> + +<row> +<entry>void showOSD()</entry> +<entry>Show the OSD display on the screen.</entry> +</row> + +<row> +<entry>void stop()</entry> +<entry>Equivalent to pressing "Stop" button.</entry> +</row> + +<row> +<entry>void transferDeviceFiles()</entry> +<entry>Transfer files to media device.</entry> +</row> + +<row> +<entry>void volumeDown()</entry> +<entry>Decrease volume by a reasonable step.</entry> +</row> + +<row> +<entry>void volumeUp()</entry> +<entry>Increase volume by a reasonable step.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="dcop-playlist"> +<title>dcop amarok playlist</title> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>int getActiveIndex()</entry> +<entry>Return the index of the currently active track. -1 if none.</entry> +</row> + +<row> +<entry>int getTotalTrackCount()</entry> +<entry>Return number of tracks in playlist. 0 if none.</entry> +</row> + +<row> +<entry>QString saveCurrentPlaylist()</entry> +<entry>Saves the current playlist to current.xml and returns its path.</entry> +</row> + +<row> +<entry>void addMedia( KURL )</entry> +<entry>Add audio media specified by the url.</entry> +</row> + +<row> +<entry>void addMediaList( KURL::List )</entry> +<entry>Add some audio media specified by the url.</entry> +</row> + +<row> +<entry>void clearPlaylist()</entry> +<entry>Clears the playlist.</entry> +</row> + +<row> +<entry>void playByIndex(int)</entry> +<entry>Starts playing the track at the specified index.</entry> +</row> + +<row> +<entry>void playMedia( KURL )</entry> +<entry>Add audio media specified by the url.</entry> +</row> + +<row> +<entry>void popupMessage( QString)</entry> +<entry>Shows a temporary popup message.</entry> +</row> + +<row> +<entry>void removeCurrentTrack()</entry> +<entry>Removes the current-track item from the playlist.</entry> +</row> + +<row> +<entry>void repopulate()</entry> +<entry>Repopulate the playlist with random tracks.</entry> +</row> + +<row> +<entry>void saveM3u( QString path, bool relativePaths)</entry> +<entry>Saves the current playlist as m3u.</entry> +</row> + +<row> +<entry>void setStopAfterCurrent( bool )</entry> +<entry>Enables/disables the "Stop After Current Track" feature.</entry> +</row> + +<row> +<entry>void shortStatusMessage( QString)</entry> +<entry>Shows a temporary message on the statusbar.</entry> +</row> + +<row> +<entry>void shufflePlaylist()</entry> +<entry>Shuffles the playlist.</entry> +</row> + +<row> +<entry>void togglePlaylist()</entry> +<entry>Toggle the Playlist-window.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="dcop-playlistbrowser"> +<title>dcop amarok playlistbrowser</title> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>void addPodcast( QString )</entry> +<entry>Add a podcast entry to the playlist browser.</entry> +</row> + +<row> +<entry>void scanPodcasts()</entry> +<entry>Scan all podcasts for updates.</entry> +</row> + +<row> +<entry>void addPlaylist( QString )</entry> +<entry>Add a playlist to the playlist browser.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +<sect2 id="dcop-script"> +<title>dcop amarok script</title> + + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>DCOP Call</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>bool runScript( QString name)</entry> +<entry>Starts the script with the given name. Returns true on success.</entry> +</row> + +<row> +<entry>bool stopScript( QString name)</entry> +<entry>Stops the script with the given name. Returns true on success.</entry> +</row> + +<row> +<entry>QStringList listRunningScripts()</entry> +<entry>Returns a list of all currently running scripts.</entry> +</row> + +<row> +<entry>void addCustomMenuItem(QString submenu, QString itemTitle )</entry> +<entry>Enables and sets custom menu item title.</entry> +</row> + +<row> +<entry>void removeCustomMenuItem(QString submenu, QString itemTitle )</entry> +<entry>Removes the custom menu item.</entry> +</row> + +<row> +<entry>QString readConfig( QString key)</entry> +<entry>Returns a AmarokConfig configuration entry value from the given key.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + + +</sect2> + +</sect1> + +<sect1 id="cmd-line-options"> +<title>Command-line Options</title> + +<para>Amarok supports the use of the standard Qt and kde command line options. Amarok also has it's own application specific options.</para> + +<para>The Qt and kde options:</para> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>Option</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>--help</entry> +<entry>Show help about options.</entry> +</row> + +<row> +<entry>--help-qt</entry> +<entry>Show Qt specific options.</entry> +</row> + +<row> +<entry>--help-kde</entry> +<entry>Show KDE specific options.</entry> +</row> + +<row> +<entry>--help-all</entry> +<entry>Show all options.</entry> +</row> + +<row> +<entry>--author</entry> +<entry>Show author information.</entry> +</row> + +<row> +<entry>-v, --version</entry> +<entry>Show version information.</entry> +</row> + +<row> +<entry>--license</entry> +<entry>Show license information.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +<para>The Amarok options:</para> + +<note><para>The &amarok; options are designed to be used while &amarok; is running.</para></note> + +<informaltable> +<tgroup cols="2"> +<thead> + +<row> +<entry>Option</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry>-r, --previous</entry> +<entry>Skip to the previous track in the playlist.</entry> +</row> + +<row> +<entry>-p, --play</entry> +<entry>Start playing current playlist.</entry> +</row> + +<row> +<entry>-s, --stop</entry> +<entry>Stop playback.</entry> +</row> + +<row> +<entry>--pause</entry> +<entry>Pause playback.</entry> +</row> + +<row> +<entry>-f, --next</entry> +<entry>Skip to the next track in the playlist.</entry> +</row> + +<row> +<entry>-a, --append</entry> +<entry>Append Files/URLs into the playlist.</entry> +</row> + +<row> +<entry>-e, --enqueue</entry> +<entry>See append, available for backwards compatability.</entry> +</row> + +<row> +<entry>--queue</entry> +<entry>Queue Files/URLs after the currently playing track.</entry> +</row> + +<row> +<entry>-m, --toggle-playlist-window</entry> +<entry>Toggle the playlist window.</entry> +</row> + +<row> +<entry>--wizard</entry> +<entry>Launch the First-run wizard.</entry> +</row> + +<row> +<entry>--engine "name"</entry> +<entry>Start &amarok; with the "name" engine.</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect1> + + +<sect1 id="script-writing"> +<title>Script Writing</title> + +<para>Scripting allows you to extend &amarok; easily without changing the main codebase. Scripts are similar to plugins, but instead of a dedicated plugin API they use &amarok;'s DCOP interface for communication. This makes it possible to write scripts in almost any programming language, like Ruby, Python or PHP. Not only can you create scripts in classic scripting languages, but also in compiled languages like C++ or plain C. Additionally, &amarok; can notify the scripts on special events and make them react accordingly. This notification system will be explained later in this section.</para> + +<sect2 id="script-bindings"> +<title>Bindings</title> + +<para>It is possible to write simple scripts that do not need user interaction, and it's also possible to make scripts with comfortable GUIs that act like little applications of their own. For GUI programming one of the many bindings which KDE provides can be used, for instance RubyQt, a Qt library binding for Ruby. However, it is worth noting that not every user has all available bindings installed. If you decide to use a binding, try to use one of the relatively wide spread ones (e.g. RubyQt or PyQt).</para> + +<para>In order to provide some feedback when a script fails to run due to a missing dependency, please check in your script if the module you want to include really exists. If the dependency is missing, you should catch the error and show an information dialog using the "kdialog" command line tool, so that the user learns why the script fails to run.</para> + +<para>This example shows how to catch a missing dependency in Ruby:</para> + +<programlisting> +begin + require 'Korundum' +rescue LoadError + error = 'Korundum (KDE bindings for ruby) from tdebindings v3.4 is required for this script.' + `kdialog --sorry '#{error}'` + exit +end +</programlisting> + +</sect2> + +<sect2 id="script-templates"> +<title>Getting Started: The Templates</title> + +<para>&amarok; provides template scripts for several languages in the <filename class="directory">scripts/templates/</filename> directory. You can use these scripts as a basis for your own scripts, and extend them with the functionality you need. You'll notice that scripting is actually quite straightforward; For instance if you know to program a bit in Python, making your own script won't take you long.</para> + +</sect2> + +<sect2 id="script-controlling-amarok"> +<title>Controlling &amarok; With DCOP</title> + +<para>Scripts can control Amarok by calling some of its DCOP functions. The easiest way to invoke a DCOP function is by using the "dcop" command line utility, which is part of every KDE distribution.</para> + +<para>Here is an example for increasing the master volume:</para> + +<programlisting>dcop amarok player volumeUp</programlisting> + +<para>Most scripting languages allow to execute external programs, with a function like exec(). This way the "dcop" utility can be invoked easily. Here is a simple Python example:</para> + +<programlisting> + import os + os.system("dcop amarok player volumeDown") +</programlisting> + +</sect2> + +<sect2 id="script-notifications"> +<title>Notifications</title> + +<para>&amarok; sends notifications to all running scripts by writing strings to their stdin channel. The script should therefore constantly monitor stdin, and react accordingly to each of the possible events. Scripts may also choose to ignore any event they don't have a use for.</para> + +<para>The following notifications are sent by &amarok;:</para> + +<programlisting> +<cmdsynopsis><command>configure</command></cmdsynopsis> +Tells the script to show its configuration dialog. The script must handle the +storing and loading of configuration options by itself. When a script is +started, Amarok sets its working directory to the folder where all data +should be stored. +</programlisting> + +<programlisting> +<cmdsynopsis><command>engineStateChange:</command><arg>empty|idle|paused|playing</arg></cmdsynopsis> +Signals a change in the engine's state. +</programlisting> + +<programlisting> +<cmdsynopsis><command>trackChange</command></cmdsynopsis> +Signals the start of a new track. The script may then use DCOP functions to +query further information about the track, e.g. metadata and the length. +</programlisting> + +<programlisting> +<cmdsynopsis><command>volumeChange</command><arg>newVolume</arg></cmdsynopsis> +Signals a change of the master volume level. The volume is an integer with a +range of 0-100. +</programlisting> + +<programlisting> +<cmdsynopsis><command>customMenuClicked:</command><arg>submenu itemTitle paths</arg></cmdsynopsis> +Returns the paths to selected files in the playlist when the custom playlist +context menu item is clicked. The submenu and itemTitle are also returned for +identification purposes in case a script is listening for multiple notifications. +To insert an item into the context menu use the DCOP call +'dcop amarok script addCustomMenuItem( submenu itemTitle )'. To remove an +item from the context menu use the DCOP call +'dcop amarok script removeCustomMenuItem( submenu itemTitle )'. +</programlisting> + +</sect2> + +<sect2 id="script-termination"> +<title>Script Termination</title> + +<para>Before &amarok; exits, or when the user stops a script with the Script Manager, &amarok; sends the SIGTERM signal to the script. This signal can be caught in order to do cleanup work, like saving data or configuration settings.</para> + +</sect2> + +<sect2 id="script-packaging"> +<title>Packaging</title> + +<para>&amarok;'s Script Manager is able to install script packages that the user has downloaded from a web server. Packages are just normal tarballs (.tar), optionally compressed with bzip2 (.bz2). We strongly recommend using a filename like myscript.amarokscript.tar.bz2, so the user can easily identify the package as an Amarok script.</para> + +<note><para>&amarok; 1.3 will only accept script packages with the amarokscript extension, so it is better to use it right from the start.</para></note> + +<para>The tarball's content must be organized as follows:</para> + +<programlisting> +myscript/ + README + myscript.py (executable) + somemodule.py + foo.data + ... +</programlisting> + +</sect2> + +<sect2 id="script-permissions"> +<title>File permissions</title> + +<para>The main script must have executable (+x) permissions set, while additional modules which the script loads should not be executable. To preserve the file permissions in the tarball, you should use tar with the -p flag:</para> + +<programlisting>tar -cf myscript.amarokscript.tar -p myscript</programlisting> + +<note><para>&amarok; will not be able to install the script if the permissions are not correctly set.</para></note> + +</sect2> + +<sect2 id="script-distributing"> +<title>Distributing</title> + +<para>When the package is finished, you can upload it to <ulink url="http://www.kde-apps.org">www.kde-apps.org</ulink>, and add the link to the &amarok; <ulink url="http://amarok.kde.org/amarokwiki/index.php/Scripts">Wiki Scripts Page</ulink>. For the kde-apps entry you should use the <ulink url="http://kde-apps.org/index.php?xcontentmode=56">&amarok; Scripts</ulink> category.</para> + +</sect2> + +</sect1> + + +</chapter> + diff --git a/doc/en/amarok_playlist.png b/doc/en/amarok_playlist.png Binary files differnew file mode 100644 index 00000000..447ba6aa --- /dev/null +++ b/doc/en/amarok_playlist.png diff --git a/doc/en/analyzer.png b/doc/en/analyzer.png Binary files differnew file mode 100644 index 00000000..b1a2721b --- /dev/null +++ b/doc/en/analyzer.png diff --git a/doc/en/buttons.png b/doc/en/buttons.png Binary files differnew file mode 100644 index 00000000..44f461e9 --- /dev/null +++ b/doc/en/buttons.png diff --git a/doc/en/collection.png b/doc/en/collection.png Binary files differnew file mode 100644 index 00000000..7a0b4ee5 --- /dev/null +++ b/doc/en/collection.png diff --git a/doc/en/config.docbook b/doc/en/config.docbook new file mode 100644 index 00000000..5a43ce7d --- /dev/null +++ b/doc/en/config.docbook @@ -0,0 +1,252 @@ +<chapter id="configuring-kapp"> +<title>Configuring &amarok;</title> +<para>&amarok; is easily configured from the configuration dialog. The configuration dialog has multiple tabs for setting up different functions of &amarok;.</para> +<para>The configuration dialog can be found by selecting <guimenuitem>Configure &amarok;</guimenuitem> in the player <link linkend="rmb-menu">&RMB; menu</link>, +or by selecting <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &amarok;...</guimenuitem></menuchoice>.</para> +<sect1 id="general-options"> +<title>General Options</title> +<screenshot> + <screeninfo>General Options Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_general.png" format="PNG"/></imageobject> +</mediaobject> +</screenshot> +<para>The General Options tab is divided into two sections, <guimenuitem>General Options</guimenuitem> and <guimenuitem>Playlist Options</guimenuitem>.</para> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>General Options</guimenu></menuchoice></term> +<listitem> +<para>In the General Options section you can configure some basic &amarok; options.</para> +<para><guilabel>Show splash-screen on startup</guilabel>: displays the splash screen when &amarok; starts.</para> +<para><guilabel>Show tray icon</guilabel>: enables the display of the system tray icon.</para> + +<para><guilabel>Flash tray icon</guilabel>: enables animation of the system tray icon.</para> +<para><guilabel>Show player window (like XMMS)</guilabel>: Turns on the XMMS-like <link linkend="player-window">Player Window</link>. When un-checked, only the <link linkend="playlist-window">Playlist Window</link>, which resembles a display mode similar to the Juk interface, is shown.</para> +<para><guilabel>Use Moodbar</guilabel>: only visible when &amarok; is compiled with moodbar support. This turns on the experimental moodbar support.</para> +<para><guilabel>Make Moodier</guilabel>: only visible when &amarok; is compiled with moodbar support. It changes the color scheme used for the moodbar.</para> +<para><guilabel>Store Mood data files with music</guilabel>: only visible when &amarok; is compiled with moodbar support. When enabled, this option allows saving of <literal role="extension">.mood</literal> files in the same location as the corresponding audio file. When disabled, the <literal role="extension">.mood</literal> files are saved within the &amarok; settings directory; usually <filename class="directory">~/.trinity/share/apps/amarok/moodbar/</filename>.</para> +<para><guilabel>Default size of cover previews</guilabel>: allows adjusting the size of the album cover image in the Context Browser.</para> +<para><guilabel>External web browser:</guilabel> allows choosing what &amarok; uses to open external links via a drop-down menu listing the installed browsers.</para> +<para><guilabel>Use another browser:</guilabel> allows you to specify the location to a browser not listed in the above menu.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Playlist-Window Options</guimenu></menuchoice></term> +<listitem> +<para>In the Playlist-Window Options section you can configure playlist behavior.</para> +<para><guilabel>Remember current playlist on exit</guilabel>: check this if you want to save your current playlist when you exit &amarok; and reload it the next time.</para> +<para><guilabel>Manually saved playlists use relative path</guilabel>: check this box to have &amarok; save playlists with the location of audio file with respect to the location of the playlist. When unchecked &amarok; will save the exact location to the audio files in the playlist.</para> +<para><guilabel>Keep active song visible on track change</guilabel>: this option automatically scrolls the <link linkend="playlist">Playlist</link>, when a track changes, to ensure that the currently playing track is always visible.</para> +<para><guilabel>Switch to Context Browser on track change</guilabel>: used to change to the Context Browser tab if it isn't active when &amarok; starts playback of a new track.</para> +<para><guilabel>Show statusbar</guilabel>: enables the &amarok; <link linkend="statusbar">statusbar</link> in the <link linkend="playlist-window">Playlist Window</link>.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="configure-appearance"> +<title>Configure Appearance</title> +<screenshot> + <screeninfo>Configure Appearance Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_appearance.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<para>The Appearance tab allows you to configure how &amarok; looks. The tab is divided into three sections.</para> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Fonts</guimenu></menuchoice></term> +<listitem> +<para>The fonts section is used for selecting the fonts to be used with &amarok;. Selecting the <guilabel>Use custom fonts</guilabel> checkbox enables font selection buttons. The available choices are for the <link linkend="player-window">Player Window</link>, the <link linkend="playlist-window">Playlist Window</link>, and the <link linkend="context-browser">Context Browser</link>. By clicking the <guibutton>Choose...</guibutton> button you can select a font from the dialog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Color Scheme</guimenu></menuchoice></term> +<listitem> +<para>The color scheme section is used to choose the color scheme for &amarok;.</para> +<para><guilabel>The current KDE color-scheme</guilabel> choice forces &amarok; use the current KDE color scheme.</para> +<para><guilabel>The classic Amarok, "funky-monkey", theme</guilabel> choice uses &amarok;'s original color scheme.</para> +<para><guilabel>Custom color scheme</guilabel> enables color selectors to choose custom foreground and background colors for &amarok;.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Context Browser Style</guimenu></menuchoice></term> +<listitem> +<para>This section allows you to change, install and remove Context Browser styles (themes). The <guilabel>Select a style</guilabel> drop-down menu selection of installed styles for use. The <guibutton>Install New Styles...</guibutton> button opens a file selection dialog where you can browse to styles saved on your system and install them. The <guibutton>Download Styles...</guibutton> button opens a dialog that fetches new styles from kde-look.org. Finally, the <guibutton>Uninstall Style</guibutton> button shows a dialog which allows you to remove any manually installed styles.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="configure-playback"> +<title>Configure Playback</title> +<screenshot> + <screeninfo>Configure Playback Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_playback.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<para>The Configure Playback tab provides an interface for configuring your audio playback characteristics.</para> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Transition Behavior</guimenu></menuchoice></term> +<listitem> +<para>You can configure how &amarok; transitions from one song to the next.</para> +<para><guilabel>No Crossfading</guilabel>: provides a silent gap between tracks, specified in milliseconds.</para> +<para><guilabel>Crossfading</guilabel>: provides a nice fading effect. The crossfade period is also specified in milliseconds.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Remaining Options</guimenu></menuchoice></term> +<listitem> +<para>The remaining checkbox configures the the following option:</para> +<para><guilabel>Resume playback on start</guilabel> allows resuming playback of the last track that was playing when &amarok; was closed, from the last known position in the track.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="configure-osd"> +<title>Configure On-Screen-Display</title> +<screenshot> + <screeninfo>Configure OSD Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_osd.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Configure On-Screen-Display</guimenu></menuchoice></term> +<listitem> +<para>The <guilabel>Configure On-Screen-Display</guilabel> tab allows you to activate the On-Screen-Display. If the On-Screen-Display check box is selected an area is activated for configuring the look of the display. When the On-Screen-Display is activated a preview widget will also be displayed allowing you to see the effects of your changes to the look of the On-Screen-Display</para> +<para>The first option for the OSD is the Font. Clicking the <guibutton>Choose</guibutton> button will open a Font Selection dialog allowing you to choose the font used in the OSD. There is also a <guilabel>Draw shadow</guilabel> checkbox to enable or disable the use of Shadowed text in the OSD</para> +<para>The next option is for the OSD colors. Checking the <guilabel>Use custom colors</guilabel> checkbox enables the <guibutton>Text color:</guibutton> and <guibutton>Background color:</guibutton> buttons. Clicking the buttons opens a dialog to choose the color OSD Text or OSD Background. If the <guilabel>Use custom colors</guilabel> checkbox is disabled the OSD will follow your current &kde; color scheme.</para> +<para>The <guilabel>Display Text</guilabel> text input box is used for configuring the text shown in the OSD. By assigning variables you can customize the OSD to suit your needs. Below is a list of the variables and the text they represent.</para> +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Text</entry> +<entry>Variable</entry> +</row> +</thead> +<tbody> +<row> +<entry>Title</entry> +<entry>%title</entry> +</row> +<row> +<entry>Album</entry> +<entry>%album</entry> +</row> +<row> +<entry>Artist</entry> +<entry>%artist</entry> +</row> +<row> +<entry>Genre</entry> +<entry>%genre</entry> +</row> +<row> +<entry>Bitrate</entry> +<entry>%bitrate</entry> +</row> +<row> +<entry>Year</entry> +<entry>%year</entry> +</row> +<row> +<entry>Track Length</entry> +<entry>%length</entry> +</row> +<row> +<entry>Track Number</entry> +<entry>%track</entry> +</row> +<row> +<entry>Filename</entry> +<entry>%file</entry> +</row> +<row> +<entry>Comment</entry> +<entry>%comment</entry> +</row> +<row> +<entry>Score</entry> +<entry>%score</entry> +</row> +<row> +<entry>Playcount</entry> +<entry>%playcount</entry> +</row> +</tbody> +</tgroup> +</informaltable> +<para>The <guilabel>Duration</guilabel> spin box is used to adjust the time, in milliseconds, that the OSD is displayed on your desktop.</para> +<para>The <guilabel>Screen</guilabel> option is for xinerama users only. This option is used to determine what screen the OSD will be shown on in a multiple monitor setup.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="configure-engine"> +<title>Configure Engine</title> +<screenshot> + <screeninfo>Configure Engine Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_engine.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<para>The Configure Engine tab allows you to select a sound engine from the list in the drop-down menu. Available options vary among the engines selected. See the "Requirements" section for different engines available. </para> +</sect1> +<sect1 id="configure-collection"> +<title>Configure Collection</title> +<screenshot> + <screeninfo>Configure Collection Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_collection.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<para>The Collection settings tab is used for configuring all the collection options. These include the folders where you music is stored, and the database used for the collection.</para> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Collection Folders</guimenu></menuchoice></term> +<listitem> +<para>This is where you choose the folders you want &amarok; to scan for music. Simply check the boxes next to the desired folders in the tree view of your filesystem. The <guilabel>Collection Folders</guilabel> section also has several check boxes to specify how the collection uses the selected folders.</para> +<para><guilabel>Scan folders recursively</guilabel>: tells &amarok; to scan the selected folders and all of their sub-folders.</para> +<para><guilabel>Watch folders for changes</guilabel>: allows &amarok; to watch the selected folders for filesystem changes (for example, added or deleted music files). An incremental scan is also performed to make the necessary changes to your collection.</para> +<para><guilabel>Import Playlists</guilabel>: allows &amarok; to import any playlists (.pls and .m3u files) it finds while scanning for tracks to add to your collection. You will find these on the "Playlists" sidebar.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Collection Database</guimenu></menuchoice></term> +<listitem> +<para>The <guilabel>Collection Database</guilabel> section is used to select a database to use for the collection. Use the <guilabel>Engine:</guilabel> combo box to select from either Sqlite or MySql. If MySql is selected, additional configuration is required in the <guilabel>MySql Configuration</guilabel> section.</para> +<para>The <guilabel>MySql Configuration</guilabel> section is for configuring what database &amarok; uses, and where it is located. First is the <guilabel>Hostname:</guilabel>, which is where the MySql database is located. Next is the <guilabel>Port:</guilabel>, which is the network port used when connecting to the database. The <guilabel>Name:</guilabel> option, is the actual database to connect to.</para> +<para>Use the <guilabel>Username:</guilabel> and <guilabel>Password:</guilabel> text input boxes to specify the username and password used for connecting to the MySql database.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="configure-scrobbler"> +<title>Configure Last.fm</title> +<screenshot> + <screeninfo>Configure last.fm Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="config_scrobbler.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> +<para>The last.fm settings tab configures the <ulink url="http://www.last.fm">last.fm</ulink> support in &amarok;. Tracks played are submitted to the last.fm server, and if asked to, &amarok; will request recommendations based on your currently playing track.</para> +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>last.fm Profile</guimenu></menuchoice></term> +<listitem> +<para>This is where you fill in the Username and Password for your last.fm profile. If you do not have a profile you can <ulink url="http://www.last.fm:80/signup.php">register at the last.fm website</ulink>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>last.fm Services</guimenu></menuchoice></term> +<listitem> +<para><guilabel>Improve my profile by submitting the tracks I play</guilabel>: allows &amarok; to submit your played tracks to your last.fm profile.</para> +<para><guilabel>Retrieve similar artists</guilabel>: this will cause &amarok; to request, from last.fm, a list of artists similar to the one you're listening to. These are also displayed in the Context Browser. Note: you do not need a last.fm profile to recieve similar artists - simply check this box.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> +</chapter>
\ No newline at end of file diff --git a/doc/en/config_appearance.png b/doc/en/config_appearance.png Binary files differnew file mode 100644 index 00000000..0204c05b --- /dev/null +++ b/doc/en/config_appearance.png diff --git a/doc/en/config_collection.png b/doc/en/config_collection.png Binary files differnew file mode 100644 index 00000000..a16911b7 --- /dev/null +++ b/doc/en/config_collection.png diff --git a/doc/en/config_engine.png b/doc/en/config_engine.png Binary files differnew file mode 100644 index 00000000..5309e2d4 --- /dev/null +++ b/doc/en/config_engine.png diff --git a/doc/en/config_general.png b/doc/en/config_general.png Binary files differnew file mode 100644 index 00000000..68c22907 --- /dev/null +++ b/doc/en/config_general.png diff --git a/doc/en/config_osd.png b/doc/en/config_osd.png Binary files differnew file mode 100644 index 00000000..b64417bf --- /dev/null +++ b/doc/en/config_osd.png diff --git a/doc/en/config_playback.png b/doc/en/config_playback.png Binary files differnew file mode 100644 index 00000000..11312bc1 --- /dev/null +++ b/doc/en/config_playback.png diff --git a/doc/en/config_scrobbler.png b/doc/en/config_scrobbler.png Binary files differnew file mode 100644 index 00000000..ba03382e --- /dev/null +++ b/doc/en/config_scrobbler.png diff --git a/doc/en/coverman.png b/doc/en/coverman.png Binary files differnew file mode 100644 index 00000000..d18bcf4b --- /dev/null +++ b/doc/en/coverman.png diff --git a/doc/en/dynamic_bar.png b/doc/en/dynamic_bar.png Binary files differnew file mode 100644 index 00000000..5431d1f5 --- /dev/null +++ b/doc/en/dynamic_bar.png diff --git a/doc/en/dynamic_settings.png b/doc/en/dynamic_settings.png Binary files differnew file mode 100644 index 00000000..aa6cb431 --- /dev/null +++ b/doc/en/dynamic_settings.png diff --git a/doc/en/equalizer.png b/doc/en/equalizer.png Binary files differnew file mode 100644 index 00000000..61d2d175 --- /dev/null +++ b/doc/en/equalizer.png diff --git a/doc/en/faq.docbook b/doc/en/faq.docbook new file mode 100644 index 00000000..d5d42c7c --- /dev/null +++ b/doc/en/faq.docbook @@ -0,0 +1,1038 @@ +<chapter id="faq"> +<title>Questions and Answers</title> + +<sect1 id="faq1"> +<title>What is &amarok;?</title> + +<qandaset id="what-is"> +<qandaentry> + +<question> +<para>What is &amarok;?</para> +</question> + +<answer> +<para>&amarok; is a music player for Unix systems (eg. Linux). More information can be found in a <ulink url="http://amarok.kde.org/amarokwiki/index.php/What_is_Amarok%3F">summary of its features</ulink> and the <ulink url="http://amarok.kde.org/index.php?set_albumName=Screenshots&option=com_gallery&Itemid=60&include=view_album.php">screenshot gallery</ulink>.</para> +</answer> + +</qandaentry> +</qandaset> + +</sect1> + +<sect1 id="faq2"> +<title>Installation</title> + +<qandaset id="installation-faq"> + + +<qandaentry> +<question> +<para>Can I use &amarok; without KDE?</para> +</question> + +<answer> +<para>&amarok; only requires KDElibs, none of the other KDE stuff. So you have to have KDElibs installed properly (including all the binaries that come with it, as &amarok; needs some of these to find plugins and for the script plugins). We have written an entry for <ulink url="http://amarok.kde.org/amarokwiki/index.php/KDElibs_without_aRts">how to compile a minimal KDElibs</ulink>, which you may find useful.</para> +<para>For some features to work correctly, such as the on-screen display, require your window manager to support the relevant freedesktop.org standards. So GNOME will work well, but fluxbox will have some trouble. We are committed to supporting &amarok; on all platforms. We use KDElibs and Qt because they provide an excellent development environment.</para> +</answer> +</qandaentry> + + +</qandaset> +</sect1> + + +<sect1 id="faq3"> +<title>Troubleshooting</title> + +<qandaset id="troubleshooting"> + +<qandaentry> +<question> +<para>&amarok; crashes during the Collection scan, always at the same point. What's happenning?</para> +</question> + +<answer> +<para>It's likely that one file in your Collection triggers a bug in the TagLib library, and makes &amarok; crash. You can identify this file by looking at ~/.trinity/share/apps/amarok/collection_scan.log. You should report this crash to the TagLib bug database on <ulink url="http://bugs.kde.org/">bugs.kde.org</ulink> and attach the broken file. Afterward you can remove the file from your Collection and repeat the scanning.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>&amarok; crashes when I play a certain track, everytime, what's wrong?</para> +</question> + +<answer> +<para>This usually means TagLib is crashing while reading that track's tags. Report the bug against TagLib at <ulink url="http://bugs.kde.org/">bugs.kde.org</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>&amarok; crashes often, what can I do?</para> +</question> + +<answer> +<para>Upgrade your ALSA libs and utils to the latest version, or use OSS, or OSS emulation.</para> +<para>If you use MySQL as the database backend, try the SQLite one, it is slightly more mature (the &amarok; code, not the db itself) </para> +<para> Try a different audio-engine.</para> +<para>Make sure that all the libraries that &amarok; uses were compiled with the same GCC version as &amarok; itself. The situation when &amarok; is compiled using GCC 3.4.x and linked against taglib which was compiled using GCC 3.3.x can lead to crashes during tag editing.</para> +<para>If you're using KDE with artsd, try disabling "auto suspend if idle after..." in the sound system settings or at least don't use a value of 1 second since that will interfere every time amarok switches songs.</para> +<para>Otherwise, forward us the backtraces when the email pops-up (you'll see). If you get a crash often you will get it fixed for sure if you forward a really good backtrace to us. See the next sections for assistance there.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How can I obtain a decent backtrace?</para> +</question> + +<answer> +<para>See the <ulink url="http://amarok.kde.org/amarokwiki/index.php/Debugging_HowTo">Debugging HowTo</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>&amarok; is not using the tags I know are in my files!</para> +</question> + +<answer> +<para>If Konqueror or other apps are displaying different Title, Artist, Album or Genre information than &amarok; is picking up when it creates your collection, it may be reading the older ID3v1 format tags rather than the newer ID3v2 tags. This can be due to your <guilabel>Encodings</guilabel> setting: Go to <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &amarok;</guimenuitem></menuchoice>, and then find the Encodings section of the Settings panel. Uncheck all checkboxes to "Do not decode the following as latin1". Rescan your collection to pick up the ID3v2 tags. </para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>&amarok; is not displaying my utf-8 id3v2 tags properly!</para> +</question> + +<answer> +<para>This is because most applications put utf8 data into id3v2 tags but do not specify the encoding as unicode. This perl script will fix that.</para> +<programlisting> +#!/usr/bin/perl +die "File $ARGV[0] doesn't exist" unless -f $ARGV[0]; +use MP3::Mplib; +my $mp3 = MP3::Mplib->new($ARGV[0]); +my $v2tag = $mp3->get_v2tag; +print "Error writing tags of $ARGV[0]\n" unless $mp3->set_v2tag($v2tag,&UTF8); +</programlisting> +<note><para>This script requires the perl module MP3::Mplib which can be installed by issuing this command +<command>perl -MCPAN -e 'install MP3::Mplib'</command></para></note> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why do my statusbar icons always look active?</para> +</question> + +<answer> +<para>&amarok; statusbar icons(Random/Repeat/Append) look constantly Active on KDE 3.4.0. This is a known bug in KDE 3.4.0. The icon effects are sometimes forgotten. Simple fix kcontrol <menuchoice><guimenu>Appearance</guimenu><guisubmenu>Icons</guisubmenu><guimenuitem>Advanced</guimenuitem></menuchoice>, set disabled state to "Gray" and "Semi-transparent". Note that sometimes you must click on the icon 3 times before it has an effect after making this change. </para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Why does &amarok; complain about undefined symbols and then refuses to start?</para> +</question> + +<answer> +<para>if you get this error : "amarokapp: symbol lookup error: amarokapp: undefined symbol: _ZN11KSystemTray9setPixmapERK7QPixmap", then check that amarokapp uses the correct libqt (check with : ldd `which amarokapp` | grep qt). </para> +<para>To fix it, you might have to remove any conflicting libqt and/or edit /etc/ld.so.conf so it pick up the correct version first.</para> +</answer> +</qandaentry> + + +</qandaset> +</sect1> + + +<sect1 id="faq5"> +<title>General Usage</title> + +<qandaset id="general-use"> + + +<qandaentry> +<question> +<para>Where can I get support for &amarok;?</para> +</question> + +<answer> +<para>There are several options. Often times problems you have with the initial install of &amarok; are best answered by experts of your particular Unix or Linux distribution. You may seek help from fellow users and developers at the <ulink url="http://amarok.kde.org/index.php?option=com_simpleboard">&amarok; forum</ulink> and the <ulink url="irc://irc.freenode.net/amarok">IRC channel</ulink> at irc.freenode.net channel #amarok.</para> +<note><para><ulink url="http://bugs.kde.org">Bugzilla</ulink> is not a place to seek support. Please do enter a bug if you are serious about helping fix a bug in &amarok; itself.</para></note> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>When I start &amarok;, I see an empty playlist. How do I actually get tracks in there?</para> +</question> + +<answer> +<para>Simple. Use the File Browser on the left side to navigate to the desired directory. Then drag the files into the Playlist part on the right.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Where is the"Home" tab?</para> +</question> + +<answer> +<para>To avoid interface-clutter "Home" tab has been transformed into "Statistics" tool, available under <menuchoice><guimenu>Tools</guimenu><guimenuitem>Statistics</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Is there a way to set up amount of information that "Context" borwser shows?</para> +</question> + +<answer> +<para>Yes, use the right mouse button menu anywhere on "Context" browser to modify it.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Why are the stars and numbers in the "Context" browser are out of sync?</para> +</question> + +<answer> +<para>The meaning of those symbols has changed in Amarok 1.4 "Fast Forward": stars represents the user-defined rating, while numbers shows calculated score.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Clicking on stars in "Context" browser does not work! How do I rate a song?</para> +</question> + +<answer> +<para>To rate a track you need a "Rating" column in playlist. Click with the &RMB; on playlist title, and choose <menuchoice><guimenu>Add Column</guimenu><guimenuitem>Rating</guimenuitem></menuchoice>. Click anywhere inside "Rating" column to set up rating for a track. You can also use shortcuts [Win]+[1-5] to quickly rate a song, with Amarok running in the background.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I remove tracks from the Playlist?</para> +</question> + +<answer> +<para>Select the files you want to remove, and press Del key on your keyboard. Or right-click the selection and choose Remove Selected from pop up menu.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How can I load a playlist?</para> +</question> + +<answer> +<para>Just drag and drop the playlist file into the Playlist, like you would do with any other file. It's that simple! </para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How can I save the current playlist?</para> +</question> + +<answer> +<para>The Save playlist button is next to Add Media button in the Playlist Toolbar. Just click it!</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>There are no visualizations in the visualizations dialog.</para> +</question> + +<answer> +<para>You probably don't have xmms-config installed, reconfigure and build after installing the appropriate xmms-devel package. You also may want to install the latest version of <ulink url="http://libvisual.sourceforge.net/v2/">libvisual</ulink>, which has some ultra fancy visualizations.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Where's the equalizer?</para> +</question> + +<answer> +<para>The Equalizer Window can be found in the right mouse button menu. You can also find it in the Menubar by selecting <menuchoice><guimenu>Tools</guimenu> <guimenuitem>Equalizer</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq6"> +<title>Playback</title> + +<qandaset id="playback-faq"> + + +<qandaentry> +<question> +<para>What media types does &amarok; support?</para> +</question> + +<answer> +<para>None. Yes, that's right! None! We have a backend independent approach, so the question you should be asking is "What media types does GStreamer/xine/aRts/NMM/MAS/KDEmm support?" So as you can guess we pretty much support absolutely every audio format you can think of. GStreamer can even decode text and PNG! </para> +<para>For more information, have a look at <ulink url="http://amarok.kde.org/amarokwiki/index.php/Audio_Engine_Comparison">Audio Engine Comparison</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Why can't &amarok; play MP3s?</para> +</question> + +<answer> +<para>It can! Chances are you're using Fedora/RedHat linux, they don't ship with MP3 decoders by default (due to patenting issues). Solution: +Alt-F2, gg:redhat mp3 kde, ENTER</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>&amarok; won't play MP3's under SUSE Linux 9.3, what could I do?</para> +</question> + +<answer> +<para>Open the "YaST Online Update" and install the 'Multimedia Option Pack 1' patch. Voila, &amarok; plays MP3's.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>With GStreamer-engine I'm getting 100% CPU usage while playing. How can I fix it?</para> +</question> + +<answer> +<para>When using GStreamer-engine with alsasink, &amarok; requires the device to provide a mixer. Mixing allows multiple applications to access the device at the same time, and output sound simultaneously. This can either be achieved by using a soundcard with hardware-mixing (e.g. SBLive), or by using the "dmix" plugin for alsa, which provides software-mixing. See <ulink url="http://amarok.kde.org/amarokwiki/index.php/Setting_up_Dmix_for_ALSA">Setting up Dmix for ALSA</ulink>. </para> +<para>After installation you need to specify "dmix" as the sound device in the engine settings dialog.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I can't get any media to play in &amarok;, why not?</para> +</question> + +<answer> +<para>You need to test the sound frameworks at the commandline: </para> +<para> +<command>artsplay foobar.mp3</command> +<command>gst-launch filesrc location=/home/foo/bar.mp3 ! spider ! audioscale ! audioconvert ! alsasink</command> +<command>xine-check</command> +</para> +<para>The output from these commands should help you identify the problems you are having and how to fix them. Please note you may need to use a different sink to test GStreamer (eg. osssink).</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Can &amarok; output directly to OSS/ALSA?</para> +</question> + +<answer> +<para>We already do! Don't forget that the media must be decoded first! You can't just pipe an MP3 to ALSA, all you will get is white-noise. GStreamer is the best choice for most people who want a low-overhead decoding solution, it reads the file, decodes it and pipes the PCM data to ALSA. Exactly like XMMS.</para> +</answer> +</qandaentry> + + + +<qandaentry> +<question> +<para>But! XMMS can output directly to ALSA!</para> +</question> + +<answer> +<para>But it decodes it first! GStreamer can output directly to ALSA too! So can xine!</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>The sound stutters, is there anything I can do to improve it?</para> +</question> + +<answer> +<para>You can either use the GStreamer engine (it's great!), or tweak aRts. Open Control Center <menuchoice><guimenu>Sound and Multimedia</guimenu> <guimenuitem>Sound System</guimenuitem></menuchoice>. Enable Run with highest possible priority, and increase the size of the Sound buffer: (warning, see the next FAQ!) You should also ensure that your artswrapper is suid:</para> +<para> +<command>su</command> +<command>chmod a+rsx /path/to/kde/bin/artswrapper</command> +<command>killall -9 artsd</command> +</para> +<para>With KDE 3.2.x there are issues with the KDEMultimedia codecs that can cause distorted playback, please see <ulink url="http://bugs.kde.org/show_bug.cgi?id=80497">this bug report</ulink>. +Also, increasing the size of the sound buffer in your .asoundrc alsa configuration file can help a great deal.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>The CPU usage is high, is there anything I can do to improve it?</para> +</question> + +<answer> +<para>Either don't use the aRts-engine, use the GStreamer or xine engines, or address the high CPU usage by installing KDEMultimedia in its entirety to get the faster aRts codecs (eg. libarts_mpeglib.so, etc.)</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>The &amarok; analyzers are really unresponsive!</para> +</question> + +<answer> +<para>You are probably using the aRts-engine, either use another engine (the xine-engine has been seriously tweaked to give perfect analyzer-sync), or reduce the size of your aRts buffer in kcontrol, sound system. The lower the buffer the more responsive the visuals. Yes this is a bug, please help us fix it!</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I have GStreamer installed but when I try to change to the GStreamer engine &amarok; crashes, what gives?</para> +</question> + +<answer> +<para>After installing GStreamer you have register it's components, running `gst-register` (sometimes suffixed with a version, so gst-register-0.8) should take care of registering your GStreamer components.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I ran gst-register but I still have have GStreamer troubles, what can I do?</para> +</question> + +<answer> +<para>You can try the <ulink url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/faq/html/chapter-using.html">GStreamer FAQ</ulink>. If all else fails you can try the knowledgeable people at the <ulink url="irc://irc.freenode.net/gstreamer">#gstreamer IRC channel</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>&amarok; says that the GStreamer engine cannot play MP3 files, although I have compiled/installed the mad plugin!</para> +</question> + +<answer> +<para>Try this (make sure that &amarok; does not run): + - <ulink url="http://gstreamer.freedesktop.org/src/gst-ffmpeg/">Download</ulink>, compile and install the ffmpeg package + - Run gst-register (you may need to run it twice, as root and as your "normal" user) + - Go to your GStreamer plugin directory (you can find it with gst-config / gstreamer-config) + - Delete the ffmpeg files (or move them somewhere else) + - Run gst-register again + - Start &amarok; </para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq7"> +<title>Development</title> + +<qandaset id="development-faq"> + + +<qandaentry> +<question> +<para>How do I get a cvs/svn version of &amarok;?</para> +</question> + +<answer> +<para><ulink url="http://amarok.kde.org/amarokwiki/index.php/Installation_HowTo#Building_SVN_Amarok">How to obtain and build SVN &amarok;</ulink></para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I've found a bug / I've got a great idea for &amarok;!</para> +</question> + +<answer> +<para>Please report it at <ulink url="http://bugs.kde.org/">bugs.kde.org</ulink>, if you have a list of suggestions/wishes it may be best to send them to our mailing list: <email>amarok-devel@lists.sourceforge.net</email> </para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Do you accept patches?</para> +</question> + +<answer> +<para>Happily! Your best course of action is to let us know what you plan to do before you do any work so we can discuss it, but don't fret we haven't turned down a patch yet! Discussion is mostly to help you patch the correct bits of &amarok;. Then either submit a patch to the mailing list, or commit if you have svn access. However, please let us know before you commit new features to svn! If you have a bug fix then just go ahead, this is open source after all :)</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Why did you choose the name &amarok;?</para> +</question> + +<answer> +<para>&amarok; is an album by British composer Mike Oldfield. I happen to like it a lot, and I think the name's got a nice sound. Plus, of course, it contains the all important “K”.. :) </para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Is it &amarok;, AmaroK or Amarok?</para> +</question> + +<answer> +<para>It is &amarok;! Yes, we understand this is unconventional ;-)</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq8"> +<title>Tips and Tricks</title> + +<qandaset id="tipsandtricks-faq"> + + +<qandaentry> +<question> +<para>How do I use &amarok; as an alarm clock?</para> +</question> + +<answer> +<para>Actually, thanks to the magic of DCOP you already can :) Simply set an alarm in your favorite calendar program and tell it to run the following command: +<command>dcop amarok player play</command> +</para> +<para>This command will tell &amarok; to start playing. Make sure that &amarok; is running before you go to bed, and you should wake up to the merry tune of whatever you pressed stop on before going to bed.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I get what &amarok; is playing right now, when I'm on another computer?</para> +</question> + +<answer> +<para>If you have a properly set up ssh environment, you can use that to get the information. The following command will return the Now Playing string. +<command>ssh -i ~/.ssh/id_rsa yourip dcop --user yourusername amarok player nowPlaying</command> +</para> +<para>Make sure that you replace yourip with your IP and yourusername with your username. Also note that this expects your identification to be found in the ~/.ssh/id_rsa file.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>What kind of tricks can the Player Window do?</para> +</question> + +<answer> +<para>The &amarok; player analyzers can be detached from the Player Window. By pressing d on your keyboard the active analyzer will open in an independent, re-sizeable window.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>What kind of tricks can the Playlist Window do?</para> +</question> + +<answer> +<para>Holding Control and clicking the right mouse button enqueues files in the order in which you clicked them. +Pressing Enter after making a playlist search will play the first search item and will clear the search.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I see the Player Window and Playlist Window have neat tricks, what about the tray icon?</para> +</question> + +<answer> +<para>Hovering your mouse on the icon will display a nice popup with current track information. +Clicking the middle mouse button on the icon play-pauses the current track. +Scrolling the mouse wheel changes volume. +Holding Shift while scrolling the mouse wheel seeks through the current track. +Holding Control while scrolling the mouse wheel will skip through tracks in the playlist. +Dragging and dropping items into the tray icon opens a pop up menu allowing you to choose from three options, Append to Playlist, Append and Play, and Queue after Current Track. +Tray icon is also a song position indicator.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Where do I find the settings for &amarok;?</para> +</question> + +<answer> +<para>~/.trinity/share/apps/amarok +~/.trinity/share/config/amarokrc</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I disable a browser section in &amarok;?</para> +</question> + +<answer> +<para>Clicking with the &RMB; on any browser title shows up a list of visible browsers. You can use this list to disable/re-enable any browsers available.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq9"> +<title>General Questions</title> + +<qandaset id="general-questions-faq"> + + +<qandaentry> +<question> +<para>How Do I use an external MySQL database with &amarok;?</para> +</question> + +<answer> +<para>See <ulink url="http://amarok.kde.org/amarokwiki/index.php/MySQL_HowTo">MySQL HowTo</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>My $HOME is located on NFS. After startup, &amarok; fails to build the Collection, printing many database errors to the console. What to do?</para> +</question> + +<answer> +<para>The internal SQLite database which &amarok; uses by default does not work on NFS. You must either link your ~/.trinity/share/apps/amarok directory to a local drive, or use the MySQL support.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How can I rip/encode Audio-CDs with &amarok;?</para> +</question> + +<answer> +<para>Insert your CD, then click on "Play Audio CD" in the menu. The File-Browser will come up and show a tree with several folders. For normal ripping, go to the "wav" folder, select some tracks and drag them to the desired destination in a Konqueror window. For automatic encoding, drag files from the "mp3" or "ogg" folder instead.</para> +<note><para>CD-ripping requires the "AudioCD TDEIO-slave" to be installed. It is part of KDE-Multimedia.</para></note> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How are track ratings determined?</para> +</question> + +<answer> +<para>&amarok; assigns a rating (a number 1-100) to a song based on how many times you've listened to it and whether you skip the song without it finishing. Every time the song finishes playing, the rating is changed. The code for changing the rating is in collectiondb.cpp. As of version 1.2.2, it was on line 1181, though you can find it by searching for "CollectionDB::addSongPercentage". +When defining a score for a track which has never been played before, &amarok; uses the calculation +score = ( ( 50 + percentage ) / 2 )</para> +<para>This sets the score equal to a number from 25-75, depending on how far through the song was allowed to play. For example, if the user stops or skips the song after only 25% of it has played, the score will be set to (50+25)/2, or 37.5. Scores are displayed as integers, however, so this number is rounded to the nearest integer before being displayed. The score is kept internally as a floating point number however, since after a song has been played several times, it may be impossible to alter the score by more than a point with a single play (see below). +When defining a score for a track which has been played before, the calculation is a bit more complicated. In the source, it is + score = ( ( values[2].toDouble() * values.first().toInt() ) + percentage ) / ( values.first().toInt() + 1 );</para> +<para>Substituting in the values from this line:</para> +<programlisting> + QStringList values = query( QString( + "SELECT playcounter, createdate, percentage FROM statistics " + "WHERE url = '%1';" ) + .arg( escapeString( url ) ) ); +</programlisting> +<para>We have + score = ( ( statistics_percentage.toDouble() * PlayCounter.toInt() ) + percentage ) / ( PlayCounter.toInt() + 1 ); +</para> +<para>Basically, this adjusts the previous score (statistics_percentage) by a decreasing amount depending on how many times the track has been played. The more times the track has been played, the less of an impact each play has on the score.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I manually change a track's rating?</para> +</question> + +<answer> +<para>You may change the rating manually by right-clicking on the playlist columns titles (the ones that say title, artist, album etc) and select Score. You can then change the score like any other song attribute, by right clicking it and selecting "Edit Tag 'Score'" or pressing F2. You can also edit the score in the Tag dialog, available by right clicking on a track.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Why isn't &amarok; part of KDEmultimedia?</para> +</question> + +<answer> +<para>The developers don't want the man telling them when they can release. (Meaning, packages in KDE proper have a release schedule that doesn't fit with &amarok;'s fast-paced development).</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I prevent the &amarok; icon from blinking in my system tray?</para> +</question> + +<answer> +<para>This is a new feature that has been added that some users might find distracting. Simply uncheck the "Flash icon tray when playing" option under General Options.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How can I show/remove the analyzer in the playlist window?</para> +</question> + +<answer> +<para>The playlist analyzer is part of the playlist toolbar. Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars</guimenuitem></menuchoice> +Add/Remove Analyzer to the Current actions +Press OK +</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I change the Context Browser theme?</para> +</question> + +<answer> +<para>Download a <ulink url="http://amarok.kde.org/amarokwiki/index.php/Themes">theme</ulink> or make your <ulink url="http://amarok.kde.org/amarokwiki/index.php/CSS_Styles">own</ulink>. Install it through <menuchoice><guimenu>Configure &amarok;... </guimenu><guisubmenu>Appearance</guisubmenu><guimenuitem>Context Browser Style</guimenuitem></menuchoice>, click Install New Style.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>What legal issues caused "Blue Wolf" icon replacement?</para> +</question> + +<answer> +<para>The icon was way too similar to the Warp Graphics, Inc. logo (elfquest.com), so it had to be removed to avoid problems.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I don't have any visualizations. Where can I obtain these ?</para> +</question> + +<answer> +<para>Install the latest version of <ulink url="http://libvisual.sf.net">libvisual</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How can I add my favorite streams to &amarok;?</para> +</question> + +<answer> +<para>First of all, load the stream into the playlist. There are several ways to do this. You can simply click on a Stream-Playlist URL in Konqueror; &amarok; will then automatically open the stream. E.g. on <ulink url="http://www.shoutcast.com">shoutcast.com</ulink>, click on the "Tune In" button. Or you can use the "Add Media" function to load a stream.Once the stream is loaded, you can save it by right-clicking on "Current Playlist" in the Playlist-Browser, then select "Save", and give it a meaningful name. The Stream will then be added to the Playlist-Browser view for later reference.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq10"> +<title>Konqueror Sidebar</title> + +<qandaset id="konq-sidebar-faq"> + + +<qandaentry> +<question> +<para>What is Konqueror Sidebar?</para> +</question> + +<answer> +<para>Konqueror sidebar allows you to monitor/control &amarok; while browsing with Konqueror. To see it, run Konqueror, press F9 to see sidebar, click on preferences (top one) button, in dropdown menu choose <menuchoice><guimenu>Add</guimenu> <guimenuitem>&amarok; Konqueror Sidebar</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq11"> +<title>Audioscrobbler</title> + +<qandaset id="audioscrobbler-faq"> + + +<qandaentry> +<question> +<para>What is Audioscrobbler?</para> +</question> + +<answer> +<para>Audioscrobbler is a free service that is sends information regarding which songs are played to an independent server. The service signup is free and only requires that you pick a user name and password that is not already in use. Audioscrobbler is currently utilized in &amarok;.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I do not want &amarok; to send information to Audioscrobbler!</para> +</question> + +<answer> +<para>Uncheck "Submit tracks I play" to prevent querying Audioscrobbler for suggested tracks.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>How do I get to the Audioscrobbler &amarok; group?</para> +</question> + +<answer> +<para>The Audioscrobbler &amarok; group is located here: <ulink url="http://www.audioscrobbler.com/group/Amarok+users/">&amarok; Audioscrobbler Group</ulink></para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq12"> +<title>General Engine/Playback Questions</title> + +<qandaset id="general-engine-faq"> + + +<qandaentry> +<question> +<para>Which sound engine should I use?</para> +</question> + +<answer> +<para>Please refer to the <ulink url="http://amarok.kde.org/amarokwiki/index.php/Audio_Engine_Comparison">Audio Engine Comparison</ulink>.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>What version of ALSA should I use?</para> +</question> + +<answer> +<para>If you output to ALSA, you should use the newest available version of ALSA possible! Old versions of ALSA have caused plenty of crashes, and have caused plenty of wrongly attributed crash-reports.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I've installed GStreamer/xine/etc., but the relevant audio-engine won't show up. What gives?</para> +</question> + +<answer> +<para>&amarok; was probably compiled before you had xine and/or gstreamer installed, so the ./configure routine did not include them in the list of engines to be built. You will have to rebuild &amarok;.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>But I did rebuild &amarok; after installing gstreamer and/or xine, but the engine still does not show up. What happened?</para> +</question> + +<answer> +<para>You most likely are using a distro that packages development libraries separately from the main library, so even though gstreamer is installed, &amarok; cannot link to it because gstreamer-devel is not installed. The same issue exists for xine, you must install xine-devel if your distro splits packages in this fashion. Don't forget to rebuild &amarok; after installing the devel packages.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq13"> +<title>GStreamer engine</title> + +<qandaset id="gstreamer-faq"> + + +<qandaentry> +<question> +<para>Why is there always a gap although I have crossfading enabled?</para> +</question> + +<answer> +<para>Make sure you don't have gst-ffmpeg installed. Instead, install the gst-mad plugin. </para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I'm getting this error: "GStreamer-CRITICAL **: Factory for `adder' has no type.". How to fix?</para> +</question> + +<answer> +<para>Your GStreamer was built with Prelinking, which is not compatible with GStreamer. You must rebuild it without this option. +merlin-tc advises: <quote>In addition, don't use any ldflags when building GStreamer.</quote></para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>You receive an error "There is no element present to handle the file's mimetype audia/mp4" even though you have the correct gstreamer-faad plugin is installed.</para> +</question> + +<answer> +<para>To correctly play mp4 or m4a files with gstreamer, you must also have gstreamer-quicktime in addition to gstreamer-faad installed.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>You receive an error "There is no element present to handle the stream's mimetype audio/mpeg"</para> +</question> + +<answer> +<para>You are trying to play an mp3 stream without the gstreamer-mad plugin installed. Install the gstreamer-mad plugin and run "gst-register" as root before restarting &amarok;.</para> +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>I have a second soundcard and I'm using ALSA. How do I make Amarok use it instead of the default?</para> +</question> + +<answer> +<para>In <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Amarok</guisubmenu><guimenuitem>Engine</guimenuitem></menuchoice>, check the 'Device' checkbox and fill in the device. Typical this is 'hw:0' for the default soundcard, and 'hw:1' for the second soundcard.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq14"> +<title>xine engine</title> + +<qandaset id="xine-faq"> + + +<qandaentry> +<question> +<para>How can I change where the audio is output to?</para> +</question> + +<answer> +<para>If you are using ALSA, you can output to a specific device with xine. Set up an ~/.asoundrc (user only) or /etc/asound.conf (system wide) file that aliases your hardware devices, and then insert that alias in the "device used for stereo output:" box in the xine-engine configuration tab. Alternatively, you can directly enter the alsa device (hw:0,0 or hw:1,0 and so on). If you choose this latter (alternate) method, be aware that ALSA's corresponding plugfoo (e.g. plughw:0,0 or plughw:1,0 and so on) routing through alsa-lib is much preferred.</para> +<para>Here is a sample ~/.asoundrc for a machine that has an onboard Intel AC97 codec and a usb-audio device:</para> +<programlisting> + pcm.intel8x0 { + type plug + slave.pcm "hw:0" + } + + ctl.intel8x0 { + type hw + card 0 + } + + pcm.usb-audio { + type plug + slave.pcm "hw:1" + } + + ctl.usb-audio { + type hw + card 1 + } +</programlisting> +<para>Now enter usb-audio in the xine-engine setup screen and output should go to the usb-audio device (with alsa-lib properly handling sample rate conversion, channels, and so on).</para> +<para> To use a dmixed virtual device, ensure that the "sound card can do mmap" checkbox is unchecked.</para> +</answer> +</qandaentry> + + +</qandaset> + +</sect1> + + +<sect1 id="faq15"> +<title>aRts engine</title> + +<note><para>Sorry, aRts-engine has no maintainer, but feel free to fix it yourself! You could be the new aRts-engine maintainer we need so desperately!</para></note> + +</sect1> + + +</chapter> diff --git a/doc/en/file_browser.png b/doc/en/file_browser.png Binary files differnew file mode 100644 index 00000000..0efc4bdf --- /dev/null +++ b/doc/en/file_browser.png diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 00000000..b94fd6a0 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,392 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY amarok "Amarok"> + <!ENTITY amarok-quick SYSTEM "quick.docbook"> + <!ENTITY amarok-config SYSTEM "config.docbook"> + <!ENTITY amarok-using SYSTEM "using.docbook"> + <!ENTITY amarok-advanced SYSTEM "advanced.docbook"> + <!ENTITY amarok-req SYSTEM "requirements.docbook"> + <!ENTITY amarok-faq SYSTEM "faq.docbook"> + <!--<!ENTITY amarok-tech SYSTEM "technology.docbook">--> + <!ENTITY kappname "&amarok;"> + <!ENTITY package "extragear"> + <!ENTITY RMB "right mouse button"> + <!ENTITY k3b "K3b"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> + +<title>The &amarok; Handbook</title> + +<authorgroup> + <author> + <firstname>Mike</firstname> + <surname>Diehl</surname> + <affiliation> + <address><email>madpenguin8@yahoo.com</email></address> + </affiliation> +</author> + +<othercredit role="developer" > + <firstname>The Amarok Development Squad</firstname> + <contrib> Developers</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> + <year>2005</year> + <holder>The Amarok Development Squad</holder> +</copyright> + +<copyright> + <year>2006</year> + <holder>The doKymotion Krew</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-02-20</date> <!-- CHANGE ME --> +<releaseinfo>2.1</releaseinfo> + +<abstract> + <para>&amarok; is a media player for the Trinity Desktop Environment.</para> +</abstract> + +<keywordset> + <keyword>TDE</keyword> + <keyword>multimedia</keyword> + <keyword>player</keyword> + <keyword>audio</keyword> + <keyword>ogg</keyword> + <keyword>mp3</keyword> + <keyword>wav</keyword> + <keyword>music</keyword> + <keyword>sound</keyword> + <keyword>script</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> <!--Merge with technology.docbook--> +<title>Introduction</title> + +<screenshot> + <screeninfo>Logo</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="logo.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>&amarok; is an audio player for &kde; that is extremely powerful, yet surprisingly simple to use. </para> + +<para>With &amarok; you can simply drag and drop music into the playlist instead of searching through endless menus. Just looking for that one song in a huge collection? &amarok;'s collection browser with its quick-search bar will help you find it in a matter of seconds.</para> + +<para>It may seem that &amarok; has the same old features found in the average audio player, but we did not stop there. One look at the context browser and you will see why &amarok; is one step ahead of the rest. The context browser shows all kinds of information related to your currently playing track - from the album cover, through to other music by the same artist, as well as related artists - an informative and fun way to learn about your collection!</para> + +<para>Do you already have many different playlists but can never decide on which one you want to use? Then the playlist browser is just for you. Never know what to listen to? Amarok's Dynamic Mode will choose your music for you, and Smart Playlists allow you to jump right in to specific parts of your collection.</para> + +<para>Amarok has outstanding support for Apple's iPod, iRiver's ifp and a multitude of generic USB devices. It also features many different audio backends allowing YOU to choose how you listen to your music. These and other features make it the most advanced audio player available. &amarok; is smart, sexy and clever. We hope that its use will truly allow you to "Rediscover your music!"</para> + +</chapter> + +<!--&amarok-tech;--> + +&amarok-quick; + +&amarok-config; + +&amarok-using; + +&amarok-advanced; + +&amarok-faq; + +<chapter id="credits"> +<title>Credits and License</title> + +<para>Program copyright 2003-2005 Mark Kretschmann <email>markey@web.de</email> +and The AmaroK Team.</para> + +<itemizedlist> +<title>The AmaroK Team</title> +<listitem><para>Christian <quote>babe-magnet</quote> Muehlhaeuser <email>chris@chris.de</email></para></listitem> +<listitem><para>Frederik <quote>ich bin kein Deustcher!</quote> Holljen <email>fh@ez.no</email></para></listitem> +<listitem><para>Mark <quote>it's good, but it's not irssi</quote> Kretschmann <email>markey@web.de</email></para></listitem> +<listitem><para>Max <quote>Turtle-Power</quote> Howell <email>max.howell@methylblue.com</email></para></listitem> +<listitem><para>Mike <quote>purple is not girly!</quote> Diehl <email>madpenguin8@yahoo.com</email></para></listitem> +<listitem><para>Pierpaolo <quote>Spaghetti Coder</quote> Di Panfilo<email>pippo_dp@libero.it</email></para> +</listitem> +<listitem><para>Roman <quote>and God said, let there be Mac</quote> Becker <email>roman@formmorf.de</email></para></listitem> +<listitem><para>Seb <quote>Surfin' down under</quote> Ruiz <email>me@sebruiz.net</email></para></listitem> +<listitem><para>Stanislav <quote>did someone say DCOP?</quote> Karchebny <email>Stanislav.Karchebny@kdemail.net</email></para></listitem> +</itemizedlist> + +<itemizedlist> +<title>Contributors:</title> + +<listitem> +<para>Adam Pigg (analyzers, patches) <email>adam@piggz.fsnet.co.uk</email></para> +</listitem> + +<listitem> +<para>Adeodato Simo (patches) <email>asp16@alu.ua.es</email></para> +</listitem> + +<listitem> +<para>Alexandre Oliveira (improvements, bugfixes) <email>aleprj@gmail.com</email></para> +</listitem> + +<listitem> +<para>Andreas Mair (MySql Support) <email>am_ml@linogate.com</email></para> +</listitem> + +<listitem> +<para>Andrew de Quincey (Postgresql support) <email>adq_dvb@lidskialf.net</email></para> +</listitem> + +<listitem> +<para>Christie Harris (roKymoter) <email>dangle.baby@gmail.com</email></para> +</listitem> + +<listitem> +<para>Dan Leinir Turthra Jensen (first run wizard) <email>admin@removeleinir.dk</email></para> +</listitem> + +<listitem> +<para>Dan Meltzer (roKymoter) <email>hydrogen@notyetimplemented.com</email></para> +</listitem> + +<listitem> +<para>Enrico Ros (analyzers, king of openGL) <email>eros.kde@email.it</email></para> +</listitem> + +<listitem> +<para>Florian 'da-flow' Egerer (Amarok application icon 'Blue Wolf) <email>flo_for_never@gmx.at</email></para> +</listitem> + +<listitem> +<para>Gérard Dürrmeyer (icons and image work) <email>gerard@randomtree.com</email></para> +</listitem> + +<listitem> +<para>Greg Meyer (Fabulous help with our pre 1.2 bug-avalanche) <email>greg@gkmweb.com</email></para> +</listitem> + +<listitem> +<para>Harald Sitter (roKymoter, translations, bug fixes, screenshots) <email>harald.sitter@kdemail.net</email></para> +</listitem> + +<listitem> +<para>Ian Monroe (patches, Ruby script template (eean) )<email>ian@monroe.nu</email></para> +</listitem> + +<listitem> +<para>Jarkko Lehti (tester) <email>grue@iki.fi</email></para> +</listitem> + +<listitem> +<para>Jocke Andersson (roKymoter) <email>ajocke@gmail.com</email></para> +</listitem> + +<listitem> +<para>Kenneth Wesley Wimer II (icons) <email>kwwii@bootsplash.org</email></para> +</listitem> + +<listitem> +<para>Kenny Lemieux (Amarok webmaster) <email>swaft@pwsp.net</email></para> +</listitem> + +<listitem> +<para>Melchior Franz (new FFT routine, bugfixes) <email>mfranz@kde.org</email></para> +</listitem> + +<listitem> +<para>Michael Pyne (K3B export code) <email>michael.pyne@kdemail.net</email></para> +</listitem> + +<listitem> +<para>Nenad Grujicic (splash screen for 1.1) <email>mchitman@neobee.net</email></para> +</listitem> + +<listitem> +<para>Olivier Bédard (website hosting) <email>paleo@pwsp.net</email></para> +</listitem> + +<listitem> +<para>Reigo Reinmets (Wikipedia support, patches) <email>xatax@hot.ee</email></para> +</listitem> + +<listitem> +<para>Roland Gigler (MAS engine) <email>michael.pyne@kdemail.net</email></para> +</listitem> + +<listitem> +<para>Sami Nieminen (Audioscrobbler support) <email>sami.nieminen@iki.fi</email></para> +</listitem> + +<listitem> +<para>Scott Wheeler (TagLib) <email>wheeler@kde.org</email></para> +</listitem> + +<listitem> +<para>Stefan Bogner (Loadsa stuff) <email>bochi@online.ms</email></para> +</listitem> + +<listitem> +<para>Stefan Siegel (patches, bugfixes) <email>kde@sdas.de</email></para> +</listitem> + +<listitem> +<para>Sven Krohlas (roKymoter) <email>sven@asbest-online.de</email></para> +</listitem> + +<listitem> +<para>Whitehawk Stormchaser (tester, patches) <email>zerokode@gmx.net</email></para> +</listitem> + +</itemizedlist> + +<para>Documentation copyright 2005 Mike Diehl <email>madpenguin8@yahoo.com</email></para> + +&underFDL; <!-- FDL: do not remove --> + +&underGPL; <!-- GPL License --> + +</chapter> + +&amarok-req; + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kapp"> +<title>How to obtain &amarok;</title> + +<para>&amarok; can be downloaded from <ulink +url="http://amarok.kde.org">The &amarok; home page</ulink></para> + + +<para>The latest development version can be obtained from &kde; SVN, module +/trunk/extragear/multimedia/amarok/.</para> + +<sect2> +<title>How to compile &amarok;</title> + +<para>In order to compile and install Amarok on your system, type the following in the +base directory of the Amarok distribution:</para> + +<para> +<command>./configure --prefix=`tde-config --prefix`</command> +<command>make</command> +<command>su -c "make install"</command> +</para> + +<note><para>The --enable-final configure flag is no longer supported.</para></note> + +<para>Since &amarok; uses <keycap>autoconf</keycap> and <keycap>automake</keycap> you should have no trouble compiling it. Should you run into problems please report them to the &kde; mailing lists.</para> + +</sect2> + +<sect2> +<title>Configure Options</title> + +<para>&amarok; is like most other apps in that it has several compile time options that can be enabled or disabled during configure. This is a list of the options that can be configured.</para> + +<note><para>Some compile time options require specific dependencies to be used. See <link linkend="requirements">the requirements section</link> for more details.</para></note> + +<informaltable> +<tgroup cols="3"> +<thead> + +<row> +<entry>Option</entry> +<entry>Default</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> + +<row> +<entry>--enable-debug=</entry> +<entry>no</entry> +<entry>Enables debug symbols. Choose from <quote>yes</quote>, <quote>no</quote>, and <quote>full</quote>. Please use the <quote>full</quote> option if you intend to help with &amarok; development.</entry> +</row> + +<row> +<entry>--enable-mysql</entry> +<entry>Disabled</entry> +<entry>Enables MySql database support for &amarok;</entry> +</row> + +<row> +<entry>--disable-amazon</entry> +<entry>Enabled</entry> +<entry>Disables Amazon cover art downloading support in &amarok;</entry> +</row> + +<row> +<entry>--without-arts</entry> +<entry>With</entry> +<entry>Disables aRts support for &amarok;</entry> +</row> + +<row> +<entry>--without-gstreamer</entry> +<entry>With</entry> +<entry>Disables GStreamer support for &amarok;</entry> +</row> + +<row> +<entry>--with-helix</entry> +<entry>With</entry> +<entry>Enables Helix engine support for &amarok;</entry> +</row> + +<row> +<entry>--without-xine</entry> +<entry>With</entry> +<entry>Disables xine support for &amarok;</entry> +</row> + +<row> +<entry>--with-nmm</entry> +<entry>Without</entry> +<entry>Enables NMM support for &amarok;</entry> +</row> + +<row> +<entry>--with-mas</entry> +<entry>Without</entry> +<entry>Enables MAS support for &amarok;</entry> +</row> + +<row> +<entry>--without-opengl</entry> +<entry>With</entry> +<entry>Disables OpenGL (analyzer) support for &amarok;</entry> +</row> + +<row> +<entry>--without-included-sqlite</entry> +<entry>With</entry> +<entry>Do not use the included sqlite sources (requires sqlite to be installed)</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +</sect2> + +</sect1> + +</appendix> + +&documentation.index; + +</book> diff --git a/doc/en/logo.png b/doc/en/logo.png Binary files differnew file mode 100644 index 00000000..be5465c5 --- /dev/null +++ b/doc/en/logo.png diff --git a/doc/en/media_device.png b/doc/en/media_device.png Binary files differnew file mode 100644 index 00000000..8f7f6ec0 --- /dev/null +++ b/doc/en/media_device.png diff --git a/doc/en/menubar.png b/doc/en/menubar.png Binary files differnew file mode 100644 index 00000000..8d1b7f86 --- /dev/null +++ b/doc/en/menubar.png diff --git a/doc/en/musicbrainz.png b/doc/en/musicbrainz.png Binary files differnew file mode 100644 index 00000000..a87e056a --- /dev/null +++ b/doc/en/musicbrainz.png diff --git a/doc/en/pl_tip1.png b/doc/en/pl_tip1.png Binary files differnew file mode 100644 index 00000000..738dda56 --- /dev/null +++ b/doc/en/pl_tip1.png diff --git a/doc/en/play_list.png b/doc/en/play_list.png Binary files differnew file mode 100644 index 00000000..58df3172 --- /dev/null +++ b/doc/en/play_list.png diff --git a/doc/en/player_window.png b/doc/en/player_window.png Binary files differnew file mode 100644 index 00000000..69053b46 --- /dev/null +++ b/doc/en/player_window.png diff --git a/doc/en/playlist_browser.png b/doc/en/playlist_browser.png Binary files differnew file mode 100644 index 00000000..282a9fc0 --- /dev/null +++ b/doc/en/playlist_browser.png diff --git a/doc/en/playlist_window.png b/doc/en/playlist_window.png Binary files differnew file mode 100644 index 00000000..0a5aac81 --- /dev/null +++ b/doc/en/playlist_window.png diff --git a/doc/en/queue_manager.png b/doc/en/queue_manager.png Binary files differnew file mode 100644 index 00000000..762ba8d2 --- /dev/null +++ b/doc/en/queue_manager.png diff --git a/doc/en/quick.docbook b/doc/en/quick.docbook new file mode 100644 index 00000000..f47059a3 --- /dev/null +++ b/doc/en/quick.docbook @@ -0,0 +1,85 @@ +<chapter id="quick-start"> +<title>&amarok; Quick Start Guide</title> + +<para>Listening to music should be easy. To this end we have provided a First-Run Wizard which presents itself the first time &amarok; is run. For those who wish to update their collection later on, or not use the wizard, this Quick Start Guide is for you. It will help you have &amarok; up and running in minutes.</para> + + +<sect1 id="collection-building"> +<title>Building a collection</title> + +<screenshot> + <screeninfo>Collection Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="collection.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>Building your collection is an essential step in using all of &amarok;'s features. From the Collection Browser, click the <guibutton>Configure Folders</guibutton> button located in the toolbar. Next you will choose which folders you would like to be in your collection from the <guilabel>Configure Collection</guilabel> dialog. Also from here you have the option to <guilabel>Scan folders recursively</guilabel>, <guilabel>Watch folders for changes</guilabel>, and <guilabel>Import playlists</guilabel> that are found in the collection folders. After selecting your folders, and checking any relevant check boxes, click the <guibutton>OK</guibutton> button. After the initial scan, your collection is built and you can move on to making a playlist.</para> + +</sect1> + + +<sect1 id="making-playlists"> +<title>Making a playlist</title> + +<screenshot> + <screeninfo>Playlist Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="play_list.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>Making a playlist is as simple as dragging items from the Collection Browser Tree View into the Playlist. To make searching for items easier, a text box is provided for filtering your collection. Just start typing in the text box, and the Tree View will change to show only the relevant results. After you are satisfied with your playlist, you can save it by clicking the <guibutton>Save Playlist As</guibutton> button found in the Playlist menu.</para> + +<screenshot> + <screeninfo>Playlist Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="playlist_browser.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>If you have your own playlists, you can add them in the Playlist Browser by clicking the <guibutton>Add</guibutton> button and choosing the <guibutton>Playlist...</guibutton> option in the toolbar. If your collection folders have your playlists in them, and you selected the Import Playlists in the collection setup, your playlists will already be in the Tree View. Right clicking a playlist in the Tree View will give you several options of how to load the playlist.</para> + +</sect1> + + +<sect1 id="streams"> +<title>Listening to streams</title> + +<para>Radio streams in &amarok; are played by adding them from the Playlist Broswer. &amarok; comes with a select set of streams for our listeners to enjoy, Cool Streams. Double-cliking or dragging an entry will load it into the playlist and once there it can be played. To add your own streams to the Playlist Browser click on the <guibutton>Add</guibutton> button in the toolbar and choose <guibutton>Radio Stream...</guibutton> from the dropdown box options. After adding your custom stream it can also be played after loading into the playlist.</para> + +</sect1> + + +<sect1 id="audiocd"> +<title>Playing an audio cd</title> + +<screenshot> + <screeninfo>Playlist Menubar Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="menubar.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + + +<para>To play an audio cd, select <menuchoice><guimenu>Actions</guimenu><guimenuitem>Play Audio CD</guimenuitem></menuchoice> in the Playlist Menubar. The File Browser will open showing several folders and also the cd tracks listed in the WAV format. Drag the WAV files into the playlist and click the <guibutton>Play</guibutton> button.</para> + +<note><para>The Play Audio CD feature uses the audiocd:/ protocol and is not compatible with all of the available engines.</para></note> + +</sect1> + +<sect1 id="cd-burning"> +<title>Burning an audio cd</title> + +<para>Burning an audio cd in &amarok; is easy thanks to the <ulink url="http://www.k3b.org">K3B</ulink> integration. To burn an album, first open the Collection Browser. Next, by expanding an artist's entry in the Tree View, right click the album you wish to burn. A pop-up menu will open, click <guilabel>Burn This Album</guilabel>, and a dialog will open prompting you to choose a mode for burning. From the dialog click the <guibutton>Audio Mode</guibutton> button, K3B will open ready to burn the album.</para> + +<note><para>Burning functionality is also provided in the Playlist. Simply right click an item in the Playlist and follow the <guilabel>Burn</guilabel> menu for multiple cd burning options.</para></note> + +</sect1> + + +</chapter>
\ No newline at end of file diff --git a/doc/en/requirements.docbook b/doc/en/requirements.docbook new file mode 100644 index 00000000..e8a85499 --- /dev/null +++ b/doc/en/requirements.docbook @@ -0,0 +1,40 @@ +<chapter id="requirements"> +<title>Requirements</title> + +<para>&amarok; requires the installation of some software packages. The required packages are listed below along with several other packages to enhance your &amarok; experience.</para> + + +<itemizedlist> +<title>Required:</title> +<listitem><para><ulink url="http://www.kde.org">KDELIBS 3.3</ulink></para></listitem> +<listitem><para><ulink url="http://freshmeat.net/projects/taglib">TagLib 1.4</ulink></para></listitem> +</itemizedlist> + +<itemizedlist> +<title>Recommended:</title> +<listitem><para><ulink url="http://gstreamer.net">GStreamer-0.8.6 and Gst-Plugins-0.8.6</ulink></para></listitem> +</itemizedlist> + +<itemizedlist> +<title>Optional:</title> +<listitem><para><ulink url="http://www.kde.org">aRts 1.3</ulink></para></listitem> +<listitem><para><ulink url="http://www.k3b.org">K3B 0.11</ulink></para></listitem> +<listitem><para><ulink url="http://www.kde.org">KDE-Base 3.3 (needed for Konqueror Sidebar)</ulink></para></listitem> +<listitem><para><ulink url="http://www.kde.org">KDEMULTIMEDIA 3.3</ulink></para></listitem> +<listitem><para><ulink url="http://www.musicbrainz.org/">libtunepimp 0.3</ulink></para></listitem> +<listitem><para><ulink url="http://libvisual.sf.net">Libvisual 0.2.0 and Libvisual plugins</ulink></para></listitem> +<listitem><para><ulink url="http://www.mediaapplicationserver.net">MAS 0.6.3</ulink></para></listitem> +<listitem><para><ulink url="http://www.mysql.com">MySQL 4</ulink></para></listitem> +<listitem><para><ulink url="http://www.networkmultimedia.org">NMM 0.7.0</ulink></para></listitem> +<listitem><para>OpenGL accelerated X-Server</para></listitem> +<listitem><para><ulink url="http://xmms-projectm.sourceforge.netm">ProjectM 0.96</ulink></para></listitem> +<listitem><para><ulink url="http://www.real.com">Real Player 10</ulink></para></listitem> +<listitem><para><ulink url="http://www.libsdl.org">SDL 1.2</ulink></para></listitem> +<listitem><para><ulink url="http://xine.sourceforge.net">xine 1.0.0</ulink></para></listitem> +<listitem><para><ulink url="http://xmms.org">XMMS 1.2 and XMMS visualization plugins</ulink></para></listitem> +</itemizedlist> + +<note><para>If you obtain these dependencies via a packaging system, you must +also install the devel versions of these packages!</para></note> + +</chapter> diff --git a/doc/en/rmb_menu.png b/doc/en/rmb_menu.png Binary files differnew file mode 100644 index 00000000..e32dd142 --- /dev/null +++ b/doc/en/rmb_menu.png diff --git a/doc/en/script_manager.png b/doc/en/script_manager.png Binary files differnew file mode 100644 index 00000000..28d94f4a --- /dev/null +++ b/doc/en/script_manager.png diff --git a/doc/en/status_bar.png b/doc/en/status_bar.png Binary files differnew file mode 100644 index 00000000..0a2ff065 --- /dev/null +++ b/doc/en/status_bar.png diff --git a/doc/en/tab_lyrics.png b/doc/en/tab_lyrics.png Binary files differnew file mode 100644 index 00000000..284414db --- /dev/null +++ b/doc/en/tab_lyrics.png diff --git a/doc/en/tab_music.png b/doc/en/tab_music.png Binary files differnew file mode 100644 index 00000000..e87e689a --- /dev/null +++ b/doc/en/tab_music.png diff --git a/doc/en/tab_wiki.png b/doc/en/tab_wiki.png Binary files differnew file mode 100644 index 00000000..60f00195 --- /dev/null +++ b/doc/en/tab_wiki.png diff --git a/doc/en/using.docbook b/doc/en/using.docbook new file mode 100644 index 00000000..03bb95cb --- /dev/null +++ b/doc/en/using.docbook @@ -0,0 +1,1270 @@ +<chapter id="using-kapp"> +<title>Using &amarok;</title> + +<para>&amarok; is a versatile audio player that offers many different ways of controlling your music collection. Like any ordinary audio player, &amarok; has a player window for controlling your most basic functions. &amarok; also has a playlist that is second to none. The playlist window has multiple browsers for creating and browsing your entire audio collection.</para> + +<para>In this chapter we will go over how to use all the features of &amarok; including creating a collection and a playlist.</para> + +<sect1 id="player-window"> +<title>The Player Window</title> + +<screenshot> + <screeninfo>Player Window Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="player_window.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + + +<para>The player window is your one click &amarok; control center. At the top of the player there is a scrolling display to show the currently playing track or stream. Just below the scrolling display there is an area to display the current track's play time, bit rate, and sample rate. Clicking this area will change the track time from total played to total time remaining.</para> + +<para>The player window also features a selection of audio analyzers also located under the scrolling display. You can cycle through the available analyzers by left clicking the analyzer area.</para> + +<anchor id="analyzer-tip"/> + +<tip> + +<screenshot> + <screeninfo>Analyzer Tip</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="analyzer.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The &amarok; player analyzers can be detached from the player window. By pressing <keycap>d</keycap> on your keyboard the active analyzer will open in an independent, re-sizeable window.</para> +</tip> + +<para>Also below the scrolling display are the <guibutton>PL</guibutton> and <guibutton>EQ</guibutton> buttons. The <guibutton>PL</guibutton> button is used to quickly enable or disable the playlist window, while the <guibutton>EQ</guibutton> button is used to enable and disable the equalizer if your engine is compatible.</para> + +<para>The remainder of the player includes the playback buttons and the volume and track position sliders. Use the sliders to choose a track postion or volume level that suits your needs. Use the playback buttons to control the playback of the current track, or to skip either forward or back through your tracks.</para> + +</sect1> + +<sect1 id="equalizer"> +<title>The Equalizer Window</title> + +<para>The built in equalizer is easy to use and works with all engines. There are 17 presets included, ranging from Classical to Techno, and you can easily create your own. </para> + +<para>To access the equalizer choose <menuchoice><guimenu>Tools</guimenu><guimenuitem>Equalizer</guimenuitem></menuchoice> from the main window or click the <guibutton>EQ</guibutton> button from the Player window. Once you check the <guibutton>Enable Equalizer</guibutton> check box in this window, the equalizer will be active.</para> + +<screenshot> + <screeninfo>Equalizer Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="equalizer.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>You can use the dialog's drop down box to select one of the built in presets. You can also adjust individual sliders here. Adjusting a slider will automatically cause a switch to the Manual preset so feel free to experiment with them until you find a desirable combination. When you are ready to save, click the <guiicon>Add new preset</guiicon> icon to the right of the drop down box. If you change to another preset without saving your changes they will be lost. In addition to saving you can also click the <guiicon>Manage presets</guiicon> icon, to the right of the drop down box, to delete or rename presets.</para> + +</sect1> + +<sect1 id="playlist-window"> +<title>The Playlist Window</title> + +<screenshot> + <screeninfo>Playlist Window Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="playlist_window.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The &amarok; playlist is the most advanced playlist available to any audio player for &kde;. The playlist offers many features that are not found in any other player. You should not be intimidated by the power of the playlist however, as it is still the easiest to use.</para> + +<para>The playlist window can be divided into two main sections, on the left is the sidebar. The sidebar is where you will find some of the excellent features of the playlist like the <link linkend="context-browser">Context Browser</link>. On the right side of the window is the playlist itself. The playlist is simple to use yet powerful enough for even the most advanced users.</para> +</sect1> + + +<sect1 id="playlist-browsers"> +<title>The Sidebar Browsers</title> + +<para>Browsers in &amarok; allow you to acess your music collection in several different ways. They are situated on the left side of the window, and each one is represented by a tab with its name written on it. Clicking on a tab brings the selected browser into view. If a browser is active clicking on its tab again will contract the browser. Only one browser is visible at any time, although you can drag tracks from one tab to another by hovering on the target tab for 1 second until that tab becomes visible. You can also hide browsers by simply right-clicking on any tab and (un)selecting the desired browser(s) in the provided context menu.</para> + +<screenshot> + <screeninfo>Browser Selection Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="browser_choice.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<sect2 id="context-browser"> +<title>Context Browser</title> + +<para>The Context Browser displays various information related to the currently playing track. Its appearance can be modified by using themes known as <link linkend="configure-appearance">Context Browser Styles</link>. It is organized into three tabs: <quote>Music</quote>, <quote>Lyrics</quote>, and <quote>Artist</quote>. These tabs, whose function will be more fully explained below, supply information on different aspects the track currently being listened to.</para> + +<note><para>Users of previous &amarok; versions will notice that there is no longer a <quote>Home</quote> tab. The information from this tab has been redistributed throughout the &amarok; interface. Analogous information can be found mainly in the Statistics dialog, accessible through <menuchoice><guimenu>Tools</guimenu><guimenuitem>Statistics</guimenuitem></menuchoice>.</para></note> + +<screenshot> + <screeninfo>Context Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="tab_music.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + + +<sect3 id="current-track-tab"> +<title>The Music Tab</title> + +<para>The <guilabel>Music</guilabel> tab offers information about the currently playing track, and it's artist and album.</para> + +<para>The first pane in this tab is for information about the track. The title of the pane lists the track name, artist name, and album. Inside the pane you will find it shows the album cover image for the track. Next to the image you will find a <ulink url="http://www.musicbrainz.org/">MusicBrainz</ulink> icon. <inlinemediaobject><imageobject><imagedata fileref="musicbrainz.png" format="PNG"/></imageobject></inlinemediaobject> Click this icon to do a MusicBrainz look-up for the track.</para> + +<para>Below the MusicBrainz icon there is more information about you current track. Here you will find the total number of times the track has been played, the track's current core, and when the track was first and last played.</para> + +<tip><para>To display album cover images in the Context Browser you must have the album cover image in the same directory as the track you are listening to. Supported file formats are .jpg, .jpeg, .gif, and .png. The images can be named anything, but images with the word <quote>front</quote> in the filename will be used with preference. The Context Browser will also use cover images saved from the album cover downloader, or images embedded in ID3v2 tags.</para></tip> + +<para>The next pane, <guilabel>Suggested Songs</guilabel>, lists multiple tracks for suggested listening. Click on any of the listed tracks to begin playback of the track.</para> + +<para>Below <guilabel>Suggested Songs</guilabel> is the <guilabel>Favorite Tracks By Artist</guilabel>. This pane lists the five highest rated tracks by the current track's artist.</para> +<!-- Insert wiki image --> +<tip><para>You can adjust the amount of information shown in the <guilabel>Music</guilabel> tab by right-clicking anywhere on Music tab and toggling items on the context menu.</para></tip> + +<para>The last pane, <guilabel>Albums By Artists</guilabel>, lists all of the albums by the current track's artists that are in your collection. Clicking on any of the albums in this pane will expand the album to show the album's content.</para> + +<tip><para>You can click on tracks in any of the panes to begin playback of the track. You can also right click albums and tracks for a pop-up menu to choose several ways to play or enqueue the track or album.</para></tip> + +</sect3> + + +<sect3 id="lyrics"> +<title>The Lyrics Tab</title> + +<para><guilabel>Lyrics</guilabel> tabs fetches lyrics for the currently played song from one of the supported websites. This feature is flexible, and it's possible to write scripts to fetch lyrics from different sites. See Chapter on Script-Writing. When you click on the Lyrics tab, &amarok; attempts to fetch lyrics for the current track. If there is no lyrics script running you will be given the opportunity to select one.</para> + +<screenshot> + <screeninfo>Lyrics Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="tab_lyrics.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<!-- TODO: Inset link to script writing or remove reference to it --> +<para>You can perform various actions on the lyrics tab, using its toolbar buttons.</para> + +<para>The <guibutton>Add</guibutton> button opens (in an external browser) the <quote>Add Lyrics</quote> page on the lyrics website, depending on which script you run.</para> + +<para>The <guibutton>Edit</guibutton> button allows you to edit lyrics for the current track. They are then stored in &amarok;'s collection database. This does not require a lyrics script to be active.</para> + +<para>The <guibutton>Search</guibutton> button launches a google.com search (in an external browser) for the lyrics of the current track.</para> + +<para>The <guibutton>Refresh</guibutton> button clears cached lyrics for current track, and searches again.</para> + +<para><guibutton>Open in external browser</guibutton> displays the current track's lyrics in your external browser.</para> + +</sect3> + +<sect3 id="wiki"> +<title>The Artist Tab</title> + +<screenshot> + <screeninfo>Artist Tab Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="tab_wiki.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>The Artist tab shows Wikipedia article about currently played artist. Toolbar contains:</para> + +<itemizedlist> +<listitem> +<para>Navigational buttons for moving forward or backward</para> +</listitem> +<listitem> +<para>Page buttons for jumping to artist's, album's or track's Wikipedia page,</para> +</listitem> +<listitem> +<para>A button for opening current page in external browser</para> +</listitem> +<listitem> +<para>A configuration button for setting the Wikipedia locale</para> +</listitem> +</itemizedlist> +</sect3> + +</sect2> + + + +<sect2 id="collection-browser"> +<title>Collection Browser</title> + +<screenshot> + <screeninfo>Collection Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="collection.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>The Collection browser is the heart of &amarok;. The entire collection is viewable here and sorted using various groupings. Within each grouping, everything is always alphabetical, symbols and numbers first, and case insensitive. In every grouping method, tracks that have unknown artists and/or albums are always grouped at the start of your collection, under <quote>Unknown</quote>. Although track numbers are not shown, tracks are listed in their album order. Clicking the header of the collection list reverses the sort order. Left-clicking on the expand icon to the left of any entry in your collection will expand that entry.</para> + +<para>The <quote>Group By</quote> pull-down menu allows you to group your collection in several ways:</para> + +<itemizedlist> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Artist</guimenuitem></menuchoice> - Top level sort only, every track is grouped under its artist, with no consideration given to albums or genres.</para> +</listitem> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Artist/Album</guimenuitem></menuchoice> - Tracks are sorted into artists, and then beneath this, sorted by album. If you want to see compilation or soundtrack albums, this is the best way to view your collection - these albums are grouped together at the very begin of your list, under <quote>Various Artists</quote>.</para> +</listitem> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Artist/Year-Album</guimenuitem></menuchoice> - Sorts by artist, with albums in descending order of year (most recent first). If there is no <quote>Year</quote> tag set for a track, the default <quote>0 - album name</quote>.</para> +</listitem> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Album</guimenuitem></menuchoice> - Every album in your collection is displayed alphabetically based on the album name, regardless of artist.</para> +</listitem> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Genre/Artist</guimenuitem></menuchoice> - Tracks are grouped according to their genre tag, then by artist.</para> +</listitem> +<listitem> +<para><menuchoice><guimenu>Group By</guimenu><guimenuitem>Genre/Artist/Album</guimenuitem></menuchoice> - Same as above, only with tracks sorted by album, below each artist.</para> +</listitem> +</itemizedlist> + + +<para>The remaining items on the pulldown menu allow you to customise the grouping with any combination of the above.</para> + +<para>The next two icons on the toolbar change the way your collection is viewed. The first, Tree View, is the default view, and the one you'll probably see the most. The next button enables Flat View, which at first appears empty. Typing search terms in the text entry box immediately below the toolbar will begin to populate your collection, which can be sorted in a variety of ways, by left-clicking on the column headers. right-clicking on the column headers will pop up a context menu allowing you to change the columns shown.</para> + +<para>The last icon in the toolbar lets you change your collection setup. Note that if you change any folders, &amarok; will automatically rescan your collection - this may take quite some time if you have many tracks.</para> + +<para>Immediately below the toolbar is a search filter, which behaves the same in both Flat and Tree views. See the Playlist section of the handbook for more details on searching techniques.</para> + +<para>Below the Search Filter, another pull-down menu lets you see the most recently added tracks to your collection. Several time periods are available, ranging from the last 24 hours, to 1 year, or your entire collection.</para> + +<sect3 id="collection-rmb"> +<title>The Collection Browser &RMB; Options</title> +<para>The following options are accessible by clicking with the &RMB; on entries in the collection browser.</para> + +<para><guilabel>Load</guilabel> - Clears the current playlist and adds selected track(s) as first track(s), in sort order.</para> + +<para><guilabel>Append to Playlist</guilabel> - Adds selected track(s) to end of current playlist. Double clicking on a single track in the collection also achieves the same result.</para> + +<para><guilabel>Queue Tracks</guilabel> - Adds the selected track(s) to the queue as the next to be played.</para> + +<para><guilabel>Save as Playlist</guilabel> - Save the selected tracks as a playlist. You'll be prompted for a name to save as.</para> + +<para><guilabel>Add to Media Device Transfer Queue</guilabel> - Adds track(s) to a queue, ready to be transferred to a media device, when such a device is attached. See <link linkend="media-device-browser">Media Device Browser</link> section for more detail.</para> + +<para><guilabel>Burn All Tracks By This Artist/Burn To CD</guilabel> - Sends track(s) to &k3b; for burning as either a data or Audio CD. If &k3b; is not installed, this option is not selectable.</para> + +<para><guilabel>Fetch Cover Image</guilabel> - Searches amazon.com for a cover image for this album.</para> + +<para><guilabel>Edit Information for (n) Tracks</guilabel> - Opens the <guilabel>Track Information</guilabel> dialog and allows you to change tags for one or more tracks. <!--See Editing Tags section for more information.--></para> + +<para><guilabel>Manage Files</guilabel></para> + +<itemizedlist> +<listitem> +<para><guilabel>Organize (n) Files</guilabel> - Opens <guilabel>Organize Collection Files</guilabel> dialog. <!--See File Organization section for more information.--></para> +</listitem> + +<listitem> +<para><guilabel>Delete (n) Files</guilabel> - Pops up a confirmation dialog asking whether you want to permanently delete the selected track(s) from your computer.</para> +</listitem> +</itemizedlist> + +<para><guilabel>Mark As Compilation</guilabel> - Sets the selected album as a compilation album, to be listed under <quote>Various Artists</quote></para> + +<para><guilabel>Unmark As Compilation</guilabel> - Changes an album marked as a compilation to a normal album, and moves the listing from <quote>Various Artists</quote>, to back under the artists listed.</para> +</sect3> + +</sect2> + + +<sect2 id="playlist-browser"> +<title>Playlist Browser</title> + +<screenshot> + <screeninfo>Playlist Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="playlist_browser.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>The Playlist Browser is used for easy handling of your multiple playlists. The Playlist Browser also features built in smart playlists making it the most clever playlist browser around.</para> + +<para>The Playlist Browser is divided into two sections, Playlists and Smart Playlists. The Playlists sections is for your own custom playlists. You can view the contents of your playlists in a list view by clicking the <quote>+</quote> symbol found next to each of the listed playlists. When you view a playlist in the list view new items can be added to the playlist by dragging and dropping them into the view. When you have found a playlist that you would like to load, you can double click the playlist, or press the <keycap>Space Bar</keycap> to have &amarok; load it. The other Playlist Browser keyboard shortcuts can be found in the <link linkend="keybd-shortcuts">Keyboard Shortcuts section</link>.</para> + +<tip><para>When you save a new playlist from the Playlist Window it is automatically added to the Playlist section.</para></tip> + +<para>The bottom section of the Playlist Browser is the Smart Playlists. The Smart Playlists use &amarok;'s built in data base to compile some useful playlists on the fly. The Smart Playlists include the following:</para> + +<itemizedlist> +<listitem> +<para>All Collection: a playlist with all the tracks that are in your configured collection.</para> +</listitem> + +<listitem> +<para>Favorite Tracks: multiple playlists of the fifteen highest rated tracks in a listview by artitst.</para> +</listitem> + +<listitem> +<para>Most Played: multiple playlists of the fifteen most played tracks in a listview by artitst.</para> +</listitem> + +<listitem> +<para>Newest Tracks: multiple playlists of the fifteen most recently added tracks in a listview by artitst.</para> +</listitem> + +<listitem> +<para>Last Played: a playlist of the fifteen most recently played tracks in your collection.</para> +</listitem> + +<listitem> +<para>Never Played: a playlist of the tracks in your collection which have never been played before.</para> +</listitem> + +<listitem> +<para>Genres: multiple playlists in a listview ordered by genre.</para> +</listitem> + +<listitem> +<para>User defined smart playlists are also possible. Clicking the <guibutton>Create Smart-Playlist</guibutton> button will open a dialog to configure a smart playlist to fit your criteria.</para> +</listitem> +</itemizedlist> +</sect2> + + +<sect2 id="media-device-browser"> +<title>Media Device Browser</title> + +<screenshot> + <screeninfo>Media Device Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="media_device.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>The Media Device panel is used for connecting your iPod, to &amarok;. To use your iPod with the Media Device browser you must have your iPod mounted at /mnt/ipod before starting &amarok;. Once you have started &amarok; you will find the tracks on your iPod listed by artist in a listview at the top of the browser.</para> + +<para>To add tracks to your iPod, drag the tracks you want to add from the playlist and drop them on the Artist listview. After you are done adding tracks to the list click the <guibutton>Transfer</guibutton> button to upload them to your iPod. After the transfer has completed, close &amarok; and unmount your iPod.</para> + +</sect2> + +<sect2 id="file-browser"> +<title>File Browser</title> + +<screenshot> + <screeninfo>File Browser Screenshot</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="file_browser.png" format="PNG"/></imageobject> + </mediaobject> +</screenshot> + +<para>The File Browser panel is like a mini konqueror embedded into the playlist. You can use the File Browser panel to browse your entire filesystem for audio files to add to the playlist. At the top of the File Browser you will find a toolbar with navigation buttons for moving Up, Back, and Forward through your filesystem. The tool bar also offers a Home, Reload, Short view and Detailed view buttons, it also features a Bookmarks button for creating bookmarks of your favorite filesystem areas.</para> + +<para>Below the toolbar is a handy search bar for searching by file name. You will find the search bar useful for directories with many files as it searches as you type leaving only the relevant file names in the view.</para> + +<para>At the bottom of the File Browser is an address bar for accessing your music from any URL that you type. For instance typing <filename class="directory">tar:/home/mike/music.tar.gz</filename> into the address bar and pressing <keycap>Enter</keycap> on your keyboard will allow you to access the files inside the music tar ball. Now you can drag the audio from the tar ball and drop it into the playlist.</para> + +<tip><para>When playlist grows larger than one screenful, it becomes hard to append files by simply dropping them. Holding <keycap>Shift</keycap> key on keyboard while dropping may help in this case: the files will be appended at the end of playlist rather than inserted at current drop position.</para></tip> + +</sect2> + +</sect1> + + +<sect1 id="playlist"> +<title>The Playlist</title> + +<screenshot> + <screeninfo>Playlist Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="play_list.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Playlist holds all the tracks you have en-queued for playing. You can change the sequence by dragging items around with the mouse, and dropping them in the desired position. Above the Playlist you see a Text Box, where you can enter a filter string. As soon as you enter a letter there, the Playlist will be redisplayed, showing only entries containing the entered characters. To stop the filtering, simply press <keycap>Backspace</keycap>, until the filter is empty.</para> + +<tip><para>Advanced, Google-esque syntax is also available.</para> + +<para>By default, when you enter terms separated by spaces, it will search for items containing all of them. +For example: one two three, will search for anything that contains one, two, and three.</para> + +<para>However, you can put OR between terms to search for items that contain either, like this: one OR two OR three. +That way, it will search for items that contain either one, or two, or three (or a combination of them).</para> + +<para>You can also use quotes to search for terms with spaces in them: "Mike Oldfield". +That will search for items that contain Mike Oldfield, but not, for example, ones that contain Mike J. Oldfield.</para> + +<para>By default, it searches in all the columns of the playlist that are currently visible. However, you can use column:term to specify the column to search in: title:amarok (this can also be a column that isn't visible). +This way, it will only search for items that have the word amarok in the title, and not, for example, in the album.</para> + +<para>When specifying a specific column to search in, you can also search for items less than or greater than a term, for example: score:>50, which will search for items with a score greater than 50.</para> + +<para>To specify a term you don't want the items to match, you can put a minus (-) sign before them: -thing, to search for anything that doesn't contain thing.</para> + +<para>You can combine the above at will, for example: "Mike Oldfield" OR score:>50 -comment:bad. That will search for anything that either contains Mike Oldfield or has a score greater than 50, but excludes items where the comment contains "bad".</para></tip> + +<tip> + +<screenshot> + <screeninfo>Playlist Tip</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="pl_tip1.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>You can select items to be played in a specific order by holding <keycap>Control</keycap> and clicking the &RMB; on items in the order in which you wish them to be played. The items will be tagged with a number showing the order in which you selected them.</para> + +</tip> + +</sect1> + +<sect1 id="menubar"> +<title>The Playlist Menubar</title> + +<screenshot> + <screeninfo>Playlist Menubar Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="menubar.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<sect2 id="actions-menu"> +<title>The Actions Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Actions</guimenu> +<guimenuitem>Play Media...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog for entering an URL.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Actions</guimenu> +<guimenuitem>Play Audio CD</guimenuitem> +</menuchoice></term> +<listitem><para>Allows you to view and play an Audio CD using the audiocd:/ protocol.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Win</keycap><keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Actions</guimenu> +<guimenuitem>Previous Track</guimenuitem> +</menuchoice></term> +<listitem><para>Move to the previous track in the playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Actions</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para>Pauses the playback of the current track.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Win</keycap><keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Actions</guimenu> +<guimenuitem>Stop</guimenuitem> +</menuchoice></term> +<listitem><para>Stops playback.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Win</keycap><keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Actions</guimenu> +<guimenuitem>Next Track</guimenuitem> +</menuchoice></term> +<listitem><para>Move to the next track in the playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>Actions</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para>Quits &amarok;.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="playlist-menu"> +<title>The Playlist Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Add Media...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog to add media to your current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Save Playlist As...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog to save your current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para>Undo the last change to the playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para>Reverts changes made by Undo.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Playlist</guimenu> +<guimenuitem>Clear</guimenuitem> +</menuchoice></term> +<listitem><para>Clears the current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Shuffle</guimenuitem> +</menuchoice></term> +<listitem><para>Shuffles the ordering of the current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>Enter</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Goto Current Track</guimenuitem> +</menuchoice></term> +<listitem><para>Moves the playlist to the currently playing track.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Queue Selected Tracks</guimenuitem> +</menuchoice></term> +<listitem><para>Queues all selected tracks in the playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Playlist</guimenu> +<guimenuitem>Remove Duplicates & Dead Entries</guimenuitem> +</menuchoice></term> +<listitem><para>Remove all duplicate or dead entries in the current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Playlist</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem><para>Selects all the tracks in the current playlist.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + + +<sect2 id="tools-menu"> +<title>The Tools Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Cover Manager</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="cover-manager">Cover Manager</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Queue Manager</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="queue_manager">Queue Manager</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>First-Run Wizard</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the First-Run wizard.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Visualizations</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="visualizations">Visualizations</link> dialog.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Equalizer</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="equalizer">Equalizer Window</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Scripts</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="script_manager">Script Manager</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Rescan Collection</guimenuitem> +</menuchoice></term> +<listitem><para>Starts a manual scan of your collection folders.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="settings-menu"> +<title>The Settings Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Hide Menubar</guimenuitem> +</menuchoice></term> +<listitem><para>Hide the Playlist Window <link linkend="menubar">Menubar</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Hide Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para>Hide the Playlist Window <link linkend="toolbar">Toolbar</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Hide Player Window</guimenuitem> +</menuchoice></term> +<listitem><para>Hide the <link linkend="player-window">Player Window</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Repeat Track</guimenuitem> +</menuchoice></term> +<listitem><para>Repeat playback of the current track.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Repeat Playlist</guimenuitem> +</menuchoice></term> +<listitem><para>Repeat playback of the current playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Random Mode</guimenuitem> +</menuchoice></term> +<listitem><para>Randomizes the order of playback of the tracks in the playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Dynamic Mode</guimenuitem> +</menuchoice></term> +<listitem><para>Starts the dynamic playlist mode.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Global Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the global shortcut configuration dialog..</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the &amarok; shortcut configuration dialog..</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the &amarok; toolbar configuration dialog..</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Amarok...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the &amarok; configuration dialog..</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + + +<sect2 id="help-menu"> +<title>The Help Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>F1</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>Amarok Handbook</guimenuitem> +</menuchoice></term> +<listitem><para>Opens this documentation.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Shift</keycap><keycap>F1</keycap></keycombo> +</shortcut> +<guimenu>Help</guimenu> +<guimenuitem>What's This</guimenuitem> +</menuchoice></term> +<listitem><para>Activates the What's This mouse cursor.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>Report Bug...</guimenuitem> +</menuchoice></term> +<listitem><para>Starts the bug reporting tool.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>about Amarok</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the about Amarok dialog.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu> +<guimenuitem>about KDE</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the about KDE dialog.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +</sect1> + + +<sect1 id="toolbar"> +<title>The Playlist Toolbar</title> + +<screenshot> + <screeninfo>Playlist Toolbar Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="buttons.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Playlist Window Toolbar is found near the bottom of the Playlist Window. The Toolbar contains buttons for many of the Playlist actions. On the right side of the Toolbar you can find the <guibutton>Add Media</guibutton> button, which opens a file dialog to add your media files to the playlist. Following the <guibutton>Add Media</guibutton> button are the <guibutton>Save Playlist</guibutton>, <guibutton>Clear Playlist</guibutton>, and <guibutton>Refresh Playlist</guibutton> buttons. You can use these buttons for handling the current Playlist.</para> + +<para>The next set of buttons are the <guibutton>Undo</guibutton>, and <guibutton>Redo</guibutton> buttons. You can use these buttons to Undo or Redo any changes made to the playlist.</para> + +<para>In the center of the Toolbar you can find a unique, re-sizeable analyzer. You can adjust the refresh rate for the analyzer by using the &RMB; menu, and selecting your desired frame rate.</para> + +<para>The last button in the Toolbar is the <guibutton>Menu</guibutton> button. The <guibutton>Menu</guibutton> button opens the same menu as the Player Window &RMB; menu. You can use this menu for accessing the &amarok; configuration options.</para> + +<tip><para>There are many other buttons available for the Toolbar including player control buttons and a volume slider. You can configure what buttons are in the Toolbar by clicking the <guibutton>Menu</guibutton> button and selecting <guimenuitem>Configure Toolbars...</guimenuitem></para></tip> + +</sect1> + +<sect1 id="statusbar"> +<title>The Playlist Status Bar</title> + +<screenshot> + <screeninfo>Status Bar Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="status_bar.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Status Bar provides quick access to some useful information about the playlist. The Status Bar displays the current track's title, the number of tracks in the playlist along with the total playlist time, Random and Repeat status, a mini track position slider, and the current track's play time. You can change the Random and Repeat status by double clicking there respective areas in the status bar.</para> + +<para>You can also choose to not have the Status Bar displayed using the <guilabel>Show statusbar</guilabel> option in the <link linkend="general-options">Configure General Options Dialog</link>.</para> + +</sect1> + +<sect1 id="rmb-menu"> +<title>The Right Mouse Button Menu</title> + +<screenshot> + <screeninfo>RMB Menu Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="rmb_menu.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The &RMB; menu can be found by right clicking the player window, it can also be found by clicking the <guibutton>Menu</guibutton> button in the playlist window. The &RMB; menu is used for access to all of &amarok;'s options.</para> + +<variablelist> + + +<varlistentry> +<term><menuchoice><guimenu>Repeat Track</guimenu></menuchoice></term> +<listitem> +<para>This option when enabled repeats playback of the current track.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Repeat Playlist</guimenu></menuchoice></term> +<listitem> +<para>This option when enabled repeats playback of the entire playlist.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Random Mode</guimenu></menuchoice></term> +<listitem> +<para>This option when enabled randomizes the playback of the tracks in your playlist.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Append Suggestions</guimenu></menuchoice></term> +<listitem> +<para>Appends the suggested songs in the Context Browser to the current playlist.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Cover manager</guimenu></menuchoice></term> +<listitem> +<para>Opens the <link linkend="cover-manager">Cover Manager</link>.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>First-run Wizard</guimenu></menuchoice></term> +<listitem> +<para>Clicking this option starts the first-run wizard for the initial configuration of &amarok;.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Visualizations...</guimenu></menuchoice></term> +<listitem> +<para>Clicking this option opens the <link linkend="visualizations">Visualizations Window</link> for choosing what visualizations to use with &amarok;.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Equalizer</guimenu></menuchoice></term> +<listitem> +<para>Opens the <link linkend="equalizer">Equalizer Window.</link></para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Script Manager</guimenu></menuchoice></term> +<listitem> +<para>Opens the Script Manager dialog.</para> +</listitem> +</varlistentry> + + + +<varlistentry> +<term><menuchoice><guimenu>Configure Toolbars...</guimenu></menuchoice></term> +<listitem> +<para>Clicking this option opens a dialog to configure the <link linkend="toolbar">Playlist Toolbar</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Configure Shortcuts...</guimenu></menuchoice></term> +<listitem> +<para>Clicking this option opens a dialog to configure the <link linkend="keybd-shortcuts">&amarok; Shortcuts</link>.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Configure Global Shortcuts...</guimenu></menuchoice></term> +<listitem> +<para>Clicking this option opens a dialog to configure the global <link linkend="keybd-shortcuts">&amarok; Shortcuts</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Configure Global Amarok...</guimenu></menuchoice></term> +<listitem> +<para>Clicking this options opens the <link linkend="configuring-kapp">&amarok; Configuration Dialog</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Help</guimenu></menuchoice></term> +<listitem> +<para>This entry provides a sub-menu providing links to this document and other &amarok; information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Quit</guimenu></menuchoice></term> +<listitem> +<para>This entry when clicked will quit &amarok;.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + + +<sect1 id="cover-manager"> +<title>Album Cover Manager</title> + +<screenshot> + <screeninfo>Album Cover Manager</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="coverman.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Album Cover Manager is a useful tool for managing your album covers. You can start the Cover Manager by selecting <menuchoice><guimenu>Actions</guimenu><guimenuitem>Cover Manager</guimenuitem></menuchoice> in the Collection Browser.</para> + +<para>The cover manager provides a listview of all the albums in your collection. You can view all of your album covers for an artist by clicking on the artist in the list view.</para> + +<para>The cover manager provides a search bar for searching in your album covers. The cover manager will search your albums for the search criteria you type in the search bar.</para> + +<para>The <guimenuitem>View</guimenuitem> menu allows you to choose what is displayed in the cover manager. You can choose from:</para> + +<para><guimenuitem>All albums</guimenuitem> which displays all your albums in your collection.</para> + +<para><guimenuitem>Albums with cover</guimenuitem> which displays only the albums that have cover images.</para> + +<para><guimenuitem>Albums without cover</guimenuitem> which displays only the albums that do not have cover images.</para> + +<para>The <guimenuitem>Fetch Missing Covers</guimenuitem> button is used to download cover images for your albums that do not already have cover images available.</para> +</sect1> + +<sect1 id="queue_manager"> +<title>The Queue Manager</title> + +<screenshot> + <screeninfo>Queue Manager Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="queue_manager.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Queue Manager makes it's grand entrance in &amarok; 1.3. This feature is designed to enable users to have even more control over their playlists. After queuing, a track a number will be shown beside it in the Queue Manager. This number indicates the order in which &amarok; will play the track: one will be first, two will be second, and so on.</para> + +<para>You can use the Queue Manager by opening it from <menuchoice><guimenu>Tools</guimenu> <guimenuitem>Queue Manager</guimenuitem></menuchoice>, selecting the track, and then pressing the <guibutton>+</guibutton> icon in the Queue Manager. You can also just drag tracks to the Queue Manager to create a queue. Alternatively, the playlist's context menu may also be used and the Queue Manager can then be opened in order to modify the order.</para> + +</sect1> + +<sect1 id="dynamic-mode"> +<title>Dynamic Playlists</title> + + <sect2> + <title>What Are They?</title> + <para> + Dynamic Playlists are self-generating playlists, created according to defined rules, which are used to keep the current playlist to a manageable size. Whilst &amarok; is fairly light on resources while running, loading a large number of tracks into a playlist at once increases RAM usage, possibly impacting on system performance, which is avoided completely by using Dynamic Playlists. Also known as Party Mode, they are also a great way to keep the music playing all night with no interaction. + </para> + </sect2> + + <sect2> + <title>Where Are They?</title> + <para>You can find Dynamic Playlists in the Playlists Sidebar.</para> + + <screenshot> + <screeninfo>Playlist Sidebar</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="playlist_browser.png" format="PNG"/> + </imageobject> + <textobject><phrase>Playlist Sidebar</phrase></textobject> +<!-- <caption><para>Dynamic Playlists shown in the Playlist Browser</para></caption> --> + </mediaobject> + </screenshot> + + <para>There are three types of Dynamic Playlists, referred to as Dynamic Modes, two of which are predefined (more details on configuring this later).</para> + + <variablelist> + <varlistentry> + <term>Random Mix</term> + <listitem><para>Initialises a playlist with random tracks from you're entire collection, and keeps adding random tracks.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Suggested Songs</term> + <listitem> + <para>Adds tracks based on <ulink url="http://www.last.fm">last.fm</ulink> (formerly audioscrobbler) suggestions. Requires some tracks already in the playlist. Note you do not need a last.fm profile for this to work.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Playlist Shuffle (user-created)</term> + <listitem><para>Adds random tracks from specified Smart Playlists, either built-in or user defined.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + + <sect2> + <title>How Do I Use Them?</title> + <para>Simply double-click your desired playlist, drag it to the playlist window, or right-click and select Load. This will replace your current playlist, so you may want to save that first if it's important to you. </para> + <para>Both Random Mix and Playlist Shuffle will populate your playlist and allow you to start playing immediately. Suggested Songs will start with an empty playlist, requiring you to add at least one song from your collection manually. The suggestions are added on a track change, so your playlist will not be populated until the end of the first song.</para> + <para>If you wish to retain your current playlist, you can enable the last type of Dynamic Mode used by selecting <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Dynamic Mode</guimenuitem></menuchoice>. This will use your existing playlist as a starting point. You can disable Dynamic Mode via the same menu option.</para> + <screenshot> + <screeninfo>Dynamic Playlist loaded</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="amarok_playlist.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Dynamic Playlist loaded</phrase> + </textobject> +<!-- <caption><para>&amarok;with a Dynamic Playlist loaded</para></caption> --> + </mediaobject> + </screenshot> + <para>The <guibutton>Repopulate</guibutton> button will clear your playlist and re-add tracks according to the Dynamic Mode you are using, and the <guibutton>Edit this Dynamic Mode</guibutton> button will pop up the Dynamic Mode Settings dialog.</para> <note><para>These buttons will not appear if you have Dynamic Mode disabled.</para></note> + </sect2> +</sect1> + +<sect1 id="config-dynamic"> +<title>Configuring Dynamic Playlists</title> + <sect2> + <title>Changing the Behaviour of a Dynamic Playlist</title> + <para>Right-clicking on a <guilabel>Dynamic Playlist</guilabel> will allow you to select <guimenuitem>Edit</guimenuitem>, which opens the Dynamic Mode Settings dialog box.</para> + + <screenshot> + <screeninfo>Dynamic Mode Settings</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dynamic_settings.png" format="PNG"/> + </imageobject> +<!-- <caption><para>Dynamic Mode Settings Dialog</para></caption> --> + </mediaobject> + </screenshot> + + <variablelist> + <varlistentry> + <term>Dynamic Playlist Name</term> + <listitem> + <para>Rename to anything you like, if you so desire. Playlist names should be unique, to avoid confusion.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Remove played tracks</term> + <listitem> + <para>If you uncheck this, your playlists will continually grow, the Upcoming Tracks setting is overridden, and you will not get repeats in your playlist. If the setting is checked, played tracks are removed from the start of the list, according to the Played tracks to show setting below.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Mark history</term> + <listitem> + <para>Greys out tracks that have been played.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Played tracks to show</term> + <listitem> + <para>Played tracks to show - number of played tracks to leave showing at the start of the playlist. Useful for seeing what has been played recently.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Upcoming tracks</term> + <listitem> + <para>This is the setting that restricts the size of your playlist.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Tracks to append</term> + <listitem> + <para>The number of tracks that will be added to your playlist after each song is played. Note that if you set this greater than 1, your playlist will grow rapidly, as only one track can be played then removed at a time.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>You can also access this dialog via the <guibutton>Edit this Dynamic Mode</guibutton> button at the top right of your playlist window.</para> + + <screenshot> + <screeninfo>Dynamic Mode Bar</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dynamic_bar.png" format="PNG"/> + </imageobject> +<!-- <caption><para>Dynamic Mode Indicator Bar</para></caption> --> + </mediaobject> + </screenshot> + </sect2> + + <sect2> + <title>Adding a Custom Dynamic Playlist</title> + <para>Right-click on Dynamic Playlists and select New Dynamic Playlist.</para> + + <screenshot> + <screeninfo>Create New Dynamic Playlist</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="add_dynamic.png" format="PNG"/> + </imageobject> +<!-- <caption><para>Adding a New Dynamic Playlist</para></caption> --> + </mediaobject> + </screenshot> + + <para>The settings on the right are as described in the previous section. In the panel on the left, you can select from any of the existing playlists and smart playlists on your system. If you select multiple playlists, &amarok; will add random tracks from each of these.</para> + </sect2> +</sect1> + +<sect1 id="script_manager"> +<title>The Script Manager</title> + +<screenshot> + <screeninfo>Script Manager Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="script_manager.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The script interface provides a simple way to extend the functionality of &amarok;. To run an &amarok; script, start the Script Manager by selecting <menuchoice><guimenu>Tools</guimenu><guimenuitem>Script Manager</guimenuitem></menuchoice> in the &amarok; Menubar. In the Script Manager dialog you will find a listview of your installed scripts, select a script from the listview and click the <guibutton>Run</guibutton> button to launch the script. The &amarok; script will run until it has finished, or is manually stopped by selecting the script in the Script Manager and clicking the <guibutton>Stop</guibutton> button.</para> + +<tip><para>Some scripts provide special configuration options. To access these options first run the script and then click the <guibutton>Configure</guibutton> button to access the script's configuration dialog.</para></tip> + +<para>To install new &amarok; scripts click the <guibutton>Install Script</guibutton> button in the Script Manager dialog. A select file dialog will open allowing you to select an &amarok; script package. After selecting a package to install a new entry for the script will appear in the listview. You can also install new scripts by clicking the <guibutton>Get More Scripts</guibutton> button, which opens a Dialog for downloading and installing scripts automatically from the internet.</para> + +<para>You may also find that there are scripts that you no longer use. To uninstall a script select the script in the Script Manager listview and click the <guibutton>Uninstall</guibutton> button.</para> + +<note><para>If you are looking for information on writing an &amarok; script, please see the <link linkend="script-writing">Script Writing</link> section of this document.</para></note> + +</sect1> + +<sect1 id="visualizations"> +<title>The Visualizations</title> + +<screenshot> + <screeninfo>Visualizations Screenshot</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="vis_window.png" format="PNG"/> + </imageobject> + </mediaobject> +</screenshot> + +<para>The Visualizations Window is used to enable your available visualizations with &amarok;. A list of your available visualizations will be provided in the window. To enable a visualization check the provided checkbox for the specific visualization.</para> + +</sect1> + +</chapter> diff --git a/doc/en/vis_window.png b/doc/en/vis_window.png Binary files differnew file mode 100644 index 00000000..89afa82e --- /dev/null +++ b/doc/en/vis_window.png |
