oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: fixed DocBook markup in doc/sticker.xml

Browse Source 
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).
This commit is contained in:
Max Kellermann 2009-05-15 18:54:50 +02:00
parent 46e0b49e71
commit 1d0be2a031
2 changed files with 56 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@ -720,7 +720,7 @@ endif
man_MANS = doc/mpd.1 doc/mpd.conf.5 man_MANS = doc/mpd.1 doc/mpd.conf.5
doc_DATA = AUTHORS COPYING NEWS README UPGRADING doc/mpdconf.example 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 if ENABLE_DOCUMENTATION
protocoldir = $(docdir)/protocol protocoldir = $(docdir)/protocol

97
doc/sticker.xml
View File

@ -28,51 +28,64 @@
its easy to change this on the fly, if needed. its easy to change this on the fly, if needed.
</para> </para>
<tag> <variablelist>
<name>rating</name> <varlistentry>
<value>1-5</value> <term><varname>rating</varname></term>
<para> <listitem>
Will store a rating value from 1 (worst) to 5 (best) for a given song. <para>
</para> Will store a rating value from 1 (worst) to 5 (best) for a
</tag> given song.
</para>
</listitem>
</varlistentry>
<tag> <varlistentry>
<name>album_rating</name> <term><varname>album_rating</varname></term>
<value>1-5</value> <listitem>
<para> <para>
Will store a rating value from 1 (worst) to 5 (best) for a given album. Will store a rating value from 1 (worst) to 5 (best) for a
</para> given album.
</tag> </para>
</listitem>
</varlistentry>
<tag> <varlistentry>
<name>style</name> <term><varname>style</varname></term>
<value>Keyword</value> <listitem>
<para> <para>
This tag is used to keep the Genre tag clean, by now having 1000's of genres. This tag is used to keep the Genre tag clean, by now
Instead you define a Main Genre for each file and can make a more specific having 1000's of genres. Instead you define a Main Genre
description. This should be one Keyword like "Post Punk" or "Progressive Death Metal" for each file and can make a more specific
An Alternative name for this tag is "Subgenre", time will tell which one gets description. This should be one Keyword like "Post Punk"
more support. or "Progressive Death Metal" An Alternative name for this
</para> tag is "Subgenre", time will tell which one gets more
</tag> support.
</para>
</listitem>
</varlistentry>
<tag> <varlistentry>
<name>lyrics</name> <term><varname>lyrics</varname></term>
<value>The lyrics of the song, including header with Artist - Title</value> <listitem>
<para> <para>
This one is self explaining. This gives the option to store lyrics of This one is self explaining. This gives the option to
a song where they belong to: mapped to the song store lyrics of a song where they belong to: mapped to the
</para> song
</tag> </para>
</listitem>
</varlistentry>
<tag> <varlistentry>
<name>similar_artists</name> <term><varname>similar_artists</varname> (Comma seperated list of artists)</term>
<value>Comma seperated list of artists</value> <listitem>
<para> <para>
This tag enables a last.fm alike aproach which will still work when being offline This tag enables a last.fm alike aproach which will still
Keep in mind, that this tag is absolutely non-standard! I am not aware of any work when being offline Keep in mind, that this tag is
other player that uses a comparable tag. absolutely non-standard! I am not aware of any other
</para> player that uses a comparable tag.
</tag> </para>
</listitem>
</varlistentry>
</variablelist>
</chapter> </chapter>
</book> </book>