[#7] Added links to the documentation of the plugins to reference manual

pom.xml

@@ -100,17 +100,30 @@
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
                 <executions>
+                    <execution>
+                        <id>overview</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirectory>src/main/asciidoc/</sourceDirectory>
+                            <sourceDocumentName>index.adoc</sourceDocumentName>
+                            <outputDirectory>${project.build.directory}/generated-docs/</outputDirectory>
+                            <backend>xhtml5</backend>
+                        </configuration>
+                    </execution>
                     <execution>
                         <id>userguide</id>
                         <phase>process-resources</phase>
                         <goals>
                             <goal>process-asciidoc</goal>
                         </goals>
                         <configuration>
-                            <sourceDirectory>${project.basedir}/src/main/asciidoc/newdocs/userguide</sourceDirectory>
+                            <sourceDirectory>src/main/asciidoc/userguide</sourceDirectory>
+                            <sourceDocumentName>index.adoc</sourceDocumentName>
                             <outputDirectory>${project.build.directory}/generated-docs/userguide</outputDirectory>
                             <backend>xhtml5</backend>
-                            <sourceDocumentName>index.adoc</sourceDocumentName>
                             <attributes>
                                 <toc>left</toc>
                                 <docRoot>${sourcedoc.directory}</docRoot>
@@ -124,9 +137,9 @@
                             <goal>process-asciidoc</goal>
                         </goals>
                         <configuration>
-                            <sourceDirectory>${project.basedir}/src/main/asciidoc/newdocs/reference</sourceDirectory>
-                            <outputDirectory>${project.build.directory}/generated-docs/reference</outputDirectory>
+                            <sourceDirectory>src/main/asciidoc/reference</sourceDirectory>
                             <sourceDocumentName>index.adoc</sourceDocumentName>
+                            <outputDirectory>${project.build.directory}/generated-docs/reference</outputDirectory>
                             <attributes>
                                 <toc>left</toc>
                                 <docRoot>${sourcedoc.directory}</docRoot>
@@ -142,12 +155,13 @@
                         </goals>
                         <configuration>
                             <attributes>
+                                <toc>auto</toc>
                                 <stylesheet>../jqassistant.css</stylesheet>
                                 <docRoot>${asciidoc.directory}</docRoot>
                             </attributes>
                             <sourceDirectory>src/main/asciidoc/manual</sourceDirectory>
-                            <outputDirectory>${project.build.directory}/generated-docs/manual</outputDirectory>
                             <sourceDocumentName>index.adoc</sourceDocumentName>
+                            <outputDirectory>${project.build.directory}/generated-docs/manual</outputDirectory>
                             <resources>
                                 <resource>
                                     <directory>${project.basedir}/src/main/asciidoc</directory>
@@ -171,8 +185,11 @@
                                 <docRoot>/${asciidoc.directory}</docRoot>
                             </attributes>
                             <sourceDirectory>src/main/asciidoc/releasenotes-overview</sourceDirectory>
-                            <outputDirectory>${project.build.directory}/generated-docs/releasenotes-overview</outputDirectory>
                             <sourceDocumentName>release-notes.adoc</sourceDocumentName>
+                            <outputDirectory>${project.build.directory}/generated-docs/releasenotes-overview</outputDirectory>
+
+
+                            <!-- todo #7 Wozu brauche ich das? -->
                             <resources>
                                 <resource>
                                     <directory>${project.basedir}/src/main/asciidoc</directory>
@@ -189,7 +206,6 @@
                     <backend>xhtml5</backend>
                     <sourceHighlighter>coderay</sourceHighlighter>
                     <attributes>
-                        <toc>auto</toc>
                         <toclevels>3</toclevels>
                         <tabsize>4</tabsize>
                         <!--

src/main/asciidoc/index.adoc

@@ -0,0 +1,27 @@
+= jQAssistant User Documentation Central
+
+[abstract]
+jQAssistent's documentation is currently in an transition phase from
+the well-known user manual to a new structure with a separate user guide,
+which comes along a reference for jQAssistant. +
+Both, the user guide and the reference for jQAssistant, are work in progress.
+
+== <<manual/index.adoc#,User Manual>>
+
+The user manual provides a comprehensive overview on jQAssistant up to
+version 1.8.0. New content for later versions will be added to the
+user guide and the jQAssistant reference.
+
+[discreate]
+== <<userguide/index.adoc#,jQAssistant User Guide>>
+
+The user guide will guide you through the features provided by
+jQAssistant with a clear on focus on the practial use of jQAssistant.
+If you are looking for a detailed reference on all usage and configuration
+options, then you should have a look ad the jQAssistant reference.
+
+[discreate]
+== <<reference/index.adoc#,jQAssistant Reference>>
+
+The reference provides detailed information on all possible configuration
+options and features of jQAssistant and its plugins.

src/main/asciidoc/manual/include/plugins.adoc

@@ -13,6 +13,7 @@ include::{docRoot}/com.buschmais.jqassistant.plugin/cdi/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/ejb3/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/graphml/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/java/asciidoc/plugin.adoc[]
+include::{docRoot}/com.buschmais.jqassistant.plugin/java8/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/javaee6/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/jaxrs/asciidoc/plugin.adoc[]
 include::{docRoot}/com.buschmais.jqassistant.plugin/jpa2/asciidoc/plugin.adoc[]

src/main/asciidoc/reference/index.adoc

@@ -0,0 +1,136 @@
+= jQAssistant Reference
+
+:tip-caption: 💡
+:sectnums:
+
+include::{docRoot}/com/buschmais/jqassistant/core/rule/index.adoc[leveloffset=+1]
+
+//
+// Include here the documentation of the plugins for jQA
+//
+
+== AsciiDoc Report Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#asciidoc-report-plugin, Asciidoc Report Plugin>>
+of the jQAssistant Manual available.
+
+== CDI Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#cdi-plugin,CDI Plugin>>
+of the jQAssistant Manual available.
+
+== EJB 3 Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#ejb-plugin, EJB 3 Plugin>>
+of the jQAssistant Manual available.
+
+== GraphML Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#graphml-plugin, GraphML Plugin>>
+of the jQAssistant Manual available.
+
+include::{docRoot}/com/buschmais/jqassistant/plugin/graphql/api/model/index.adoc[leveloffset=+1]
+
+
+== Java Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#java-plugin,Java Plugin>>
+of the jQAssistant Manual available.
+
+== Java EE 6 Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#javaee-plugin,Java EE 6 Plugin>>
+of the jQAssistant Manual available.
+
+== JAX-RS Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#jaxrs-plugin,JAX-RS Plugin>>
+of the jQAssistant Manual available.
+
+== JPA 2 Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#jpa2-plugin,JPA 2 Plugin>>
+of the jQAssistant Manual available.
+
+== JSON Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#json-plugin,JSON Plugin>>
+of the jQAssistant Manual available.
+
+== JUnit Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#junit-plugin,JUnit Plugin>>
+of the jQAssistant Manual available.
+
+== Maven 2 Repository Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#m2repo-plugin,Maven 2 Repository Plugin>>
+of the jQAssistant Manual available.
+
+== Maven 3 Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#maven3-plugin,Maven 3 Plugin>>
+of the jQAssistant Manual available.
+
+== OSGi Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#osgi-plugin,OSGi Plugin>>
+of the jQAssistant Manual available.
+
+== RDBMS Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#rdbms-plugin,RDBMS Plugin>>
+of the jQAssistant Manual available.
+
+== Spring Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#spring-plugin,Spring Plugin>>
+of the jQAssistant Manual available.
+
+== TestNG Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#testng-plugin,TestNG Plugin>>
+of the jQAssistant Manual available.
+
+== Tycho Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#tycho-plugin,Tycho Plugin>>
+of the jQAssistant Manual available.
+
+== XML Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#xml-plugin,XML Plugin>>
+of the jQAssistant Manual available.
+
+== YAML Plugin
+
+The documentation of this plugin is still only the section
+<<../manual/index.html#yaml-plugin,YAML Plugin>>
+of the jQAssistant Manual available.
+
+include::{docRoot}/com/buschmais/jqassistant/plugin/yaml2/api/model/index.adoc[leveloffset=+1]
+
+
+//
+// Include here all appendixes
+//
+include::{docRoot}/com/buschmais/jqassistant/core/rule/yaml-schema.adoc[]
+