You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/09/10 07:30:46 UTC
[isis] branch master updated: ISIS-2426: resolving trademark issues
with AsciiDoc
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new ea7d734 ISIS-2426: resolving trademark issues with AsciiDoc
ea7d734 is described below
commit ea7d73434478dfb8555ff5f7b6b03789f31bb251
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Sep 10 09:30:26 2020 +0200
ISIS-2426: resolving trademark issues with AsciiDoc
---
tooling/{asciidoc-model => model4adoc}/README.adoc | 14 ++++++++++---
tooling/{asciidoc-model => model4adoc}/pom.xml | 7 ++++---
.../isis/tooling/model4adoc}/AsciiDocFactory.java | 24 ++++++++++++++++------
.../isis/tooling/model4adoc}/AsciiDocWriter.java | 14 ++++++++++++-
.../model4adoc}/ast/ContentNodeAbstract.java | 2 +-
.../isis/tooling/model4adoc}/ast/SimpleCell.java | 2 +-
.../isis/tooling/model4adoc}/ast/SimpleColumn.java | 2 +-
.../tooling/model4adoc}/ast/SimpleDocument.java | 2 +-
.../isis/tooling/model4adoc}/ast/SimpleRow.java | 2 +-
.../model4adoc}/ast/SimpleStructuralNode.java | 2 +-
.../isis/tooling/model4adoc}/ast/SimpleTable.java | 2 +-
.../tooling/adocmodel/test/AsciiDocWriterTest.java | 4 ++--
.../tooling/adocmodel/test/attributed-table.adoc | 0
.../isis/tooling/adocmodel/test/simple-table.adoc | 0
tooling/pom.xml | 2 +-
15 files changed, 56 insertions(+), 23 deletions(-)
diff --git a/tooling/asciidoc-model/README.adoc b/tooling/model4adoc/README.adoc
similarity index 63%
rename from tooling/asciidoc-model/README.adoc
rename to tooling/model4adoc/README.adoc
index 00ed77f..9d9a79b 100644
--- a/tooling/asciidoc-model/README.adoc
+++ b/tooling/model4adoc/README.adoc
@@ -1,7 +1,14 @@
-= Tooling - AsciiDoc Model
+= Tooling - Model for AsciiDoc
Allows for programmatic generation of ascii-doc representing document models.
+NOTE: The _AsciiDoc_ name is trademarked by the https://www.eclipse.org/[_Eclipse Foundation_].
+This project is *not* part of the specification effort for _AsciiDoc_ under the
+_AsciiDoc Working Group_. See https://projects.eclipse.org/proposals/asciidoc-language[]
+and https://accounts.eclipse.org/mailing-list/asciidoc-wg[]. However, we are happy to
+help with transfer of source code, if any project (under the umbrella of the
+_AsciiDoc Working Group_) is willing to take over.
+
WARNING: This is work-in-progress, no official Maven artifacts are published yet at the time of writing.
However, snapshots are available with our nightly-builds:
https://github.com/apache-isis-committers/isis-nightly[]
@@ -11,7 +18,8 @@ https://github.com/apache-isis-committers/isis-nightly[]
[source,java]
----
-import static org.apache.isis.tooling.adocmodel.AsciiDocFactory.*;
+import org.apache.isis.tooling.model4adoc.AsciiDocWriter;
+import static org.apache.isis.tooling.model4adoc.AsciiDocFactory.*;
...
@@ -66,7 +74,7 @@ https://github.com/apache-isis-committers/isis-nightly#maven[]
----
<dependency>
<groupId>org.apache.isis.tooling</groupId>
- <artifactId>isis-tooling-asciidoc-model</artifactId>
+ <artifactId>isis-tooling-model4asciidoc</artifactId>
<version>2.0.0-???</version>
</dependency>
----
diff --git a/tooling/asciidoc-model/pom.xml b/tooling/model4adoc/pom.xml
similarity index 87%
rename from tooling/asciidoc-model/pom.xml
rename to tooling/model4adoc/pom.xml
index 13b42c0..1a38568 100644
--- a/tooling/asciidoc-model/pom.xml
+++ b/tooling/model4adoc/pom.xml
@@ -20,11 +20,12 @@
<version>2.0.0-SNAPSHOT</version>
</parent>
- <artifactId>isis-tooling-asciidoc-model</artifactId>
+ <artifactId>isis-tooling-model4adoc</artifactId>
- <name>Apache Isis Tooling - AsciiDoc Model</name>
+ <name>Apache Isis Tooling - Model for AsciiDoc</name>
<description>
- Library for programmatic AsciiDoc generation.
+ Library for programmatic AsciiDoc generation.
+ (AsciiDoc is a trademark held by the Eclipse Foundation.)
</description>
<properties>
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocFactory.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocFactory.java
similarity index 82%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocFactory.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocFactory.java
index a6f2aaf..5a77c32 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocFactory.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocFactory.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel;
+package org.apache.isis.tooling.model4adoc;
import org.asciidoctor.ast.Cell;
import org.asciidoctor.ast.Column;
@@ -25,14 +25,26 @@ import org.asciidoctor.ast.Row;
import org.asciidoctor.ast.StructuralNode;
import org.asciidoctor.ast.Table;
-import org.apache.isis.tooling.adocmodel.ast.SimpleCell;
-import org.apache.isis.tooling.adocmodel.ast.SimpleColumn;
-import org.apache.isis.tooling.adocmodel.ast.SimpleDocument;
-import org.apache.isis.tooling.adocmodel.ast.SimpleRow;
-import org.apache.isis.tooling.adocmodel.ast.SimpleTable;
+import org.apache.isis.tooling.model4adoc.ast.SimpleCell;
+import org.apache.isis.tooling.model4adoc.ast.SimpleColumn;
+import org.apache.isis.tooling.model4adoc.ast.SimpleDocument;
+import org.apache.isis.tooling.model4adoc.ast.SimpleRow;
+import org.apache.isis.tooling.model4adoc.ast.SimpleTable;
import lombok.val;
+/**
+ * Provides convenient factory methods to build a (AsciiDoc) Document Model.
+ * @since Sep 10, 2020
+ * @apiNote The <i>AsciiDoc<i> name is trademarked by the <i>Eclipse Foundation</i>.
+ * <p>
+ This project is <b>not</b> part of the specification effort for <i>AsciiDoc<i> under the
+ <i>AsciiDoc Working Group</i>. See https://projects.eclipse.org/proposals/asciidoc-language
+ and https://accounts.eclipse.org/mailing-list/asciidoc-wg. However, we are happy to
+ help with transfer of source code, if any project (under the umbrella of the
+ <i>AsciiDoc Working Group</i>) is willing to take over.
+ </p>
+ */
public class AsciiDocFactory {
/**
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocWriter.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocWriter.java
similarity index 88%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocWriter.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocWriter.java
index b1fc9a8..5188cc7 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/AsciiDocWriter.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/AsciiDocWriter.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel;
+package org.apache.isis.tooling.model4adoc;
import java.io.IOException;
import java.io.StringWriter;
@@ -35,6 +35,18 @@ import lombok.RequiredArgsConstructor;
import lombok.val;
import lombok.extern.log4j.Log4j2;
+/**
+ * Writes an (AsciiDoc) Document Model to a given {@link Writer}.
+ * @since Sep 10, 2020
+ * @apiNote The <i>AsciiDoc<i> name is trademarked by the <i>Eclipse Foundation</i>.
+ * <p>
+ This project is <b>not</b> part of the specification effort for <i>AsciiDoc<i> under the
+ <i>AsciiDoc Working Group</i>. See https://projects.eclipse.org/proposals/asciidoc-language
+ and https://accounts.eclipse.org/mailing-list/asciidoc-wg. However, we are happy to
+ help with transfer of source code, if any project (under the umbrella of the
+ <i>AsciiDoc Working Group</i>) is willing to take over.
+ </p>
+ */
@Log4j2
public class AsciiDocWriter {
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/ContentNodeAbstract.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/ContentNodeAbstract.java
similarity index 99%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/ContentNodeAbstract.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/ContentNodeAbstract.java
index 8412347..6d68934 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/ContentNodeAbstract.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/ContentNodeAbstract.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import java.util.ArrayList;
import java.util.HashMap;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleCell.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleCell.java
similarity index 97%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleCell.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleCell.java
index 96c35e9..54ddf0a 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleCell.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleCell.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import org.asciidoctor.ast.Cell;
import org.asciidoctor.ast.Column;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleColumn.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleColumn.java
similarity index 97%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleColumn.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleColumn.java
index b424c24..9df1a29 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleColumn.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleColumn.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import org.asciidoctor.ast.Column;
import org.asciidoctor.ast.Table;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleDocument.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleDocument.java
similarity index 97%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleDocument.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleDocument.java
index 72f18f9..9119819 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleDocument.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleDocument.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import java.util.HashMap;
import java.util.Map;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleRow.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleRow.java
similarity index 95%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleRow.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleRow.java
index 6bda645..902aa7a 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleRow.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleRow.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import java.util.ArrayList;
import java.util.List;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleStructuralNode.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleStructuralNode.java
similarity index 98%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleStructuralNode.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleStructuralNode.java
index 52d27e7..897913d 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleStructuralNode.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleStructuralNode.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import java.util.ArrayList;
import java.util.Collections;
diff --git a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleTable.java b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleTable.java
similarity index 96%
rename from tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleTable.java
rename to tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleTable.java
index 3044b2e..2b174fd 100644
--- a/tooling/asciidoc-model/src/main/java/org/apache/isis/tooling/adocmodel/ast/SimpleTable.java
+++ b/tooling/model4adoc/src/main/java/org/apache/isis/tooling/model4adoc/ast/SimpleTable.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.isis.tooling.adocmodel.ast;
+package org.apache.isis.tooling.model4adoc.ast;
import java.util.ArrayList;
import java.util.List;
diff --git a/tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java b/tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java
similarity index 97%
rename from tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java
rename to tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java
index 8120b13..8a0749f 100644
--- a/tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java
+++ b/tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/AsciiDocWriterTest.java
@@ -32,9 +32,9 @@ import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.apache.isis.tooling._infra._Strings;
-import org.apache.isis.tooling.adocmodel.AsciiDocWriter;
+import org.apache.isis.tooling.model4adoc.AsciiDocWriter;
-import static org.apache.isis.tooling.adocmodel.AsciiDocFactory.*;
+import static org.apache.isis.tooling.model4adoc.AsciiDocFactory.*;
import lombok.val;
diff --git a/tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/attributed-table.adoc b/tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/attributed-table.adoc
similarity index 100%
rename from tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/attributed-table.adoc
rename to tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/attributed-table.adoc
diff --git a/tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/simple-table.adoc b/tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/simple-table.adoc
similarity index 100%
rename from tooling/asciidoc-model/src/test/java/org/apache/isis/tooling/adocmodel/test/simple-table.adoc
rename to tooling/model4adoc/src/test/java/org/apache/isis/tooling/adocmodel/test/simple-table.adoc
diff --git a/tooling/pom.xml b/tooling/pom.xml
index 35de159..4f9fe0c 100644
--- a/tooling/pom.xml
+++ b/tooling/pom.xml
@@ -207,7 +207,7 @@
<modules>
<module>commons</module>
- <module>asciidoc-model</module>
+ <module>model4adoc</module>
<module>project-model</module>
</modules>