LODE - Live OWL Documentation Environment

<!DOCTYPE html> <html> <head> <title>LODE - Live OWL Documentation Environment</title> <link rel="shortcut icon" href="/assets/img/lode/lode.ico" /> <link href="/assets/css/lode/owl.css" rel="stylesheet" type="text/css" /> <link href="/assets/css/lode/Primer.css" rel="stylesheet" type="text/css" /> <link href="/assets/css/lode/rec.css" rel="stylesheet" type="text/css" /> <link href="/assets/css/lode/extra.css" rel="stylesheet" type="text/css" /> <meta charset="UTF-8" /> <style type="text/css"> h1 { float:left; } form { text-align:left; margin-top:70px; margin-bottom:50px; margin-left:30%; } form div { line-height:170%; } .text , .modules label { margin-right:1em; } .reasoner { margin-right:4em; } .noWrap { white-space:nowrap; } </style> </head> <body> <h1><img src="/assets/img/lode/logo.png" alt="LODE logo" /></h1> <form method="GET" action="http://150.146.207.114/lode/extract" accept-charset="utf-8"> <input type="url" id="url" name="url" placeholder="Put here the complete ontology URL" size="60" /> <div> <label>Modules:</label> <input type="checkbox" name="owlapi" value="true" /> OWLAPI <input type="checkbox" name="imported" value="true" /> Imported <input type="checkbox" name="closure" value="true" /> Closure <input type="checkbox" id="reasoner" name="reasoner" value="true" /> Reasoner <label for="number">Language</label>: <input id="number" type="text" name="lang" value="en" placeholder="'en' if empty" /> </div> <button type="submit">Generate Documentation</button> </form> <a href="http://www.github.com/essepuntato/LODE" title="Project homepage hosted by GitHub">Live OWL Documentation Environment</a> (LODE) is a service that automatically extracts classes, object properties, data properties, named individuals, annotation properties, general axioms and namespace declarations from an OWL and OWL2 ontology, and renders them as ordered lists, together with their textual definitions, in a human-readable HTML page designed for browsing and navigation by means of embedded links. This LODE service is an open source development, and can be freely used, as described in this document. It may be used in conjunction with content negotiation to display this human-readable version of an OWL ontology when the user accesses the ontology using a web browser, or alternatively to deliver the OWL ontology itself when the user accesses the ontology using an ontology editing tool such as <a href="http://protege.stanford.edu/">Prot茅g茅</a> and <a href="http://neon-toolkit.org">NeOn Toolkit</a>. An exemplar implementation of such content negotiation is given in the <a href="http://www.w3.org/TR/swbp-vocab-pub/">Best Practice Recipes for Publishing RDF Vocabularies</a> by using the .htaccess file: <pre> AddType application/rdf+xml .rdf # Rewrite engine setup RewriteEngine On # Rewrite rule to serve HTML content RewriteCond %{HTTP_ACCEPT} !application/rdf\+xml.*(text/html|application/xhtml\+xml) RewriteCond %{HTTP_ACCEPT} text/html [OR] RewriteCond %{HTTP_ACCEPT} application/xhtml\+xml [OR] RewriteCond %{HTTP_USER_AGENT} ^Mozilla/.* RewriteRule ^ontology\$ https://w3id.org/lode/http://www.mydomain.com/ontology [R=303,L] # Rewrite rule to serve RDF/XML content if requested RewriteCond %{HTTP_ACCEPT} application/rdf\+xml RewriteRule ^ontology\$ ontology.owl [R=303] # Choose the default response RewriteRule ^ontology\$ ontology.owl [R=303] </pre> Depending on the parameters specified, the HTML page created by LODE takes into account both ontological axioms and annotations. The CSSs used for the resulting HTML page are based on the <a href="http://www.w3.org">W3C</a> CSSs for Recommendation documents. The following pseudo-URL describes the way to call the LODE service: <blockquote> https://w3id.org/lode/optional-parameters/ontology-url </blockquote> where: <dl> <dt>w3id.org/lode</dt> <dd> is the URL to call the service. </dd> <dt>ontology-url</dt> <dd> is the full http://... URL of the OWL ontology that will be processed by the service. It must be always the last item in the pseudo-URL, and may be preceded by one or more (slash-separated) parameters. </dd> </dl> optional slash-separated parameters: <dl> <dt>owlapi</dt> <dd> When this optional parameter is specified, the ontology specified in ontology-url will be pre-processed via <a href="http://owlapi.sourceforge.net/">OWLAPI</a>, in order to linearized it in standard RDF/XML format. This parameter is always strongly recommended. </dd> <dt>closure</dt> <dd> When this optional parameter is specified, the transitive closure given by considering the imported ontologies of ontology-url is added to the HTML description of the ontology. This parameter implicitly specifies the owlapi parameter. If both functions closure and imported are specified (in any order), just imported will be considered. </dd> <dt>imported</dt> <dd> When this optional parameter is specified, the axioms contained the ontologies directed imported into ontology-url are added to the HTML description of the ontology. This parameter implicitly specifies the owlapi parameter. If both parameters closure and imported are specified (in any order), just imported will be considered. </dd> <dt>reasoner</dt> <dd> When this optional parameter is specified, the assertions inferable from ontology-url using the <a href="http://clarkparsia.com/pellet">Pellet reasoner</a> will be added to the HTML description of the ontology. This parameter implicitly specifies the owlapi parameter. Note that, depending upon the nature of your ontology, this computationally intensive function can be very time-consuming. </dd> <dt>lang=XXX</dt> <dd> When this optional parameter is specified, the specified language will be used as preferred language instead of English when showing annotations of the ontology specified in ontology-url. E.g.: <q>lang=it</q>, <q>lang=fr</q>, etc. </dd> </dl> <h2> Some examples </h2> <ul> <li> <a href="https://w3id.org/lode/http://purl.org/spar/fabio">https://w3id.org/lode/http://purl.org/spar/fabio</a> </li> <li> <a href="https://w3id.org/lode/owlapi/http://www.essepuntato.it/2008/12/earmark">https://w3id.org/lode/owlapi/http://www.essepuntato.it/2008/12/earmark</a> </li> <li> <a href="https://w3id.org/lode/imported/http://www.essepuntato.it/2008/12/earmark">https://w3id.org/lode/imported/http://www.essepuntato.it/2008/12/earmark</a> </li> <li> <a href="https://w3id.org/lode/closure/http://www.essepuntato.it/2008/12/earmark">https://w3id.org/lode/closure/http://www.essepuntato.it/2008/12/earmark</a> </li> </ul> <h2>Annotations</h2> LODE takes the most common properties used for denoting annotations, such as dc:title, dc:description, rdfs:label and rdfs:comment. The translation in HTML of annotations made using those properties varies a little depending on whether the annotations describe the ontology itself, or its entities (classes, properties, instances). The following figures illustrates how ontology's annotations are handled by LODE. <img src="/assets/img/lode/ontology.png" alt="visualization of ontology annotations" /> <img src="/assets/img/lode/picture.png" alt="visualization of pictures" /> Similarly, the following picture describes how annotations about each entity of the ontology are handled by LODE. <img src="/assets/img/lode/class.png" alt="visualization of class annotations" /> The annotation properties handled by LODE are: <ul> <li> dc:contributor </li> <li> dc:creator </li> <li> dc:date </li> <li> dc:description, used with a literal as object, if you want to add a textual description to the ontology, or with a resource as object, if you want to trasclude that resource (e.g., a picture) as description of an entity. </li> <li> dc:publisher </li> <li> dc:rights </li> <li> dc:title </li> <li> owl:backwardCompatibleWith </li> <li> owl:incompatibleWith </li> <li> owl:versionInfo </li> <li> owl:versionIRI </li> <li> rdfs:comment </li> <li> rdfs:isDefinedBy </li> <li> rdfs:label </li> </ul> <h2>References</h2> Peroni, S., Shotton, D., Vitali, F. (2012). The Live OWL Documentation Environment: a tool for the automatic generation of ontology documentation. To appear in Proceedings of the 18th International Conference on Knowledge Engineering and Knowledge Management (EKAW 2012). Available at <a href="http://speroni.web.cs.unibo.it/publications/peroni-2012-live-documentation-environment.pdf">http://speroni.web.cs.unibo.it/publications/peroni-2012-live-documentation-environment.pdf</a> Peroni, S., Shotton, D., Vitali, F. (2013). Tools for the automatic generation of ontology documentation: a task-based evaluation. To appear in International Journal on Semantic Web and Information Systems, 9 (1). Available at <a href="http://speroni.web.cs.unibo.it/publications/peroni-2013-tools-automatic-generation.pdf">http://speroni.web.cs.unibo.it/publications/peroni-2013-tools-automatic-generation.pdf</a> <h2>About the author</h2> <a href="http://www.essepuntato.it">Silvio Peroni</a> (Ph.D.) is an Assistant Professor at the Department of Classical Philology and Italian Studies, University of Bologna. <h2>Acknowledgements</h2> The online service is currently hosted by a server kindly provided by the <a href="http://stlab.istc.cnr.it/">Semantic Technology Laboratory (STLab)</a>, <a href="http://istc.cnr.it">Institute of Cognitive Sciences and Technologies</a>, <a href="http://www.cnr.it">National Research Council</a>, Rome, Italy. </body> </html>

CINXE.COM

LODE - Live OWL Documentation Environment