[jqassistant-archive/jqa-manual#7] Added the basic structure for the …

…userguide as well as a very basic initial document for the reference.

manual/.gitignore

@@ -1,5 +1,6 @@
 target
 /.idea
+*.html
 *.iml
 *.ipr
 *~

manual/pom.xml

@@ -93,6 +93,39 @@
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
                 <executions>
+                    <execution>
+                        <id>userguide</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirectory>${project.basedir}/src/main/asciidoc/newdocs/userguide</sourceDirectory>
+                            <outputDirectory>${project.build.directory}/generated-docs/userguide</outputDirectory>
+                            <backend>xhtml5</backend>
+                            <sourceDocumentName>index.adoc</sourceDocumentName>
+                            <attributes>
+                                <toc>left</toc>
+                            </attributes>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>reference</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirectory>${project.basedir}/src/main/asciidoc/newdocs/userguide</sourceDirectory>
+                            <outputDirectory>${project.build.directory}/generated-docs/userguide</outputDirectory>
+                            <backend>xhtml5</backend>
+                            <sourceDocumentName>index.adoc</sourceDocumentName>
+                            <attributes>
+                                <toc>left</toc>
+                            </attributes>
+                        </configuration>
+                    </execution>
+
                     <execution>
                         <id>manual</id>
                         <phase>process-resources</phase>

manual/src/main/asciidoc/newdocs/index.adoc

@@ -0,0 +1,5 @@
+= jQAssistant User Documention Central
+
+== <<userguide.adoc#,jQAssistant Userguide>>
+
+== <<reference.adoc#,jQAssistant Reference>>

manual/src/main/asciidoc/newdocs/reference/reference.adoc

@@ -0,0 +1,9 @@
+= jQAssistant Reference
+
+
+
+
+<<../userguide/userguide.adoc#TEST,Mehr im Userguide>>
+Damit Ihr indess erkennt, woher dieser ganze Irrthum gekommen ist, und weshalb man die Lust anklagt und den Schmerz lobet, so will ich Euch Alles eröffnen und auseinander setzen, was jener Begründer der Wahrheit und gleichsam Baumeister des glücklichen Lebens selbst darüber gesagt hat. Niemand, sagt er, verschmähe, oder hasse, oder fliehe die Lust als solche, sondern weil grosse Schmerzen ihr folgen, wenn man nicht mit Vernunft ihr nachzugehen verstehe. Ebenso werde der Schmerz als solcher von Niemand geliebt, gesucht und verlangt, sondern weil mitunter solche Zeiten eintreten, dass man mittelst Arbeiten und Schmerzen eine grosse Lust sich zu verschaften suchen müsse. Um hier gleich bei dem Einfachsten stehen zu bleiben, so würde Niemand von uns anstrengende körperliche Uebungen vornehmen, wenn er nicht einen Vortheil davon erwartete. Wer dürfte aber wohl Den tadeln, der nach einer Lust verlangt, welcher keine Unannehmlichkeit folgt, oder der einem Schmerze ausweicht, aus dem keine Lust hervorgeht?
+
+Dagegen tadelt und hasst man mit Recht Den, welcher sich durch die Lockungen einer gegenwärtigen Lust erweichen und verführen lässt, ohne in seiner blinden Begierde zu sehen, welche Schmerzen und Unannehmlichkeiten seiner deshalb warten. Gleiche Schuld treffe Die, welche aus geistiger Schwäche, d.h. um der Arbeit und dem Schmerze zu entgehen, ihre Pflichten verabsäumen. Man kann hier leicht und schnell den richtigen Unterschied treffen; zu einer ruhigen Zeit, wo die Wahl der Entscheidung völlig frei ist und nichts hindert, das zu thun, was den Meisten gefällt, hat man jede Lust zu erfassen und jeden Schmerz abzuhalten; aber zu Zeiten trifft es sich in Folge von schuldigen Pflichten oder von sachlicher Noth, dass man die Lust zurückweisen und Beschwerden nicht von sich weisen darf. Deshalb trifft der Weise dann eine Auswahl, damit er durch Zurückweisung einer Lust dafür eine grössere erlange oder durch

manual/src/main/asciidoc/newdocs/shared/to-be-written.adoc

@@ -0,0 +1,6 @@
+
+
+[NOTE]
+====
+This chapter has not been written yet.
+====

manual/src/main/asciidoc/newdocs/userguide/features/00-features.adoc

@@ -0,0 +1,51 @@
+== Features
+
+include::../../shared/to-be-written.adoc[]
+
+=== Intuitive and Expansible Graph Model
+
+include::../../shared/to-be-written.adoc[]
+
+=== Flexible Query Language
+
+include::../../shared/to-be-written.adoc[]
+
+=== Rules
+
+include::../../shared/to-be-written.adoc[]
+
+=== Various Severties
+
+include::../../shared/to-be-written.adoc[]
+
+=== Multiple Formats
+
+include::../../shared/to-be-written.adoc[]
+
+=== Executable Architecture Documentation
+
+include::../../shared/to-be-written.adoc[]
+
+=== Reporting
+
+include::../../shared/to-be-written.adoc[]
+
+=== Build System Integration
+
+include::../../shared/to-be-written.adoc[]
+
+=== Support of other Systems
+
+include::../../shared/to-be-written.adoc[]
+
+==== SonarQube
+
+include::../../shared/to-be-written.adoc[]
+
+==== Jupyter
+
+include::../../shared/to-be-written.adoc[]
+
+
+
+

manual/src/main/asciidoc/newdocs/userguide/gettingstarted/00-gettingstarted.adoc

@@ -0,0 +1,19 @@
+== Getting Started
+
+include::../../shared/to-be-written.adoc[]
+
+=== Overview
+
+include::../../shared/to-be-written.adoc[]
+
+=== Exploration of Structures
+
+include::../../shared/to-be-written.adoc[]
+
+=== Getting Started in a Maven Project
+
+include::../../shared/to-be-written.adoc[]
+
+=== Getting Started with the Commandline Distribution
+
+include::../../shared/to-be-written.adoc[]

manual/src/main/asciidoc/newdocs/userguide/index.adoc

@@ -0,0 +1,10 @@
+= jQAssistant User Guide
+:toc: left
+
+
+include::introduction/00-introduction.adoc[]
+include::usecases/00-usecases.adoc[]
+include::features/00-features.adoc[]
+include::gettingstarted/00-gettingstarted.adoc[]
+include::structures/00-structures.adoc[]
+include::rules/00-rules.adoc[]

manual/src/main/asciidoc/newdocs/userguide/introduction/00-introduction.adoc

@@ -0,0 +1,4 @@
+== Introduction
+
+include::../../shared/to-be-written.adoc[]
+

manual/src/main/asciidoc/newdocs/userguide/rules/00-rules.adoc

@@ -0,0 +1,36 @@
+== Rules
+
+include::../../shared/to-be-written.adoc[]
+
+=== Rule types
+
+include::../../shared/to-be-written.adoc[]
+
+=== Concepts
+
+include::../../shared/to-be-written.adoc[]
+
+=== Constraints
+
+include::../../shared/to-be-written.adoc[]
+
+=== Groups
+
+include::../../shared/to-be-written.adoc[]
+
+=== Writing Rules
+
+include::../../shared/to-be-written.adoc[]
+
+=== Dependencies between Rules
+
+include::../../shared/to-be-written.adoc[]
+
+=== Severities of Rules
+
+include::../../shared/to-be-written.adoc[]
+
+=== Support of Scripting Languages for Rules
+
+include::../../shared/to-be-written.adoc[]
+

manual/src/main/asciidoc/newdocs/userguide/structures/00-structures.adoc

@@ -0,0 +1,15 @@
+== Software as a Graph
+
+include::../../shared/to-be-written.adoc[]
+
+=== Representing Software Artifacts as a Graph
+
+include::../../shared/to-be-written.adoc[]
+
+=== Query your Software with Cypher
+
+include::../../shared/to-be-written.adoc[]
+
+==== Cypher Examples
+
+include::../../shared/to-be-written.adoc[]

manual/src/main/asciidoc/newdocs/userguide/usecases/00-usecases.adoc

@@ -0,0 +1,22 @@
+== Use Cases for jQAssistant
+
+include::../../shared/to-be-written.adoc[]
+
+=== Exploration and Analyses of Software Systems
+
+include::../../shared/to-be-written.adoc[]
+
+
+=== Documentation of Software Systems
+
+include::../../shared/to-be-written.adoc[]
+
+
+=== Guarding of Software Architecture
+
+include::../../shared/to-be-written.adoc[]
+
+=== Active Management of technical Debts
+
+include::../../shared/to-be-written.adoc[]
+