This is an automated email from the ASF dual-hosted git repository.
mawiesne pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opennlp-site.git
The following commit(s) were added to refs/heads/main by this push:
new 3d542fb2 adds a new page that lists OpenNLP artifacts for integration
into a Gradle managed sw project beautifies some other pages for better UX
3d542fb2 is described below
commit 3d542fb20c5dd6ace4c01a972dbe64c5d3afc1fe
Author: Martin Wiesner <[email protected]>
AuthorDate: Fri Jun 9 20:32:15 2023 +0200
adds a new page that lists OpenNLP artifacts for integration into a Gradle
managed sw project
beautifies some other pages for better UX
---
src/main/jbake/content/docs/index.ad | 10 +--
src/main/jbake/content/download.ad | 7 +-
src/main/jbake/content/faq.ad | 10 +--
src/main/jbake/content/gradle-dependency.ad | 103 ++++++++++++++++++++++++++++
src/main/jbake/content/maven-dependency.ad | 31 ++++-----
src/main/jbake/content/models.ad | 6 +-
src/main/jbake/templates/menu.ftl | 3 +-
7 files changed, 135 insertions(+), 35 deletions(-)
diff --git a/src/main/jbake/content/docs/index.ad
b/src/main/jbake/content/docs/index.ad
index 7e1a5594..e6836261 100755
--- a/src/main/jbake/content/docs/index.ad
+++ b/src/main/jbake/content/docs/index.ad
@@ -22,8 +22,10 @@
:jbake-status: published
:idprefix:
-There exists a manual and Javadoc API documentation for Apache OpenNLP. The
manual
-explains how the various OpenNLP components can be used and trained.
+There exists a manual and Javadoc API documentation for Apache OpenNLP.
+The manual explains how the various OpenNLP components can be used and trained.
+
+NOTE: All the documentation is also included in the binary distribution.
== Apache OpenNLP {opennlp_version} documentation
@@ -33,6 +35,4 @@ explains how the various OpenNLP components can be used and
trained.
*
link:/docs/{opennlp_version}/apidocs/opennlp-brat-annotator/index.html[Apache
OpenNLP BRAT Annotator Javadoc]
*
link:/docs/{opennlp_version}/apidocs/opennlp-morfologik-addon/index.html[Apache
OpenNLP Morfologik Addon Javadoc]
-Note: All the documentation is also included in the binary distribution.
-
-Documentation for archived releases can be found link:/docs/legacy.html[here].
\ No newline at end of file
+TIP: Documentation for archived releases can be found
link:/docs/legacy.html[here].
\ No newline at end of file
diff --git a/src/main/jbake/content/download.ad
b/src/main/jbake/content/download.ad
index 5f815e36..be02f3aa 100755
--- a/src/main/jbake/content/download.ad
+++ b/src/main/jbake/content/download.ad
@@ -26,6 +26,10 @@
Apache OpenNLP {opennlp_version} is now available for download.
+NOTE: Please note that the _tar.gz_ archive contain file names longer than 100
characters and has
+been created using https://www.gnu.org/software/tar/[GNU tar,window=_blank]
extensions.
+It must be untarred with a GNU compatible version of tar.
+
[options="header"]
|===
|.tar.gz | .zip
@@ -47,9 +51,6 @@
https://www.apache.org/dist/opennlp/opennlp-{opennlp_version}/apache-opennlp-{op
https://www.apache.org/dist/opennlp/opennlp-{opennlp_version}/apache-opennlp-{opennlp_version}-src.zip.asc[asc]
|===
-Note: Please note that the tar.gz archive contain file names longer than 100
characters and has
-been created using GNU tar extensions. It must be untarred with a GNU
compatible version of tar.
-
### Verifying Signatures
The sha512 and asc files are signature files and can be used to verify the
integrity of the
downloaded distribution package.
diff --git a/src/main/jbake/content/faq.ad b/src/main/jbake/content/faq.ad
index e96a0eba..97e472db 100644
--- a/src/main/jbake/content/faq.ad
+++ b/src/main/jbake/content/faq.ad
@@ -23,13 +23,13 @@
:idprefix:
This list contains common questions asked in link:mailing-lists.html[mailing
lists] and
-https://stackoverflow.com/questions/tagged/opennlp[forums].
+https://stackoverflow.com/questions/tagged/opennlp[forums,window=_blank].
++++
<dl>
<dt>Where can I download the models used in OpenNLP?</dt>
- <dd>They are hosted at <a
href="https://opennlp.sourceforge.net/models-1.5/";>SourceForge</a>.</dd>
+ <dd>They are hosted at <a href="https://opennlp.sourceforge.net/models-1.5/";
target="_blank">SourceForge</a>.</dd>
<dt></dt>
<dd></dd>
@@ -53,15 +53,15 @@ information about model compatibility.</dd>
<dt><strong>Is there a commercial license for OpenNLP?</strong></dt>
<dd>OpenNLP is licensed under the business-friendly Apache software license,
version 2.0. You can read the license
-<a href="https://www.apache.org/licenses/LICENSE-2.0";>here</a>
-or <a href="https://en.wikipedia.org/wiki/Apache_License";>its Wikipedia
page</a>
+<a href="https://www.apache.org/licenses/LICENSE-2.0"; target="_blank">here</a>
+or <a href="https://en.wikipedia.org/wiki/Apache_License"; target="_blank">its
Wikipedia page</a>
for more information.</dd>
<dt><strong>How can I start contributing to this project?</strong></dt>
<dd>Have a look at our <a href="/get-involved.html">Getting Involved</a>
page.
We have a list of issues needing help there, as well as instructions to get
started
contributing to OpenNLP. You may also consider making a
-<a href="https://www.apache.org/foundation/contributing.html";>donation to the
Apache Software Foundation</a>.</dd>
+<a href="https://www.apache.org/foundation/contributing.html";
target="_blank">donation to the Apache Software Foundation</a>.</dd>
</dl>
++++
diff --git a/src/main/jbake/content/gradle-dependency.ad
b/src/main/jbake/content/gradle-dependency.ad
new file mode 100755
index 00000000..d3cc6273
--- /dev/null
+++ b/src/main/jbake/content/gradle-dependency.ad
@@ -0,0 +1,103 @@
+////
+ 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.
+////
+= Gradle Integration
+:jbake-type: page
+:jbake-tags: maven
+:jbake-status: published
+:idprefix:
+
+Apache OpenNLP is also distributed via the Maven Central Repository.
+The maven artifacts are located
https://repo1.maven.org/maven2/org/apache/opennlp/[here].
+The Apache OpenNLP project publishes the library, javadoc and source code jars.
+To use OpenNLP in your https://gradle.org[Gradle,window=_blank] project,
specify exactly one of the following dependencies,
+all transient dependencies are resolved automatically.
+
+== Latest Release
+=== OpenNLP Tools Dependency
+
+To use the OpenNLP Tools define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-tools', version:
'{opennlp_version}'
+}
+----
+
+=== OpenNLP DL Dependency
+
+To use the OpenNLP DL define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-dl', version:
'{opennlp_version}'
+}
+----
+
+=== OpenNLP UIMA Annotators Dependency
+
+To use the OpenNLP UIMA Annotators define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-uima', version:
'{opennlp_version}'
+}
+----
+
+=== OpenNLP Morfologik AddOn Dependency
+
+To use the OpenNLP Morfologik-Addon define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name:
'opennlp-morfologik-addon', version: '{opennlp_version}'
+}
+----
+
+=== OpenNLP Brat Annotator Dependency
+
+To use the OpenNLP UIMA Annotators define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-brat-annotator',
version: '{opennlp_version}'
+}
+----
+
+== SNAPSHOTS
+=== OpenNLP Tools SNAPSHOT Dependency
+
+To use the current version of the _main_ branch define the following
dependency:
+
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-tools', version:
'2.2.1-SNAPSHOT'
+}
+----
+
+NOTE: The `SNAPSHOT` dependency requires the following Maven repository in
your Gradle project:
+
+[source,indent=0,subs=attributes+]
+----
+ https://repository.apache.org/content/repositories/snapshots/
+----
diff --git a/src/main/jbake/content/maven-dependency.ad
b/src/main/jbake/content/maven-dependency.ad
index 1e4aa923..56f83704 100755
--- a/src/main/jbake/content/maven-dependency.ad
+++ b/src/main/jbake/content/maven-dependency.ad
@@ -16,20 +16,20 @@
specific language governing permissions and limitations
under the License.
////
-= Maven Dependency
+= Maven Integration
:jbake-type: page
:jbake-tags: maven
:jbake-status: published
:idprefix:
-Apache OpenNLP is also distributed via the Maven Central Repository and
-the maven artifacts are located
https://repo1.maven.org/maven2/org/apache/opennlp/[here].
+Apache OpenNLP is also distributed via the Maven Central Repository.
+The maven artifacts are located
https://repo1.maven.org/maven2/org/apache/opennlp/[here].
The Apache OpenNLP project publishes the library, javadoc and source code jars.
-To use OpenNLP in your project, specify exactly one of the following
dependencies,
+To use OpenNLP in your https://maven.apache.org[Maven,window=_blank] project,
specify exactly one of the following dependencies,
all transient dependencies are resolved automatically.
-## OpenNLP Tools Dependency
-
+== Latest Release
+=== OpenNLP Tools Dependency
To use the OpenNLP Tools define the following dependency:
[source,xml,indent=0,subs=attributes+]
@@ -41,8 +41,7 @@ To use the OpenNLP Tools define the following dependency:
</dependency>
----
-## OpenNLP DL Dependency
-
+=== OpenNLP DL Dependency
To use the OpenNLP DL define the following dependency:
[source,xml,indent=0,subs=attributes+]
@@ -54,8 +53,7 @@ To use the OpenNLP DL define the following dependency:
</dependency>
----
-## OpenNLP UIMA Annotators Dependency
-
+=== OpenNLP UIMA Annotators Dependency
To use the OpenNLP UIMA Annotators define the following dependency:
[source,xml,indent=0,subs=attributes+]
@@ -67,8 +65,7 @@ To use the OpenNLP UIMA Annotators define the following
dependency:
</dependency>
----
-## OpenNLP Morfologik AddOn Dependency
-
+=== OpenNLP Morfologik AddOn Dependency
To use the OpenNLP Morfologik-Addon define the following dependency:
[source,xml,indent=0,subs=attributes+]
@@ -80,8 +77,7 @@ To use the OpenNLP Morfologik-Addon define the following
dependency:
</dependency>
----
-## OpenNLP Brat Annotator Dependency
-
+=== OpenNLP Brat Annotator Dependency
To use the OpenNLP UIMA Annotators define the following dependency:
[source,xml,indent=0,subs=attributes+]
@@ -93,9 +89,8 @@ To use the OpenNLP UIMA Annotators define the following
dependency:
</dependency>
----
-## OpenNLP Tools SNAPSHOT Dependency
-
-To use the current trunk version define the following dependency:
+=== OpenNLP Tools SNAPSHOT Dependency
+To use the current version of the _main_ branch define the following
dependency:
[source,xml,indent=0,subs=attributes+]
----
@@ -106,7 +101,7 @@ To use the current trunk version define the following
dependency:
</dependency>
----
-The SNAPSHOT dependency requires the following repository:
+NOTE: The `SNAPSHOT` dependency requires the following Maven repository:
[source,xml,indent=0,subs=attributes+]
----
diff --git a/src/main/jbake/content/models.ad b/src/main/jbake/content/models.ad
index 57a5b55e..55129c90 100755
--- a/src/main/jbake/content/models.ad
+++ b/src/main/jbake/content/models.ad
@@ -24,7 +24,7 @@
Use the links in the table below to download the pre-trained models for the
Apache OpenNLP.
-Note: All models are zip compressed (like a jar file), they *must not* be
uncompressed.
+WARNING: All models are zip compressed (like a jar file), they *must not* be
uncompressed.
[options="header"]
|======
@@ -204,7 +204,7 @@ Use the following commands to verify the integrity:
* gpg --print-md SHA1 fileName.tar.gz
* gpg --verify fileName.tar.gz.asc
-It might be necessary to import the
https://www.apache.org/dist/opennlp/KEYS[KEYS file] to verify the integrity
+It might be necessary to import the
https://www.apache.org/dist/opennlp/KEYS[KEYS file,window=_blank] to verify the
integrity
of the asc files.
That can easily be done with:
@@ -212,7 +212,7 @@ That can easily be done with:
* gpg --import KEYS
More information about release signing and verifying signatures can
-be found https://www.apache.org/dev/release-signing.html[here].
+be found https://www.apache.org/dev/release-signing.html[here,window=_blank].
## SourceForge Models
diff --git a/src/main/jbake/templates/menu.ftl
b/src/main/jbake/templates/menu.ftl
index 1ed9acb5..593aa997 100755
--- a/src/main/jbake/templates/menu.ftl
+++ b/src/main/jbake/templates/menu.ftl
@@ -41,7 +41,8 @@
<ul class="dropdown-menu">
<li><a href="/download.html">OpenNLP
Releases</a></li>
<li><a href="/models.html">OpenNLP Models</a></li>
- <li><a href="/maven-dependency.html">Maven
Dependency</a></li>
+ <li><a href="/maven-dependency.html">Maven
Integration</a></li>
+ <li><a href="/gradle-dependency.html">Gradle
Integration</a></li>
</ul>
</li>
