aksw/rdfauthor

RDFauthor creates formular widgets out of RDFa-enhanced webpages.

dev-develop 2016-04-14 11:51 UTC

README

Requirements

To make use of RDFauthor your web project must meet the following requirements:

  • RDFa must be used to embed RDF triples in your XHTML markup.
  • The triple store where your data comes from must provide a SPARQL/Update endpoint.
  • The URI of the update endpoint must be embedded in the page using our update vocabulary.

Installation

RDFauthor is a JavaScript library, hence no installation is needed.

Using RDFauthor within your Project

Three steps are required in order to use RDFauthor within your project.

  1. Embed provenance information (as RDFa) for named graphs in your page. If you don't use named graphs, the URI of the page is used as the graph URI.
  2. Define a global JavaScript variable named RDFAUTHOR_BASE that contains the URI of RDFauthor on your web server (e.g. http://example.com/MyWebApp/lib/rdfauthor/).
  3. Define another global variable called RDFAUTHOR_READY_CALLBACK which contains a function to be executed when RDFauthor has finished loading. Typical usage is calling setOptions() and start():

    RDFAUTHOR_READY_CALLBACK = function () {
        // RDFauthor is now loaded and ready to use
        RDFauthor.setOptions({});
        RDFauthor.start();
    };
    
  4. Include rdfauthor.js (found under RDFAUTHOR_BASE) lazily.

Options

Currently, the following options exist:

var _defaultOptions = {
    title: 'Title', 
    saveButtonTitle: 'saveButtonTitle', 
    cancelButtonTitle: 'cancelButtonTitle', 
    showButtons: true, 
    useAnimations: true, 
    autoParse: true, 
    usePredicateInfo: true, 
    useSPARQL11: false, 
    fetchAllPredicates: true, 
    viewOptions: {
        type: 'popover' /* inline or popover */
    }
};

Unless you are using the update-API up Ontowiki, you probably want to set useSPARQL11 to true, so it uses SPARQL-update.

API Documentation

RDFauthor's API documentation can be built with JsDoc Toolkit. Under Ubuntu, you can install this by running sudo apt-get install jsdoc-toolkit. Afterwards run jsdoc -d=./doc ./src in the directory of RDFauthor.

If you manually downloaded the toolkit, you need to set two environment variables:

  • set $JSDOCDIR to the path under which you installed JsDoc (e.g. /opt/local/jsdoc-toolkit).
  • set $JSDOCTEMPLATEDIR to RDFauthor's documentation template dir (e.g. /opt/local/rdfauthor/misc/jsdoc-template). The template dir is located under misc/jsdoc-templates in your RDFauthor dir.

Assuming jsrun.sh is available in you path, you can run JsDoc from within the RDFauthor directory using the following command:

jsrun.sh -d=./doc ./src

This will build the API documentation in a diectory named doc under your RDFauthor directory.