Warning, /multimedia/libkcddb/kcmcddb/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY kappname "&kscd;">
0004   <!ENTITY package "kdemultimedia">
0005   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0006   <!ENTITY % addindex "IGNORE">
0007 ]>
0008 
0009 <article id="kcmcddb" lang="&language;">
0010 
0011 <articleinfo>
0012 <title>CDDB Retrieval</title>
0013 
0014 <authorgroup>
0015 
0016 <author>
0017 <firstname>Mike</firstname>
0018 <surname>McBride</surname> 
0019 <affiliation><address>&Mike.McBride.mail;</address></affiliation>
0020 </author>
0021 
0022 <author>
0023 <firstname>Jonathan</firstname>
0024 <surname>Singer</surname>
0025 <affiliation><address>&Jonathan.Singer.mail;</address></affiliation>
0026 </author>
0027 
0028 <author>
0029 <firstname>David</firstname>
0030 <surname>White</surname>
0031 <affiliation><address><email>a9403784@unet.univie.ac.at</email></address>
0032 </affiliation>
0033 </author>
0034 
0035 <othercredit role="developer">
0036 <firstname>Bernd</firstname>
0037 <othername>Johannes</othername>
0038 <surname>Wuebben</surname>
0039 <affiliation><address>&Bernd.Johannes.Wuebben.mail;</address></affiliation>
0040 <contrib>Developer</contrib>
0041 </othercredit>
0042 
0043 <othercredit role="developer">
0044 <firstname>Dirk</firstname>
0045 <surname>Forsterling</surname>
0046 <affiliation><address><email>milliByte@gmx.net</email></address></affiliation>
0047 <contrib>Developer</contrib>
0048 </othercredit>
0049 
0050 <othercredit role="developer">
0051 <firstname>Dirk</firstname>
0052 <surname>Foersterling</surname>
0053 <affiliation><address><email>milliByte@gmx.net</email></address></affiliation>
0054 <contrib>Developer</contrib>
0055 </othercredit>
0056 
0057 <othercredit role="reviewer">
0058 <firstname>Lauri</firstname>
0059 <surname>Watts</surname>
0060 <affiliation><address>&Lauri.Watts.mail;</address></affiliation>
0061 <contrib>Reviewer</contrib>
0062 </othercredit>
0063 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0064 </authorgroup>
0065 
0066 <copyright>
0067 <year>2000</year><year>2004</year>
0068 <holder>J Singer</holder>
0069 
0070 </copyright>
0071 <copyright>
0072 
0073 <year>2005-2006</year>
0074 <holder>&Mike.McBride;</holder>
0075 </copyright>
0076 
0077 <date>2013-12-05</date>
0078 <releaseinfo>&kde; 4.12</releaseinfo>
0079 
0080 </articleinfo>
0081 
0082 <sect1 id="cddb-page">
0083 <title>CDDB Retrieval</title>
0084 <para>The module <guilabel>CDDB Retrieval</guilabel> is divided in the <guilabel>Lookup</guilabel> tab
0085 and the <guilabel>Submit</guilabel> tab.</para>
0086 
0087 <sect2 id="lookup-tab">
0088 <title>The Lookup Tab</title>
0089 <screenshot>
0090 <screeninfo>The <guilabel>Lookup</guilabel> tab</screeninfo>
0091 <mediaobject>
0092 <imageobject> <imagedata fileref="kscd14.png" format="PNG"/> </imageobject>
0093 <textobject><phrase>The <guilabel>Lookup</guilabel> tab</phrase></textobject>
0094 </mediaobject>
0095 </screenshot>
0096 
0097 <para> The <guilabel>Lookup</guilabel> tab sets up the <acronym>CDDB</acronym> functions
0098 of &kde;.</para>
0099 
0100 <para>You can select the options <guilabel>Enable MusicBrainz lookup</guilabel> or <guilabel>Enable freedb lookup</guilabel>.</para>
0101 
0102 <para>The <guilabel>Freedb server</guilabel> section determines which CDDB mirror site is used by &kde; to 
0103 get album information.  You can enter a server name, port number and protocol using the text boxes and drop 
0104 down boxes or you can click the <guibutton>Show Mirror List</guibutton> button.  Clicking this button will 
0105 open a new window with a list of CDDB mirrors and their locations.  Simply select the server you want from 
0106 the list and click <guibutton>OK</guibutton>.</para>
0107 
0108 <para>The section labeled <guilabel>Cache Locations</guilabel> lets you determine where the CDDB information 
0109 is saved on your computer.  To add a folder, enter the folder location in the text box at the top of the section and click 
0110 <guibutton>Add</guibutton>.  You can also select a 
0111 folder by clicking on the blue file folder to the right of the text box. To delete a folder, click on the folder name 
0112 once with the &LMB; and click <guibutton>Remove</guibutton>. You can change the order the folders are searched by 
0113 clicking on the folder name and clicking on the <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons.</para>
0114 
0115 <para>The <guibutton>Help</guibutton> button opens the this help contents
0116 page. The <guibutton>Defaults</guibutton> button restores the default values of all entries in this dialog; <guibutton>OK</guibutton> saves the current settings and exits;
0117 <guibutton>Apply</guibutton> saves the current settings without exiting.</para>
0118 
0119 </sect2>
0120 
0121 <sect2 id="submit-tab">
0122 <title>The Submit Tab</title>
0123 
0124 <screenshot>
0125 <screeninfo>The Submit tab</screeninfo>
0126 <mediaobject>
0127 <imageobject><imagedata fileref="kscd16.png" format="PNG"/></imageobject>
0128 </mediaobject>
0129 </screenshot>
0130 
0131 <para>The <guilabel>Submit</guilabel> tab sets up connection to a mail
0132 server or a web server to submit new <acronym>CDDB</acronym> entries. This is useful
0133 if you do not have your own system configured as a server. </para>
0134 
0135 <para>If you plan to submit a CDDB entry, enter your email address into the first textbox.  </para>
0136 <para>You can enter a server name or port number in the text boxes provided.  If 
0137 you want to send this information to the international servers, you do not need to 
0138 change anything.</para>
0139 </sect2>
0140 </sect1>
0141 
0142 <!-- follwing chapters need proofreading -->
0143 <sect1 id="cddb-editor">
0144 <title>The CD Database Editor</title>
0145 
0146 <screenshot>
0147 <screeninfo>The &CD; Database Editor</screeninfo>
0148 <mediaobject>
0149 <imageobject><imagedata fileref="kscd13.png" format="PNG"/></imageobject>
0150 <textobject><phrase>The &CD; Database Editor</phrase></textobject>
0151 </mediaobject>
0152 </screenshot>
0153 
0154 <para>The &CD; Database Editor allows you to modify, download, save, annotate,
0155 and upload <link linkend="cddb-support"><acronym>CDDB</acronym> (Compact Disc
0156 Data Base)</link> entries.</para>
0157 
0158 <para>If there is an entry in your local <acronym>CDDB</acronym> tree
0159 (see the <link linkend="cddb-page">CDDB subsection</link> in the
0160 Configuration chapter) for the &CD; in your &CD-ROM; drive, or if the
0161 disc could be found in the freedb, you will see the name of the artist
0162 and the title of the &CD; in the <guilabel>Artist:</guilabel> and
0163 <guilabel>Title</guilabel> fields and a list of tracks with song
0164 titles in the <interface>Tracks</interface> selection box. Otherwise,
0165 you will see a list of tracks and play times without titles.</para>
0166 
0167 <para>You can make an annotation for the entire disc with the
0168 <guilabel>Comment</guilabel> field under the
0169 <guilabel>Title</guilabel> field, or for a selected track in the
0170 <guilabel>Tracks</guilabel> selection box with the adjacent
0171 <guibutton>Comment</guibutton> button. If you select a track in the
0172 <guilabel>Tracks</guilabel> selection box, the title, if present, will
0173 appear in the <guilabel>Title</guilabel> field below. You can type a
0174 title for the track in the box, or edit the entry to suit your
0175 needs. Press the <keycap>Return</keycap> key on your keyboard, and the
0176 text will appear in the proper line in the selection box.</para>
0177 
0178 <para>Once all tracks have been given titles and the
0179 <guilabel>Artist:</guilabel> and <guilabel>Title</guilabel> fields have
0180 been filled out, you can press the <guibutton>Upload</guibutton>
0181 button to send your submission by email to freedb.</para>
0182 
0183 <para>You will be prompted to select a category for the
0184 submission. The <guilabel>Disc ID</guilabel> section displays the 32
0185 bit <acronym>ID</acronym> code used by freedb to identify a compact
0186 disc. Above the <acronym>ID</acronym> code is the category of the
0187 <guilabel>freedb</guilabel> entry. These categories correspond to the
0188 subfolders tree of the folder chosen in the <guilabel>freedb
0189 Base Folder:</guilabel> in the <link
0190 linkend="cddb-page"><guilabel>CDDB</guilabel> page</link> of the 
0191 configuration window.</para>
0192 
0193 <para>The <guilabel>Length:</guilabel> display shows the total play time of
0194 the &CD;.</para>
0195 
0196 <para>Press the <guibutton>Fetch Info</guibutton> button to download 
0197 <acronym>CDDB</acronym> data.
0198 Press the <guibutton>OK</guibutton> button to save your changes locally.
0199 The <guibutton>Cancel</guibutton> button closes the &CD;
0200 Database Editor without saving.</para>
0201 
0202 </sect1>
0203 
0204 <sect1 id="cddb-support">
0205 <title><acronym>CDDB</acronym> Support</title>
0206 
0207 <para>freedb is a distributed network database accessible
0208 over the Internet that contains information about most audio &CD;s in
0209 circulation. If you have Internet access, you will likely never have to manually
0210 enter track information for your &CD;s if you have this set up properly. See
0211 <link linkend="cddb-page">The CDDB Page</link> section 
0212 for detailed instructions on how to configure this service, and
0213 the <link linkend="cddb-editor">&CD; Database Editor</link> section for
0214 instructions on how to edit <acronym>CDDB</acronym> entries.</para>
0215 
0216 <para>Use of the <acronym>CDDB</acronym> is free. Submissions from users are
0217 encouraged.</para>
0218 
0219 <para>When preparing entries for the <acronym>CDDB</acronym>, please keep the
0220 following points in mind:</para>
0221 
0222 <itemizedlist>
0223 <listitem><para>Use <quote>standard</quote> latin characters in the entries. Some
0224 special characters are supported, but Cyrillic or Greek alphabet submissions,
0225 for example, cannot be accepted.</para></listitem>
0226 <listitem><para>Use only one <keysym>/</keysym> character in the
0227 <guilabel>Disc Artist / Title</guilabel> field in the &CD; Database
0228 Editor.</para>
0229 
0230 <para>For classical &CD;s, it is standard practice to put the composer's name in
0231 the Artist section (before the slash) and the performer's name in the Title
0232 section (after the slash).</para></listitem> 
0233 <listitem><para>If you send an entry that already exists in the database, any
0234 additional information you provide may be added to the existing entry.</para>
0235 </listitem>
0236 </itemizedlist>
0237 
0238 <para>By default, the standard <acronym>CDDB</acronym>
0239 categories are installed in <filename class="directory">$HOME/.cddb</filename>. You can create as
0240 many category subfolders as you like. However, when uploading, only the
0241 official <acronym>CDDB</acronym> categories are displayed. The default upload
0242 address is <email>gnudb-submit@gnudb.org</email>. For more information about
0243 <abbrev>gnudb</abbrev> visit the <abbrev>gnudb</abbrev> homepage.</para>
0244 
0245 <para>The local <acronym>CDDB</acronym> entry for a particular &CD; is stored in
0246 the file <filename><replaceable>category name</replaceable>/<replaceable>disc
0247 ID</replaceable></filename> under the <acronym>CDDB</acronym> Base
0248 Folder. These files can be edited with any text editor.</para>
0249 </sect1>
0250 
0251 </article>
0252 <!--
0253 Local Variables:
0254 mode: sgml
0255 sgml-minimize-attributes: nil
0256 sgml-general-insert-case: lower
0257 End:
0258 -->