1# pgn4web
2
3pgn4web (a DokuWiki plugin) displays the nice interactive pgnviewer from http://pgn4web.casaschi.net
4
5Demo of the plugin: http://sk-schwanstetten.de/dw/doku.php?id=schachpartien:perlen_der_schachwelt_mit_kommentaren
6
7## DESCRIPTION
8
9I embedded only pgn4web in a plugin (which was difficult enough for me).
10
11All foreign code is placed in the subfolder `pgn4web`.
12
13## KNOWN ISSUES
14
15You can only display one instance of pgn4web in a page.
16This is a limitation if you use it together with the blog or include plugin.
17As a solution, provide a link to the page alone, which is automatically done
18with the blog plugin. In this case the board is not drawn - instead a hint
19is created which instructs the reader to open solely the article.
20
21Tested only with
22
23* Windows 7: IE 11, Firefox 45, Chrome 51
24* Windows 10: Edge, Firefox 47
25* Linux: Firefox 47, Chromium 51
26* Android 5.1.1: Firefox and Chrome
27
28I am not sure if the 32x32 editor icon is a problem, but it is really nicer compared to 16x16.
29
30## DEVELOPER
31
32To create a working version you must download pgn4web from http://pgn4web.casaschi.net...
33
34```
35cd lib/plugins/pgn4web
36unzip ~/Downloads/pgn4web-<version>.zip
37mv pgn4web-<version> pgn4web
38# diff -u pgn4web/pgn4web.js /tmp/pgn4web.js >pgn4web.patch # created the patch
39patch pgn4web/pgn4web.js <pgn4web.patch # apply patch (optional: change +/= to utf-arrow/||)
40find pgn4web/ -type f -name "*.png" | xargs pngquant --ext .png --force --skip-if-larger # (optional: reduce png size)
41```
42
43## CREDITS AND LICENSE
44
45The embedded items remain subject to their original licenses (if any).
46Details are documented in pgn4web/README.txt
47
48The used [jin piece sets](http://ixian.com/chess/jin-piece-sets/) have a
49changed license these days:
50[Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/) - in pgn4web is still version 3.0 mentioned.
51
52Remaining pgn4web (plugin) code is copyright (C) 2014-2016 Michael Arlt
53
54GNU General Public License the Free Software Foundation, version 3 of the License.
55
56This program is distributed in the hope that it will be useful,
57but WITHOUT ANY WARRANTY; without even the implied warranty of
58MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
59GNU General Public License for more details.
60
61You should have received a copy of the GNU General Public License along
62with this program; if not, write to the Free Software Foundation, Inc.,
6351 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
64
65See LICENSE or http://www.gnu.org/licenses/gpl.html
66
67## PERMISSION
68
69Here is the permission, Paolo gave me on 2014-12-11 - Thanks!
70
71> i would like to release my dokuwiki plugin. I have several questions and
72> ask for your permission:
73>
74>   - I would like to use the name "pgn4web" as plugin name
75
76
77That's fine for me.
78
79...
80
81--
82Paolo
83
84