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

From SW_OWF
Jump to navigation Jump to search
((FForms))
(link external tool download sites →‎Installation Fresnel Forms for End Users)
Line 11: Line 11:
 
== Installation Fresnel Forms for End Users ==
 
== Installation Fresnel Forms for End Users ==
  
# Download and install the prerequisites:
+
# Download and install [https://www.mediawiki.org/wiki/MediaWiki MediaWiki]
 +
# Download and install the MediaWiki prerequisites:
 
## [http://www.mediawiki.org/ MediaWiki]
 
## [http://www.mediawiki.org/ MediaWiki]
 
## [http://semantic-mediawiki.org/ Semantic MediaWiki]
 
## [http://semantic-mediawiki.org/ Semantic MediaWiki]
Line 17: Line 18:
 
## [http://www.mediawiki.org/wiki/Extension:ParserFunctions ParserFunctions]
 
## [http://www.mediawiki.org/wiki/Extension:ParserFunctions ParserFunctions]
 
## [http://www.mediawiki.org/wiki/Extension:Character_Escapes Character Escapes]
 
## [http://www.mediawiki.org/wiki/Extension:Character_Escapes Character Escapes]
## [http://protege.stanford.edu/products.php#desktop-protege Protégé 5.0.0-beta-15] or see [[Building Protege 5]]
+
# Adjust your MediaWiki installation with the following steps
# Add to your wiki's LocalSettings.php file the following line:<br/><code>$wgAllowImageTag=true;</code><br/>
+
## Add to your wiki's LocalSettings.php file the following line:<br/><code>$wgAllowImageTag=true;</code><br/>
# Copy the content of [[Default_CSS_Fresnel_Forms]] and paste into MediaWiki:Common.css.
+
## Copy the content of [[Default_CSS_Fresnel_Forms]] and paste into MediaWiki:Common.css.
# Copy and paste the Fresnel Forms .jar file in your Protégé /plugins directory.
+
# Download and install build 17 from [http://protegewiki.stanford.edu/wiki/Protege_Desktop_Old_Versions Protégé]
# Restart Protégé.
+
## Copy and paste the Fresnel Forms .jar file in your Protégé /plugins directory.
# In case Protégé does not show the Fresnel Forms tab, select the plug-in in Protégé/Window/Tabs.
+
## Start Protégé.
# Done.
+
## If Protégé does not show the Fresnel Forms tab, select the plug-in in Protégé/Window/Tabs.
  
 
== Compatibility ==
 
== Compatibility ==

Revision as of 13:22, 6 July 2016

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 the MediaWiki prerequisites:
    1. MediaWiki
    2. Semantic MediaWiki
    3. Semantic Forms
    4. ParserFunctions
    5. 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 build 17 from Protégé
    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 plug-in in Protégé/Window/Tabs.

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

  • 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.
  • Read the document ‘Userinterface instructie.docx’ before loading really large ontology’s like dbpedia.
  • Before loading Fresnel, make sure Protégé has loaded the ontology the Fresnel style sheet was based on.
  • 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.
  • 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’
  • 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.