PoolParty Thesaurus

Description

PoolParty thesaurus plugin helps to make WordPress blogs and websites more understandable. The website will be improved by linking posts with key terms and key terms with other key terms. The plugin imports a controlled vocabulary (SKOS thesaurus) or retrieves a thesaurus from a (public) SPARQL endpoint via web. Based on the thesaurus, terms in articles are high-lighted automatically, definitions are provided “inline” (as mouse-over effect) and links to the thesaurus terms are generated on-the-fly. The thesaurus is available as an extra resource on the blog and can be navigated to learn more about the knowledge domain instantly. The plugin also works with multilingual blogs. Dbpedia (Linked data) is used to retrieve definitions automatically whenever the imported thesaurus lacks of definitions.

With this plugin any SKOS/RDF thesaurus can be imported or retrieved from a SPARQL endpoint and used within your WordPress blog to underpin articles with key terms.

On two extra pages (which are generated automatically) the thesaurus can be displayed and used as a browsable glossary on your blog. The main page of the glossary displays all concepts with their preferred labels and their alternative labels (synonyms). The list of concepts is displayed in an alphabetical order and can be filtered by their first letters. The second page represents the detail view of each concept. All kinds of labels and relations (prefLabel, altLabel, hiddenLabel, definition, scopNote, broader, narrower und related) of a given term (concept) can be loaded and displayed.

Each post is analysed automatically to find words and phrases matching labels of a concept (prefLabel, altLabel or hiddenLabel) in the thesaurus. The first hit will be highlighted automatically. A mousover tooltip shows the short description of the term/phrase and the link points to the more detailed description on the glossary page.

Shortcodes

  • [ppt-abcindex]: displays an abc filter for filtering the concepts alphabetically.
  • [ppt-itemlist]: displays a list of concepts (filterd by its first letter).
  • [ppt-itemdetails]: displays the detail page of a selected concept.
  • [ppt-noparse] … [/ppt-noparse]: the content between of the shortcode is excluded from autmatic linking.
  • [ppt-searchform title=”…” width=”…[ px | % ]”]: displays a search form with a autocomplete field to find a concept.

What’s new?

  • The Plugin works now with the user-friendly multilingual dynamic content management qTranslate X for a multilingual WordPress
  • The URL to the detail page of a concept is now SEO optimized
  • The search algorithm behind the search link on top of the concept detail page is extended (searches now for prefered and alternative labels)
  • Implemented new shortcode with which you can add a simple glossary search form between content. The shortcode is called [ppt-searchform] and has two optional parameters: title (The title over the textfield. Leave blank if you don’t want a title) and width (The width of the textfield). An example: [ppt-searchform title=”Glossary search” width=”50%”]

Thanks to Benjamin Nowack: The thesaurus is imported into the system and is queried via ARC2 (https://github.com/semsol/arc2).
Thanks to rduffy (https://wordpress.org/extend/plugins/profile/rduffy). His ‘Glossary’ Plugin (https://wordpress.org/extend/plugins/automatic-glossary) inspired me, and I was able to develop this plugin on top of his ideas.

Works with PHP 5, MySQL 5 und ARC2

Screenshots

  • Tooltip with the description of a concept
  • The detail page of a concept
  • Admin settings page

Installation

Install using WordPress

  1. Log in and go to Plugins and click on Add New.
  2. Search for poolparty thesaurus and hit the Install Now link in the results. WordPress will install it.
  3. From the Plugin Management page in WordPress, activate the PoolParty Thesaurus plugin.
  4. Go to Settings -> PoolParty Thesaurus in WordPress, specify a RDF/XML file or SPARQL endpoint and click on Import/Update Thesaurus. Uploading the thesaurus can take a few minutes. Please remain patient and do not interrupt the procedure.

Install manually

  1. Download the plugin zip file and unzip it.
  2. Upload the plugin contents into your WordPress installations plugin directory on the server. The plugins .php files, readme.txt and subfolders should be installed in the wp-content/plugins/poolparty-thesaurus/ directory.
  3. Download ARC2 from https://github.com/semsol/arc2 and unzip it.
  4. Open the unziped folder and upload the entire contents into the /wp-content/plugins/poolparty-thesaurus/arc/ directory.
  5. From the Plugin Management page in WordPress, activate the PoolParty Thesaurus plugin.
  6. Go to Settings -> PoolParty Thesaurus in WordPress, specify a RDF/XML file or SPARQL endpoint and click on Import/Update Thesaurus. Uploading the thesaurus can take a few minutes. Please remain patient and don*t interrupt the procedure.

Install ARC2 manually (if automatic install has failed)

  1. Download ARC2 from https://github.com/semsol/arc2 and unzip it.
  2. Open the unziped folder and upload the entire contents into the /wp-content/plugins/poolparty-thesaurus/arc/ directory.

For users, who have installed version 1.x already

Version 2.0 was reworked completely, thus take in mind:

  • Please deactivate the older version and delete /wp-content/plugins/poolparty-thesaurus/ folder
  • Please delete the page Thesaurus and the subpage called Item
  • You can also delete the template file pp-thesaurus-template.php from your active theme folder. There is no use for this anymore.

FAQ

Does my automatically generated glossary page need to be titled **Glossary**?

No. It can be called whatever you like. You can enter a content if you like, but be careful with the shortcuts.

Does my automatically generated subpage need to be titled **Item**?

No. It can be called whatever you like. You can enter a content if you like, but be careful with the shortcuts.

How do I add a thesaurus item?

You will need a SKOS thesaurus management tool like PoolParty (http://poolparty.biz) to add/modify terms. The glossary is generated automatically from the imported thesaurus or (public) SPARQL endpoint.

Where can I find SKOS thesauri on the web?

A good source for this is CKAN, see: http://ckan.net/package?tags=format-skos

How con I exclude certain text sections from parsing?

Enclose such text sections with preceding [ppt-noparse] and a final [/ppt-noparse]

How can I update the glossary?

Simply load the updated thesaurus again (admin area: Settings -> PoolParty Thesaurus). The old thesaurus will be overwritten. New or updated concepts will be recognized immediately by the link generator.

How to I style the tooltip?

The tooltip consists of a CSS file and three PNG pictures which can be found in the plugin directory (js/unitip/). Two pictures consist of the top and bottom edge with without the pointer and the third picture consists of the middle part. To style this tooltip, the three pictures can be interchanged and the CSS file adjusted accordingly.

Contributors & Developers

“PoolParty Thesaurus” is open source software. The following people have contributed to this plugin.

Contributors

Translate “PoolParty Thesaurus” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

2.7.1 – 17.02.2016

  • The Plugin can be used in multilingual WordPress blogs. Pre-condition is to use another plugin called qTranslate X (https://wordpress.org/plugins/qtranslate-x/) by the qTranslate Team

2.7 – 21.12.2015

  • Small bug fixes and deprecated functions exchanged
  • The URL to the detail page of a concept is now SEO optimized
  • The search algorithm behind the search link on top of the concept detail page is extended (searches now for prefered and alternative labels)
  • Implemented new shortcode with which you can add a simple glossary search form between content. The shortcode is called [ppt-searchform] and has two optional parameters: title (The title over the textfield. Leave blank if you don’t want a title) and width (The width of the textfield). An example: [ppt-searchform title=”Glossary search” width=”50%”]

2.6.2 – 08.09.2015

  • Bug fixed on the uninstall functionality

2.6.1 – 24.03.2015

  • Bug fixes on the ARC2 installation function

2.6 – 19.02.2015

  • Improved speed of the linking posts with key terms
  • Added new filter in the configurations to exclude terms from automated linking

2.5.1 – 17.10.2014

  • Resolved Problem with the activation and the deinstallation if the ARC2 library is not installed
  • Resolved Problem with the HTML tag

2.5 – 21.08.2014

  • Adapted the plugin settings page
  • Improved the uninstall mechanism
  • Improved sidebar widget Glossary Search
  • Changed style for the automatically generated links
  • Changed style for the tooltip

2.4.1 – 03.02.2014

  • Small bug fix on autocomplete function

2.4 – 17.09.2012

  • Small bug fix

2.3 – 19.01.2012

  • Improved the autocomplete field (sidebar-widget)
  • Performance improvements
  • Bugfix for the wordpress version 3.3.1

2.2.2 – 01.12.2011

  • Fixed small error in the header title

2.2.1 – 30.11.2011

  • Few bugfixes

2.2 – 29.11.2011

  • Updating the plugin via the wordpress admin interface has been simplified. The plugin now gets the ARC2-tripelstore and installs it automatically without need to intervene manually.
  • There is a new sidebar-widget which incorporates a search field including autocomplete. This autocomplete service suggests terms from the glossary. Once such a term is chosen, one is automatically connected to the webpage describing the term. The widget can be pulled into any sidebar (depending on the theme) from the sub-section of appearance/widgets.
  • There is a new shortcode with which specific parts of the content can be excluded from automatically being linked. The shortcode is called ppt-noparse, and it is opened with [ppt-noparse] and closed with [/ppt-noparse]. Automatic linking is disabled for any text between the code.
  • Automatic finding and linking of concepts in running content can be totally disabled under settings. The glossary area is still present and can be reached via the glossary link and the sidebar widget.
  • The procedure for the automatic linking has been stabilized and improved
  • Bugfixes

2.1 – 29.07.2011

  • Few bugfixes

2.0 – 28.07.2011

  • Plugin has been re-worked from scratch
  • Definitions are displayed as tooltip via mouseover (can be dectivated)
  • Plugin can be used in multilingual WordPress blogs. Pre-condition is to use another plugin called qTranslate (https://wordpress.org/extend/plugins/qtranslate/) by chineseleper
  • Thesaurus can also be retrieved/updated via (public) SPARQL-Endpoint
  • If definition of a concept is missing it will be retrieved automatcally from DBPedia (via SPARQL), pre-condition is that concept is mapped via close or exact match with corresponding DBPedia resource.

1.2 – 21.04.2011

  • Few bugfixes

1.1 – 13.04.2011

  • Bugfix: Compat fix for upgrade
  • Changed: Only concepts with a definition are displayed on the thesaurus pages.

1.0

  • First plugin version