Skip to content

Rework the Ontology documentation

Sam Thursfield requested to merge sam/ontology-docs into master

This change was motivated by #104 (closed). We want to move to using URLs that we control for the ontologies, like this:

    http://api.gnome.org/ontologies/nfo/3.0/#Document
    http://api.gnome.org/ontologies/nfo/3.0/#url

For this scheme to work, each ontology needs to document all classes and properties on a single page.

It's an opportunity to reorganize the documentation too and try to prioritize the most important info. Here's a partial list of changes in this commit:

  • One page per ontology, listing all classes and properties defined in that ontology.
  • URL fragments matching class and property names, so for example /nmm.html#artistName links to the nmm:artistName property.
  • Cross references now work between libtracker-sparql3 and tracker3-nepomuk ontology docs
  • Properties are shown as a concise table.
  • Classes and properties are listed in alphabetical order.
  • New 'tracker:specification' property which allows us to link to upstream documentation.
  • New 'synopsis' section for each ontology showing appropriate Turtle @prefix statement

Also, the docs/tools/ttl2xml program now returns failed status when it encounters parse errors in an ontology.

Edited by Sam Thursfield

Merge request reports