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

From SW_OWF
Jump to navigation Jump to search
(full install instructions)
Line 8: Line 8:
 
* [[File:Dbp_complete.n3.zip]]: The default Fresnel code that Fresnel Forms generates from this ontology.
 
* [[File:Dbp_complete.n3.zip]]: The default Fresnel code that Fresnel Forms generates from this ontology.
 
* http://is.cs.ou.nl/OWF/files/FresnelForms/dbp_complete.xml.zip: The wiki interface that Fresnel Forms generates from this default Fresnel code.
 
* http://is.cs.ou.nl/OWF/files/FresnelForms/dbp_complete.xml.zip: The wiki interface that Fresnel Forms generates from this default Fresnel code.
 +
 +
== Installation ==
 +
# Download and install the prerequisites:
 +
## [http://www.mediawiki.org/ MediaWiki]
 +
## [http://semantic-mediawiki.org/ Semantic MediaWiki]
 +
## [http://www.mediawiki.org/wiki/Extension:Semantic_Forms Semantic Forms]
 +
## [http://www.mediawiki.org/wiki/Extension:ParserFunctions ParserFunctions]
 +
## [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 [[Bouwen Protégé 5|instructions for building 5.0.0-beta-16-SNAPSHOT (dutch)]]
 +
# 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 and paste the Fresnel Forms .jar file in your Protégé /plugins directory.
 +
# Restart Protégé.
 +
# In case Protégé does not show the Fresnel Forms tab, select the plug-in in Protégé/Window/Tabs.
 +
# Done.
 +
 +
== Compatibility ==
 +
Fresnel Forms has been tested with the following software versions:
 +
{| class="wikitable"
 +
|+Fresnel Forms compatibility table
 +
!Product
 +
!Version
 +
|-
 +
|[http://protege.stanford.edu/products.php#desktop-protege Protégé Desktop] (or [https://github.com/protegeproject/protege.git Git master branch])
 +
|5.0.0-beta-15 or 5.0.0-beta-16-SNAPSHOT from Git (tested up to commit dcddbf6e815aff1cffd56de414bdd0d7512fd901)
 +
|-
 +
|[https://www.mediawiki.org/ MediaWiki]
 +
|1.19.14+dfsg-1
 +
|-
 +
|[http://www.php.net/ PHP]
 +
|5.5.9-1ubuntu4.6 (apache2handler)
 +
|-
 +
|[http://www.mysql.com/ MySQL]
 +
|5.5.41-0ubuntu0.14.04.1
 +
|-
 +
|[https://www.mediawiki.org/wiki/Extension:Semantic_Forms Semantic Forms]
 +
|2.8
 +
|-
 +
|[https://semantic-mediawiki.org/ Semantic MediaWiki]
 +
|2.0
 +
|-
 +
|[https://www.mediawiki.org/wiki/Extension:Character_Escapes Character Escapes]
 +
|0.9.1
 +
|-
 +
|[https://www.mediawiki.org/wiki/Extension:ParserFunctions Parser Functions]
 +
|1.4.1
 +
|}
 +
 +
<code>These were the software versions which were up-to date for Ubuntu 14.04.2 LTS at 2015-02-22.</code>
 +
 +
== Tips & Tricks ==
 +
 +
* Entering certain HTML symbols in the delimiter field http://www.mediawiki.org/wiki/Help_talk:Formatting  may cause special:import on the MediaWiki to crash. Instead of e.g. <code>&amp;nbsp;</code> enter <code>&<bold>amp;</bold>nbsp;</code>
 +
*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.

Revision as of 14:54, 3 April 2015

Fresnel Forms is a plugin for the Protégé ontology editor that helps create Fresnel-defined interfaces, and exports them as semantic wiki's. It 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/releases

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

Installation

  1. Download and install the prerequisites:
    1. MediaWiki
    2. Semantic MediaWiki
    3. Semantic Forms
    4. ParserFunctions
    5. Character Escapes
    6. Protégé 5.0.0-beta-15 or see instructions for building 5.0.0-beta-16-SNAPSHOT (dutch)
  2. Add to your wiki's LocalSettings.php file the following line:
    $wgAllowImageTag=true;
  3. Copy the content of Default_CSS_Fresnel_Forms and paste into MediaWiki:Common.css.
  4. Copy and paste the Fresnel Forms .jar file in your Protégé /plugins directory.
  5. Restart Protégé.
  6. In case Protégé does not show the Fresnel Forms tab, select the plug-in in Protégé/Window/Tabs.
  7. Done.

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

  • Entering certain HTML symbols in the delimiter field http://www.mediawiki.org/wiki/Help_talk:Formatting may cause special:import on the MediaWiki to crash. Instead of e.g. &nbsp; enter &<bold>amp;</bold>nbsp;
  • 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.