ximdex/drupal7-xowl-client

Drupal 7 module for Xowl service (named entity recognition using semantic technologies)

Xowl-service client for drupal 7

This client allows you to enrich your content managed into Drupal with a semantic layer. You can test this service on-line here: http://demo.ximdex.com/xowl/

Requirements

• Drupal 7 core: https://www.drupal.org/project/drupal
• module ckeditor for Drupal 7: http://ftp.drupal.org/files/projects/ckeditor-7.x-1.16.tar.gz
• module jquery_update: http://ftp.drupal.org/files/projects/jquery_update-7.x-2.5.tar.gz
• module Xowl for Drupal 7 (latest release v1.0): https://github.com/XIMDEX/drupal7-xowl-client/archive/v1.0.tar.gz

Optional

• potx: "Translation template extractor" module allows easy strings translation during development.

Installing Xowl module

• Install drupal 7 on your server as usual (more info here).
• Go to the following folder (<DRUPAL_ROOT> is your Drupal root path): <DRUPAL_ROOT>/sites/all/modules/.
• Unzip all the downloaded drupal modules into this folder. At the end, you must have three folders, named: ckeditor, drupal7-xowl-client-X.X, jquery_update.
• Access to your drupal web interface using a browser and select modules on the main menu. You'll see the Xowl module at the end of the list, but you can not install it yet because it depends on other two, jquery_update and ckeditor, so you have to enable them first.

If all the three modules are now properly enabled (in green), you are ready to configure them in the next step.

Translations

Ensure "locale" module is enabled. Go to configuration -> Regional and language -> translate interface -> import Load local file translations/es.po and clear caches. Set spanish language in drupal administration.

Xowl service

Start configuring the Xowl module. Access to its configuration on the tab called Xowl Configuration above or on the modules list, on the Xowl module's Configure link.

You have to select the content types that your are going to use to write your content and enrich it. Save the changes.

To configure the service's URL, go to the another configuration link called Xowl Server Configuration and enter a valid Xowl service URL (default: http://xowl.ximdex.net/api/v1). You will need a valid API token, if you don't have one, you have to visit the link xowl register and follow the steps:

CKeditor

You also have to configure the CKeditor to integrate properly a custom button for Xowl requests with your content.

Check "Use toolbar Drag&Drop feature" as disabled.

To insert the own CSS of the Xowl module into CKeditor, go to configure -> Profiles -> Full -> edit

Expand CSS panel and set the input Editor CSS with the value Define CSS and the input CSS file path with the following value (change the X.X with your version):

%hsites/all/modules/drupal7-xowl-client-X.X/resources/css/xowl.css

Next to css: Editor Appearance, add under "Maximize" a new item to the list: ['xowl_enhance_plugin_button']

Check the plugins list below and activate Xowl plugin to allow enhancing content in CKEditor

Save all the changes made.

Usage

To use this enrichment service, log in into your Drupal CMS and click on "Add new content" link and create, for example, a new article.

On the edition page, select Full Html text format on CKeditor options. Its toolbar will change and you'll see a new button at the end of the third row, pretty similar to a book and a pencil.

Now you can write some relevant sentences and then click on the Xowl button.

After a few seconds, all the recognized entities will be highlighted with a color and a number. The color means the following:

• Red: People
• Green: Places
• Yellow: Organizations
• Light orange: Creative Works
• Blue: Other catagories

We can click on it to select the correct dbpedia entity. Now we can save and see on the text became a link to dbpedia uri that represents that entity.

Notes

We have been working hard to release this client for the Drupal community. Now we are developing a Xowl's client for the brand new Drupal 8 stable release. As you may know, there have been so many changes between Drupal 7 and 8, so these two clients will have some different behaviours.

You can find our Xowl service client for Drupal 8 here.

drupal7-xowl-client's Issues

module i18n

Prepare the code to the i18n mechanisms.

Same text with different suggestions make an error

Let's consider the following text (spanish):

Ayrton Senna. Piloto brasileño de Fórmula1. Nació el 21 de marzo de 1960 en São Paulo (Brasil). Fue el segundo de tres hijos. Debutó en 1973 en el Campeonato de Brasil de karts y en 1977 en el Campeonato Sudamericano.

The service suggests 3 entities for the first "Brasil" and 1 for second. The implementation is using the entity text as key in internal structure, so the second "Brasil" overwrites the first one.

Disabling disambiguation dialog on stored links

When the article is saved and the link is pointed to wikipedia, when the user click on that link, the disambiguation pop-up appears.

Styles on persisted links

Green supra-index.

Error level (Notice): Incorrect array index access

The following message is found when saving a post:

Notice: Undefined index: xedit-tags in xowl_createXMLRepresentation() (line 76 of /var/www/html/drupal7/sites/all/modules/drupal7-xowl-client-1.0/includes/xowl.util).

The line content:
if(count($info['xedit-tags'])>0)

must be replaced by:
if(isset($info['xedit-tags']) && count($info['xedit-tags'])>0)

Problem with language prefixes on content

When the entity refers to a spanish wikipedia page, the prefix is wrong: 'es.en.wikipedia.org/...'

Adding trim function when saving token URL

In order to avoid problems with the token copy&paste.