Issue #390: Merge uimaFIT modules into UIMAJ repository

- Integrate uimafit documentation module into uimaj documentation module
apache · Sep 23, 2024 · 47a4294 · 47a4294
1 parent d7072ef
commit 47a4294
Show file tree

Hide file tree

Showing 20 changed files with 55 additions and 166 deletions.
diff --git a/aggregate-uimaj/pom.xml b/aggregate-uimaj/pom.xml
@@ -56,7 +56,6 @@
     <module>../uimafit-examples</module>
     <module>../uimafit-spring</module>
     <module>../uimafit-maven-plugin</module>
-    <module>../uimafit-documentation</module>
     <module>../uimafit-cpe</module>
     <module>../uimafit-benchmark</module>
 

diff --git a/uimafit-documentation/pom.xml b/uimafit-documentation/pom.xml
diff --git a/uimaj-documentation/.asciidoctorconfig.adoc b/uimaj-documentation/.asciidoctorconfig.adoc
@@ -0,0 +1,12 @@
+// +++++++++++++++++++++++++++++++++++++++++++++++++++++++
+// +  Initial AsciiDoc editor configuration file - V1.0  +
+// ++++++++++++++++++++++++++++++++++++++++++++++++++++++
+// 
+// Did not find any configuration files, so creating this at project root level.
+// If you do not like those files to be generated - you can turn it off inside Asciidoctor Editor preferences.
+// 
+// You can define editor specific parts here.
+// For example: with next line you could set imagesdir attribute to subfolder "images" relative to the folder where this config file is located.
+// :imagesdir: {asciidoctorconfigdir}/images
+// 
+// For more information please take a look at https://github.com/de-jcup/eclipse-asciidoctor-editor/wiki/Asciidoctor-configfiles
diff --git a/uimaj-documentation/pom.xml b/uimaj-documentation/pom.xml
@@ -74,7 +74,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./tug</imagesDir>
+                <imagesdir>./tug</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -89,7 +89,7 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./tug</imagesDir>
+                <imagesdir>./tug</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -104,7 +104,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./oas</imagesDir>
+                <imagesdir>./oas</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -119,7 +119,7 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./oas</imagesDir>
+                <imagesdir>./oas</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -134,7 +134,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./ref</imagesDir>
+                <imagesdir>./ref</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -149,7 +149,7 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./ref</imagesDir>
+                <imagesdir>./ref</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -164,7 +164,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./tools</imagesDir>
+                <imagesdir>./tools</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -179,7 +179,7 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./tools</imagesDir>
+                <imagesdir>./tools</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -194,7 +194,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./maint</imagesDir>
+                <imagesdir>./maint</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -209,7 +209,7 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./maint</imagesDir>
+                <imagesdir>./maint</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -224,7 +224,7 @@
               <backend>html5</backend>
               <attributes>
                 <toc>left</toc>
-                <imagesDir>./user</imagesDir>
+                <imagesdir>./user</imagesdir>
               </attributes>
             </configuration>
           </execution>
@@ -239,7 +239,37 @@
               <backend>pdf</backend>
               <attributes>
                 <toc>preamble</toc>
-                <imagesDir>./user</imagesDir>
+                <imagesdir>./user</imagesdir>
+              </attributes>
+            </configuration>
+          </execution>
+          <execution>
+            <id>fit-html</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>process-asciidoc</goal>
+            </goals>
+            <configuration>
+              <sourceDocumentName>fit.adoc</sourceDocumentName>
+              <backend>html5</backend>
+              <attributes>
+                <toc>left</toc>
+                <imagesdir>./fit</imagesdir>
+              </attributes>
+            </configuration>
+          </execution>
+          <execution>
+            <id>fit-pdf</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>process-asciidoc</goal>
+            </goals>
+            <configuration>
+              <sourceDocumentName>fit.adoc</sourceDocumentName>
+              <backend>pdf</backend>
+              <attributes>
+                <toc>preamble</toc>
+                <imagesdir>./fit</imagesdir>
               </attributes>
             </configuration>
           </execution>

diff --git a/...-documentation/src/main/asciidoc/fit.adoc → ...-documentation/src/docs/asciidoc/fit.adoc b/...-documentation/src/main/asciidoc/fit.adoc → ...-documentation/src/docs/asciidoc/fit.adoc
diff --git a/...c/main/asciidoc/fit/common_book_info.adoc → ...c/docs/asciidoc/fit/common_book_info.adoc b/...c/main/asciidoc/fit/common_book_info.adoc → ...c/docs/asciidoc/fit/common_book_info.adoc
diff --git a/...n/asciidoc/fit/tools.uimafit.casutil.adoc → ...s/asciidoc/fit/tools.uimafit.casutil.adoc b/...n/asciidoc/fit/tools.uimafit.casutil.adoc → ...s/asciidoc/fit/tools.uimafit.casutil.adoc
diff --git a/...ools.uimafit.configurationparameters.adoc → ...ools.uimafit.configurationparameters.adoc b/...ools.uimafit.configurationparameters.adoc → ...ools.uimafit.configurationparameters.adoc
diff --git a/...ciidoc/fit/tools.uimafit.experiments.adoc → ...ciidoc/fit/tools.uimafit.experiments.adoc b/...ciidoc/fit/tools.uimafit.experiments.adoc → ...ciidoc/fit/tools.uimafit.experiments.adoc
diff --git a/.../fit/tools.uimafit.externalresources.adoc → .../fit/tools.uimafit.externalresources.adoc b/.../fit/tools.uimafit.externalresources.adoc → .../fit/tools.uimafit.externalresources.adoc
diff --git a/...doc/fit/tools.uimafit.gettingstarted.adoc → ...doc/fit/tools.uimafit.gettingstarted.adoc b/...doc/fit/tools.uimafit.gettingstarted.adoc → ...doc/fit/tools.uimafit.gettingstarted.adoc
diff --git a/...iidoc/fit/tools.uimafit.introduction.adoc → ...iidoc/fit/tools.uimafit.introduction.adoc b/...iidoc/fit/tools.uimafit.introduction.adoc → ...iidoc/fit/tools.uimafit.introduction.adoc
diff --git a/...ain/asciidoc/fit/tools.uimafit.maven.adoc → ...ocs/asciidoc/fit/tools.uimafit.maven.adoc b/...ain/asciidoc/fit/tools.uimafit.maven.adoc → ...ocs/asciidoc/fit/tools.uimafit.maven.adoc
diff --git a/...asciidoc/fit/tools.uimafit.migration.adoc → ...asciidoc/fit/tools.uimafit.migration.adoc b/...asciidoc/fit/tools.uimafit.migration.adoc → ...asciidoc/fit/tools.uimafit.migration.adoc
diff --git a/...asciidoc/fit/tools.uimafit.packaging.adoc → ...asciidoc/fit/tools.uimafit.packaging.adoc b/...asciidoc/fit/tools.uimafit.packaging.adoc → ...asciidoc/fit/tools.uimafit.packaging.adoc
diff --git a/...asciidoc/fit/tools.uimafit.pipelines.adoc → ...asciidoc/fit/tools.uimafit.pipelines.adoc b/...asciidoc/fit/tools.uimafit.pipelines.adoc → ...asciidoc/fit/tools.uimafit.pipelines.adoc
diff --git a/...n/asciidoc/fit/tools.uimafit.testing.adoc → ...s/asciidoc/fit/tools.uimafit.testing.adoc b/...n/asciidoc/fit/tools.uimafit.testing.adoc → ...s/asciidoc/fit/tools.uimafit.testing.adoc
diff --git a/...sciidoc/fit/tools.uimafit.typesystem.adoc → ...sciidoc/fit/tools.uimafit.typesystem.adoc b/...sciidoc/fit/tools.uimafit.typesystem.adoc → ...sciidoc/fit/tools.uimafit.typesystem.adoc
diff --git a/...sciidoc/fit/tools.uimafit.validation.adoc → ...sciidoc/fit/tools.uimafit.validation.adoc b/...sciidoc/fit/tools.uimafit.validation.adoc → ...sciidoc/fit/tools.uimafit.validation.adoc
diff --git a/uimaj-parent/pom.xml b/uimaj-parent/pom.xml
@@ -659,6 +659,7 @@
               <!-- default configuration -->
             <configuration>
               <excludes combine.children="append">
+                <exclude>**/.asciidoctorconfig.adoc</exclude>
                 <!-- Eclipse launch files - no need for a license -->
                 <exclude>**/run_configuration/*.launch</exclude>
               </excludes>