User_Notes_Web_Platforms

Integrating pgn4web with commonly used web platforms

What works

These are some notes about customizing a number of popular software platforms in order to integrate with pgn4web. The instructions have been tested with the indicated versions of the software platforms and of the necessary plugins. Any further customization of your site, or different versions of the software might require adaptations to the suggested pgn4web integration instructions.

These are test sites showing pgn4web integration with those platforms; keep in mind these are test sites, things might (and will) be occasionally broken.

Please let me know if you successfully integrate pgn4web with any other web platforms.

blogger.com blog service

The blogger blog service fully supports using inline frames to insert pgn4web board widgets, with the code produced by the pgn4web board generator.

When entering the iframe code, please make sure you are using the HTML editing option, otherwise the enhanced editor might alter the code you enter.

See for instance the pgn4web test blogger site, or look at the users sites gallery.

The chess puzzler gadget can also be added to blogger based blogs, for instance to the sidebar.

Please take into account the note at the pgn4web board generator page about showing http iframes within https sites.

tumblr.com blog service

The tumblr blog service fully supports using inline frames to insert pgn4web board widgets, with the code produced by the pgn4web board generator.

See for instance the pgn4web test tumblr site.

wordpress.org blog platform

Integration with the wordpress.org blog platform: users can add a pgn4web chessboard either using a generic plugin enabling iframes or a dedicated plugin allowing for a tag to display chess games, like this:

[pgn parameter=value ...] ... PGN data ... [/pgn]

See for instance the pgn4web test wordpress.org site (this is a test site, things might occasionally be broken), or look at the users sites gallery.

See the wordpress.org integration wiki page for detailed instructions about pgn4web integration.

dokuwiki portal platform

A developer for the dokuwiki portal platform (qwertologe(at)googlemail.com) has produced the pgn4web dokuwiki plugin, that integrates the pgn4web chessboard and provides a custom bbcode for entering PGN games in dokuwiki articles. The plugin allows for a variety of chessboard options.

For more information see the dokuwiki plugin site, the source code repository and the demo site.

drupal portal platform

A developer for the drupal portal platform has produced a drupal module available at the drupal modules repository. The module integrates the pgn4web chessboard and provides a custom bbcode for entering PGN games in drupal articles, like this:

[pgn] ... PGN data ... [/pgn]

See the drupal integration wiki page for detailed instructions about the drupal module and an alternative pgn4web integration.

e107 portal platform

A user reported success integrating pgn4web with the e107 portal platform. See the e107 integration wiki page for detailed instructions about pgn4web integration.

google sites portal platform

Integration with the google sites portal platform is supported through the option of inserting custom HTML in a google site page.

Two versions of google sites are currently available while google is transitioning from the old google site platform to a new google sites platform:
with the older version of google sites, insert a gadget in your page, select the "include gadget (iframe)" option and enter the URL produced by the pgn4web board generator in the src= portion of the iframe.
with the new version of google sites, use the "embed" control, then select the "embed code" option and enter the full HTML code produced by the pgn4web board generator.

Please take into account the note at the pgn4web board generator page about showing http iframes within https sites.

IPS portal platform

A developer for the IPS portal platform produced a modification providing a PGN Chess BBCode tag based on pgn4web. See the IPS integration wiki page for detailed instructions about pgn4web integration.

joomla portal platform

Integration with the joomla portal platform: users can add a pgn4web chessboard either using a generic plugin enabling iframes or a dedicated plugin allowing for a tag to display chess games, like this:

[pgn parameter=value ...] ... PGN data ... [/pgn]

See for instance the pgn4web test joomla site (this is a test site, things might occasionally be broken), or look at the users sites gallery.

See the joomla integration wiki page for detailed instructions about pgn4web integration.

mediawiki portal platform

Integration with the mediawiki portal platform: users can add a pgn4web chessboard using a dedicated extension allowing for a tag to display chess games, like this:

<pgn parameter=value ...> ... PGN data ... </pgn>

See the mediawiki integration wiki page for detailed instructions about pgn4web integration.

liferay portlet

For the liferay portal platform a portlet based on pgn4web is available, see an example at the developer's site.

See the liferay integration wiki page for more information.

plone add-on product

A developer for the plone portal platform has produced a plone add-on product allowing entering PGN games in Plone articles.

See the plone integration wiki page for detailed instructions about the plone add-on product.

SPIP portal platform

A developer for the SPIP portal platform has produced a plugin for SPIP2 and SPIP3. The plugin integrates the pgn4web chessboard and provides a custom bbcode for entering PGN games in SPIP articles, like this:

[pgn parameter=value ...] ... PGN data ... [/pgn]

See the SPIP integration wiki page for detailed instructions about the SPIP plugin.

TYPO3 portal platform

A developer for the TYPO3 portal platform has produced a pgn4web extension for TYPO3 integrating the pgn4web chessboard in TYPO3 pages.

See the TYPO3 integration wiki page for more information.

MyBB forum platform

A user reported success integrating pgn4web with the MyBB forum platform. See the MyBB integration wiki page for detailed instructions about pgn4web integration.

phpBB forum platform

Integration with the phpBB forum platform: with phpBB v3 the forum administrator can easily create a new custom bbcode for PGN games, like this:

[pgn] ... PGN data ... [/pgn]

See for instance the pgn4web test phpBB site (this is a test site, things might occasionally be broken), or look at the users sites gallery.

See the phpBB integration wiki page for detailed instructions about pgn4web integration.

PunBB forum platform

A pgn4web user reported success integrating pgn4web with the PunBB forum platform. See the PunBB integration wiki page for detailed instructions about pgn4web integration.

simplemachines forum platform

Integration with the simplemachines forum platform: users can add a pgn4web chessboard just by adding bbcode tags to their posts, like this:

[pgn] ... PGN data ... [/pgn]

See the simplemachines integration wiki page for detailed instructions about pgn4web integration.

vbulletin forum platform

Integration with the vbulletin forum platform: users can add a pgn4web chessboard just by adding bbcode tags to their posts, like this:

[pgn] ... PGN data ... [/pgn]

The integration code has been validated with the demo facility.

See the vbulletin integration wiki page for detailed instructions about pgn4web integration.

Look at the users sites gallery for examples.

What does not work

  • wordpress.com, in its public implementation (as opposed to wordpress.org implementations on your own server), does not allow the iframe HTML tag used by the pgn4web board generator. No fix available other than moving your blog to Blogger. If you have your own wordpress.org installation on your server, see note above about the embed iframe plugin.

Generic instructions for using pgn4web in a blog or website

At present pgn4web allows only for one chessboard instance for each web page. In addition, some blog servers might not allow you to upload javascript files and the other supporting files required by pgn4web.

The easiest way to include pgn4web in a blog is to create a separate HTML file for each chessboard and then include those HTML files in your blog post using the HTML iframe tag:

<iframe src=http://yourhost.com/yourfile.html frameborder=0></iframe>

Most modern browsers support this feature. You can see an example of this at http://pgn4web-test.casaschi.net/blogger/ (this blog is hosted by the free provider blogspot).

If you need hosting space for your HTML files (and the pgn4web supporting files), please see the next topic.

If you are looking for an even simpler solution for posting games to a blog without the need of uploading a new HTML file for each game, you can use the board.html file as described in the board widget example.


Related

Wiki: BoardWidget_generator
Wiki: BoardWidget_instructions
Wiki: BoardWidget_summary
Wiki: Contribute
Wiki: Example_Puzzler
Wiki: Features_Limitations_Bugs
Wiki: Index
Wiki: ReadMeFirst_Deployment
Wiki: User_Notes_IPS
Wiki: User_Notes_SPIP
Wiki: User_Notes_TYPO3
Wiki: User_Notes_drupal
Wiki: User_Notes_e107
Wiki: User_Notes_joomla
Wiki: User_Notes_liferay
Wiki: User_Notes_mediawiki
Wiki: User_Notes_mybb
Wiki: User_Notes_phpBB
Wiki: User_Notes_plone
Wiki: User_Notes_punbb
Wiki: User_Notes_simplemachines
Wiki: User_Notes_vbulletin
Wiki: User_Notes_wordpress
Wiki: User_Sites