anchor.diff:  
   :leveloffset: 2
   
  -== Integrated Live Console ==
  -
  -An interactive console can be added and will show up in the online HTML version.
  -An optional title can be added, which will be used for the text of the button.
  -
  -This is how to do it, using Cypher to define the data, with an empty line to separate it from the query:
  -
  -[source]
  -----
  - .Interactive Example
  - [console]
  - ----
  - CREATE (n {name: 'Neo4j'})
  -
  - MATCH (n)
  - return n
  - ----
  -----
  -
  -And this is the result:
  -
  -.Interactive Example
  -[console]
  -----
  -CREATE (n {name: 'Neo4j'})
  -
  -MATCH (n)
  -return n
  -----
  -
  -== Toolchain ==
  -
  -Useful links when configuring the docbook toolchain:
  -
  -* http://www.docbook.org/tdg/en/html/docbook.html
  -* http://www.sagehill.net/docbookxsl/index.html
  -* http://docbook.sourceforge.net/release/xsl/1.76.1/doc/html/index.html
  -* http://docbook.sourceforge.net/release/xsl/1.76.1/doc/fo/index.html
  -
  +== Images
  +
  +.pris-overview.graphml
  +image::images/pris-overview.png[pris-overview.graphml]
  +
  +.example.odp
  +image::images/example.png[example.odp]
  +
  
positive.code: Ronny Trommer <ronny@opennms.org>; Markus von Rüden <mvr@opennms.com>
  :ascii-ids:
  
  == Chapter 1
  
  === Chapter 1.1
  
  == Chapter 2
  
  
  == Images
  
  .pris-overview.graphml
  image::images/pris-overview.png[pris-overview.graphml]
  
  .example.odp
  image::images/example.png[example.odp]
  
  [[community-docs]]
  Writing OpenNMS Documentation
  ===========================
  
  NOTE: Other than writing documentation, you can help out by providing comments about improvements or reporting bugs - head over to the http://issues.opennms.org/browse/NMS/component/10011[issue tracker for documentation] to do that!
  
  For how to build the manual see:
  https://github.com/neo4j/neo4j/blob/master/manual/README.asciidoc[readme]
  
  The documents use the asciidoc format, see:
  
  * http://www.methods.co.nz/asciidoc/[Aciidoc Reference]
  * http://powerman.name/doc/asciidoc[AsciiDoc cheatsheet]
  
  The cheatsheet is really useful!
  
  [[community-docs-overall-flow]]
  == Overall Flow ==
  
  Each (sub)project has its own documentation, which will produce a 'docs.jar' file.
  By default this file is assembled from the contents in 'src/docs/'.
  Asciidoc documents have the +.asciidoc+ file extension.
  
  The documents can use code snippets which will extract code from the project.
  The corresponding code must be deployed to the 'sources.jar' or 'test-sources.jar' file.
  
  By setting up a unit test accordingly, documentation can be written directly in the JavaDoc comment.
  
  The above files are all consumed by the build of the manual (by adding them as dependencies).
  To get content included in the manual, it has to be explicitly included by a document in the manual as well.
  
  Note that different ways to add documentation works best for different cases:
  
  * For detail level documentation, it works well to write the documentation as part of unit tests (in the JavaDoc comment).
    In this case, you typically do not want to link to the source code in the documentation.
  * For tutorial level documentation, the result will be best by writing a +.asciidoc+ file containing the text.
    Source snippets and output examples can then be included from there.
    In this case you typically want to link to the source code, and users should be able to run it without any special setup.
  
  == File Structure in 'docs.jar' ==
  
  [options="header", cols="e,d"]
  |========================
  | Directory | Contents
  | dev/ | content aimed at developers
  | dev/images/ | images used by the dev docs
  | ops/ | content aimed at operations
  | ops/images/ | images used by the ops docs
  | man/ | manpages
  |========================
  
  Additional subdirectories are used as needed to structure the documents,
  like 'dev/tutorial/', 'ops/tutorial/' etc.
  
  == Headings and document structure ==
  
  Each document starts over with headings from level zero (the document title).
  Each document should have an id.
  In some cases sections in the document need to have id's as well, this depends on where they fit in the overall structure.
  To be able to link to content, it has to have an id.
  Missing id's in mandatory places will fail the build.
  
  This is how a document should start:
  
  
negative.code: 
  [source]
  ----
  http://www.opennms.org/[Link text here]
  ----
  
  Which renders like: http://www.opennms.org/[Link text here]
  
  For short links it may be better not to add a link text, just do:
  
  [source]
  ----
  http://www.opennms.org/
  ----
  
  Which renders like: http://www.opennms.org/
  
  NOTE: It's ok to have a dot right after the URL, it won't be part of the link.
  
  