Extension:PgnJS: Difference between revisions
Update hooks |
→Features and Examples: Related to the previous edit. |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 9: | Line 9: | ||
|username = xeyownt |
|username = xeyownt |
||
|author = Michaël Peeters |
|author = Michaël Peeters |
||
|description = display and animate chess games (boards and moves) given in {{tag|pgn|open}} tags |
|description = display and animate chess games (boards and moves) given in <wbr/>{{tag|pgn|open}} tags |
||
|image = Pgnjs-screenshot.png |
|image = Pgnjs-screenshot.png |
||
|version = 0.5.1 |
|version = 0.5.1 |
||
| Line 20: | Line 20: | ||
|parameters = |
|parameters = |
||
|rights = |
|rights = |
||
|example = see [https://wikitest.immie.org/wiki/PgnJS WikiTest PgnJS page]. |
|example = <!-- see [https://wikitest.immie.org/wiki/PgnJS WikiTest PgnJS page]. //Page does not exist as of 2026-02-07 --> |
||
}} |
}} |
||
The '''PgnJS''' extension displays and animates chess games (boards and moves). Chess games are simply given in PGN format in a <code><pgn></code> tag and displayed thanks to the powerful javascript engine [https://github.com/mliebelt/PgnViewerJS '''PgnViewerJS''']. In fact most of the functionality is provided by PgnViewerJS. This extension only implements the parsing of the <code><pgn></code> tag. |
The '''PgnJS''' extension displays and animates chess games (boards and moves). Chess games are simply given in PGN format in a <code><pgn></code> tag and displayed thanks to the powerful javascript engine [https://github.com/mliebelt/PgnViewerJS '''PgnViewerJS''']. In fact most of the functionality is provided by PgnViewerJS. This extension only implements the parsing of the <code><pgn></code> tag. |
||
== Features |
== Features == |
||
* Four display modes: <code>board</code>, <code>view</code>, <code>print</code> and <code>edit</code>, and one mode to define defaults. |
* Four display modes: <code>board</code>, <code>view</code>, <code>print</code> and <code>edit</code>, and one mode to define defaults. |
||
| Line 33: | Line 33: | ||
* Read default configuration from user preferences. |
* Read default configuration from user preferences. |
||
* Internationalization support. |
* Internationalization support. |
||
Visit the '''[https://wikitest.immie.org/wiki/PgnJS PgnJS page on WikiTest server]''' for a detailed list of all features. There you can see the extension at work and try it by yourself! |
|||
== Documentation and Source Code == |
== Documentation and Source Code == |
||
| Line 71: | Line 69: | ||
== See also == |
== See also == |
||
* [[Extension:ChessBrowser]] |
* [[Extension:ChessBrowser]] |
||
[[category:Chess extensions]] |
|||
Latest revision as of 08:51, 7 February 2026
 Release status: beta |
|
|---|---|
 |
|
| Implementation | Parser function |
| Description | display and animate chess games (boards and moves) given in <pgn> tags |
| Author(s) | Michaël Peeters (xeyownttalk) |
| Latest version | 0.5.1 (2021-02-07) |
| MediaWiki | 1.17+ |
| Licence | Apache License 2.0 |
| Download | GitHub:
Note: |
The PgnJS extension displays and animates chess games (boards and moves). Chess games are simply given in PGN format in a <pgn> tag and displayed thanks to the powerful javascript engine PgnViewerJS. In fact most of the functionality is provided by PgnViewerJS. This extension only implements the parsing of the <pgn> tag.
Features
[edit | edit source]- Four display modes:
board,view,printandedit, and one mode to define defaults. - Different layout possibilities (
left,top...). - Many attributes, including styling and classes.
- Support for wiki templates.
- Read default configuration from user preferences.
- Internationalization support.
Documentation and Source Code
[edit | edit source]Please visit the GitHub page.
Installation
[edit | edit source]The simplest is to clone the git repository in folder extensions of your wiki and run the install target (for MW 1.25 or above) or install-1.24 (for MW 1.24 or older):
cd /path/to/your/wiki/extensions
git clone --recursive --depth 1 https://github.com/xeyownt/mwpgnjs PgnJS
cd PgnJS
make install # For MW 1.25 or above
make install-1.24 # For MW 1.24 or older
Don't forget the --recursive option since the extension uses git submodules.
make install / make install-1.24 will delete all files that are not necessary for the extension to run, and add the following line at the end of LocalSettings.php:
// For MW 1.25 or above:
wfLoadExtension( 'PgnJS' );
// For MW 1.24 or older:
require_once "$IP/extensions/PgnJS/PgnJS.php";
Done! Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Compatibility
[edit | edit source]Extension uses the ResourceLoader, so it requires at least MediaWiki 1.17.
The extension has been tested on
- MediaWiki 1.22.1, 1.27.4, 1.32.6, 1.33.0, 1.33.4, 1.34.4, 1.35.0, 1.35.1.