Entagged Documentation
$Id: readme.html,v 1.1 2007/03/23 14:16:43 nicov1 Exp $
| Revision History | |
|---|---|
| Revision 0.09 | 14 April 2004 |
| First version of this readme (shipped with v0.09) | |
| Revision 0.10 | 18 July 2004 |
| Update for v0.10 | |
| Revision 0.11 | 31 october 2004 |
| Update for v0.11 | |
Table of Contents
Please report bugs. That would help us to improve the stability and make this program a great tool !
Our aim is to provide a simple, intuitive and powerful interface for audio file tagging. Simple because it don't bug the user with thousand of options, only the essential one are provided. Powerful because it supports freedb, it supports recursive processing of tag and rename operations. Intuitive because it is nearly transparent for the user. Want to rename all your files ? Simply select the directory and choose a mask, click rename, it's done !TODO
Here is a list of current Entagged features
Support for OGG Vorbis files - MP3 (id3v1 and id3v2 tags) files - FLAC Files - MPC(MP+) Musepack Files - APE Monkey Audio Files - WAV files (see the section called “Supported File types”)
Handles all files independently of their type (allows to batch files even from mixed types)
Edit essential tag information (Artist-Album-Title-TrackNb-Comment-Genre-Year) easily
Rename files from their tag using any of the above infos with any pattern
Tag files (again using the above fields) from their filename with any pattern
Pattern can use filename but also directory name, easy to create a well structured audio files repository
freedb search using automatically computed cddb id's (the way it is meant to be used). Simply select some files that represent an album, then query and tag.
freedb search using manually searched cddb id. When entagged can't find any match, you can search freedb for a given artist/album and find the correct match yourself, then ask entagged to tag the files.
Supports Multi langage (currently only english,french and spanish) (contributors appreciated)
Recursive processing of all the above operations, easily !
Text transformation: capitalize, uppercase roman numerals, lowercase, and more that can be used either while tagging or renaming.
Separate freedb and audioformats libraries that can be used independently by anyone who want to read and/or write meta data to audio files
More (to come)
The following features are planned to be added soon or late...
Support for Musicbrainz database or others ?
You will need:
Java J2RE or Java J2SDK v1.4 (v1.4.2_01 or better recommended) at least installed (and maybe the java executable in your shell path for linux users)
Some audio files :)
To run Entagged, you need first of all to download the Java Runtime Environment (JRE or JDK) because Entagged is written in Java. This ensures crossplatform compatibility at the little (approx. 10Mb) cost of these libraries.
You can grab the latest Sun JRE or any other java JRE that suits your architecture (Blackdown on linux, etc) (Entagged needs at least JRE v1.4.1 to work properly !).
Go to the "Download J2SE v 1.4.xxx" table and pick under "JRE" your platform's version.
You can then download Entagged at sourceforge file release section, make sure you are downloading the latest version !
Entagged is packaged in three different ways:
entagged-install-w32-x.xx.exe is the windows only installer version of this package. Windows user should use this. (note: that it is only a .exe wrapper to lauch the jar file, no native code here !)
entagged-tageditor-x.xx.zip is the "all platform" package, Linux and Mac users have to use this one, windows could also use it, but it's easier with the installer.
entagged-tageditor-x.xx.tar.gz contains the source code and the resources needed to compile and build entagged (ant file, resources, NSIS script, etc). This package is NOT needed if you only want to use Entagged (this is a developper resource)
TO BE COMPLETED
After a successful CVS checkout or using the downloaded tarball, use $ ant package to create the package, or $ ant compile to compile the files in place, in the root directory. Mail me if there are problems
Simply follow these instructions:
Windows users: if you used the windows installer, icons should have been created in the start menu (under Programs--Entagged) and/or on your desktop. Simply double-click on it to launch entagged.
Zip-file users: change the current directory to installation_dir and launch $ java -jar entagged-tageditor-x.xx.jar (this assumes that java is in your current path of course).
Example: (assuming that you extracted the zip file in /home/kikidonk/bin/entagged/
$ cd /home/kikidonk/bin/entagged/
$ java -jar entagged-tageditor-0.10.jar
If you compiled yourself Entagged and want to run it from the sources, there is a script called entagged.sh or entagged.bat (unix or windows), to launch entagged.
If you have any problems feel free to send a mail to raf.raf AT wol.be or post it on the sourceforge site.
TODO
The main window is divided in 5 zones
The Classic menu bar
The main view
The control panel (that contains several tabs as described in the section called “The control panel”
The general procedure is to
For windows users, select the disk you want to browse in the upper left of the screen.
Browse through the directories using the main view and select the files and directories you want to process.
Use the control panel to do the desired action on these files
Opens the Entagged-Tag Editor option dialog
Here you will browse the folders on the selected disk.
This view uses color codes to show useful infos about the displayed files
Simple folders will appear with a white background
Supported audio files that have already a tag will appear with a light green background
Supported audio files that have not already been tagged will appear with a light blue background
Supported audio files that could not be read, or had errors are displayed with a light red background, and an exclamation icon
Selected files will appear with a grey background
There are also little icons that indicate at a glance of wich type are the displayed files like
and
The different fields are displayed as cells of a table, the first column shows the filename, then the artist, etc, or blank if that info is blank or don't exists in the tag.
The columns can be resized and moved for the best convenience. It can also be sorted by clicking on the header of the column
To enter a folder, double click it.
Selections are important, because entagged will always process the selected files only. To select multiple files: ctrl+ and select your files, or shift+ to select a lot of contiguous files.
You can select files or folders, or both, files will be processed independently, folders will be processed recursively, that means that if you select a folder and choose to rename, all the files contained in every subfolder of the selected one will be processed.
This is the operational panel, it contains several tabs described here under. Remember, any action done in this panel will only apply to selected files and directories in the main view
This is the simple yet powerful tag editor. Simply change the field you want to update then click save. When multiple files are selected the <??> text may appear, that means that this field will remain untouched when changes are saved.
Example: you select an entire album, all the tracks have different titles, and the artist field is blank. Simply select all files fill the artist field and check that <??> is put in the title filed. Now click save, all the files have now the same artist, but kept their own title...
You can also select a transformation that will be applied to all fields of the tag. Mutually exclusive options, like UPPERCASE and lowercase, cannot be selected at the same time. To select (compatible) multiple transformations, just click on the name, it works like a toggle: selected is on, unselected is off...
On the top combobox you can enter the pattern that will be used to create the new file's directory if the checkbox is selected, otherwise it won't be used (meaning that the files will stay in the current directory after the rename)
On the bottom, you can enter the pattern that will be used to create the new filename.
You can use any of the following strings that will be replaced by the indicated string during the rename:
<artist> will become Artist
<album> will become Album
<title> will become Title
<track> will become Track
<genre> will become Genre
<year> will become Year
<comment> will become Comment
You can of course also add any other string in the pattern that will be left as is: eg. <track> - <title> some crap <artist>_other crap-<album>. Also if there are invalid characters (characters that can't be used in a filename) they will be deleted or replaced by a _
Example: Directory pattern /home/kikidonk/<artist>/<album> and file pattern <track> - <title> will rename to /home/kikidonk/Genesis/Tresspass/01 - Title_oftrack1.ogg
Notes: the last / or \ (depending on the OS) in the directory pattern is optional. The filename pattern must not contain the extension, it will be added automatically !
You can also select a transformation that will be applied to the filename of the processed file. Mutually exclusive options, like UPPERCASE and lowercase, cannot be selected at the same time. To select (compatible) multiple transformations, just click on the name, it works like a toggle: selected is on, unselected is off...
This panel looks exactly the same as the rename from tag, except that it does the exact oposite !
The special characters <xxxx> have the same meaning.
An additional mask <ignore> is accepted, and will simply ignore a variable amount of text located between two other masks.
The directory pattern will try to match the file's directory, and the filename pattern will try to match the file's filename
Note: You should very carefully create the pattern so the files can be easily tagged, see the example to see how to do it
Example: Directory pattern: /home/kikidonk/<artist>/<album> , filename pattern: <track> <ignore>- <title>. If the file is /home/kikidonk/artist/album/05 some crap - Nice_title.mp3 it will be tagged with the following fields: Artist = artist, Album = album, TrackNb = 05, Title = Nice_title
Notes: the last / or \ (depending on the OS) in the directory pattern is optional. The filename pattern must not contain the extension !
You can also select a transformation that will be applied to all fields of the tag. Mutually exclusive options, like UPPERCASE and lowercase, cannot be selected at the same time. To select (compatible) multiple transformations, just click on the name, it works like a toggle: selected is on, unselected is off...
This panel allows you to search the freedb database for the selected album. You must remember that freedb uses the length of the tracks to compute an unique identifier for an album. It is important that the files are in the correct order and are in the same number as on the original CD for this function to work properly
Select the files that are an album (note that it can be with files of several different formats, entagged doesn't care), then click Search.
Quickly after, the combobox will populate with the results of the query, select a result to display the infos it contains in the fields.
You can change the fields if you feel like, before clicking on the save button, and your files are tagged.
Note: You can't change the titles individually, but only the album infos: Artist, genre, year, album name, etc. Of course, after using the freedb function, you can always use the tag editor to fine tune the titles individually...
This panel allows the same thing as the above one, but you have to enter manually the freedb id and genre of the result you want to be applied.
!! This is still experimental, and the number of selected files must match the number of tracks in the freedb result. !!
Browse the freedb site, either by clicking the Launch Browser button (browser command line must be configured in the option dialog before) or manually as you would do everyday.
Search your album and copy/paste the the freedb ID number and select the correct freedb genre. You can now click search and the result will be loaded
You can change as before the album infos, then click save, and the files are tagged !
Note: This feature will be improved with a conflict resolution dialog if the number of track doesn't match..
TODO
Preferences are changed using the Option Dialog located in the menu. Click on the left buttons-icons to select a preferences page and modify the options. Then click save to exit or close the dialog to cancel.
There is only one combobox that allows to choose the langage of Entagged-Tag Editor (currently only english and partially french). You need to restart entagged for the changes to take effect !
Here you can change the skin of Entagged. Squareness Look And Feel is selected by defaut, but you are free to change.
Skin changes are applied immediately but you may need to restart for some icons to reload properly !
Used for the moment only to indicate the command to execute to launch the browser, %1 is replaced with the URL. Linux users will use mozilla %1 or something like that most of the time, Windows users will use iexplore.exe %1 i think,...
These are the people who helped me so far:
Miguel Sahagun (Anacleto) (developpement)
Andrew Gaydenko (debug, tests..)
This product includes:
The Squareness look and feel
All the licenses regarding these libraries can be found either on their website, or in the /docs/ folder located in your entagged installation directory. Thanks to them, for providing such great libraries!
I would like to thank:
O'Reilly & Associates, "Java Foundation Classes in a nutshell". Making a filesystem tree easily
Terry Yuen - http://jelude.cjb.net (for the idea of making the nsis launcher for the .jar)
Nullsoft for making this great GPL tool : NSIS Installer Script compiler
Sourceforge for providing such a kick-ass Web management for OSD.
The authors of Look And Feels
(c) 2003 Entagged Developpement Team http://www.sourceforge.net/projects/entagged
All rights reserved
The Entagged project is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation;
The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html
This program contains libraries with their own licenses, see the entagged/lib/ folder to read it.