Any bundle may provide some user documentation. This documentation is provided by a file named "documentation.nt" in the META-INF directory of the bundle-jar. This file can provide multiple documentation resources described using the discobits ontology. The resources have UriRefs starting with "bundle:///", this will be replaced with http://<hostname>/bundle-doc/<Bundle-SymbolicName> by the documentation aggregator which provides the graph urn:x-localinstance:/documentation.graph containing the documentation of all installed bundles. To reference a documentation entry from another bundle the bundle-uri can contain a Borundle-SymbolicName after the second slash, e.g. bundle://org.apache.clerezza.platform.content/intro.
By convention any bundle documentation provides a resource named bundle:///intro introducing the functionality of the bundle.
Writing Documentation
The recommended way to create and edit the documentation of a bundle is as follows:
- Launch clerezza (in the following we assume its running on localhost:8080)
- Install and start the stable n-triples serialization provider (to make the stored files more suitable for version control) by entering on the commmand line:
start("mvn:org.apache.clerezza/rdf.stable.serializer")
- Install and start the file storage provider(to access local rdf files as named graphs) by entering on the commmand line:
start("mvn:org.apache.clerezza/rdf.file.storage") - If it doesn't exist yet create an empty file src/main/resources/META-INF/documentation.nt in the project to be documented and
- Open http://clerezza.apache.org/tools/editor/, enter the file-uri of the previously created file as Graph and a bundle-uri (such as bundle:///intro) as resource
- edit, save, ship your bundle
