aboutsummaryrefslogtreecommitdiffhomepage
path: root/plugins/playvideos/README.md
diff options
context:
space:
mode:
authorArthur <arthur@hoa.ro>2015-11-07 16:53:07 +0100
committerArthur <arthur@hoa.ro>2015-11-07 16:53:07 +0100
commit245432e796a6e520ec830bd1d486420e115853d8 (patch)
treec68d8da23711f7144c88c61af90000d2681c0882 /plugins/playvideos/README.md
parentc536c98ae134191108171d266b73326d6b851f93 (diff)
parent840caea64f8c37f035fb3525f63153eb68492731 (diff)
downloadShaarli-245432e796a6e520ec830bd1d486420e115853d8.tar.gz
Shaarli-245432e796a6e520ec830bd1d486420e115853d8.tar.zst
Shaarli-245432e796a6e520ec830bd1d486420e115853d8.zip
Merge pull request #284 from ArthurHoaro/plugin-playvideos
PLUGIN playvideos
Diffstat (limited to 'plugins/playvideos/README.md')
-rw-r--r--plugins/playvideos/README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/plugins/playvideos/README.md b/plugins/playvideos/README.md
new file mode 100644
index 00000000..ec1ead8d
--- /dev/null
+++ b/plugins/playvideos/README.md
@@ -0,0 +1,71 @@
1### ► Play Videos plugin for Shaarli
2This plugin adds a `► Play Videos` button to [Shaarli](https://github.com/shaarli/Shaarli)'s toolbar. Click this button to play all videos on the page in an overlay HTML5 player. Nice for continuous stream of music, documentaries, talks...
3
4This uses code from https://zaius.github.io/youtube_playlist/ and is currently only compatible with Youtube videos.
5
6![](https://cdn.mediacru.sh/D_izf0zjAtxy.png)
7
8#### Installation and setup
9Place the files in the `tpl/plugins/playvideos/` directory of your Shaarli.
10This is a default Shaarli plugin, you just have to enable it.
11
12To enable the plugin, add `playvideos` to the `TOOLBAR_PLUGINS` config option in your `index.php` or `data/options.php`. Example:
13
14 $GLOBALS['config']['TOOLBAR_PLUGINS'] = array('aplugins', 'anotherone', 'playvideos');
15
16#### Troubleshooting
17If your server has [Content Security Policy](http://content-security-policy.com/) headers enabled, this may prevent the script from loading fully. You should relax the CSP in your server settings. Example CSP rule for apache2:
18`Header set Content-Security-Policy "script-src 'self' 'unsafe-inline' https://www.youtube.com https://s.ytimg.com 'unsafe-eval'"`
19
20### License
21```
22File: youtube_playlist.js
23Copyright: (c) 2010-2014, David Kelso <david@kelso.id.au>
24License: The ISC License (http://opensource.org/licenses/ISC)
25
26Files: jquery*.js
27License: MIT License (http://opensource.org/licenses/MIT)
28Copyright: (C) jQuery Foundation and other contributors, https://jquery.com/download/
29
30-----------------------------------------------------
31
32The ISC License (http://opensource.org/licenses/ISC)
33
34Copyright (c) 2010-2014, David Kelso (david at kelso dot id dot au)
35Copyright (c) 2010-2014, nodiscc (nodiscc at gmail dot com)
36
37Permission to use, copy, modify, and/or distribute this software for any
38purpose with or without fee is hereby granted, provided that the above
39copyright notice and this permission notice appear in all copies.
40
41THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
42WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
43MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
45WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
46ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
47OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE
48
49----------------------------------------------------
50MIT LICENSE
51
52Permission is hereby granted, free of charge, to any person obtaining a copy
53of this software and associated documentation files (the "Software"), to deal
54in the Software without restriction, including without limitation the rights
55to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
56copies of the Software, and to permit persons to whom the Software is
57furnished to do so, subject to the following conditions:
58
59The above copyright notice and this permission notice shall be included in
60all copies or substantial portions of the Software.
61
62THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
64FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
65AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
66LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
67OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
68THE SOFTWARE.
69
70----------------------------------------------------
71``` \ No newline at end of file