diff options
Diffstat (limited to 'doc/juk/index.docbook')
| -rw-r--r-- | doc/juk/index.docbook | 1665 |
1 files changed, 1665 insertions, 0 deletions
diff --git a/doc/juk/index.docbook b/doc/juk/index.docbook new file mode 100644 index 00000000..28763a3d --- /dev/null +++ b/doc/juk/index.docbook @@ -0,0 +1,1665 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY package "kdemultimedia"> + <!ENTITY kappname "&juk;"> + <!ENTITY juk "<application>JuK</application>"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &juk; Handbook</title> + +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author> +<firstname>Michael</firstname> +<surname>Pyne</surname> +<affiliation> +<address><email>michael.pyne@kdemail.net</email></address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Scott</firstname> +<surname>Wheeler</surname> +<affiliation> +<address>&Scott.Wheeler.mail;</address> +</affiliation> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2001</year> +<year>2002</year> +<year>2004</year> +<holder>&Scott.Wheeler;</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2004-05-06</date> +<releaseinfo>2.1</releaseinfo> + +<abstract> +<para> +&juk; is a jukebox, tagger and music collection manager. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdemultimedia</keyword> +<keyword>audio</keyword> +<keyword>tagger</keyword> +<keyword>player</keyword> +<keyword>jukebox</keyword> +<keyword>JuK</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&juk; is, well, a jukebox. As is typical with many jukebox +applications, &juk; allows you to edit the <quote>tags</quote> of your +audio files, and manage your collection and playlists. +</para> +</chapter> + +<chapter id="using-juk"> +<title>Using &juk;</title> + +<para> +<screenshot> +<screeninfo>Here's a screenshot of &juk;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="juk-main.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot of &juk; in action.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>&juk; maintains a list of all files that it knows about. This +is called the <guilabel>Collection List</guilabel>. The collection +list is specific to &juk; and is not shared with other +applications.</para> + +<para>Independent of the Collection List, are playlists. You can have +as many playlists as you want. You can use &juk; created playlists +with other media players (such as &noatun; or +<application>xmms</application>) and you can manage playlists created +in those applications from within &juk;.</para> + +<para>You can add files to the Collection List individually, using +<menuchoice><guimenu>File</guimenu><guimenuitem>Open +File...</guimenuitem></menuchoice> and selecting them from a standard +&kde; file dialog. You can add entire folders using +<menuchoice><guimenu>File</guimenu><guimenuitem>Open +Folder...</guimenuitem></menuchoice>. Folders added this way +will be rescanned every time you start &juk; +<!-- ask scott: + Asked 2004-04-27 (mpyne), Choosing Reload from the Collection + List context menu will result in a rescan. Also, a KDirWatch + watches the folders, but is apparently not recursive. --> +. You can force the folders to be rescanned by right-clicking on the <guilabel>Collection List</guilabel> +icon, and selecting <guimenuitem>Reload</guimenuitem>.</para> + +<para>Adding a song to a playlist will automatically add its file to +the Collection List, but adding a file to the Collection List won't +automatically add the song to any playlists.</para> + +<para>You can quickly create a playlist from your entire Collection +List, by &RMB; clicking on the <guilabel>Collection List</guilabel> +icon, and choosing <guimenuitem>Duplicate</guimenuitem>. The +resulting playlist is a normal playlist, and editing it will not +affect the <guilabel>Collection List</guilabel>.</para> + +<para>You can add playlist files created outside &juk; individually by +selecting them with +<menuchoice><guimenu>File</guimenu><guimenuitem>Open +File...</guimenuitem></menuchoice>. Any playlist files found in +folders you add with +<menuchoice><guimenu>File</guimenu><guimenuitem>Open +Folder...</guimenuitem></menuchoice> will also be added +automatically.</para> + +<para>You can create a new playlist by choosing +<menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> +or the <guiicon>New</guiicon> icon on the toolbar. You will be +prompted for a name, and then an icon for that playlist will appear in +the playlist pane. You can now drag and drop files from the +Collection List, or from other playlists, to your playlist. Use the <guiicon>Save</guiicon> +icon or +<menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice> to +save the playlist at any time.</para> + +<sect1 id="collection-list-gui"> +<title>The Song List</title> + +<para>When you are viewing the Collection List, the main pane contains +all the files that &juk; knows about. When you are viewing a +playlist, only the songs that are in that playlist are shown. In +either case, the appearance and behavior of the list is the +same.</para> + +<para>Each song takes one row in the display. There is a column for +each metadata field that &juk; tracks. These columns correspond to +the fields available to edit in the tag editor.</para> + +<para>You can reorder the list at any time by &LMB; clicking on the +column header. This will first sort the files in ascending order +based on the contents of that column. If you &LMB; click again on the +same header, the files will be re-sorted in descending order.</para> + +<para>The columns are initially sized wide enough to show the longest +entry available. You can resize the columns by placing your mouse +cursor on the divider between two columns. When the cursor changes +from a pointer, &LMB; click and drag in the direction you want to +resize the columns.</para> + +<para>You can reorder the columns by &LMB; clicking on a header and +dragging the header to the left or right. You cannot drag past the +edge of the window when doing this however, so you may need to scroll +a little to the left or right, and repeat dragging the header, until +you have placed it in your preferred position.</para> + +<para>You can hide or unhide columns by &RMB; clicking on a column header, +and clicking on the name of the column to change.</para> + +<para>&LMB; double clicking on a file will play it with the built-in +player. If another song was already playing, it will stop, and the +new song will play.</para> + +<para>&RMB; clicking on a file offers you several options:</para> + +<variablelist> +<varlistentry> +<term><guimenuitem>Play Next</guimenuitem></term> +<listitem> +<para>This will start playing the file as soon as the current +song is over. If no song is playing, the file will be played when +you next hit the <guiicon>Play</guiicon> button. If you have already +chosen the Play Next option on a different file, then this file will +override that selection.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Cut</guimenuitem></term> +<term><guimenuitem>Copy</guimenuitem></term> +<term><guimenuitem>Paste</guimenuitem></term> +<listitem> +<para>...</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Clear</guimenuitem></term> +<listitem> +<para>If you are viewing the Collection List, choosing +<guimenuitem>Clear</guimenuitem> will remove the file from the list, +and will also remove all corresponding entries for this song from all +playlists. You should note that if this file is in a folder that +&juk; scans on startup, it will be readded to the Collection List the +next time you start up &juk; but it won't be automatically added to +any playlists.</para> +<para>If you are viewing a playlist, <guimenuitem>Clear</guimenuitem> +will simply remove the song from the playlist.</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Edit</guimenuitem></term> +<listitem> +<para>Will allow you to edit the currently highlighted song, in the +column you clicked in. For example, if you do not have the tag editor +visible, and you are busy creating a playlist, but you notice a +mis-spelling in an artist name, you can edit it directly with this +menu item.</para> +<para>Changes made in this manner are always saved immediately as soon +as you click elsewhere and are finished editing.</para> +<para>This menu item will be disabled if &juk; detects that the track you +have selected is read-only.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Refresh Items</guimenuitem></term> +<listitem> +<para>This will reload the tag information of the selected files, in +case the files have been changed while &juk; was running.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Remove From Disk</guimenuitem></term> +<listitem> +<para>This will remove the file from the Collection List, remove all +entries for the song in all playlists, and delete the file from your +disk. You cannot undo this, although you will be asked to confirm +your choice. Use this with caution.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guisubmenu>Guess Tag Information</guisubmenu></term> +<listitem> +<para>This will make &juk; try to guess information such as the +Artist and Title of a song. &juk; employs different methods of guessing: + <variablelist> + + <varlistentry><term><guimenuitem>From File Name</guimenuitem></term> + <listitem><para>&juk; will try to guess the tags of the song based on its filename. + For example, a song name such as <filename>Roxette - You've Got the Look.mp3</filename> + would guess Roxette for the artist and You've Got the Look as the title. You + can adjust the way &juk; guesses for tags by selecting <menuchoice><guimenu>Settings + </guimenu><guimenuitem>Tag Guesser...</guimenuitem></menuchoice>, which will open the + <link linkend="juk-tag-guesser-configuration">Tag Guesser dialog</link>. &juk; will not + replace tags that it did not guess from the file name.</para> + </listitem> + </varlistentry> + + <varlistentry><term><guimenuitem>From Internet</guimenuitem></term> + <listitem><para>&juk; will try to guess the tags of the song by using the + MusicBrainz program. You must have MusicBrainz installed for this command to work. + </para> + </listitem> + </varlistentry> + + </variablelist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Rename File</guimenuitem></term> +<listitem> +<para>This will rename the selected files to conform to a given format. You must +choose the way you want the files renamed first by selecting <menuchoice> +<guimenu>Settings</guimenu><guimenuitem>File Renamer...</guimenuitem></menuchoice>. +The resulting name of each file is based on its metadata tags. For example, +the Ogg Vorbis song <quote>The Theme (Metroid)</quote> by Stemage could result in +<filename>/usr/share/music/Stemage/The Theme (Metroid).ogg</filename>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Create Playlist From Selected Items</guimenuitem></term> +<listitem> +<para>This allows you to quickly create a playlist from songs in your Collection List. +This function will prompt you for a name for the new playlist, and will then insert all of +the songs that are selected into the new playlist.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Add Selected Items to K3b Project</guimenuitem></term> +<listitem> +<para>This allows you to quickly create a K3b &CD;-burning project from your selected songs. &juk; will ask you if you would like an Audio &CD; project or a Data &CD; project, unless K3b already has a project open.</para> + +<para>If K3b is not already running, &juk; will start it up for you. After that, &juk; will add your selected files to the current K3b project. You can then save the project in K3b for burning later, or burn the &CD; right away. +</para> + +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="juk-playlists"> +<title>&juk; Playlists</title> +<para>A playlist is simply a collection of songs grouped by some category. For example, you +may have a playlist of songs that you listen to while coding, while trying to sleep, or even +when you need a laugh. &juk; supports several different types of playlists. +</para> + +<variablelist> + +<varlistentry> +<term id="juk-normal-playlists">Normal playlists</term> +<listitem><para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="normal-playlist.png"/></imageobject></inlinemediaobject> +This is the most common kind of playlist. It is a playlist composed of files, just +like the Collection List.</para></listitem> +</varlistentry> + +<varlistentry> +<term id="juk-history-playlists">The history playlist</term> +<listitem><para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="history-playlist.png"/></imageobject></inlinemediaobject> +If you enable this playlist (by enabling <menuchoice><guimenu>View</guimenu><guimenuitem>Show History</guimenuitem></menuchoice>, +this playlist will record every song that &juk; plays. The playlist will have an extra column, <guilabel>Time</guilabel>, which +records the exact time and date the song played. The playlist doesn't start tracking the history until it is enabled, however. +</para></listitem> +</varlistentry> + +<varlistentry> +<term id="juk-search-playlists">Search playlists</term> +<listitem><para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="search-playlist.png"/></imageobject></inlinemediaobject> +This is a playlist which is based off of a search. You can create a playlist like this by clicking <menuchoice> +<guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Search Playlist</guimenuitem></menuchoice>, or by clicking on the +<link linkend="juk-advanced-search-dialog">Advanced Search</link> + button on the <link linkend="search-bar">Search Bar</link>.</para> +<para>After creating this playlist, it will keep track of which songs in the Collection List match your criteria, and automatically update itself accordingly whenever the +Collection List changes.</para></listitem> +</varlistentry> + +</variablelist> + +<para>Playlists are organized in the <guilabel>Playlist pane</guilabel>, which is the vertical bar at the left. In this pane is an icon +for every playlist you have. There are different view mode for this pane, which can be selected from the +<guimenu>View</guimenu><guisubmenu>View Modes</guisubmenu> menu. + +<variablelist> + +<varlistentry> +<term id="juk-viewmode-default">Default View mode</term> +<listitem> +<para> +This is the default view mode. In this mode, all the playlists are shown as large icons, one above the other in the view mode. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="juk-viewmode-compact">Compact View mode</term> +<listitem> +<para> +This mode is similar to the Normal Viewmode, with the exception that the playlists are represented with horizontal bars with small icons instead +of with square boxes. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="juk-viewmode-tree">Tree View mode</term> +<listitem> +<para>This mode is the most powerful. This mode is just like the Compact viewmode, except that the Collection List is now the root of a tree of virtual +playlists. The Collection List has three children nodes, Artist, Album, and Genre. Each of these node has children representing all of the entries +from that specific category. For example, if your Collection List contains music from 4 different artists, you would have 4 entries under the artist +node.</para> +<para>One nifty feature of the tree view mode is something called drag-and-drop retagging. Simply select some files in the track list, and drag them +onto one of the artist, album, or genre nodes under Collection List. The songs will automatically be retagged to match the item you dropped the +tracks on. For example, if you drag a group of tracks onto a Genre called "Rock", all of the tracks will be retagged will a Genre tag of Rock. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</para> + +</sect1> + +<sect1 id="juk-tagger"> +<title>The &juk; Tag Editor</title> + +<para>For many file formats, it is practical to use the filename to +describe the contents of the file: <quote><filename>Report for the +board - June 2003.doc</filename></quote> for example, may be all the +information you need in order to find that file again. Trying to +capture all the useful information about a particular song however, +could lead to filenames like this: <quote><filename>Type O Negative - +The Glorious Liberation Of The Peoples Technocratic Republic Of +Vinnland By The Combined Forces Of The United Territories Of +Europa.mp3</filename></quote> or <quote><filename>Various +Artists_15_The Smithsonian Collection of Classic Jazz Volume II_Jimmie +Lunceford & His Orchestra - Organ Grinder's +Swing.mp3</filename></quote>. These are neither very practical to +use, nor do they contain all of the useful information that you might +have collected about the song. Adding the album, and track number, +for example, to the first would make it even longer and more +unmanageable, while still not telling you at a glance the year it was +released, or what style of music it is, if you're not familiar with +the artist.</para> + +<para>The solution then, is to store this kind of metadata inside the +files themselves. Mp3 and ogg files can also contain small snippets of +text which you can use to describe the content of the file. There are +several formats, but &juk; hides the details of the differences +between them, and provides a standard way to edit a standard subset of +well known tags for all your audio files.</para> + +<para>&juk;'s full featured tag editor allows you to edit the tags in +both mp3 and ogg files. You can edit single files or multiple files, +and you can select a mix of mp3 and ogg files to edit. The only +requirement is that you have write access to the files themselves; you +cannot edit the tags of a file that is mounted from a &CD-ROM; for +example.</para> + +<sect2 id="tagging-a-single-file"> +<title>Editing the Tags in a Single File</title> + +<para>To edit the tag in a single file, select it in either the +collection list or any entries it has in any playlist. If the tag +editor is not visible, enable it by choosing +<menuchoice><guimenu>View</guimenu><guimenuitem>Show Tag +Editor</guimenuitem></menuchoice>. The tag editor displays in the +bottom of the list view.</para> + +<para>Simply type into any of the editable fields to change the +information. When you are done, &LMB; click back in the list, and you +will be prompted to save your changes.</para> + +<para>You may find that the tag editor remains disabled when you've +clicked on a file. This happens when &juk; has detected that the track +is read-only.</para> + +<variablelist> +<title>Tag Editor Fields</title> +<varlistentry> +<term><guilabel>Artist Name:</guilabel></term> +<listitem> +<para>The name of the Artist(s) who released the song.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Track name:</guilabel></term> +<listitem> +<para>The name of the song.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Album name:</guilabel></term> +<listitem> +<para>The name of the album the song was released on.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Genre:</guilabel></term> +<listitem> +<para>The <quote>Style</quote> of the music. &juk; provides a list +corresponding roughly to the informal id3 standard, but you are free +to type your own entries in this list.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>File name:</guilabel></term> +<listitem> +<para>The file name of the actual file on disk. You can edit this +directly, and when you save, the file will be renamed.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Track:</guilabel></term> +<listitem> +<para>The position of the track on the original recording.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Year:</guilabel></term> +<listitem> +<para>The year the song was released.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Length:</guilabel></term> +<listitem> +<para>This is not editable, it is simply shown for information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Bitrate:</guilabel></term> +<listitem> +<para>This is not editable, it is simply shown for information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Comment:</guilabel></term> +<listitem> +<para>You can add your own free text comment here, with additional +notes &etc;</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You can explicitly and immediately save your changes at any time +using the +<menuchoice><guimenu>Tagger</guimenu><guimenuitem>Save</guimenuitem></menuchoice> +menu entry or by pressing +<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>.</para> + +</sect2> + +<sect2 id="tagging-multiple-files"> +<title>Editing the Tags in Multiple Files</title> + +<para>You can select multiple files in the list view, and edit one or +more fields in the tags for all files at once.</para> + +<para>Use <keycap>Shift</keycap> and the &LMB; to select a contiguous +list of files, and &Ctrl; and &LMB; to select individual +non-contiguous files.</para> + +<para>If the tag editor is not visible, you can enable it by choosing +<menuchoice><guimenu>View</guimenu><guimenuitem>Show Tag +Editor</guimenuitem></menuchoice>. The tag editor displays in the +bottom of the list view.</para> + +<para>The tag editor behaves slightly differently when you have +selected multiple files.</para> + +<para>Each field in the tag editor will now show an +<guilabel>Enable</guilabel> check box next to it. Any field that has +exactly the same contents for all the files you selected, displays +that content, and is enabled for editing, with the +<guilabel>Enable</guilabel> check box checked.</para> + +<!-- put screeny here --> + +<para>Any field that does not have matching contents in all selected +files is not initially editable, and does not display any contents at +all.</para> + +<para>To change the content of any field, check the +<guilabel>Enable</guilabel> check box if it is not already checked, and +edit the field as you normally would.</para> + +<para>When you are done, &LMB; click back in the list view and you +will be prompted to save your changes. The prompt dialog will show +you a list of the affected files, so you have a chance to check that +you are indeed altering the files you intended to.</para> + +<para>You can explicitly and immediately save your changes at any time +using the +<menuchoice><guimenu>Tagger</guimenu><guimenuitem>Save</guimenuitem></menuchoice> +menu entry or by pressing +<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>.</para> + +</sect2> + +</sect1> + +<sect1 id="juk-rename-dialog"> +<title>The Rename File dialog</title> +<para> +<screenshot> +<screeninfo>The Rename File dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="juk-file-renamer.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot of the Rename File dialog.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>The File Renamer Configuration dialog box is used to configure the +Rename File action, which renames a song's based on the information contained +within its metadata tags. First the tags are altered according to the different +tokens you can alter, and then the tokens are used to generate the filename +according to the <guilabel>Filename scheme</guilabel>. +</para> + +<para>The most important part of the dialog is the <guilabel>Filename +scheme</guilabel> section. You can type a file name scheme here which &juk; +will use to rename the files. The way it works is that some characters are +special. +</para> + +<para><variablelist> +<varlistentry> +<term>%t</term> +<listitem><para>This will be replaced with the Title token upon evaluation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%a</term> +<listitem><para>This will be replaced with the Artist token upon evaluation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%A</term> +<listitem><para>This will be replaced with the Album token upon evaluation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%T</term> +<listitem><para>This will be replaced with the Track token upon evaluation.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%c</term> +<listitem><para>This will be replaced with the Comment token upon evaluation.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<para>Every token can contain %s, which is replaced with the actual tag, +and any text you want, including slashes (/). If a token has a slash, then +that will indicate a folder separator. Of course, it would be possible to +simply type folder separators in the <guilabel>Filename scheme</guilabel> +line.</para> + +<para>Using the tokens, however, allows us to completely ignore tags that are empty. +If you check the <guilabel>Need value</guilabel> check box, then the token will be +ignored if the corresponding tag is empty. For example, you could use this to separate +files with comments from those without by placing something such as +<replaceable>has-comment/%s</replaceable> in the <guilabel>Comment token</guilabel> +editor.</para> + +<para>You can test your filename scheme by using the <guilabel>Current filename</guilabel> editor +at the bottom of the dialog. Type in a filename of a music file, and the <guilabel>New +filename</guilabel> area will display would &juk; would rename the file as given the current +settings. +</para> +</sect1> + +<sect1 id="juk-tag-guesser-configuration"> +<title>The Tag Guesser Configuration dialog</title> +<para> +<screenshot> +<screeninfo>The Tag Guesser Configuration dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="juk-tag-guesser.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot of the Tag Guesser Configuration dialog.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>The Tag Guesser Configuration dialog is used to configure the +Guess from Filename command.</para> + +<para>In the dialog you will see a list on the left of different filename scheme patterns. +&juk; includes an extensive set of defaults patterns to match most common filenaming styles. +If you'd like to add a new scheme, click on the <guibutton>Add</guibutton> button, and type +in your scheme and click on <guibutton>OK</guibutton>. You may use the same percent +tokens as defined in the <link linkend="juk-rename-dialog">Rename Dialog Configuration</link>. +</para> + +<para>&juk; will try the schemes you have listed one at a time, starting at the top of the list. +The first scheme which results in a match will be the scheme used to guess the song's tags. +Some songs may match more than one scheme. You can make sure that the correct scheme matches +first by selecting the scheme in the list box and then using the arrow buttons to move it to the +top of the list. +</para> + +<para>You can also edit or remove a scheme from the list. Just select the scheme in the list, +and use the <guibutton>Modify</guibutton> button to change the scheme, or the +<guibutton>Remove</guibutton> button to remove the scheme from the list. +</para> +</sect1> + +<sect1 id="juk-advanced-search-dialog"> +<title>The Advanced Search dialog</title> +<para> +<screenshot> +<screeninfo>The Advanced Search dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="juk-adv-search.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot of the Advanced Search Dialog.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>The Advanced Search dialog is used to create <link linkend="juk-search-playlists">Search +Playlists</link>. It allows you create a fine-grained search among the different tags of +your song collection.</para> + +<para>At the top of the dialog, you can type in the name of your search playlist. Then, you +can define your search criteria in the <guilabel>Search Criteria</guilabel> group. +</para> + +<para>The top of the <guilabel>Search Criteria</guilabel> group has two radio buttons, +<guilabel>Match any of the following</guilabel> and <guilabel>Match all of the +following</guilabel>. If you select <guilabel>Match any of the following</guilabel>, then +a match by any of the conditions you define will include the song in the playlist. Otherwise, +every condition you define must match in order to include the song in the playlist. +</para> + +<para>Below the radio buttons are the condition definitions. You can add more conditions +by using the <guibutton>More</guibutton> button, and remove conditions by using the +<guibutton>Fewer</guibutton> button. Any conditions you leave blank are ignored, so you do +not have to use <guibutton>Fewer</guibutton> to eliminate empty conditions. +</para> + +<para>Every condition definition has three parts: The tag chooser list on the left, the +matching style list on the right, and the search text in the middle. The tag chooser +lets &juk; know what tag you want to search for the text in. If you choose the special +tag "<All Visible>", then any tag that you can see in the Collection List listing +is fair game to match the search text. +</para> + +<para>The match style list lets &juk; know which search method to use. +The search methods you can use are as follows: +<variablelist> +<varlistentry> +<term>Normal Matching</term> +<listitem><para>This is the default matching style. It searches for the given +text anywhere in the chosen tag, ignoring case differences. For example a +search for mode in the Artist tag would match Depeche Mode.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Case Sensitive</term> +<listitem><para>This search is just like Normal Matching, except that +the search must match the exact case of the text.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Pattern Matching</term> +<listitem><para>This is the most powerful search method. The search +text you type in will define a regular expression used to search within +the tag. Regular expressions are beyond the scope of this documentation, but +the application &kregexpeditor; can help you form a regular expression. +&juk; uses the &Qt; regular expression style.</para></listitem> +</varlistentry> + +</variablelist> + +</para> + +<para>Simply choose the conditions you want to include in your search, and +click <guibutton>OK</guibutton> to create your search playlist! +</para> +</sect1> + +<sect1 id="juk-cover-manager"> + +<title>The &juk; Cover Manager</title> + +<para>&juk; 2.3 (part of &kde; 3.5) includes improved cover management code which introduces some new possibilities for users compared with &juk; 2.2 (which was shipped with &kde; 3.4). It also can change the workflow slightly for you if you are used to the way covers were handled in &juk; 2.2. So first, let's review how things used to be.</para> + +<sect2 id="covers-in-juk-2.2"> +<title>How Covers Worked in &juk; 2.2</title> + +<para>In &juk; 2.2, the cover for a track was strictly tied to its <guilabel>Artist</guilabel> and <guilabel>Album</guilabel> information. Although this proved useful enough, and had a few advantages, it wasn't a great way to organize the covers. If you wanted to use a cover for a different track, you either had to rename the tags in the track, or you had to duplicate the cover, wasting hard disk space. And if your track had no <guilabel>Artist</guilabel> or <guilabel>Album</guilabel> information, &juk; would prevent you from setting a cover since it had no information to go by. It worked, but it could be better.</para> + +</sect2> + +<sect2 id="covers-in-juk-2.3"> + +<title>How Covers work in &juk; 2.3</title> + +<para>In &juk; 2.3, the code was redesigned to add a core component responsible for dealing with cover art. Instead of looking on disk for a picture file with a specific name like &juk; 2.2, the Cover Manager in &juk; 2.3 associates every cover with an identification tag, and then uses the tag with your music. It's still not perfect, but it works, and it can save you time while allowing you to do more.</para> + +<sect3 id="examples-adding-covers"> + +<title>Examples of adding covers</title> + +<para>So just as an example, let's say you wanted to set a cover for tracks you just ripped off of your &CD;. We'll use <quote>Alabama - Greatest Hits III</quote> for the sake of discussion. In &juk; 2.2, you could simply select any one of those tracks, and import a cover from the Internet by right-clicking on that track, and using the <menuchoice><guimenu>Tagger</guimenu> <guisubmenu>Cover Manager</guisubmenu> <guimenuitem>Get Cover From Internet</guimenuitem></menuchoice> command. As a side effect of the way &juk; worked, the cover would then be immediately applied to <emphasis>all</emphasis> of the <quote>Alabama - Greatest Hits III</quote> tracks, <emphasis>whether you wanted that or not</emphasis></para> + +<para>In &juk; 2.3, the procedure is exactly the same, with one exception: You should select all of the tracks you want to apply the cover to first. So you would select all the <quote>Alabama - Greatest Hits III</quote> tracks before using the <menuchoice><guimenuitem>Get Cover From Internet</guimenuitem></menuchoice> command. Or if you only wanted to set cover art to half of the tracks for some reason, you'd only select half the tracks before running the <menuchoice><guimenuitem>Get Cover From Internet</guimenuitem></menuchoice> command. Don't worry about duplicating covers, either: &juk; is smart enough to re-use the same image, so you won't get 14 duplicate <literal role="extension">.png</literal> images cluttering your hard drive.</para> +</sect3> + +<sect3 id="reusing-old-covers"> + +<title>Reusing Old Covers</title> + +<para>But what happens if you forgot to select all the tracks you wanted to tag? You could select them and repeat the process, but that would leave a duplicate cover on your hard drive because &juk; cannot quickly tell that the cover you've found is the same as one you already have. But that's alright, because you can tell &juk; to use the cover from another track.</para> + +<para>There are two ways of doing this:</para> + +<para>1. Open the <guilabel>Cover Manager</guilabel> dialog using the <guimenu>Tagger</guimenu> menu (<menuchoice><guimenu>Tagger Cover</guimenu> <guisubmenu>Manager</guisubmenu> <guimenuitem>Show Cover Manager</guimenuitem></menuchoice>). The Cover Manager will display a list of all the covers &juk; knows about on the right, and after they have loaded you can quickly pare the list down using the search line at the top, or by using the list of Artists on the left. Once you see the cover you want to use, you can drag-and-drop the cover onto a track to apply it. It should happen nearly instantaneously since &juk; is reusing the same cover (and you'll see the cover while you're dragging it as well). Unfortunately, it can take awhile to load the covers in the first place, and the Cover Manager isn't really useful for much else besides.</para> + +<para>2. I prefer to use this method because it's rather easy. All you do is double-click on the track that has the cover you want, in order to start it playing. This will cause its cover to show up in the <interface>Now Playing bar</interface>, and you can drag-and-drop the cover to the track you want to change exactly as you would for the Cover Manager.</para> + +</sect3> + +<sect3 id="dragging-covers"> + +<title>Dragging covers to more than one track at once</title> + +<para>Also note that you can use drag-and-drop to quickly apply covers to more than one track. Just select the tracks you want to apply a cover to, and drag the cover onto any one of the selected tracks.</para> +</sect3> + +<sect3 id="old-covers"> + +<title>What happens to my old covers?</title> + +<para>You may be wondering what &juk; will do if you already have covers from &juk; 2.2. What happens is that &juk; will automatically convert the old covers and merge them into the cover management system.</para> + +<para>Because this is a time consuming process, it does not happen all at once. Instead, the old cover is only converted when the cover needs to be shown on screen. As the conversion process is happening, &juk; will recognize what tracks would have shown the cover being converted, and will automatically apply the new cover to those tracks. The end result is that there should be no visible changes: &juk; will keep the same cover on your tracks that they've always had, except that now you can immediately take advantage of the new cover management features.</para> + +</sect3> +<sect3 id="removing-covers"> + +<title>Removing Covers</title> + +<para>Another side effect is that you can now remove a cover from a track without simultaneously removing it from all other tracks with the same <guilabel>Artist</guilabel> and <guilabel>Album</guilabel>.</para> + +<para>In &juk; 2.3, the Remove Cover command now only removes the covers from the selected tracks. +</para> + +</sect3> +<sect3 id="suggested-use"> + +<title>Suggested Uses:</title> + +<para>1. You can now apply the same cover to tracks with Albums that have <quote>Disc 1</quote>, <quote>Disc 2</quote>, etc, which you couldn't do in &juk; 2.2 without duplicating the cover.</para> + +<para> +2. Applying a generic cover to tracks if you simply must have a cover on every track, or if you have music that wasn't released as an album but fits a genre well. You could make yourself a cover for that type of music and apply it to the songs in question.</para> + +</sect3> +</sect2> +</sect1> + +</chapter> + +<chapter id="toolbar-reference"> +<title>The &juk; Toolbar</title> + +<sect1 id="main-toolbar"> +<title>The Main Toolbar</title> + +<screenshot> +<screeninfo>The &juk; toolbar.</screeninfo> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="toolbar.png" /> +</imageobject> +<textobject> +<phrase>The &juk; toolbar.</phrase> +</textobject> +<caption><para>The &juk; toolbar.</para></caption> +</mediaobject> +</screenshot> + +<para>From left to right in the screenshot above, the icons on the +default toolbar are:</para> + +<variablelist> +<varlistentry> +<term><guiicon>New</guiicon></term> +<listitem><para>Create a new playlist. If you hold down the button, a +menu will pop up allowing you to select the different kinds of playlists +to create. +</para> + <variablelist> + <varlistentry><term><guimenuitem>Empty Playlist...</guimenuitem></term> + <listitem><para>This prompts you for a playlist name, and then inserts it into the + Playlist view. The playlist starts out completely empty.</para></listitem> + </varlistentry> + + <varlistentry><term><guimenuitem>Playlist From Folder...</guimenuitem></term> + <listitem><para>This prompts you for a folder to open, and then creates a playlist + containing the music within the folder and any sub-folders. The name of the created + playlist is the same as the name of the selected folder.</para></listitem> + </varlistentry> + + <varlistentry><term><guimenuitem>Search Playlist...</guimenuitem></term> + <listitem><para>This brings up the Advanced Search Dialog, allowing you to create a + <quote>virtual playlist</quote>. Any songs in your Collection List that match the search + criteria that you specify in the Advanced Search Dialog will be added to the new playlist. + As your Collection List changes, the new playlist will as well. For example, if you create a playlist + of all of your Depeche Mode songs, and then add another Depeche Mode song to your Collection List, + it will show up in the Depeche Mode playlist with no special action required on your part. + </para></listitem> + </varlistentry> + + </variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Open</guiicon></term> +<listitem><para>Add a file to the collection list (if it's active) or +to the currently selected playlist. Adding a file to a playlist will +add it to the collection list automatically, but not vice +versa.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Save</guiicon></term> +<listitem><para>Save the currently selected playlist. To save a tag +you have edited, either select another item, or press <keycombo +action="simul">&Ctrl;<keycap>T</keycap></keycombo> +instead.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Cut</guiicon></term> +<listitem><para>If a playlist or song is selected, cut (remove) it from the +list. If the tag editor is active, this works like cut in any editor, +removing the selected text, but keeping a copy on the +clipboard.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Copy</guiicon></term> +<listitem><para>If the tag editor is active, this works like copy in +any editor, placing a copy of the selected text on the +clipboard.</para> +<para>If you use copy on a song in the collection list, the url is +placed on the clipboard, so you can paste it. For example, you could +paste the url into a text editor, &konqueror;, or another +playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Paste</guiicon></term> +<listitem><para>If you previously either cut or copied a url from the +collection list, you can paste the url back into a new playlist. You +could also paste a url you have copied from &konqueror; or any other +application. If you are operating in the tag editor, paste will paste +any text currently on the clipboard into the selected +field.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Show Search Bar</guiicon></term> +<listitem><para>Show or hide <link linkend="search-bar">the search +bar</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Show Tag Editor</guiicon></term> +<listitem><para>Show or hide <link linkend="tagging-a-single-file">the +tag editor</link>.</para></listitem> +</varlistentry> + +<varlistentry id="play-toolbar"> +<term>Play controls</term> +<listitem> +<para>These work like any standard media player you may have come +across. The controls are <guiicon>Play</guiicon>, +<guiicon>Pause</guiicon>, <guiicon>Stop</guiicon>, <guiicon>Skip to +the previous song</guiicon> and <guiicon>Skip to the next +song</guiicon>.</para> +<para>There is also a tracking bar, showing how far along (relatively) +in the current song you are. You can drag this slider with the mouse +in order to skip forwards or backwards within a track.</para> +<para>Finally there is a volume slider. As you may expect, this +raises and lowers the volume. <quote>Loud</quote> is on the right, +and <quote>Quiet</quote> is on the left.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="search-bar"> +<title>The Search bar</title> + +<para>The search bar allows you to quickly search for a song in the +collection list or a playlist.</para> + +<para>Simply typing text into the search bar will reduce the visible +list of songs to those which contain that text in any visible +column. Pressing <keycap>Enter</keycap> will start playing the top match in the playlist view.</para> + +<para>Searching begins instantly when text is entered into the search +field. Searching is incremental, that is, as you type each character +into the text field, the search is narrowed further. This is useful +to find a song where you only remember part of a name, for +instance.</para> + +<para>If you would like to make a more fine-grained search, you can click +the Advanced Search button to the right of the search bar, which will allow +you to create a virtual playlist. If you would like to cancel the search, +you can simply click on the Clear button to the left of the search bar.</para> + +</sect1> + +</chapter> + +<chapter id="menu-and-command-reference"> +<title>Menu and Command Reference</title> + +<sect1 id="menus"> +<title>Menus</title> + +<sect2 id="menu-file"> +<title><guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Empty Playlist...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Create a new playlist</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Playlist From +Folder...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Creates a new playlist, containing all music files +in a folder and any sub-folders. Any music within playlists files that +&juk; recognizes will also be added.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Search Playlist...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Creates a new <link linkend="juk-search-playlists">search playlist</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Select a file (or files) to add to the collection list. If you select +a playlist file, every file in the playlist will be added.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu><guimenuitem>Add Folder...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Select a folder (or folders) to add to the +collection list. These folders will also be rescanned whenever +&juk; is started or +<menuchoice><guimenu>File</guimenu><guimenuitem>Reload</guimenuitem> +</menuchoice> is chosen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Rename...</guimenuitem></menuchoice> +</term> +<listitem><para>Rename a playlist.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu><guimenuitem>Duplicate...</guimenuitem></menuchoice> +</term> +<listitem><para>Create a duplicate of the selected playlist, and +prompt for a new name. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu><guimenuitem>Reload</guimenuitem></menuchoice> +</term> +<listitem><para>Reloads the tag information on every file in the selected +playlist. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>File</guimenu><guimenuitem>Remove</guimenuitem></menuchoice></term> +<listitem><para>Remove the selected playlist.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu><guimenuitem>Save</guimenuitem> +</menuchoice> +</term> +<listitem><para>Save the selected playlist.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Save the selected playlist, with a different name.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="menu-edit"> +<title><guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu><guimenuitem>Clear</guimenuitem> +</menuchoice> +</term> +<listitem><para>Removes the selected songs from the playlist.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="menu-view"> +<title><guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guimenuitem>Show Search Bar</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle action that sets whether or not the +<link linkend="search-bar">Search Bar</link> is shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guimenuitem>Show Tag Editor</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle action that sets whether or not the +<interface>Tag Editor</interface> is shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guimenuitem>Show History</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle action that sets whether or not the +<link linkend="juk-history-playlists">History Playlist</link> is shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guisubmenu>View Modes</guisubmenu><guimenuitem>Default</guimenuitem> +</menuchoice> +</term> +<listitem><para>Switches to <link linkend="juk-viewmode-default">Default View mode</link>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guisubmenu>View Modes</guisubmenu><guimenuitem>Compact</guimenuitem> +</menuchoice> +</term> +<listitem><para>Switches to <link linkend="juk-viewmode-compact">Compact View mode</link>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guisubmenu>View Modes</guisubmenu><guimenuitem>Tree</guimenuitem> +</menuchoice> +</term> +<listitem><para>Switches to <link linkend="juk-viewmode-tree">Tree View mode</link>. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="menu-player"> +<title><guimenu>Player</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Random Play</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option which controls the Random Play setting. +If Random Play is enabled, then &juk; will randomly select a random song from the +current playlist when the currently playing song is over.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Loop Playlist</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option which controls the Loop Playlist setting. +If Loop Playlist is enabled, then &juk; will start playing from the beginning when +it has finished playing every song in the current playlist.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Play</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command starts playing the currently selected song, or resumes +playback of the song if it was paused.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Pause</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command pauses the currently playing song. Use the +Play command to restart playback.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Stop</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command stops the playback of the currently playing song. +You cannot resume playback from its current position after that.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Previous Track</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command plays the song that was playing before +the currently playing song.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Player</guimenu><guimenuitem>Next Track</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command skips to the next song to play in the +playlist.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="menu-tagger"> +<title><guimenu>Tagger</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"><keycap>Ctrl</keycap><keycap>T</keycap></keycombo></shortcut> +<guimenu>Tagger</guimenu><guimenuitem>Save</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command saves any changes to the tags that you are +editing. Normally, changes are not saved until you deselect the file you +are editing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tagger</guimenu><guimenuitem>Delete</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command deletes the currently selected files from +the Collection List and any playlists containing it, and then deletes +the selected file from the disk. +<!-- God this is a dumb place to put this particular command --></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"><keycap>Ctrl</keycap><keycap>F</keycap></keycombo></shortcut> +<guimenu>Tagger</guimenu><guisubmenu>Guess Tag +Information</guisubmenu><guimenuitem>From Filename</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command tries to guess the tags of the selected files +by scanning the filename. You can configure the patterns used for guessing +by selecting <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Tag Guesser...</guimenuitem></menuchoice>, which opens the +<link linkend="juk-tag-guesser-configuration">Tag Guesser Configuration dialog</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"><keycap>Ctrl</keycap><keycap>I</keycap></keycombo></shortcut> +<guimenu>Tagger</guimenu><guisubmenu>Guess Tag +Information</guisubmenu><guimenuitem>From Internet</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command tries to guess the tags of the selected files +by using the <application>trm</application> provided with +<ulink url="http://www.musicbrainz.org/">MusicBrainz</ulink>.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="menu-settings"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Show Main Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command shows or hide the <link linkend="main-toolbar">Main +Toolbar</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Show Play Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command shows or hide the <link linkend="play-toolbar">Play +Toolbar</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Splash Screen on Startup</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option. If enabled, &juk; will display +an informational screen upon startup as it loads your music collection.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Dock in System Tray</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option. If enabled, &juk; will display an +icon in your system tray. You can use the system +tray icon to tell if &juk; is playing, and control playback.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Stay in System Tray on Close</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option. If enabled, &juk; will remain +running if you close the main window. The Dock in System Tray option must +also be enabled. To quit &juk;, use the <menuchoice><guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem></menuchoice> command from the main window, or +the <guimenuitem>Quit</guimenuitem> command from the system tray's context +menu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Popup Track Announcement</guimenuitem> +</menuchoice> +</term> +<listitem><para>This is a toggle option. If enabled, &juk; will display +an indicator whenever a song starts playing, with information on the artist and +title, and with buttons allowing you to quickly switch to a different song. The +Dock in System Tray option must also be enabled.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Tag Guesser...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command brings up the <link linkend="juk-tag-guesser-configuration">Tag Guesser Configuration +dialog box</link>, where you can alter the patterns used to guess tag information +from filenames.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>File Renamer...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This command brings up the <link linkend="juk-rename-dialog">File Renamer Configuration +dialog box</link>, where you can alter the way &juk; renames files for you.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This brings up the standard &kde; dialog box where you can configure +keyboard shortcuts for &juk;. Some reasonable defaults are included as well, including +Multimedia keys for people who have multimedia keyboards.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +</sect1> + +<sect1 id="keybindings"> +<title>Keybinding Reference</title> + +<!-- +ctrl-a select all +ctrl-c copy +ctrl-r rename file +ctrl-i guess tag entries from internet +ctrl-f guess tag entries based on filename +ctrl-f new search playlist +ctrl-n new empty playlist +ctrl-d new playlist from folder +ctrl-o open file (add to the collection or a playlist) +ctrl-q quit +ctrl-s save +ctrl-t save edited tag information +ctrl-v paste +ctrl-x cut +f1 Show manual +shift-f1 what's this help + +--> +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Key Combination</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>A</keycap></keycombo></entry> +<entry>Select all</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></entry> +<entry>Copy</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>R</keycap></keycombo></entry> +<entry>Rename file</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>I</keycap></keycombo></entry> +<entry>Guess tags from the Internet.</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>G</keycap></keycombo></entry> +<entry>Guess tags from the filename.</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>F</keycap></keycombo></entry> +<entry>New <link linkend="juk-search-playlists">search playlist</link>.</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></entry> +<entry>Guess tag entries based on filename</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry> +<entry>New empty Playlist</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>D</keycap></keycombo></entry> +<entry>New playlist from folder.</entry> +</row> +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>T</keycap></keycombo></entry> +<entry>Save changes to edited tags.</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</sect1> +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para>&juk; Copyright © 2002, 2003, 2004 &Scott.Wheeler;.</para> + +<para>&juk; is developed and maintained by &Scott.Wheeler; +&Scott.Wheeler.mail;.</para> + +<para>Many thanks to the following people who have contributed to &juk;:</para> + +<itemizedlist> +<listitem><para>&Daniel.Molkentin; &Daniel.Molkentin.mail; for system tray docking, <quote>inline</quote> tag +editing, bug fixes, evangelism, moral support.</para> +</listitem> +<listitem><para>Tim Jansen <email>tim@tjansen.de</email> for +the <application>GStreamer</application> port</para> +</listitem> + +<listitem><para>Stefan Asserhäll <email>stefan.asserhall@telia.com</email> +for global shortcut support.</para> +</listitem> + +<listitem><para>Stephen Douglas <email>stephen_douglas@yahoo.com</email> +for track announcement popups.</para> +</listitem> + +<listitem><para>&Frerich.Raabe; &Frerich.Raabe.mail; +for automagical track data guessing, and bugfixes.</para> +</listitem> + +<listitem><para>Zack Rusin <email>zack@kde.org</email> +for more automagical things, including MusicBrainz support.</para> +</listitem> + +<listitem><para>Adam Treat <email>manyoso@yahoo.com</email> +for co-conspiring in MusicBrainz wizardry.</para> +</listitem> + +<listitem><para>Matthias Kretz <email>kretz@kde.org</email> +for being the friendly neighborhood &arts; guru.</para> +</listitem> + +<listitem><para>Maks Orlovich <email>maksim@kde.org</email> +for making &juk; friendlier to people with terabytes of music.</para> +</listitem> + +<listitem><para>Antonio Larrosa Jimenez <email>larrosa@kde.org</email> +for the &DCOP; interface.</para> +</listitem> + +</itemizedlist> + +<para>Documentation Copyright © 2003, &Lauri.Watts;, and copyright +© 2004 Michael Pyne.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +&documentation.index; + +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +--> |