Difference between revisions of "Fresnel Forms Protégé plugin"

From SW_OWF
Jump to navigation Jump to search
(sort and nest →‎Tips & Tricks)
Line 73: Line 73:
 
== Tips & Tricks ==
 
== Tips & Tricks ==
  
* To generate the project documentation locally, you can execute ‘mvn site’. After that, the resulting documentation will be present in the target/site folder of the source folder. The entry point for the documentation is index.html.
+
# Documentation
* Read the document ‘Userinterface instructie.docx’ before loading really large ontology’s like dbpedia.
+
## To generate the project documentation locally, you can execute ‘mvn site’. After that, the resulting documentation will be present in the target/site folder of the source folder. The entry point for the documentation is index.html.
* Before loading Fresnel, make sure Protégé has loaded the ontology the Fresnel style sheet was based on.
+
## Read the document ‘Userinterface instructie.docx’ before loading really large ontology’s like dbpedia.
* Show the superclass in the gui to prevent problems with inheriting attributes.
+
# Before loading Fresnel, make sure Protégé has loaded the ontology the Fresnel style sheet was based on.
* Make sure the lens boxes do not visibly overlap each other in the GUI. If they do, you may not be able to get the property menu when right clicking a property.
+
# Opening ontologies
* If you want to open an ontology a second time, open in a new window (might incur failure otherwise).
+
## If you open a large ontology expand the lenses one by one. Do not activate the the right menu item ‘Expand all’
* If you open a large ontology expand the lenses one by one. Do not activate the the right menu item ‘Expand all’
+
## If you want to open an ontology a second time, open in a new window (might incur failure otherwise).
* After selecting the ‘Expand all’ menu item select also the ‘rearrange’ menu item to be sure that the lenses do not overlap.
+
# GUI
* In a form, for properties (not of type page) with multiple values, separate values by a comma. Separate URL's for an image property by a space, then a comma.
+
## Show the superclass in the gui to prevent problems with inheriting attributes.
 +
## Make sure the lens boxes do not visibly overlap each other in the GUI. If they do, you may not be able to get the property menu when right clicking a property.
 +
## After selecting the ‘Expand all’ menu item select also the ‘rearrange’ menu item to be sure that the lenses do not overlap.
 +
# In a form, for properties (not of type page) with multiple values, separate values by a comma. Separate URL's for an image property by a space, then a comma.

Revision as of 11:57, 2 October 2018

Publication

Lloyd Rutledge, Thomas Brenninkmeijer, Tim Zwanenberg, Joop van de Heijning, Alex Mekkering, J. N. Theunissen and Rik Bos. From Ontology to Semantic Wiki – Designing Annotation and Browse Interfaces for Given Ontologies, Volume 9507 of the series Lecture Notes in Computer Science, pp 53-72, 16 April 2016.

Software Description

This is a deprecated version of Fresnel Forms. The functionality from this version is being merged into a renewed Semantic MediaWiki extension: Fresnel Forms SMW extension.

Fresnel Forms (FForms) is a plugin for the Protégé ontology editor that helps create Fresnel-defined interfaces, and exports them as semantic wiki's. FForms generates default Fresnel interface code for the ontology currently loaded in Protégé. This plugin then provide a GUI for editing Fresnel-defined interfaces. Finally, Fresnel Forms exports Fresnel-defined interfaces as semantic wikis. These wikis provide both browsing of existing data and form-based annotation interfaces for adding new data.

Fresnel Forms can be downloaded and installed from https://github.com/ABI-Team-30/Fresnel-Forms.

We have applied FForms to the entire DBpedia ontology to generate Fresnel style and a corresponding wiki interface for it. The files involved are:

Installation Fresnel Forms for End Users

  1. Download and install MediaWiki
  2. Download and install these MediaWiki extensions:
    1. Semantic MediaWiki
    2. Page Forms (formerly Semantic Forms)
    3. ParserFunctions
    4. Character Escapes
  3. Adjust your MediaWiki installation with the following steps:
    1. Add to your wiki's LocalSettings.php file the following line:
      $wgAllowImageTag=true;
    2. Copy the content of Default_CSS_Fresnel_Forms and paste into MediaWiki:Common.css
  4. Download and install Protégé 5.0 beta 17
    1. Copy and paste the Fresnel Forms .jar file in your Protégé /plugins directory
    2. Start Protégé.
    3. If Protégé does not show the Fresnel Forms tab, select the Fresnel Forms tab from the Protégé pull-down menu Window / Tabs
    4. If you get the error "Couldn't load view plugin" then simply load the view yourself:
      1. Click the message away on the 'x'. You then have an empty Fresnel Forms tab, without any view.
      2. Select the Fresnel Forms view from the Protégé pull-down menu / Window / Views / Ontology Views / Fresnel Forms
      3. Place the Fresnel Forms view in the Fresnel Forms tab

Compatibility

Fresnel Forms has been tested with the following software versions:

Fresnel Forms compatibility table
Product Version
Protégé Desktop (or Git master branch) 5.0.0-beta-15 or 5.0.0-beta-16-SNAPSHOT from Git (tested up to commit dcddbf6e815aff1cffd56de414bdd0d7512fd901)
MediaWiki 1.19.14+dfsg-1
PHP 5.5.9-1ubuntu4.6 (apache2handler)
MySQL 5.5.41-0ubuntu0.14.04.1
Semantic Forms 2.8
Semantic MediaWiki 2.0
Character Escapes 0.9.1
Parser Functions 1.4.1

These were the software versions which were up-to date for Ubuntu 14.04.2 LTS at 2015-02-22.

Tips & Tricks

  1. Documentation
    1. To generate the project documentation locally, you can execute ‘mvn site’. After that, the resulting documentation will be present in the target/site folder of the source folder. The entry point for the documentation is index.html.
    2. Read the document ‘Userinterface instructie.docx’ before loading really large ontology’s like dbpedia.
  2. Before loading Fresnel, make sure Protégé has loaded the ontology the Fresnel style sheet was based on.
  3. Opening ontologies
    1. If you open a large ontology expand the lenses one by one. Do not activate the the right menu item ‘Expand all’
    2. If you want to open an ontology a second time, open in a new window (might incur failure otherwise).
  4. GUI
    1. Show the superclass in the gui to prevent problems with inheriting attributes.
    2. Make sure the lens boxes do not visibly overlap each other in the GUI. If they do, you may not be able to get the property menu when right clicking a property.
    3. After selecting the ‘Expand all’ menu item select also the ‘rearrange’ menu item to be sure that the lenses do not overlap.
  5. In a form, for properties (not of type page) with multiple values, separate values by a comma. Separate URL's for an image property by a space, then a comma.