Add doc for emms-tag-editor

darcs-hash:20070308141415-94065-3d08068b5eeab98f5a95a92a3634a9abf7d30f71.gz

1 files changed, 45 insertions, 1 deletions

diff --git a/emms.texinfo b/emms.texinfo
index 29f91e9..4434185 100644
--- a/emms.texinfo
+++ b/emms.texinfo
@@ -1687,7 +1687,51 @@ Sort emms playlist by score in descending order.
 
 @cindex track editor
 
-Write me.
+Using @file{emms-tag-editor.el}, emms can set tag info of tracks. With
+the help of external programs, such as `mp3info', `vorbiscomment',
+emms can write the tag info to track file as well.
+
+Using key `E' to edit tags of current track or marked tracks(See
+@xref{Markable Playlists}. for how to mark tracks). The track's info
+is listed in text format. The field name is marked in bold face and not
+editable. And tag info is after an equal sign and is changable. A
+special field `name' is the track file name. If any change made in
+this field, the track file will rename to the new name.
+
+A few commands to perform changes on all tracks.
+
+@defun emms-tag-editor-set-all
+Set specified tag of all tracks to the string reading from minibuffer.
+@end defun
+
+@defun emms-tag-editor-replace-in-tag
+Replace things that matching regexp in specified tag of all tracks.
+@end defun
+
+@defun emms-tag-editor-transpose-tag
+Transpose two tag info of all tracks.
+@end defun
+
+@defun emms-tag-editor-submit
+Make changes take effect. `emms-tag-editor-submit-and-exit' does the
+same thing except it bury current buffer.
+@end defun
+
+@defvr {User Option} emms-tag-editor-formats
+This variable determine how to insert track fields to
+`emms-tag-editor-edit-buffer'. Emms tag info editable fields is usually
+determined by the extension of track name. The variable
+`emms-tag-editor-tags' contains all tags that emms track may have. A
+single charactar is asign to the tag to make the
+`emms-tag-editor-formats' easier to generate.
+@end defvr
+
+@defvr {User Option} emms-tag-editor-tagfile-functions
+To write tags to track file, an extern program should specific in this
+variable. Typically, a function should write for other type of track.
+If the extern program has an interface like `mp3info', you don't have
+to write a function. Take `mp3' and `ogg' as example.
+@end defvr
 
 @node Emms Mode Line
 @chapter Emms Mode Line