aksw / rdfauthor
RDFauthor creates formular widgets out of RDFa-enhanced webpages.
Installs: 8 620
Dependents: 1
Suggesters: 0
Security: 0
Stars: 18
Watchers: 15
Forks: 5
Open Issues: 20
Language:JavaScript
This package is not auto-updated.
Last update: 2024-11-05 04:45:37 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.
-
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.
-
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/
). -
Define another global variable called
RDFAUTHOR_READY_CALLBACK
which contains a function to be executed when RDFauthor has finished loading. Typical usage is callingsetOptions()
andstart()
:RDFAUTHOR_READY_CALLBACK = function () { // RDFauthor is now loaded and ready to use RDFauthor.setOptions({}); RDFauthor.start(); };
-
Include
rdfauthor.js
(found underRDFAUTHOR_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 undermisc/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.