Improve documentation
This commit is contained in:
parent
208c90ef42
commit
34a1595641
44
README.md
44
README.md
|
|
@ -95,7 +95,12 @@ The Tag Editor has a GUI (Qt 5) and a command line interface. For a C++ library
|
|||
interface checkout the underlying tagparser library.
|
||||
|
||||
### GUI
|
||||
The GUI should be self-explaining. Just open a file, edit the tags and save the changings.
|
||||
The GUI should be self-explaining - a lot of the UI elements have tooltips with further explanations.
|
||||
The basic workflow is quite simple:
|
||||
|
||||
0. Open a file
|
||||
1. Edit the tags
|
||||
2. Save changes
|
||||
|
||||
You can set the behaviour of the editor to keep previous values, so you don't have to enter
|
||||
information like album name or artist for all files in an album again and again.
|
||||
|
|
@ -110,25 +115,36 @@ This screenshot shows the experimental MusicBrainz/LyricsWikia search.
|
|||
|
||||
|
||||
#### Settings
|
||||
Checkout the settings dialog. You can:
|
||||
- customize which fields the editor shows and in which order
|
||||
- change settings regarding the tag processing (ID3 version(s) to be used, preferred character set, usage of padding, ...)
|
||||
- set whether unknown/unsupported tags should be ignored/kept or removed
|
||||
- set whether ID3v1 and ID3v2 tags should be edited together or separately
|
||||
- set the directory used to store temporary files
|
||||
- set the desired file layout options (see section "File layout options")
|
||||
- and more.
|
||||
Checkout the settings dialog. You can
|
||||
- customize which fields the editor shows and in which order.
|
||||
- change settings regarding the tag processing (ID3 version(s) to be used, preferred character set, usage of padding, ...).
|
||||
- set whether unknown/unsupported tags should be ignored/kept or removed.
|
||||
- set whether ID3v1 and ID3v2 tags should be edited together or separately.
|
||||
- set the directory used to store temporary files.
|
||||
- set the desired file layout options (see section "File layout options").
|
||||
- enable auto-correction features like trimming whitespaces.
|
||||
|
||||
Settings of the GUI do not affect the CLI.
|
||||
|
||||
#### File renaming
|
||||
There is also a tool to rename files using the tag information stored in the files. The new name is generated
|
||||
by a small JavaScript which can be customized. An example script is provided. Before any actual changes are made,
|
||||
you will see a preview with the generated file names.
|
||||
There is also a tool to rename files using the tag information stored in the files. The new name for each file is
|
||||
generated by a small JavaScript which can be customized. An example script is provided. Before any actual changes are
|
||||
made, you will see a preview with the generated file names. As shown in the example script it is also possible to
|
||||
move files into another directory.
|
||||
|
||||
#### MusicBrainz, Cover Art Archive and LyricaWiki search
|
||||
The tag editor also features a MusicBrainz, Cover Art Archive and LyricaWiki search which can be opened with *F10*.
|
||||
However, this feature is still experimental.
|
||||
The tag editor also features a MusicBrainz, Cover Art Archive and LyricaWiki search.
|
||||
|
||||
0. Open the search by pressing *F10*.
|
||||
1. Open the first file in the album.
|
||||
2. If album and artist are already present those are automatically inserted as search terms. Otherwise you need to
|
||||
enter the album and artist to search for manually. It makes most sense to search for an entire album and therefore
|
||||
leave the fields for track number and title blank.
|
||||
3. Click on eg. "Search LyricWikia".
|
||||
4. Select the row and fields to be used and click on "Use selected row".
|
||||
5. Use the "Insert automatically" option to insert search results for the next files automatically when you open them.
|
||||
To find the matching row for the song in the search results the title or track number needs to be present. If artist
|
||||
and album are present as well these are also tried to match for further disambiguation.
|
||||
|
||||
### CLI
|
||||
#### Usage
|
||||
|
|
|
|||
|
|
@ -2,14 +2,6 @@
|
|||
<ui version="4.0">
|
||||
<class>QtGui::EditorAutoCorrectionOptionPage</class>
|
||||
<widget class="QWidget" name="QtGui::EditorAutoCorrectionOptionPage">
|
||||
<property name="geometry">
|
||||
<rect>
|
||||
<x>0</x>
|
||||
<y>0</y>
|
||||
<width>346</width>
|
||||
<height>446</height>
|
||||
</rect>
|
||||
</property>
|
||||
<property name="windowTitle">
|
||||
<string>Auto correction</string>
|
||||
</property>
|
||||
|
|
@ -20,7 +12,7 @@
|
|||
<item>
|
||||
<widget class="QLabel" name="label">
|
||||
<property name="text">
|
||||
<string><html><head/><body><p>Auto correction/completion will be applied when showing the selected tag fields after <span style=" font-style:italic;">loading</span> a file but <span style=" font-style:italic;">not</span> before saving.</p></body></html></string>
|
||||
<string><html><head/><body><p>Auto correction/completion will be applied when showing the selected tag fields after <span style=" font-style:italic;">loading</span> a file but <span style=" font-style:italic;">not</span> before saving. So the tag values you see when opening a file are already corrected. However, when clicking the save button the tags are stored as they are with no further correction applied.</p></body></html></string>
|
||||
</property>
|
||||
<property name="wordWrap">
|
||||
<bool>true</bool>
|
||||
|
|
|
|||
Loading…
Reference in New Issue