File: HOWTO.DOCUMENTATION

package info (click to toggle)
shared-desktop-ontologies 0.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 5,556 kB
  • sloc: python: 419; makefile: 2
file content (16 lines) | stat: -rw-r--r-- 750 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
How the Ontology documentation works:

A script generates references for all ontologies. Each ontology entity has
an id which matches its abbreviated URI (Example: nao:prefLabel). Thus, in
order to link to any ontology entity (property or class) just use the xref
or the link tag with the appropriate linkend (link allows to specify a 
custom text which xref uses the title from the linked element).

Author information goes into the <onto>-authors.docbook file.

All other documentation goes into the <onto>-main.docbook file which should
contain sections and optional appendixes.
Please use <onto>:sec-<topic> as the id for a section.

Each ontology gets its own chapter which has as an id the namespace abbreviation
(Example: <chapter id="nfo">).