Skip to content

Commit 39e52b7

Browse files
terrillterrill
committed
Update readme.txt
1 parent e79113f commit 39e52b7

File tree

1 file changed

+59
-66
lines changed

1 file changed

+59
-66
lines changed

‎readme.txt‎

Lines changed: 59 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
=== AblePlayer ===
1+
=== Able Player ===
22
Contributors: terrillthompson
3-
Plugin URI: https://github.com/ableplayer-wordpress
3+
Plugin URI: https://github.com/ableplayer/ableplayer-wordpress
44
Author URI: http://terrillthompson.com
55
Tags: html5,media,audio,video,accessibility
6-
Requires at least: 2.6
7-
Tested up to: 4.5
8-
Stable tag: 0.1
6+
Requires at least: 4.9
7+
Tested up to: 5.3
8+
Requires PHP: 5.2
9+
Stable tag: 1.0
910
License: MIT
10-
License URI: https://github.com/ableplayer-wordpress/LICENSE
11+
License URI: https://github.com/ableplayer/ableplayer-wordpress/blob/master/LICENSE
1112

1213

1314
HTML5 accessible media player
@@ -22,102 +23,94 @@ This plug-in uses Able Player, an open-source fully-accessible cross-browser HTM
2223
1. Activate the Able Player plugin through the 'Plugins' menu in WordPress
2324
1. Follow the Instructions for Use
2425

26+
== Screenshots ==
27+
28+
1. Able Player as an audio player
29+
2. Able Player as a video player, showing captions and an auto-generated interactive transcript
30+
2531
== Instructions for Use ==
2632

2733
There are currently two ways to add an Able Player instance to a WordPress site:
2834

29-
1. Enter or paste any valid HTML5 Able Player code into your web page. Full documentation, including a list and explanation of all supported HTML5 attributes, is available on the [Able Player](http://ableplayer.github.io/ableplayer) project page on GitHub.
35+
1. Enter or paste any valid HTML5 Able Player code into your web page. Full documentation is available on the [Able Player](http://ableplayer.github.io/ableplayer) project page on GitHub.
36+
37+
2. Enter an [able-player] shortcode. The shortcode is intended for adding videos hosted on YouTube or Vimeo, with captions and subtitles hosted on these services. For anything more complex, use HTML.
3038

31-
2. Enter an [able-player] shortcode, in combination with one or more [able-source] shortcodes, plus one or more [able-track] shortcodes.
39+
== The [able-player] shortcode ==
3240

33-
= The [able-player] shortcode =
41+
The [able-player] shortcode supports the following attributes.
3442

35-
The [able-player] shortcode is a container, so must be terminated by the [/able-player] shortcode. In between these opening and closing shortcodes, you must have at least one [able-source] shortcode.
43+
= Required attributes (one of these) =
44+
45+
* youtube-id - 11-character YouTube ID
46+
* vimeo-id - Vimeo ID
3647

37-
The [able-player] shortcode supports the following attributes:
48+
= Optional attributes =
3849

39-
* type (required) - either "video" or "audio"
40-
* id - a unique id for the player (if omitted, one will be assigned)
50+
* youtube-desc-id - YouTube ID of a described version of the video
51+
* vimeo-desc-id - Vimeo ID of a described version of the video
52+
* youtube-nocookie => "true" or "false" (use "true" to embed YouTube untracked, for added privacy)
53+
* id - a unique id for the player (if omitted, one will be automatically assigned)
4154
* autoplay - "true" or "false" (default is "false")
4255
* loop' - "true" or "false" (default is "false")
43-
* playsinline - "true" or "false" (default is "true")
44-
* hidecontrols - "true" or "false" (default is "false")
56+
* playsinline - "true" or "false" (default is "true"). By setting to "false", some devices (e.g., iPhones) will play the video in their own media player rather than in Able Player.
57+
* hidecontrols - "true" or "false" (default is "false"). Set to "true" to enable the player controls to fade away during playback. They will appear again if the user hovers over the player or pressing a key, and they are always accessible to screen reader users.
4558
* poster - the URL of a poster image, displayed before the user presses Play
4659
* width - a value in pixels (by default, the player will be sized to fit its container)
4760
* height - a value in pixels (by default, the height of the player will be in proportion to the width)
4861
* heading - The HTML heading level (1-6) of the visually hidden "Media Player" heading that precedes the player (for the benefit of screen reader users). If omitted, a heading level will be intelligently assigned based on context.
4962
* speed - "animals" or "arrows" (default is "animals")
50-
* start - start time at which to start playing the media, in seconds
51-
* volume - "0" to "10" (default is "7" to avoid overpowering screen reader audio)
52-
* seekinterval - number of seconds to forward/rewind.
53-
* nowplaying - "true" or "false" to include a "Selected Track" section within the media player (default is "false")
54-
55-
= The [able-source] shortcode =
56-
57-
The [able-source] shortcode is self-contained (i.e., it does not need a closing shortcode).
58-
59-
The [able-source] shortcode supports the following attributes:
63+
* start - start time at which to start playing the media, in seconds. Some browsers do not support this.
64+
* volume - "0" to "10" (default is "7" to avoid overpowering screen reader audio). Some browsers do not support this.
65+
* seekinterval - number of seconds to forward/rewind with the Forward and Rewind buttons. If omitted, the interval will be intelligently assigned based on length of the video.
66+
* nowplaying - "true" or "false" to include a "Selected Track" section within the media player (default is "false").
6067

61-
* src - URL of the media file
62-
* type - the mime type of the media file (e.g., "audio/mpeg", "video/mp4")
63-
* desc-src - URL of the media file for the described version
64-
* sign-src - URL of the media file for synchronized sign language
65-
* youtube-id - 11-character YouTube ID
66-
* youtube-desc-id - 11-character YouTube ID of the described version
67-
* youtube-nocookie => "true" or "false" (use "true" to embed YouTube untracked, for added privacy)
68-
* vimeo-id - Vimeo ID
69-
* vimeo-desc-id - Vimeo ID for described version
68+
== Examples ==
7069

71-
= The [able-track] shortcode =
70+
= Example 1 =
7271

73-
The [able-track] shortcode is self-contained (i.e., it does not need a closing shortcode).
72+
This example uses HTML to add an audio player to the page, with one source (an MP3 file).
7473

75-
The [able-track] shortcode supports the following attributes:
74+
<audio id="audio1" preload="auto" data-able-player src="path_to_audio.mp3">
75+
</audio>
7676

77-
* kind - "captions", "subtitles", "chapters", "descriptions", or "metadata"
78-
* src - URL to the track file (must be a valid WebVTT file)
79-
* srclang - language code of the track language (e.g., "en" for English, "es" for Español)
80-
* label - A label to display in the captions/subtitles menu (e.g., "English")
77+
= Example 2 =
8178

79+
This example uses HTML to add a video player to the page, with one source (an MP4 file) and four tracks (for captions, descriptions, and chapters in English; and subtitles in Spanish).
8280

83-
= Example 1 =
81+
<video id="able-player-1" data-able-player preload="auto" poster="path_to_image.jpg">
82+
<source type="video/mp4" src="path_to_video.mp4">
83+
<track kind="captions" src="path_to_captions.vtt" srclang="en" label="English">
84+
<track kind="subtitles" src="path_to_subtitles.vtt" srclang="es" label="Español">
85+
<track kind="descriptions" src="path_to_descriptions.vtt" srclang="en">
86+
<track kind="chapters" src="path_to_chapters.vtt" srclang="en">
87+
</video>
8488

85-
This example uses HTML to add a video player to the page, with one source (an MP4 file) and four tracks (for captions, descriptions, and chapters in English; and subtitles in Spanish).
89+
= Example 3 =
8690

87-
<video id="able-player-1" data-able-player preload="auto" poster="path_to_image.jpg">
88-
<source type="video/mp4" src="path_to_video.mp4">
89-
<track kind="captions" src="path_to_captions.vtt" srclang="en" label="English">
90-
<track kind="subtitles" src="path_to_subtitles.vtt" srclang="es" label="Español">
91-
<track kind="descriptions" src="path_to_descriptions.vtt" srclang="en">
92-
<track kind="chapters" src="path_to_chapters.vtt" srclang="en">
93-
</video>
91+
This example uses a shortcode to add a YouTube player to the page, with two versions of the video, one with audio description and the other without (the user can toggle between the two versions using the D button).
9492

95-
= Example 2 =
93+
[able-player youtube-id="XXXXXXXXXXX" youtube-desc-id="YYYYYYYYYYY"]
9694

97-
This example is the same as Example 1, but uses shortcodes.
95+
= Example 4 =
9896

99-
[able-player type="video" id="able-player-1" poster="path_to_image.jpg">
100-
[able-source type="video/mp4" src="path_to_video.mp4"]
101-
[able-track kind="captions" src="path_to_captions.vtt" srclang="en" label="English"]
102-
[able-track kind="subtitles" src="path_to_subtitles.vtt" srclang="es" label="Español"]
103-
[able-track kind="descriptions" src="path_to_descriptions.vtt" srclang="en"]
104-
[able-track kind="chapters" src="path_to_chapters.vtt" srclang="en"]
105-
[/able-player]
97+
This example uses a shortcode to add a Vimeo player to the page, with two versions of the video, one with audio description and the other without (the user can toggle between the two versions using the D button).
10698

99+
[able-player vimeo-id="XXXXXXXXX" vimeo-desc-id="YYYYYYYYY"]
107100

108-
== Next Steps ==
109-
1. Reconsider shortcode implementation, as currently it offers no advantage whatsoever over HTML.
101+
== Roadmap ==
110102
1. Provide a user interface by which authors can select and configure default options through WordPress.
111-
1. Interface directly with existing WordPress media libraries so users can select their media files and other assets rather than typing in URLs.
112-
1. Test whether and how to pass third party shortcodes to select HTML attributes rather than URLs, and add relevant documentation to this README.
103+
1. Interface directly with WordPress media libraries so users can select their media files and other assets rather than typing in URLs.
113104

114105
== Changelog ==
115106

116-
= 0.1 =
107+
= 1.0 =
117108
* Initial version
118109

119-
= 0.1.1 =
120-
* Add support for shortcodes
110+
== Upgrade Notice ==
111+
112+
= 1.0 =
113+
This is the initial release. It simplifies the process of adding Able Player to WordPress pages.
121114

122115

123116

0 commit comments

Comments
 (0)