From 47a4294835c079057252264c36ed2c0539a8c8a5 Mon Sep 17 00:00:00 2001
From: Richard Eckart de Castilho <rec@apache.org>
Date: Mon, 23 Sep 2024 17:49:50 +0200
Subject: [PATCH] Issue #390: Merge uimaFIT modules into UIMAJ repository

- Integrate uimafit documentation module into uimaj documentation module
---
 aggregate-uimaj/pom.xml                       |   1 -
 uimafit-documentation/pom.xml                 | 153 ------------------
 uimaj-documentation/.asciidoctorconfig.adoc   |  12 ++
 uimaj-documentation/pom.xml                   |  54 +++++--
 .../src/docs}/asciidoc/fit.adoc               |   0
 .../docs}/asciidoc/fit/common_book_info.adoc  |   0
 .../asciidoc/fit/tools.uimafit.casutil.adoc   |   0
 ...tools.uimafit.configurationparameters.adoc |   0
 .../fit/tools.uimafit.experiments.adoc        |   0
 .../fit/tools.uimafit.externalresources.adoc  |   0
 .../fit/tools.uimafit.gettingstarted.adoc     |   0
 .../fit/tools.uimafit.introduction.adoc       |   0
 .../asciidoc/fit/tools.uimafit.maven.adoc     |   0
 .../asciidoc/fit/tools.uimafit.migration.adoc |   0
 .../asciidoc/fit/tools.uimafit.packaging.adoc |   0
 .../asciidoc/fit/tools.uimafit.pipelines.adoc |   0
 .../asciidoc/fit/tools.uimafit.testing.adoc   |   0
 .../fit/tools.uimafit.typesystem.adoc         |   0
 .../fit/tools.uimafit.validation.adoc         |   0
 uimaj-parent/pom.xml                          |   1 +
 20 files changed, 55 insertions(+), 166 deletions(-)
 delete mode 100644 uimafit-documentation/pom.xml
 create mode 100644 uimaj-documentation/.asciidoctorconfig.adoc
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/common_book_info.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.casutil.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.configurationparameters.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.experiments.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.externalresources.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.gettingstarted.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.introduction.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.maven.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.migration.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.packaging.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.pipelines.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.testing.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.typesystem.adoc (100%)
 rename {uimafit-documentation/src/main => uimaj-documentation/src/docs}/asciidoc/fit/tools.uimafit.validation.adoc (100%)

diff --git a/aggregate-uimaj/pom.xml b/aggregate-uimaj/pom.xml
index ef5f19a18..92936832e 100644
--- 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
deleted file mode 100644
index d38d6344d..000000000
--- a/uimafit-documentation/pom.xml
+++ /dev/null
@@ -1,153 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one
-  or more contributor license agreements. See the NOTICE file
-  distributed with this work for additional information
-  regarding copyright ownership. The ASF licenses this file
-  to you under the Apache License, Version 2.0 (the
-  "License"); you may not use this file except in compliance
-  with the License. You may obtain a copy of the License at
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing,
-  software distributed under the License is distributed on an
-  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  KIND, either express or implied. See the License for the
-  specific language governing permissions and limitations
-  under the License.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <modelVersion>4.0.0</modelVersion>
-
-  <parent>
-    <groupId>org.apache.uima</groupId>
-    <artifactId>uimaj-parent</artifactId>
-    <version>3.6.0-SNAPSHOT</version>
-    <relativePath>../uimaj-parent/pom.xml</relativePath>
-  </parent>
-
-  <artifactId>uimafit-documentation</artifactId>
-  <name>Apache UIMA uimaFIT - Documentation</name>
-  <packaging>pom</packaging>
-
-  <properties>
-    <maven.deploy.skip>true</maven.deploy.skip>
-  </properties>
-
-  <build>
-    <plugins>
-      <plugin>
-        <groupId>org.asciidoctor</groupId>
-        <artifactId>asciidoctor-maven-plugin</artifactId>
-        <version>${asciidoctor.plugin.version}</version>
-        <configuration>
-          <sourceDocumentName>fit.adoc</sourceDocumentName>
-          <outputDirectory>${project.build.directory}/site/d</outputDirectory>
-          <attributesChain>webfonts!</attributesChain>
-          <attributes>
-            <experimental>true</experimental>
-            <doctype>book</doctype>
-            <toclevels>8</toclevels>
-            <sectanchors>true</sectanchors>
-            <sectnums>true</sectnums>
-            <docinfo1>true</docinfo1>
-            <project-version>${project.version}</project-version>
-            <revnumber>${project.version}</revnumber>
-            <product-website-url>https://uima.apache.org</product-website-url>
-            <relativeBaseDir>true</relativeBaseDir>
-            <xrefstyle>short</xrefstyle>
-          </attributes>
-          <requires>
-            <require>asciidoctor-pdf</require>
-          </requires>
-        </configuration>
-        <executions>
-          <execution>
-            <id>fit-html</id>
-            <phase>generate-resources</phase>
-            <goals>
-              <goal>process-asciidoc</goal>
-            </goals>
-            <configuration>
-              <backend>html5</backend>
-              <attributes>
-                <toc>left</toc>
-              </attributes>
-            </configuration>
-          </execution>
-          <execution>
-            <id>fit-pdf</id>
-            <phase>generate-resources</phase>
-            <goals>
-              <goal>process-asciidoc</goal>
-            </goals>
-            <configuration>
-              <backend>pdf</backend>
-              <attributes>
-                <toc>preamble</toc>
-              </attributes>
-            </configuration>
-          </execution>
-        </executions>
-        <dependencies>
-          <dependency>
-            <groupId>org.asciidoctor</groupId>
-            <artifactId>asciidoctorj</artifactId>
-            <version>${asciidoctor.version}</version>
-          </dependency>
-          <dependency>
-            <groupId>org.asciidoctor</groupId>
-            <artifactId>asciidoctorj-pdf</artifactId>
-            <version>${asciidoctor.pdf.version}</version>
-          </dependency>
-        </dependencies>
-      </plugin>
-    </plugins>
-  </build>
-
-  <profiles>
-    <profile>
-      <id>m2e</id>
-      <activation>
-        <property>
-          <name>m2e.version</name>
-        </property>
-      </activation>
-      <build>
-        <pluginManagement>
-          <plugins>
-            <!--
-              - This plugin's configuration is used to store Eclipse m2e settings only.
-              - It has no influence on the Maven build itself.
-            -->
-            <plugin>
-              <groupId>org.eclipse.m2e</groupId>
-              <artifactId>lifecycle-mapping</artifactId>
-              <version>1.0.0</version>
-              <configuration>
-                <lifecycleMappingMetadata>
-                  <pluginExecutions>
-                    <pluginExecution>
-                      <pluginExecutionFilter>
-                        <groupId>org.asciidoctor</groupId>
-                        <artifactId>asciidoctor-maven-plugin</artifactId>
-                        <versionRange>[1.0,)</versionRange>
-                        <goals>
-                          <goal>process-asciidoc</goal>
-                        </goals>
-                      </pluginExecutionFilter>
-                      <action>
-                        <execute />
-                      </action>
-                    </pluginExecution>
-                  </pluginExecutions>
-                </lifecycleMappingMetadata>
-              </configuration>
-            </plugin>
-          </plugins>
-        </pluginManagement>
-      </build>
-    </profile>
-  </profiles>
-</project>
\ No newline at end of file
diff --git a/uimaj-documentation/.asciidoctorconfig.adoc b/uimaj-documentation/.asciidoctorconfig.adoc
new file mode 100644
index 000000000..d3cddb773
--- /dev/null
+++ 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
index fc0516522..e5b833eaa 100644
--- 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/uimafit-documentation/src/main/asciidoc/fit.adoc b/uimaj-documentation/src/docs/asciidoc/fit.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/common_book_info.adoc b/uimaj-documentation/src/docs/asciidoc/fit/common_book_info.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/common_book_info.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/common_book_info.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.casutil.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.casutil.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.casutil.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.casutil.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.configurationparameters.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.configurationparameters.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.configurationparameters.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.configurationparameters.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.experiments.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.experiments.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.experiments.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.experiments.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.externalresources.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.externalresources.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.externalresources.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.externalresources.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.gettingstarted.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.gettingstarted.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.gettingstarted.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.gettingstarted.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.introduction.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.introduction.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.introduction.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.introduction.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.maven.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.maven.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.maven.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.maven.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.migration.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.migration.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.migration.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.migration.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.packaging.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.packaging.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.packaging.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.packaging.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.pipelines.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.pipelines.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.pipelines.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.pipelines.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.testing.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.testing.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.testing.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.testing.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.typesystem.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.typesystem.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.typesystem.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.typesystem.adoc
diff --git a/uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.validation.adoc b/uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.validation.adoc
similarity index 100%
rename from uimafit-documentation/src/main/asciidoc/fit/tools.uimafit.validation.adoc
rename to uimaj-documentation/src/docs/asciidoc/fit/tools.uimafit.validation.adoc
diff --git a/uimaj-parent/pom.xml b/uimaj-parent/pom.xml
index efe2c1231..0a62b3310 100644
--- 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>