Incorporating Jamal macro into the documentation

README.adoc

@@ -1,4 +1,10 @@
+
 = AsciidoctorJ: Java bindings for Asciidoctor
+////
+This is a generated file. DO NOT EDIT!!!!!
+To modify this file edit README.adoc.jam in the same directory
+
+////
 Alex Soto <https://github.com/lordofthejars[@lordofthejars]>; Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Robert Panzer <https://github.com/robertpanzer[@robertpanzer]>
 // Settings:
 :compat-mode!:
@@ -22,25 +28,32 @@ ifdef::env-github[]
 endif::[]
 // Aliases:
 :dagger: &#8224;
+// global attributes:
+:groupId: org.asciidoctor
 // URIs:
 ifdef::awestruct[:uri-docs: link:/docs]
 ifndef::awestruct[:uri-docs: https://asciidoctor.org/docs]
 :uri-asciidoctor: {uri-docs}/what-is-asciidoctor
-:uri-repo: https://github.com/asciidoctor/asciidoctorj
+:github-url: https://github.com/
+:uri-repo: {github-url}asciidoctor/asciidoctorj
 :uri-issues: {uri-repo}/issues
 :uri-zulip: https://asciidoctor.zulipchat.com/
-:artifact-version: 2.5.7
+:artifact-version: 3.0.0-alpha.1
+:artifact-dev-version: 3.0.0-alpha.2-SNAPSHOT
+:api-version: 3.0.0-alpha.1
+:api-dev-version: 3.0.0-alpha.2-SNAPSHOT
 :asciidoctorj-epub3-version: 1.5.1
-:asciidoctorj-pdf-version: 1.6.2
-:uri-maven-artifact-query: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.asciidoctor%22%20AND%20a%3A%22asciidoctorj%22%20AND%20v%3A%22{artifact-version}%22
-:uri-maven-artifact-detail: http://search.maven.org/#artifactdetails%7Corg.asciidoctor%7Casciidoctorj%7C{artifact-version}%7Cjar
-:uri-maven-artifact-file: http://search.maven.org/remotecontent?filepath=org/asciidoctor/asciidoctorj/{artifact-version}/asciidoctorj-{artifact-version}
-:uri-maven-artifact-api-query: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.asciidoctor%22%20AND%20a%3A%22asciidoctorj-api%22%20AND%20v%3A%22{artifact-version}%22
-:uri-maven-artifact-api-detail: http://search.maven.org/#artifactdetails%7Corg.asciidoctor%7Casciidoctorj-api%7C{artifact-version}%7Cjar
-:uri-maven-artifact-api-file: http://search.maven.org/remotecontent?filepath=org/asciidoctor/asciidoctorj-api/{artifact-version}/asciidoctorj-api-{artifact-version}
+:asciidoctorj-pdf-version: 2.3.7
+:maven-search: http://search.maven.org/
+:uri-maven-artifact-query: {maven-search}#search%7Cga%7C1%7Cg%3A%22org.asciidoctor%22+AND+a%3A%22asciidoctorj-api%22+AND+v%3A%22{artifact-version}%22
+:uri-maven-artifact-file: {maven-search}remotecontent?filepath=org/asciidoctor/asciidoctorj/{artifact-version}/asciidoctorj-{artifact-version}
+:uri-maven-artifact-api-query: {maven-search}#search%7Cga%7C1%7Cg%3A%22org.asciidoctor%22+AND+a%3A%22asciidoctorj-api%22+AND+v%3A%22{artifact-version}%22
+:uri-maven-artifact-detail: {maven-search}%23artifactdetails%7Corg.asciidoctor%7Casciidoctorj%7C{artifact-version}%7Cjar
+:uri-maven-artifact-api-detail: {maven-search}%23artifactdetails%7Corg.asciidoctor%7Casciidoctorj-api%7C{artifact-version}%7Cjar
+:uri-maven-artifact-api-file: {maven-search}remotecontent?filepath=org/asciidoctor/asciidoctorj-api/{artifact-version}/asciidoctorj-api-{artifact-version}
 :uri-maven-guide: {uri-docs}/install-and-use-asciidoctor-maven-plugin
 :uri-gradle-guide: {uri-docs}/install-and-use-asciidoctor-gradle-plugin
-:uri-tilt: https://github.com/rtomayko/tilt
+:uri-tilt: {github-url}rtomayko/tilt
 :uri-font-awesome: http://fortawesome.github.io/Font-Awesome
 :uri-gradle: https://gradle.org
 :uri-chocolatey: https://chocolatey.org
@@ -51,7 +64,7 @@ Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of
 You can find the documentation for integrating Asciidoctor in your JVM based language of choice at the https://docs.asciidoctor.org/asciidoctorj/latest/[Asciidoctor Docs site].
 
 ifdef::badges[]
-image:https://github.com/asciidoctor/asciidoctorj/workflows/Build%20Main/badge.svg?event=push[Build Status (Github Actions)]
+image:{github-url}asciidoctor/asciidoctorj/workflows/Build%20Main/badge.svg?event=push[Build Status (Github Actions)]
 image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[project chat,link=https://asciidoctor.zulipchat.com/]
 endif::[]
 
@@ -69,28 +82,31 @@ The artifact information can be found in the tables below.
 |===
 |Group Id |Artifact Id |Version |Download
 
-|org.asciidoctor
+|{groupId}
 |{uri-maven-artifact-query}[asciidoctorj]
 |{uri-maven-artifact-detail}[{artifact-version}]
 |{uri-maven-artifact-file}.pom[pom] {uri-maven-artifact-file}.jar[jar] {uri-maven-artifact-file}-javadoc.jar[javadoc (jar)] {uri-maven-artifact-file}-sources.jar[sources (jar)] distribution ({uri-maven-artifact-file}-bin.zip[zip] {uri-maven-artifact-file}-bin.tar[tar])
 
-|org.asciidoctor
+|{groupId}
 |{uri-maven-artifact-api-query}[asciidoctorj-api]
-|{uri-maven-artifact-api-detail}[{artifact-version}]
+|{uri-maven-artifact-api-detail}[{api-version}]
 |{uri-maven-artifact-api-file}.pom[pom] {uri-maven-artifact-api-file}.jar[jar] {uri-maven-artifact-api-file}-javadoc.jar[javadoc (jar)] {uri-maven-artifact-api-file}-sources.jar[sources (jar)]
 
-|org.asciidoctor
+|{groupId}
 |asciidoctorj-epub3
 |{asciidoctorj-epub3-version}
 |{empty}
 
-|org.asciidoctor
+|{groupId}
 |asciidoctorj-pdf
 |{asciidoctorj-pdf-version}
 |{empty}
 |===
 
 CAUTION: The artifactId changed to `asciidoctorj` starting in 1.5.0.
+The latest version released in the repository may be an alpha version.
+You may consider using the latest stable version instead.
+The document you are currently reading describes the version {api-dev-version}.
 
 == Quick win: using the command line interface
 
@@ -145,7 +161,7 @@ If you don't use a Dependency Management system please check the dependency grap
 ----
 <dependencies>
   <dependency>
-    <groupId>org.asciidoctor</groupId>
+    <groupId>{groupId}</groupId>
     <artifactId>asciidoctorj</artifactId>
     <version>{artifact-version}</version> <!--1-->
   </dependency>
@@ -157,15 +173,15 @@ If you don't use a Dependency Management system please check the dependency grap
 .Declaring the dependency in a Gradle build file (e.g., build.gradle)
 ----
 dependencies {
-  compile 'org.asciidoctor:asciidoctorj:{artifact-version}'
+  compile '{groupId}:asciidoctorj:{artifact-version}'
 }
 ----
 
 [source,scala]
 [subs="specialcharacters,attributes,callouts"]
 .Declaring the dependency in an SBT build file (e.g., build.sbt)
 ----
-libraryDependencies += "org.asciidoctor" % "asciidoctorj" % "{artifact-version}" // <1>
+libraryDependencies += "{groupId}" % "asciidoctorj" % "{artifact-version}" // <1>
 ----
 
 <1> Specifying the version of AsciidoctorJ implicitly selects the version of Asciidoctor
@@ -174,7 +190,7 @@ libraryDependencies += "org.asciidoctor" % "asciidoctorj" % "{artifact-version}"
 [subs="specialcharacters,attributes,callouts"]
 .Declaring the dependency in a Leiningen build file (e.g., project.clj)
 ----
-:dependencies [[org.asciidoctor/asciidoctorj "{artifact-version}"]]
+:dependencies [[{groupId}/asciidoctorj "{artifact-version}"]]
 ----
 
 // DA: Should we mention how to download if you just want to use the asciidoctorj command?
@@ -333,7 +349,7 @@ TIP: We strongly recommend that you use Gradle via the https://www.timroes.de/20
 
 To clone the project, compile the source and build the artifacts (i.e., jars) locally, run:
 
- $ git clone https://github.com/asciidoctor/asciidoctorj
+ $ git clone {github-url}asciidoctor/asciidoctorj
    cd asciidoctorj
    ./gradlew assemble
 
@@ -381,7 +397,7 @@ Then, import the project into Eclipse using menu:File[Import,General,Existing Pr
 === Continuous integration
 
 Continuous integration for the AsciidoctorJ project is performed by GitHub Actions.
-You can find recent build results, including the build status of pull requests, on the https://github.com/asciidoctor/asciidoctorj/actions[asciidoctor/asciidoctorj] page.
+You can find recent build results, including the build status of pull requests, on the {github-url}asciidoctor/asciidoctorj/actions[asciidoctor/asciidoctorj] page.
 
 === Release and publish the artifacts