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