aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-05-15 18:54:50 +0200
committerMax Kellermann <max@duempel.org>2009-05-15 18:54:50 +0200
commit1d0be2a031283feb05440043241dbf964b1bc9e2 (patch)
tree6ee72b1a213d15037b152d87e1316cf0d4ac627a
parent46e0b49e71fd4bf3a7e13cf8d1d16faf925a2163 (diff)
downloadmpd-1d0be2a031283feb05440043241dbf964b1bc9e2.tar.gz
mpd-1d0be2a031283feb05440043241dbf964b1bc9e2.tar.xz
mpd-1d0be2a031283feb05440043241dbf964b1bc9e2.zip
doc: fixed DocBook markup in doc/sticker.xml
The old sticker.xml used elements which are not valid in DocBook. Now that the file is valid, let's add it to $(DOCBOOK_FILES).
-rw-r--r--Makefile.am2
-rw-r--r--doc/sticker.xml97
2 files changed, 56 insertions, 43 deletions
diff --git a/Makefile.am b/Makefile.am
index 585b3b3b0..e9ca647ec 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -720,7 +720,7 @@ endif
man_MANS = doc/mpd.1 doc/mpd.conf.5
doc_DATA = AUTHORS COPYING NEWS README UPGRADING doc/mpdconf.example
-DOCBOOK_FILES = doc/protocol.xml doc/user.xml
+DOCBOOK_FILES = doc/protocol.xml doc/user.xml doc/sticker.xml
if ENABLE_DOCUMENTATION
protocoldir = $(docdir)/protocol
diff --git a/doc/sticker.xml b/doc/sticker.xml
index ed9d4c087..0e27ba8cf 100644
--- a/doc/sticker.xml
+++ b/doc/sticker.xml
@@ -28,51 +28,64 @@
its easy to change this on the fly, if needed.
</para>
- <tag>
- <name>rating</name>
- <value>1-5</value>
- <para>
- Will store a rating value from 1 (worst) to 5 (best) for a given song.
- </para>
- </tag>
+ <variablelist>
+ <varlistentry>
+ <term><varname>rating</varname></term>
+ <listitem>
+ <para>
+ Will store a rating value from 1 (worst) to 5 (best) for a
+ given song.
+ </para>
+ </listitem>
+ </varlistentry>
- <tag>
- <name>album_rating</name>
- <value>1-5</value>
- <para>
- Will store a rating value from 1 (worst) to 5 (best) for a given album.
- </para>
- </tag>
+ <varlistentry>
+ <term><varname>album_rating</varname></term>
+ <listitem>
+ <para>
+ Will store a rating value from 1 (worst) to 5 (best) for a
+ given album.
+ </para>
+ </listitem>
+ </varlistentry>
- <tag>
- <name>style</name>
- <value>Keyword</value>
- <para>
- This tag is used to keep the Genre tag clean, by now having 1000's of genres.
- Instead you define a Main Genre for each file and can make a more specific
- description. This should be one Keyword like "Post Punk" or "Progressive Death Metal"
- An Alternative name for this tag is "Subgenre", time will tell which one gets
- more support.
- </para>
- </tag>
+ <varlistentry>
+ <term><varname>style</varname></term>
+ <listitem>
+ <para>
+ This tag is used to keep the Genre tag clean, by now
+ having 1000's of genres. Instead you define a Main Genre
+ for each file and can make a more specific
+ description. This should be one Keyword like "Post Punk"
+ or "Progressive Death Metal" An Alternative name for this
+ tag is "Subgenre", time will tell which one gets more
+ support.
+ </para>
+ </listitem>
+ </varlistentry>
- <tag>
- <name>lyrics</name>
- <value>The lyrics of the song, including header with Artist - Title</value>
- <para>
- This one is self explaining. This gives the option to store lyrics of
- a song where they belong to: mapped to the song
- </para>
- </tag>
+ <varlistentry>
+ <term><varname>lyrics</varname></term>
+ <listitem>
+ <para>
+ This one is self explaining. This gives the option to
+ store lyrics of a song where they belong to: mapped to the
+ song
+ </para>
+ </listitem>
+ </varlistentry>
- <tag>
- <name>similar_artists</name>
- <value>Comma seperated list of artists</value>
- <para>
- This tag enables a last.fm alike aproach which will still work when being offline
- Keep in mind, that this tag is absolutely non-standard! I am not aware of any
- other player that uses a comparable tag.
- </para>
- </tag>
+ <varlistentry>
+ <term><varname>similar_artists</varname> (Comma seperated list of artists)</term>
+ <listitem>
+ <para>
+ This tag enables a last.fm alike aproach which will still
+ work when being offline Keep in mind, that this tag is
+ absolutely non-standard! I am not aware of any other
+ player that uses a comparable tag.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</chapter>
</book>