Commit 19f653ae authored by Urs Fleisch's avatar Urs Fleisch
Browse files

document new features

parent 22e6dadd
Sat Feb 14 17:45:43 CET 2009 Urs Fleisch <ufleisch@users.sourceforge.net>
* New:
+ Import of album cover art from various sources.
+ Mark changed tag fields and filenames.
+ Option to store ID3v2 genre as text instead of numeric string.
* Improved:
+ Directory deb to generate Debian packages for KDE 4 and Qt 4 or
KDE 3 and Qt3.
* Fixed:
+ Format replacements %c, %y, ... are replaced with empty
strings if the corresponding field is empty
+ Charset for gnudb.org import.
+ ID3v1 fields are displayed correctly after saving when the
ID3v2.3 encoding is set to UTF16.
Sat Sep 27 15:51:35 CEST 2008 Urs Fleisch <ufleisch@users.sourceforge.net>
* Release 1.1
......
......@@ -527,6 +527,8 @@ es wird ebenfalls eine Liste mit Alben zur Auswahl gestellt.
Wenn <guilabel>Zusätzliche Tags</guilabel> markiert ist, werden mehr
verfügbare Informationen importiert, z.B. Interpreten, Arrangierer oder der
Herausgeber.
Wenn <guilabel>Cover-Bilder</guilabel> markiert ist, werden Cover-Bilder
heruntergeladen, falls vorhanden.
</para>
<para id="import-musicbrainzrelease">
In der gleichen Art kann mit <guibutton>Von MusicBrainz Album</guibutton>
......@@ -708,6 +710,50 @@ wie <guimenuitem>Importieren...</guimenuitem>, öffnet jedoch direkt auch
den <guibutton>Von MusicBrainz Fingerprint</guibutton> Dialog.</para></listitem>
</varlistentry>
<varlistentry id="browse_pictures">
<term><menuchoice>
<guimenu>Datei</guimenu>
<guimenuitem>Nach Cover-Bildern suchen...</guimenuitem>
</menuchoice></term>
<listitem>
<para>
Der Dialog <action>Nach Cover-Bildern suchen</action> hilft bei der Suche nach
Album Cover-Bildern. <guilabel>Interpret/Album</guilabel> werden wenn möglich
aus den Tags übernommen. <guilabel>Quelle</guilabel> stellt eine Vielzahl von
Websites mit Cover-Bildern zur Verfügung. Unter dem Namen ist die URL mit
Interpret und Album als Parametern angegeben. Für URL-codierte Werte können
dabei <userinput>%u{artist}</userinput> und <userinput>%u{album}</userinput>
angegeben werden oder auch andere Werte aus
den Tags, wie in <link linkend="configure-kid3">Kid3 einrichten</link>
bei <guilabel>Benutzerbefehle</guilabel> beschrieben. Nach "Custom Source"
können auch eigene Quellen hinzugefügt werden. Dazu wird "Custom Source" durch
den Namen der Quelle ersetzt, dann Return gedrückt, die URL eingegeben und mit
<guibutton>Einstellungen speichern</guibutton> gesichert. Das resultierende
Browser-Kommando wird oben im Dialog dargestellt und nach Drücken des
<guibutton>Browser</guibutton>-Knopfes ausgeführt. Der Browser, welcher in den
Einstellungen konfiguriert werden kann, wird mit der gewählten Quelle
gestartet. Das gewünschte Cover-Bild kann dann aus dem Browser in das &kid3;
Fenster gezogen werden und wird im Bild-Feld von Tag 2 der selektierten
Dateien gesetzt.
</para>
<para>
Da nicht alle Browser Drag'n'Drop von Bildern unterstützen und häufig die
Bilder auf Websites mit einer URL unterlegt sind, erhält &kid3; in solchen
Fällen bloss die entsprechende URL und nicht das Bild. Wenn die URL auf ein
Bild zeigt, wird dieses heruntergeladen. Falls die URL jedoch auf sonst eine
Website hinweist, so muss von dieser auf das gewünschte Cover-Bild geschlossen
werden. Dies ist die Aufgabe der Tabelle <guilabel>URL
Ersetzung</guilabel>. Die linke Spalte <guilabel>Vergleich</guilabel> enthält
einen regulären Ausdruck, welcher mit der URL verglichen wird. Wenn eine
Übereinstimmung festgestellt wird, so werden die erhaltenen Klammer-Werte im
Muster der Spalte <guilabel>URL des Bildes</guilabel> ersetzt (\1 usw.). Der
ersetzte reguläre Ausdrucks enthält dann die URL des Bildes. Auf diese Weise
können auch Bilder von Amazon, Google Images, usw. per Drag'n'Drop importiert
werden. Natürlich können auch hier eigene Ersetzungen erfasst werden.
</para>
</listitem>
</varlistentry>
<varlistentry id="export">
<term><menuchoice>
<guimenu>Datei</guimenu>
......@@ -1161,6 +1207,15 @@ ungesicherte Änderungen werden konvertiert.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Einstellungen</guimenu>
<guimenuitem>Bild ausblenden</guimenuitem>
</menuchoice></term>
<listitem><para><action>Schaltet die Anzeige des Cover-Bildes ein und aus.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Einstellungen</guimenu>
......@@ -1214,6 +1269,18 @@ Das Markierungsfeld
<guilabel>Benutze Format Nummer/Anzahl Stücke</guilabel> bewirkt, dass im
Tracknummer-Feld bei den ID3v2 Tags nicht bloß die Tracknummer gespeichert
wird, sondern auch die Gesamtzahl der Stücke im Verzeichnis.
</para>
<para>
Wenn <guilabel>Stil als Text statt als Nummer</guilabel> aktiviert ist, werden
alle Stile als Text gespeichert, auch wenn ein ID3v1-Code für den Stil
existiert. Ohne diese Einstellungen werden solche Stile als die Nummer des
entsprechenden ID3v1-Codes gespeichert (in Klammern für ID3v2.3). Der Stil
Metal wird also abhängig von dieser Option entweder als "Metal" oder als "(9)"
gespeichert. Stile, für welche kein ID3v1-Code existiert, werden immer als
Text gespeichert. Der Sinn dieser Option ist es, die Kompatibilität mit
Geräten zu verbessern, welche die Codes nicht korrekt interpretieren.
</para>
<para>
<guilabel>Text Codierung</guilabel> bestimmt die Codierung von ID3v2
Elementen und kann
auf <guilabel>ISO-8859-1</guilabel>, <guilabel>UTF16</guilabel> oder
......@@ -1221,12 +1288,16 @@ auf <guilabel>ISO-8859-1</guilabel>, <guilabel>UTF16</guilabel> oder
ID3v2.3.0 nicht gültig; wenn dieser Wert gesetzt ist, wird
stattdessen <guilabel>UTF16</guilabel> verwendet.
Für ID3v2.4.0 sind alle drei Codierungen möglich.
</para>
<para>
<guilabel>Version für neue Tags</guilabel> legt fest, ob neue ID3v2 Tags mit
der Version 2.3.0 oder 2.4.0 erzeugt werden. Im ersteren Fall wird id3lib
verwendet, TagLib kommt nur dann zum Einsatz, wenn ein ID3v2.4.0 Tag
bearbeitet werden muss. Mit der Einstellung <guilabel>ID3v2.4.0
(TagLib)</guilabel> wird für MP3-Dateien immer die TagLib verwendet;
veränderte oder neu erstellte Tags werden dann als ID3v2.4.0 gespeichert.
</para>
<para>
Das Auswahlfeld
<guilabel>Name des Kommentar-Feldes</guilabel> ist für Ogg/Vorbis und
FLAC-Dateien relevant und bestimmt den Namen des Feldes, welches für
......@@ -1285,6 +1356,10 @@ Auf der Seite <guilabel>Dateien</guilabel>, kann mit dem Markierungsfeld
dass die Modifikationszeit der Datei nicht verändert wird.
</para>
<para>
Wenn <guilabel>Änderungen markieren</guilabel> aktiviert ist, werden veränderte
Felder markiert, indem der Hintergrund des Namens grau gesetzt wird.
</para>
<para>
<guilabel>Dateinamen Format</guilabel> enthält Einstellungen für das
Format der Dateinamen. Dabei sind die selben Optionen wie bei
<guilabel>Tag Format</guilabel> möglich.
......@@ -1522,11 +1597,8 @@ werden, was verwendet werden soll. Die Voreinstellung ist
</para>
<para>
Für die Erzeugung von RPM-Paketen ist die Datei <filename>kid3.spec</filename>
vorhanden, für Debian-Pakete stehen die Skripte
<filename>build-deb-kde3.sh</filename>,
<filename>build-deb-qt.sh</filename> und
<filename>build-deb-kde4.sh</filename>
zur Verfügung.
vorhanden, für Debian-Pakete steht das Skript
<filename>build-deb.sh</filename> zur Verfügung.
</para>
<para>
Um &kid3; mit KDE 4 zu kompilieren, wird
......@@ -1684,6 +1756,19 @@ spezifiziert. Die Kid3 Schnittstelle hat die folgenden Methoden:
<para>Wenn OK wird true zurückgegeben.</para>
</sect2>
<sect2 id="dbus-downloadAlbumArt">
<title>Cover-Bild herunterladen</title>
<funcsynopsis>
<funcprototype>
<funcdef><function>downloadAlbumArt</function></funcdef>
<paramdef>string <parameter>url</parameter> URL des Bildes oder einer
dazugehörigen Website</paramdef>
<paramdef>boolean <parameter>allFilesInDir</parameter> falls true, wird das
Bild in allen Dateien des Verzeichnisses hinzugefügt</paramdef>
</funcprototype>
</funcsynopsis>
</sect2>
<sect2 id="dbus-exportToFile">
<title>Tags in Datei exportieren</title>
<funcsynopsis>
......
......@@ -498,6 +498,8 @@ A search on the Discogs server can be performed using
you can enter artist and album and then choose from a list of releases.
If <guilabel>Additional Tags</guilabel> is marked, more information is
imported if available, e.g. performers, arrangers, or the publisher.
If <guilabel>Cover Art</guilabel> is marked, cover art will be downloaded if
available.
</para>
<para id="import-musicbrainzrelease">
You can search in the same way in the release database of MusicBrainz
......@@ -660,6 +662,46 @@ opens directly the <guibutton>From MusicBrainz Fingerprint</guibutton>
dialog.</para></listitem>
</varlistentry>
<varlistentry id="browse_pictures">
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Browse Cover Art...</guimenuitem>
</menuchoice></term>
<listitem><para>
The <action>Browse Cover Art</action> dialog helps to find album cover
art. <guilabel>Artist/Album</guilabel> is filled from the tags if
possible. <guilabel>Source</guilabel> offers a variety of websites with album
cover art. The URL with artist and album as parameters can be found beneath
the name. URL-encoded values for artist and album can be inserted using
<userinput>%u{artist}</userinput> and <userinput>%u{album}</userinput>, other
values from the tags are possible too, as described
in <link linkend="configure-kid3">Configure Kid3</link>, <guilabel>User
Actions</guilabel>. More sources can be entered after the entry "Custom
Source" by replacing "Custom Source" with the source's name, pressing Enter,
then inserting the URL and finally pressing <guibutton>Save
Settings</guibutton>. The resulting browser command is displayed at the top of
the dialog and can be started by clicking <guibutton>Browse</guibutton>. The
browser, which can be configured in the settings, is started with the selected
source. A cover image can then be dragged from the browser into the &kid3;
window and will be set in the picture frame of the selected files.
</para>
<para>
Because not all browsers support drag'n'drop of images and the pictures on
websites often have a URL, in such cases &kid3; will receive the URL and not
the picture. If the URL points to a picture, it will be downloaded. However,
if the URL refers to some other web resource, it has to be translated to the
corresponding picture. Such mappings are defined in the table <guilabel>URL
extraction</guilabel>. The left column <guilabel>Match</guilabel> contains a
regular expression which is compared with the URL. If it matches, the captured
expressions in parentheses are inserted into the pattern of the
right <guilabel>Picture URL</guilabel> column (at the positions marked with \1
etc.). The replaced regular expression contains the URL of the picture. By
this means cover art can be imported from Amazon, Google Images, etc. using
drag'n'drop. It is also possible to define your own mappings.
</para>
</listitem>
</varlistentry>
<varlistentry id="export">
<term><menuchoice>
<guimenu>File</guimenu>
......@@ -1087,6 +1129,16 @@ unsaved changes will be converted.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Hide Picture</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggles displaying of the album cover art preview
picture.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
......@@ -1136,18 +1188,34 @@ The check box <guilabel>Use track/total number of tracks
format</guilabel> controls whether the track number field of ID3v2 tags
contains simply the track number or additionally the total number of tracks in
the directory.
</para>
<para>
When <guilabel>Genre as text instead of numeric string</guilabel> is checked,
all ID3v2 genres will be stored as a text string even if there is a
corresponding code for ID3v1 genres. If this option is not set, genres for which
an ID3v1 code exists are stored as the number of the genre code (in
parentheses for ID3v2.3). Thus the genre Metal is stored as "Metal" or "(9)"
depending on this option. Genres which are not in the list of ID3v1 genres are
always stored as a text string. The purpose of this option is improved
compatibility with devices which do not correctly interpret genre codes.
</para>
<para>
<guilabel>Text encoding</guilabel> defines the default encoding used for ID3v2
frames and can be set
to <guilabel>ISO-8859-1</guilabel>, <guilabel>UTF16</guilabel>,
or <guilabel>UTF8</guilabel>. <guilabel>UTF8</guilabel> is not valid for
ID3v2.3.0 frames; if it is set, <guilabel>UTF16</guilabel> will be used
instead. For ID3v2.4.0 frames, all three encodings are possible.
</para>
<para>
<guilabel>Version used for new tags</guilabel> determines whether new ID3v2
tags are created as version 2.3.0 or 2.4.0. In the first case, id3lib is used
as it was in earlier versions of &kid3; and TagLib is only applied when an
ID3v2.4.0 tag is encountered. In the second case, <guilabel>ID3v2.4.0
(TagLib)</guilabel>, TagLib is generally used for MP3 files; changed or newly
created tags will then be saved in version 2.4.0.
</para>
<para>
The combo box <guilabel>Comment field name</guilabel> is only
relevant for Ogg/Vorbis and FLAC files and sets the name of the field used for
comments. Different applications seem to use different names, "COMMENT" for
......@@ -1196,6 +1264,10 @@ timestamp</guilabel> can be marked to preserve the file modification time
stamp.
</para>
<para>
If <guilabel>Mark changes</guilabel> is active, changed fields are marked with
a light gray label background.
</para>
<para>
<guilabel>Filename Format</guilabel> contains options for the format of the
filenames. The same options as in <guilabel>Tag Format</guilabel> are available.
</para>
......@@ -1423,9 +1495,7 @@ libraries are compiled in. The default is
</para><para>
Generation of RPM-Packages is supported by the
file <filename>kid3.spec</filename>, for Debian-Packages,
the scripts <filename>build-deb-kde3.sh</filename>,
<filename>build-deb-qt.sh</filename> and
<filename>build-deb-kde4.sh</filename> are available.
the script <filename>build-deb.sh</filename>is available.
</para>
<para>
To build &kid3; with KDE 4, use
......@@ -1582,6 +1652,19 @@ following methods:
<para>Returns true if ok.</para>
</sect2>
<sect2 id="dbus-downloadAlbumArt">
<title>Download album cover art</title>
<funcsynopsis>
<funcprototype>
<funcdef><function>downloadAlbumArt</function></funcdef>
<paramdef>string <parameter>url</parameter> URL of picture file or album art
resource</paramdef>
<paramdef>boolean <parameter>allFilesInDir</parameter> true to add the image
to all files in the directory</paramdef>
</funcprototype>
</funcsynopsis>
</sect2>
<sect2 id="dbus-exportToFile">
<title>Export tags to a file</title>
<funcsynopsis>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment