diff --git a/Makefile.am b/Makefile.am index 307fcba11..00b425d0d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2109,7 +2109,9 @@ developer_DATA = $(wildcard doc/developer/*.html) DOCBOOK_HTML = $(patsubst %.xml,%/index.html,$(DOCBOOK_FILES)) -$(DOCBOOK_HTML): %/index.html: %.xml +DOCBOOK_INCLUDES = $(wildcard $(srcdir)/doc/include/*.xml) + +$(DOCBOOK_HTML): %/index.html: %.xml $(DOCBOOK_INCLUDES) $(XMLTO) -o $(@D) --stringparam chunker.output.encoding=utf-8 html --stringparam use.id.as.filename=1 $< doc/api/html/index.html: doc/doxygen.conf diff --git a/doc/include/tags.xml b/doc/include/tags.xml new file mode 100644 index 000000000..554b43a82 --- /dev/null +++ b/doc/include/tags.xml @@ -0,0 +1,154 @@ + + + + + + + artist: the artist name. Its meaning is not + well-defined; see composer and + performer for more specific tags. + + + + + + artistsort: same as + artist, but for sorting. This usually omits + prefixes such as "The". + + + + + + album: the album name. + + + + + + albumsort: same as album, + but for sorting. + + + + + + albumartist: on multi-artist albums, this is + the artist name which shall be used for the whole album. The + exact meaning of this tag is not well-defined. + + + + + + albumartistsort: same as + albumartist, but for sorting. + + + + + + title: the song title. + + + + + + track: the track number within the album. + + + + + + name: a name for this song. This is not the + song title. The exact meaning of this tag is not well-defined. + It is often used by badly configured internet radio stations + with broken tags to squeeze both the artist name and the song + title in one tag. + + + + + + genre: the music genre. + + + + + + date: the song's release date. This is + usually a 4-digit year. + + + + + + composer: the artist who composed the song. + + + + + + performer: the artist who performed the song. + + + + + + comment: a human-readable comment about this + song. The exact meaning of this tag is not well-defined. + + + + + + disc: the disc number in a multi-disc album. + + + + + + musicbrainz_artistid: the artist id in the + MusicBrainz + database. + + + + + + musicbrainz_albumid: the album id in the + MusicBrainz + database. + + + + + + musicbrainz_albumartistid: the album artist + id in the MusicBrainz + database. + + + + + + musicbrainz_trackid: the track id in the + MusicBrainz + database. + + + + + + musicbrainz_releasetrackid: the release track + id in the MusicBrainz + database. + + + diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index 72210009c..84c5545c3 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -176,10 +176,8 @@ when saving playlists. The default is "no". .TP .B metadata_to_use This specifies the tag types that will be scanned for and made available to -clients. Possible values are artist, album, title, -track, name, genre, date, composer, performer, comment, disc, -musicbrainz_artistid, musicbrainz_albumid, musicbrainz_albumartistid, -musicbrainz_releasetrackid, musicbrainz_trackid. Multiple tags may be specified +clients. Possible values are listed in the MPD user manual. +Multiple tags may be specified as a comma separated list. An example value is "artist,album,title,track". The special value "none" may be used alone to disable all metadata. The default is to use all known tag diff --git a/doc/mpdconf.example b/doc/mpdconf.example index 4b55f8801..6ba0351e8 100644 --- a/doc/mpdconf.example +++ b/doc/mpdconf.example @@ -115,7 +115,7 @@ # # This setting defines a list of tag types that will be extracted during the # audio file discovery process. The complete list of possible values can be -# found in the mpd.conf man page. +# found in the user manual. #metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc" # # This setting enables automatic update of MPD's database when files in diff --git a/doc/protocol.xml b/doc/protocol.xml index 3a64f1a1b..ac78ab8ae 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -202,6 +202,25 @@ omitted, then the maximum possible value is assumed. + +
+ Tags + + + The following tags are supported by + MPD: + + + + + + There can be multiple values for some of these tags. For + example, MPD may return multiple + lines with a performer tag. A tag value is + a UTF-8 string. + +
diff --git a/doc/user.xml b/doc/user.xml index 40f625a9c..c96cbf61c 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -1298,6 +1298,19 @@ database { +
+ Metadata + + + When scanning or playing a song, + MPD parses its metadata. The + following tags are supported: + + + +
+
The queue