Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.55 KB

Readme.md

File metadata and controls

41 lines (31 loc) · 2.55 KB
Raw

Neo4J

This is the technical documentation for our Neo4J driver

  • Driver outlines the technical details of the driver.
  • Preprocessor is about the maven preprocessor plugin that is necessary for the Namespace parts of the driver ONLY.

How to contribute

To everyone contributing. Please read the following carefully before contributing:

  • This documentation is intended for both the developers, as well as the users of the project. Please carefully separate the information for both of these groups.

Technical details

This documentation is written in markdown. It includes code commentary using regular code ('''java), and tooling for drawing graphs ('''puml -> PlantUML, '''dot -> GraphViz). For all supported diagrams see here. An extended tooling support can also be used to render latex.

Please note that the tooling is only supported with markdown-preview-enhanced whch is only available on Atom or VisualStudioCode. To use full graph support you need to install GrapzViz as well as a latex distribution.

Notes for CodeChunk (latex etc.):

  • You have to enable scripts in the settings before this works
  • The code is only executed when you use shift + enter (current snippet); ctrl + shift + enter (all snippets in file) or run the play button in the preview.[^1]

bring it to work with VisualStudioCode

  • Tex Live
    • instructions
    • includes links for download installation took a real long time
  • Install pdf2svg
    • pdf2svg-windows
      • just download the zip file
      • extract the zip
      • put it wherever you want it to be (e.g.: I:/programs/pdf2vsg)
      • add pdf2svg.exe to Path I:\programs\pdf2svg\dist-64bits\pdf2svg.exe
      • restart computer
  • VisualStudioCode Extensions

*[MPE]: Markdown Preview Enhanced *[PASS]: Plan Analysis using Self-learining Solutions and simulations *[vEMOOS]: virtual Expo in the Middle Of Our Street