summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorSam Thursfield <sam@afuera.me.uk>2020-04-09 01:45:54 +0200
committerSam Thursfield <sam@afuera.me.uk>2020-04-18 14:12:22 +0200
commitd40452bb1291f8f0ff1e6f5124dc55f7d21d3043 (patch)
treea08619b805e60f9156cd86028b4ccf88fe46dd15 /examples
parent4411d9cac3e2ba3e7c1cb1b41eb4cc803c3583c1 (diff)
downloadtracker-d40452bb1291f8f0ff1e6f5124dc55f7d21d3043.tar.gz
Rework the Ontology documentation
This change was motivated by https://gitlab.gnome.org/GNOME/tracker/issues/104. 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:classSpecification' and 'tracker:propertySpecification' properties which allow 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.
Diffstat (limited to 'examples')
0 files changed, 0 insertions, 0 deletions