Extension:Semantic Image Annotator

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Semantic Image Annotator

Release status:Extension status beta

ImageAnnotation.png
ImplementationTemplate:Extension#type Page action, Ajax, Special page
DescriptionTemplate:Extension#description Allows to add, edit and observe semantic annotations to images
Author(s)Template:Extension#username Tobias Weller;Felix Obenbauer (Tobias Wellertalk)
Maintainer(s)Template:Extension#maintainer User:Tobias Wellertalk
Latest versionTemplate:Extension#version 0.7.2 (2017-06-08)
MediaWikiTemplate:Extension#mediawiki 1.25+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license MIT License
Download
ExampleTemplate:Extension#example Example
Hooks usedTemplate:Extension#hook
OutputPageBeforeHTMLManual:Hooks/OutputPageBeforeHTML
smwInitProperties

Translate the Semantic Image Annotator extension if it is available at translatewiki.net

Check usage and version matrix.

Semantic Image Annotator is an extension for Semantic MediaWiki developed that allows to add, edit and query image annotations in your wiki. It requires Semantic MediaWiki and Page Forms. The extension is based on the JavaScript library annotorious. It's engine is based on the Semantic Text Annotator.


Installation[edit]

The Semantic MediaWiki extension and Page Forms extension must be installed in order to use this extension.
  • Download, extract and place the file(s) in a directory called SemanticImageAnnotator in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'SemanticImageAnnotator' );
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'SemanticImageAnnotator' );, you need to use:

require_once "$IP/extensions/SemanticImageAnnotator/SemanticImageAnnotator.php";

Usage[edit]

In the following is the usage and functionality of Semantic Image Annotator described. It starts with establishing annotation Categories, creating new annotations, and edit and delete annotations.


Link PageForms to Annotations[edit]

Semantic Text Annotator has a special page which allows to Link existing Page Forms to Annotation Categories. Thus, users are very flexible in providing meta-information about an annotation, based on a Page Form. The Special Page is currently structured under the section Other Special Pages

On the Special Page, users can add and delete linked Forms to Annotation Categories, as well as colours. The currently supported colours are red, green, yellow, blue and grey. The linked Page Forms to the Annotation Category defines the called Page Form for entering meta-information about the text annotation.

Special Page of the Semantic Image Annotator that allows for linking Page Forms to Annotation Categories.


Create Annotation[edit]

On a Uploaded File Page (Namespace: 6) appears on the navigation bar an additional icon, called Annotate Image. By clicking on this button, the Annotation Mode starts. The Semantic Image Annotator Extension loads all dependencies.

Click on the Button Annotate Image to start the Annotation Mode of an uploaded image File.

Existing annotations are highlighted in the image. To create an annotation, draw with the mouse by clicking and holding on the image a rectangle. Afterwards, a popup is displayed that allows to enter a comment (optional) and select a PageForm. The categories were created and linked to the corresponding Page Forms on the Special Page (see above).

Popup of the Annotator for entering a Comment and selecting the PageForm.

After clicking on create, a Popup is shown that allows to enter more meta-information about the marked text via Page Forms. The Page Form that appears is the corresponding one that was selected on the small window or rather linked on the special page.

After saving the Page Form, a new wiki page with the corresponding content is stored, which can be queried. The marked are in the image is marked as annotated.

PageForm of the selected Annotation-Category allows for adding additional Information.


Edit and Delete Annotation[edit]

To edit or delete an annotation, simply move with the mouse over the annotation which should be edited or deleted and click on the corresponding button on the top right of the mouseover-window.

Mouseover-window displays edit and delete button


Query Annotations[edit]

For every Image that was annotated via the Semantic Image Annotator, an additional page within the Namespace Annotation is created (Namespace 248). This page lists all annotations for the corresponding wiki page. Users can jump on the specific annotation page, which contains all entered information by the user (Comment, Information from Page Forms), as well as some additional information (Modification Date, Modification Users, etc.)

Wiki Page on the Annotation Namespace lists all annotations for the corresponding wiki page.

The corresponding Query Syntax is depicted in the following.

Syntax for the overview page to query the annotations for a specific wiki Page.

Known issues[edit]


Future Work[edit]

  • Include Reinstall Button
  • Include Repair Mode

Remarks[edit]

Log History[edit]

  • Update on 07.06.2017: Issue solved in which non-permissioned users were allowed to create annotations.
  • Update on 07.06.2017: Only sysops users can now access the Special Page of the Semantic Image Annotator.
  • Update on 08.06.2017: Version 0.7.2 published with a reinstall button.

See also[edit]

Link to authors


Link to information pages

Acknowledgements[edit]

The idea of the Semantic Image Annotator is based on a previous extension by Felix Obenauer. For the Semantic Image Annotator is the JS Library annotorious used.