=== xspf player ===

tags: music, media, multimedia, podcast

some contributors: jan reinhardt <http://www.grnch.de>, darran

<http://darran.digital-pulse.net>,
ana la bella <http://littleovulation.net>, johnny haeusler
<http://www.spreeblick.com>,
pablo chinea <http://www.khertz.net>, renato alves

xspf player is a plugin that will embed the gpl'ed flash player xspf web player
(see http://musicplayer.sourceforge.net).
you can play music stored remotely or locally in your web server (must be http mp3
links files).
there are three player versions (you can use any of them). actually only slim
player has been tested, but it's supposed
to work with any of them.

for an up-to-date help and info, go to the plugin-help page:

http://www.boriel.com/?page_id=12 (a wiki us about to come)

== installation ==

1. upload the .zip file content to your plugins folder, usually `wp-
content/plugins/`.
after this, you should have the folder wp-content/plugins/xspf_player created
and several files inside of it.
2. activate the plugin on the plugin screen
5. go to the managements page (xspf player management) and add some url songs to
the database.
6. invoke the player anywhere into your template pages using: <?php
xspf_player::start('category-tag'); ?>
where 'category-tag' is the name of a category of songs you defined. e.g.:
xspf_player::start('celt music')
category-tag is optional. if omitted, all tracks are played.

that's all.

== upgrading from previous versions ==

1. deactivate the xspf player plugin at the plugin admin panel.

2. remove any file you installed with previous version (that is the
xspf_player.php and the xspf_player/ folder).
3. proceed to install as described in the installation section.

to invoke the player within your post, use <xpsf>_start()</xpsf> (you can press
the quicktag 'xspf' button in the editor page).

warning!!!: this has changed from previous versions of xspf (3.0) (it was
<xspf>start()</xspf>). both will work, but the later one
*must* be used when invoking embedding the player within a post (to keep xhtml 1.0
compliance).

currently only user with admin privileges can insert the player within the post.
allowing it to everybody could be a security hazard if you don't trust your
registered users. so, by now, only admin (user level >= 9) can use this
feature.

== frequently asked questions ==

= how can i play local files? =
put the complete url of your local file as if they were remote files.
you also must upload your mp3 files to your web server (using, for example the
file management menu in wordpress).
these files must be accesible and public via http.
e.g. if your server is named "www.boriel.com", and your files are under directory
/www/media/song1.mp3, you must use
http://www.boriel.com/media/song1.mp3 and not /media/song1.mp3.

== change log ==

--- 3.x ---

* version 3.3a
.- bugfix: wp 2.3 seems to have a bug in wpdb->query (null does not
cache). categories not shown. fixed.

* version 3.3
.- feature: url and category description can now have up to 255 chars
long.
.- feature: version displayed in config menu, and other cosmetics.
.- feature: better directory protection.
.- feature: button to clear all sql xspf tables.
.- bugfix: category edition not shown when no tracks on database.
fixed.

* version 3.2
.- bugfix: when no default player mode is selected, the player may not
work. fixed.
.- bugfix: the [xspf] button does not work on wp 2.1. fixed (thanks,
renato alves).
.- bugfix: cleanup database songs tables when installing for first
time.
.- feature: now it's possible (and preferred) to use [xsfp] ... [/xspf]
instead of <xspf>...</xspf> tags.
.- other: everything is in one folder (tidy up)
* version 3.1
.- bugfix: playlist sometimes does not works with php version < 5.x
(mbcs). fixed.
.- bugfix: slim mode sometimes showed an underlining color background.
fixed.
.- bugfix: sometimes the height and width were not set when choosing
the mode on-the-fly (advanced users). fixed.
.- bugfix: when calling the player inside a post/page body, the output
was not xhtml compliant. fixed (must use _start() function now).
.- feature: under some free web-hosts, the playlist did not work
because header insertions. this have been solved.
* version 3.0 (alias "d.a.r.y.l.")
.- feature: can insert the player within the post body
.- feature: added mode 0 (player can choose player url)
.- feature: added mode 4 (button with overlay menu)
.- feature: parameters changeable on the fly (see wiki)
.- other: some glitches and code rearrangement.

--- 2.x ---

* version 2.1
.- bugfix: total page number not correctly displayed in the tracks
management panel.
.- feature: improved track management.
.- feature: plugin background color selectable via color picker.
.- feature: improved player mode selection.
* version 2.0 (alias "the grinch")
.- bug fix: no more than 10 tracks displayed on the tracks management
panel. fixed.
.- bug fix: sometimes didn't delete tracks from database if wp was
localized to other languages. fixed.
.- feature: song order now available per category!
.- feature: the 3 player bundled, and selectable with one click (3
player modes)!
.- change: categories now moved to the management page.
.- bug fix: some glitches with de css fixed.
.- feature: tracks now are paginated for better management.

--- 1.x ---

* version 1.6
.- feature: autoload playlist
.- feature: preview in options panel!
.- bugfix: playlist may give errors with some plugins. fixed. thanks, ana.

.- bugfix: entering a blank url trak made the management panel to

dissapear until page reloaded. fixed.
.- bugfix: characters ' and " escaped. fixed.
* version 1.5
.- php 5.x compatible (was already compatible with 5.1)
* version 1.4
.- going valid xhtml
* version 1.3
.- bug fix. playlist category not correctly selected due to debug
instrucions. argh!
.- feature. random play ('shuffle' mode) added for each category.
.- feature. when no track title is entered, the url track is displayed
as a default.
* version 1.2
.- bug fix. playlist not loaded in internet explorer.
* version 1.1
.- bug fix. playlist not well-formed when info url's added.
* version 1.0
.- initial version.