WordPress.org
Get WordPress

Plugin Directory

Changeset 1268144


Ignore:
Timestamp:
10/18/2015 11:30:37 AM (10 years ago)
Author:
hearthis
Message:

Stable Version 1.0

Location:
hearthisat/trunk
Files:
35 added
2 edited

Legend:

Unmodified
Added
Removed

  • hearthisat/trunk/readme.txt

    r1250130 r1268144  
    11=== hearthis.at ===
    2 Contributors: hearthis
    3 Tags: hearthis, html5, player, shortcode,
    4 Requires at least: 3.1.0
    5 Tested up to: 3.4.0
    6 Stable tag: trunk
     2Plugin Name:       hearthis.at
     3Plugin URI:        https://wordpress.org/plugins/hearthisat/
     4Description:       the hearthis.at plugin allows you to integrate a player widget from hearthis.at into your Wordpress Blog by using a Wordpress shortcodes.
     5Tags: hearthis,    html5, player, shortcodes, music, widget
     6Contributors:      hearthis, dj_force
     7Donate link:       http://hearthis.at
     8Requires at least: 3.1
     9Tested up to:      4.3
     10Stable tag:        stable
     11Version:           1.0.0
     12Author:            Andreas Jenke <[email protected]>
     13Author URI:        http://so-ist.es/
     14License:           GPL-2.0+
     15License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
     16Text Domain:       hearthis
     17Domain Path:       /languages
     18License:           GPL-2.0+ or later
     19Tags:              hearthis, html5, player, sound, mp3, audio, shortcodes, music, widget
     20License URI:       http://www.gnu.org/licenses/gpl-2.0.html
    721
    8 The hearthis.at Shortcode plugin allows you to integrate a player widget from hearthis.at into your Wordpress Blog by using a Wordpress shortcodes.
     22The hearthis.at plugin allows you to integrate a player widget from hearthis.at into your Wordpress Blog by using a Wordpress shortcodes.
     23
    924
    1025== Description ==
    1126
    12 Use it in your blog post or pages by adding this Shortcode to your content: 
    13       `[hearthis]http://hearthis.at/LINK_TO_TRACK_SET_OR_ARTIST/[/hearthis]`.
     27The hearthis.at plugin allows you to integrate a player widget from hearthis.at into your Wordpress Blog by using a Wordpress shortcodes.
     28this is how it works:     
     29`[hearthis]http://http://hearthis.at/LINK_TO_TRACK_SET_OR_ARTIST/[/hearthis]` 
    1430
    15 The Plugin also supports optional parameters. By now these are width, height and params.
    16 The "params" parameter will pass the given options on to the player widget. The hearthis
    17 player accepts the following parameter options:
     31These Shortcodes do also supports several optional parameters. These parameters will pass its given value as option on to the player widget. 
     32At the moment the hearthis Shortcode accepts the following parameter and options:
    1833
    19 * theme  = you can choose between these 2 options __transparent__ (default) or __transparent_black__
    20 * width  = define the width of the widget (integer value or % value or empty string '', default is 100%)   
    21 * height           =  define the height of the widget (integer value or empty string '', default is 145) 
    22 * profile_height   =  define the height of the profile view (integer value or %, default is 400) 
    23 * multi_height     =  define the height of the playlist view (integer value or empty string '', default is 450) 
    24 * color2            =  highlight color for the waveform (not set or a hex color string with prependig #) 
    25 * color            =  button and passed time color for the waveform (not set or a hex color string with prependig #) 
    26 * cover            =  hides the cover img (values not set, 1 or 0) 
    27 * autoplay         =  starts with autoplay (values not set, 1 or 0) 
    28 * style            =  style 1 or 2 
    29 * waveform         =  hide the waveform (values not set, 1 or 0) 
    30 * background       =  shows the background if set (values not set, 1 or 0, if is 1 the height is 400px) 
    31 * digitized_space      =  size of the spaces between the waveform blocks (integer, steps from 1 to 10, works only if style is set to 2) 
    32 * liststyle       =  only aviable on playlists and will also works only with 'single' as value
    33      
     34*   `width` define the width of the widget (integer value or % value or empty string '', default is 100%)
     35*   `height` define the height of the widget (integer value or empty for default )    
     36if this value is less 100 it will passed as percent if it is higher than 100 it will parsed as pixels
     37*   `theme` you can choose between these 2 options transparent (default) or transparent_black
     38*   `hcolor` button and passed time color for the waveform (not set or a hex color string with prependig #)
     39*   `color` highlight color for the waveform (not set or a hex color string with prependig #)
     40*   `style` style 1 or 2
     41*   `background` shows the background if set (values not set, 1 or 0, if is 1 the height is 400px)
     42*   `waveform` hide the waveform if it set to 1 (values not set, 1 or 0)
     43*   `autoplay` starts with autoplay (values not set, 1 or 0)
     44*   `cover` hides the cover img if it set to 1 (values not set, 1 or 0)
     45*   `block_size` size of the waveform blocks (integer, steps from 1 to 10, default is 2, works only if style is set to 2)
     46*   `block_space` size of the spaces between the waveform blocks (integer, steps from 1 to 10, default is 1, works only if style is set to 2)
     47*   `liststyle` only available on playlists and will also works only with 'single' as value
     48*   `css` string, should contain a valid uri that will load an additional css file link the link tag
    3449
    35 Examples
    36 --------------
    3750
    38 Embed a single track without params. 
     51**IMPORTANT NOTE**
     52
     53This Version **is now stable** and provides also a fallback for some old hearthis Shortcode params.   
     54So these params could also being used because they will passed to the their new names.
     55
     56*   `color2` the old name of the hcolor property
     57*   `param` a params string with the namend values
     58*   `digitized_size` old name of the waveform block size (see block_size)
     59*   `digitized_space` old name of the waveform block space (see block_space)
     60
     61== Examples ==
     62
     63Embed a single track without params.   
    3964      `[hearthis]https://hearthis.at/shawne/shawne-pornbass-12-06042013-2300-0200-uhr/[/hearthis]`
    4065
    41 Embed a playlist or set without params. 
     66Embed a playlist or set without params.   
    4267      `[hearthis]https://hearthis.at/crecs/set/tbase-feat-charlotte-haining-oscar-michael-unspoken-words-ep/[/hearthis]`
    4368
    44 Embed a user without color params and autostart. 
    45       `[hearthis color="#ff5c24" color2="#33fd11" autostart="1"]http://hearthis.at/djforce/[/hearthis]`
     69Embed a user without color params and autostart.   
     70      `[hearthis color="#ff5c24" color="#33fd11" autostart="1"]http://hearthis.at/djforce/[/hearthis]`
    4671
    47 Embeds a track with a black theme and a bachground image (if set). 
     72Embeds a track with a black theme and a bachground image (if set).   
    4873      `[hearthis theme="transparent_black" background="1" ]https://hearthis.at/djforce/baesser-forcesicht-dnbmix/[hearthis]`
    4974
    50 Embeds a track player with 300px width and a green button color. 
     75Embeds a track player with 300px width and a green button color.   
    5176      `[hearthis width="300" color="#33fd11"]https://hearthis.at/crec/maverick-krl-c-recordings-guestmix/[/hearthis]`
    52      
    53 Embeds a playlist or set with 400px height. 
     77
     78Embeds a track player with 300px width and waveform and highlight color and the theme transparent_black.   
     79      `[hearthis width="300" params="color=33e040&color2=00ff00&theme=transparent_black"]https://hearthis.at/djforce/dj-force-is-breaking-the-habit-electrobreaks-bass-dubstep-mix-052014/[/hearthis]`
     80 
     81Embeds a playlist or set with 400px height.   
    5482      `[hearthis height="400"]https://hearthis.at/set/51-7/[/hearthis]`
     83 
     84I embeds a hook so if you have a playlist and do set the liststyle="single" option, it will parse all tracks from this set as single tracks. 
     85      `[hearthis liststyle="single"]https://hearthis.at/crecs/set/tbase-feat-charlotte-haining-oscar-michael-unspoken-words-ep/[/hearthis]
    5586
    56 I embeds a hook so if you have a playlist and do set the liststyle="single" option, it will parse all tracks from this set as single tracks. 
    57       `[hearthis liststyle="single"]https://hearthis.at/crecs/set/tbase-feat-charlotte-haining-oscar-michael-unspoken-words-ep/[/hearthis]`
    5887
    5988== Installation ==
    6089
    61 Download the Plugin and extract the content. You should see a folder
    62 named hearthisat. Move or upload this folder to your Wordpress installation
    63 plugins directory. By default the wordpress plugin folder is under /wp-content/plugins/.
     901. Download the Plugin and extract its content. You should see a folder named hearthisat or hearthis.   
     912. Upload the complete `hearthis` folder to the `/wp-content/plugins/` directory   
     923. Activate the plugin through the 'Plugins' menu in WordPress   
     934. Now you are ready to go and you can place `[hearthis]` Shortcodes to your pages or articles   
    6494
    65 After you done this go to your Wordpress Backend and activate the Plugin.
    66 Now you are ready to go and can insert the hearthis Shortcodes.
     95
    6796
    6897== Frequently Asked Questions ==
     98
     99
     100= What is about httpful ? =
     101
     102With version 1.0.0 this was removed.
     103
     104This was included till version 0.6.5. If you use a former version,
     105you can update this library by downloading the latest phar file
     106from the distributors [website][5]. The latest integrated version of [httpful][3] was v 0.2.19.
     107For more informations please visit the [httpful developer site][4].
     108
     109
    69110== Screenshots ==
    70111
    71 with a single Track 
    72 ![Track view ](/hearthisat/screenshot_track.png "the hearthis widget with a single track")
     112This is how the player widget could looks like: 
    73113
    74 with a playlist or set 
    75 ![playlist view](/hearthisat/screenshot_playlist.png "the widget with a playlist widget") 
     1141. with a single Track
     115![track view ](/hearthisat/screenshot_track.png "the view of the hearthis widget with a single track")
     116
     1172. ... or with a playlist or set
     118![playlist view](/hearthisat/screenshot_playlist.png "the view of the widget for a playlist")
     119
     1203. ... or if the url is a profile
     121![profile view](/hearthisat/screenshot_profile.png "the view of the widget for a profile")
    76122
    77123
    78 1. This is how the player looks.
     124== Changelog ==
    79125
    80 == Changelog ==
    81 = latest version is 0.6.3 =
     126= 1.0.0 =
     127* removed the httpful Phar file so that this works completly without this 
     128* now based on the [Plugin API](http://codex.wordpress.org/Plugin_API), [Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards), and [Documentation Standards](http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/).
     129* all classes, functions, and variables are documented so that you know what you need to be changed.
     130* includes a `.pot` file for internationalization but I don't used it.
     131* added the latest hearthis.at API functions for the shortcode params
     132* new backend/wp-admin Menu with color pickers 
    82133
    83 = version 0.6.3 =
     134= 0.6.5 =
     135* several bugfixes and reformating code to object base programming standard
    84136
    85 + add a shortcode option as a hook to parse all tracks from a playlist as single tracks
     137= 0.6.4 =
     138* added a trailing slash to an URL if its not exist
    86139
    87 = version 0.6.2 =
     140= 0.6.3 =
     141* added a Shortcodes option as a hook to transform a playlist url into single widgets for each track from this set instead of displaying a list view.
    88142
    89 + the plugin was originaly written by Benedikt Groß the founder of hearthis.at and this release fixes old or wrong options and bug so that you can use it with the latest wordpress version and you will have the full controll of all original hearthis paramsn
     143= 0.6.2 =
     144* fix and reformating the original code which was written by Benedikt Groß the founder of hearthis.at a year ago. This release fixes deprecated or wrong options and removes errors so now you will be able to use this plugin in the latest wordpress version. Now you will have full control about the latest original hearthis parameters.
    90145
     146
     147== special thanks and credits ==
     148
     149= hearthis.at - music is our passion =
     150
     151**thx for using and supporting** [hearthis.at][1]
     152
     153[1]: https://hearthis.at/
     154[2]: https://de.wordpress.org/
     155[3]: https://github.com/nategood/httpful
     156[4]: http://phphttpclient.com/
     157[5]: http://phphttpclient.com/downloads/httpful.phar
     158
Note: See TracChangeset for help on using the changeset viewer.