Update for 0.6.2-incubating release
diff --git a/content/odftoolkit/conformance/ODFValidator.mdtext b/content/odftoolkit/conformance/ODFValidator.mdtext
index 22b5e72..f8187e5 100644
--- a/content/odftoolkit/conformance/ODFValidator.mdtext
+++ b/content/odftoolkit/conformance/ODFValidator.mdtext
@@ -2,9 +2,9 @@
**ODF Validator** is a tool that validates OpenDocument files and checks them for certain conformance criteria.
-**ODF Validator** is available as Java library for command line or embedded use,
+**ODF Validator** is available as Java library for command line or embedded use,
as well as a servlet. An instance of the servlet is [hosted online][1] courtesy of the
-[OpenDoc Society][2]. This page primarily describes the command line tool.
+[OpenDoc Society][2]. This page primarily describes the command line tool.
## How to start
To use the '''ODF Validator''', the following steps are required:
@@ -14,42 +14,43 @@
* Get the ODF 1.0, 1,1 and 1.2 schemas, and add the directories where your local copies of the schemas are stored to the '''schema.user.properties''' file.
* Get the MathML 1.01 DTD and the MathML 2.0 schemas, and add the directories where you local copies of the schemas are stored to the '''schema.user.properties''' file.
* Build the project.
+* You may deploy the WAR bundle from the target file into your application server of choice (e.g. Tomcat)
* Choose an arbitrary OpenDocument file <odffile>
-* If you are using JRE 1.5, call the '''ODF Validator''' with
+* OR for command line usage and help, call the '''ODF Validator''' with
- java -jar "<path>/odfvalidator.jar" <odffile>
+ java -jar "./target/odfvalidator-<VERSION>-incubating-jar-with-dependencies.jar" <odffile>
-* If you are using JRE 1.6, call the ODF Validator with
+* You may call the ODF Validator with
- java
+ java
-Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl
-Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl
- -jar "<path>/odfvalidator.jar" <odffile>
+ -jar "<PATH>/odfvalidator-<VERSION>-incubating-jar-with-dependencies.jar" <odffile>
## Usage
### Usage Summary
-In an Java 1.5 environment, **ODF Validator** is invoked by the following command:
+In a command-line environment, **ODF Validator** is invoked by the following command:
- java -jar "<path>/odfvalidator.jar"
+ java -jar "<path>/odfvalidator-VERSION-incubating-jar-with-dependencies.jar"
-In an Java 1.6 environment, the following command line has to be used:
+For instance, with the following parameters:
-
+
java
-Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl
-Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl
- -jar "<path>/odfvalidator.jar"
+ -jar "<path>/odfvalidator-<VERSION>-incubating-jar-with-dependencies.jar"
These command lines are abbreviated *odfvalidator* from now on.
The **ODF Validator** may be called with the following options:
-
- odfvalidator [-r] [-c|-e|-s] [-d] [-v|-w] [-x <expclude pattern>]
+
+ odfvalidator [-r] [-c|-e|-s] [-d] [-v|-w] [-x <expclude pattern>]
[-o outputfile] [-1.0|-1.1|-1.2] <odffiles>
odfvalidator [-r] [-c|-e|-s] [-d] [-v|-w] [-x <expclude pattern>]
[-o outputfile] -S <schemafile> <odffiles>
@@ -82,7 +83,7 @@
**-r**: Process directories recursively.
-**-s**: Use the strict schema for validation (ODF 1.0/1.1 documents only).
+**-s**: Use the strict schema for validation (ODF 1.0/1.1 documents only).
**-v**: Verbose: print information like the generator or the documents that are processed.
@@ -98,50 +99,50 @@
### Validation using default schemas
-The ODF 1.0, ODF 1.1, ODF 1.2 schemas as well as the MathML 1.01 DTD and
-the MathML 2.0 schema are included in the **ODFValidator.jar** file. If
+The ODF 1.0, ODF 1.1, ODF 1.2 schemas as well as the MathML 1.01 DTD and
+the MathML 2.0 schema are included in the **ODFValidator.jar** file. If
the ODFValidator is called without the **-S** or **-C** options, these schemas are used for validation.
-
+
odfvalidator [-r] [-c|-e|-s] [-d] [-v|-w] [-x <expclude pattern>]
[-o outputfile] [-1.0|-1.1|-1.2] <odffiles>
-**<odffiles>** is the list of files and directories that should be
-validated. If a directory is specified, all files that have an OpenDocument
-extension (like **odt**, **ods** or **ott**) are validated. If **-r** is
+**<odffiles>** is the list of files and directories that should be
+validated. If a directory is specified, all files that have an OpenDocument
+extension (like **odt**, **ods** or **ott**) are validated. If **-r** is
specified additionally, all directories are processed recursively.
-By default, the **ODF Validator** detects the version of the files that
-shall be validated and chooses the corresponding schema. The command line
-options **-1.0**', **-1.1** and **-1.2** can be used to specify that the
-schemas of a particular ODF version should be used for all files,
+By default, the **ODF Validator** detects the version of the files that
+shall be validated and chooses the corresponding schema. The command line
+options **-1.0**', **-1.1** and **-1.2** can be used to specify that the
+schemas of a particular ODF version should be used for all files,
regardless of the version they specify themselves.
-The command line option **-d** specifies that the MathML 1.01 DTD should
-be used for the validation of the **content.xml** of formula documents.
+The command line option **-d** specifies that the MathML 1.01 DTD should
+be used for the validation of the **content.xml** of formula documents.
Default is to use the MathML 2.0 schema.
-If the **-c** command line option is specified and if the validated document
-is an ODF 1.0 or ODF 1.1 document, unknown markup is ignored as specified
-in the conformance rules for ODF 1.0/1.1. If the **-s** command line
-option is specified and if the validated document is an ODF 1.0 or ODF 1.1
-document, the strict schema is used for validation. If the **-e** command
-line option is specified and if the validated document is an ODF 1.2
-document, unknown markup is ignored as specified in the extended conformance
-class rules for ODF 1.2. If neither **-c** nor **-e** nor **-s**
-are specified, the regular ODF schemas are used and errors are reported
-for unknown markup, unless it appears in styles or metadata of ODF 1.0/1.1
+If the **-c** command line option is specified and if the validated document
+is an ODF 1.0 or ODF 1.1 document, unknown markup is ignored as specified
+in the conformance rules for ODF 1.0/1.1. If the **-s** command line
+option is specified and if the validated document is an ODF 1.0 or ODF 1.1
+document, the strict schema is used for validation. If the **-e** command
+line option is specified and if the validated document is an ODF 1.2
+document, unknown markup is ignored as specified in the extended conformance
+class rules for ODF 1.2. If neither **-c** nor **-e** nor **-s**
+are specified, the regular ODF schemas are used and errors are reported
+for unknown markup, unless it appears in styles or metadata of ODF 1.0/1.1
documents.
-The optional **-x** switch allows to exclude certain files or directories
-from the validation. The files that shall be excluded are specified by a
-[regular expression] [4]. Please note that the full absolute path names of
-directories and files are matched against this pattern. This means that the
-regular expression either must include the absolute path of the files and
-directories that shall be excluded, or must start with **.***.
-The **-x** option can be specified only once. If several paths shall
-be excluded, these paths have to be specified in a single regular
+The optional **-x** switch allows to exclude certain files or directories
+from the validation. The files that shall be excluded are specified by a
+[regular expression] [4]. Please note that the full absolute path names of
+directories and files are matched against this pattern. This means that the
+regular expression either must include the absolute path of the files and
+directories that shall be excluded, or must start with **.***.
+The **-x** option can be specified only once. If several paths shall
+be excluded, these paths have to be specified in a single regular
expression using the **|** operator.
If **-w** is specified additionally, not only validation errors are reported, but also warnings.
@@ -152,11 +153,11 @@
### Validation using a non-default schema
-To specify the schema that is used for **meta-xml**, **content.xml**,
-**styles.xml** and **settings.xml** on the command line,
+To specify the schema that is used for **meta-xml**, **content.xml**,
+**styles.xml** and **settings.xml** on the command line,
**ODF Validator** has to be called with the following parameters:
-
+
odfvalidator [-r] [-c|-e|-s] [-d] [-v|-w] [-x <expclude pattern>]
[-o outputfile] -S <schemafile> <odffiles>
@@ -167,18 +168,18 @@
### Validation using a configuration file
-The schemas and the files that should be validated can be specified in a
-configuration file. A configuration file is a Java XML properties file as
-described in the [Java 2 API documentation] [5]. The following properties
+The schemas and the files that should be validated can be specified in a
+configuration file. A configuration file is a Java XML properties file as
+described in the [Java 2 API documentation] [5]. The following properties
are supported:
* **strict-schema**: Specifies the strict schema to be used.
* **manifest-schema**: Specifies the manifest schema to be used.
* **mathml-schema**: Specifies the MathML 1.01 schema to be used.
* **mathml2-schema**: Specifies the MathML 2 schema to be used.
-* **path***: All properties whose names start with "path" are considered to be files or directories that shall be validated.
+* **path***: All properties whose names start with "path" are considered to be files or directories that shall be validated.
* **recursive**: This boolean property specifies whether directories are scanned recursively. It takes the values **true** and **false**.
-* **exclude**: Specifies files and directories that shall be excluded as
+* **exclude**: Specifies files and directories that shall be excluded as
a [regular expression] [6]. See description of **-x** option.
A sample configuration file looks like this:
@@ -201,7 +202,7 @@
- If the test type is **conformance test** (default, or if **-c** is provided) , and if the file is not a formula file, then the sub files *content.xml*, *styles.xml*, *meta.xml* and *settings.xml* are validated with respect to the OpenDocument v1.2 schema.
- If the test type is **extended conformance test** (**-e** is provided), and if the file is not a formula file, then the sub files *content.xml*, *styles.xml*, *meta.xml* and *settings.xml* are pre-processed as described in section 1.4.2.1 of the OpenDocument v1.2 specification (that is *foreign elements and attributes* are removed), and are then validated with respect to the OpenDocument v1.2 schema.
- OpenDocument v1.1/1.0 documents:
- - If the test type is **conformance test** (**-c** is provided),
+ - If the test type is **conformance test** (**-c** is provided),
and if the file is not a formula file, then the sub files *content.xml*, *styles.xml*, *meta.xml* and *settings.xml* are pre-processed as described in section 1.5 of the <a href="http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.odt">OpenDocument specification</a> (that is *foreign elements and attributes* are removed), and are then validated with respect to the schema of the selected OpenDocument version.
- If the test type is **validation** (default), and if the file is not a formula file, then the sub files *content.xml*, *styles.xml*, *meta.xml* and *settings.xml* are validated with respect to the schema of the selected OpenDocument version. Pre-processing of *foreign elements and attributes* is not applied.
- If the test type is **strict validation** (**-s** is provided), and if the file is not a formula file, then the sub files *content.xml*, *styles.xml*, *meta.xml* and *settings.xml* are validated with respect to the strict schema of the selected OpenDocument version. Pre-processing of *foreign elements and attributes* is not applied.
@@ -251,42 +252,42 @@
## Where do I get the schemas?
-The OpenDocument schemas are available on the [OASIS OpenDocument Technical
-Committee] [7] page. The ODF 1.0 and 1.1 schemas can be downloaded directly
-from that page]. A zip file containing the most recent ODF 1.2 schemas is
+The OpenDocument schemas are available on the [OASIS OpenDocument Technical
+Committee] [7] page. The ODF 1.0 and 1.1 schemas can be downloaded directly
+from that page]. A zip file containing the most recent ODF 1.2 schemas is
available in the document section.
-The MathML DTD that is included in the ODF Validator us the one that is
-included in the **/share/dtd/math/1_01/** folder of each
+The MathML DTD that is included in the ODF Validator us the one that is
+included in the **/share/dtd/math/1_01/** folder of each
OpenOffice.org/Oracle Open Office installation.
## Requirements
**ODF Validator** requires J2RE 1.5 or J2RE 1.6. For J2RE 1.6, the following options have to be included into the **java** command line:
- -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl
+ -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl
-Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl
**ODF Validator** further requires the following packages:
-* [MSV] [8]. **msv.jar**, **isorelax.jar**, **relaxngDatatype.jar** and **xsdlib.jar** included in the MSV distribution must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
-* [ISORELAX JARV -> JAXP 1.3 Xml Validation Engine Adaptor] [9]. **isorelax-jaxp-bridge-1.0.jar** must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
-* **odfdom.jar** from the ODFDOM component must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
+* [MSV] [8]. **msv.jar**, **isorelax.jar**, **relaxngDatatype.jar** and **xsdlib.jar** included in the MSV distribution must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
+* [ISORELAX JARV -> JAXP 1.3 Xml Validation Engine Adaptor] [9]. **isorelax-jaxp-bridge-1.0.jar** must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
+* **odfdom.jar** from the ODFDOM component must be added to the project's libraries and must be in the classpath or a folder called **lib** that is next to the **odfvalidator.jar** at runtime.
The NetBeans project is pre-configured to build ODFDOM while building **ODF Validator**. This requires that the ODFDOM sources are located in a folder **odfdom** next to the folder of the **ODF Validator** project.
Alternatively, the reference to the ODFDOM project in the compile time classpath of the **ODF Validator** project may be replaced with a reference to an already compiled **odfdom.jar**.
-The references to all other jar files must be updated manually before
+The references to all other jar files must be updated manually before
building **ODF Validator**.
**Note:** ODFDOM requires [Apache Xerces] [10]. The jar file **xercesImpl.jar** also must exist in a folder **lib** next to **odvalidator.jar** file, or it must be in the classpath. The **ODF Validator** NetBeans projects includes a reference to **xersesImpl.jar** in the runtime classpath which has to be adapted after checking out the project.
-**Note:** ODFDOM requires at least Xerces 2.8.0. Please note that MSV distribution contains an xercesImpl.jar which is older.
+**Note:** ODFDOM requires at least Xerces 2.8.0. Please note that MSV distribution contains an xercesImpl.jar which is older.
## Source Code
-The **ODF Validator** source code is located [here][11]. **ODF Validator** uses Mercurial for source control. Please check the
+The **ODF Validator** source code is located [here][11]. **ODF Validator** uses Mercurial for source control. Please check the
help for instruction how to use Mercurial.
@@ -300,4 +301,4 @@
[8]: https://msv.dev.java.net/
[9]: https://isorelax-jaxp-bridge.dev.java.net
[10]: http://xml.apache.org/dist/xerces-j/
- [11]: http://odftoolkit.org/projects/conformancetools/sources/odf-validator-src/show
\ No newline at end of file
+ [11]: http://odftoolkit.org/projects/conformancetools/sources/odf-validator-src/show
diff --git a/content/odftoolkit/contact.mdtext b/content/odftoolkit/contact.mdtext
index cc988c2..e430aef 100644
--- a/content/odftoolkit/contact.mdtext
+++ b/content/odftoolkit/contact.mdtext
@@ -24,5 +24,5 @@
- [odf-private@incubator.apache.org][2].
- [1]: mailto:ooo-dev@incubator.apache.org
- [2]: mailto:ooo-private@incubator.apache.org
+ [1]: mailto:odf-dev@incubator.apache.org
+ [2]: mailto:odf-private@incubator.apache.org
diff --git a/content/odftoolkit/downloads.mdtext b/content/odftoolkit/downloads.mdtext
index 0ca9d86..8b81f48 100644
--- a/content/odftoolkit/downloads.mdtext
+++ b/content/odftoolkit/downloads.mdtext
@@ -18,91 +18,38 @@
**Current Version**
-The Apache ODF Toolkit(incubating) team is pleased to announce the release of 0.6.1-incubating on June 2nd, 2014.
-
-A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.6.1-incubating.txt). People interested should also follow the [mailing list](http://incubator.apache.org/odftoolkit/mailing-lists.html) to track progress.
+The Apache ODF Toolkit (incubating) team is pleased to announce
+the release of 0.6.2-incubating on April 10th, 2017.
-The ODF Toolkit source release as well as the pre-built binary deployment packages are listed below.
+A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.6.2-incubating.txt). People interested should also follow the [mailing list](http://incubator.apache.org/odftoolkit/mailing-lists.html) to track progress.
+
+The ODF Toolkit source release as well as the pre-built binary deployment packages are listed below.
Below is a list of the downloads:
- * Source:
- * [odftoolkit-0.6.1-incubating-src.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.6.1-incubating-src.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.1-incubating-src.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.1-incubating-src.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.1-incubating-src.zip.sha)]
- * Binaries:
- * [odftoolkit-0.6.1-incubating-bin.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.6.1-incubating-bin.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6.1-incubating-bin.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6.1-incubating-bin.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6-incubating-bin.zip.sha)]
- * Documentation:
- * [odftoolkit-0.6.1-incubating-doc.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.6.1-incubating-doc.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.1-incubating-doc.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.1-incubating-doc.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.1-incubating-doc.zip.sha)]
-
-
-**Older Versions**
-
-**0.6-incubating**
+ * Source:
+ * [odftoolkit-0.6.2-incubating-source-release.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.6.2-incubating-source-release.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.2-incubating-source-release.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.2-incubating-source-release.zip.md5)]
+ [[sha](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6.2-incubating-source-release.zip.sha)]
+ * Binaries:
+ * [odftoolkit-0.6.2-incubating-bin.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.6.2-incubating-bin.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6.2-incubating-bin.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6.2-incubating-bin.zip.md5)]
+ [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6-2-incubating-bin.zip.sha)]
+ * Documentation:
+ * [odftoolkit-0.6.2-incubating-doc.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.6.2-incubating-doc.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.2-incubating-doc.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.2-incubating-doc.zip.md5)]
+ [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6.2-incubating-doc.zip.sha)]
-The Apache ODF Toolkit(incubating) team is pleased to announce the release of 0.6.1-incubating on Jun 22, 2013.
-
-A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.6-incubating.txt). People interested should also follow the [mailing list](http://incubator.apache.org/odftoolkit/mailing-lists.html) to track progress.
+ *Note*: All downloads can be verified using the Apache ODF Toolkit code signing [KEYS](http://www.apache.org/dist/incubator/odftoolkit/KEYS).
+ When downloading from a mirror please check the [md5sum](http://www.apache.org/dev/release-signing#md5)
+ and verify the [OpenPGP](http://www.apache.org/dev/release-signing#openpgp) compatible
+ signature from the main [Apache site](http://www.apache.org). Links are provided above (next to the release download link). This [KEYS](http://www.apache.org/dist/incubator/odftoolkit/KEYS) file contains the public
+ keys used for signing release. It is recommended that (when possible) a [web of trust](http://www.apache.org/dev/release-signing#web-of-trust) is
+ used to confirm the identity of these keys. For more information, please see the [Apache Release FAQ](http://www.apache.org/dev/release.html).
-The ODF Toolkit source release as well as the pre-built binary deployment packages are listed below.
-Below is a list of the downloads:
+**Older Apache Versions**
- * Source:
- * [odftoolkit-0.6-incubating-src.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.6-incubating-src.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6-incubating-src.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.6-incubating-src.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/odftoolkit-0.6-incubating-src.zip.sha)]
- * Binaries:
- * [odftoolkit-0.6-incubating-bin.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.6-incubating-bin.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6-incubating-bin.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6-incubating-bin.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.6-incubating-bin.zip.sha)]
- * Documentation:
- * [odftoolkit-0.6-incubating-doc.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.6-incubating-doc.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6-incubating-doc.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6-incubating-doc.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.6-incubating-doc.zip.sha)]
-
+Older versions can be found in the [Apache Archive](http://archive.apache.org/dist/incubator/odftoolkit/).
-**0.5-incubating**
-
-The Apache ODF Toolkit(Incubating) team is pleased to announce the release of 0.5-incubating on Jan 14, 2012. This is our first Apache release.
-
-A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.5-incubating.txt). People interested should also follow the [mail list](http://incubator.apache.org/odftoolkit/mailing-lists.html) to track progress.
-
-The ODF Toolkit source release as well as the pre-built binary deployment packages are listed below. Pre-built versions of all ODF Toolkit components are available in the central Maven repository under Group ID "org.apache.odftoolkit" and Version "0.5-incubating".
-
-Below is a list of the downloads:
-
- * Source:
- * [odftoolkit-0.5-incubating-src.tar.gz](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.sha)]
- * [odftoolkit-0.5-incubating-src.tar.bz2](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.bz2 ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.bz2.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.bz2.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.bz2.sha)]
- * [odftoolkit-0.5-incubating-src.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.zip.sha)]
- * Binaries:
- * [odftoolkit-0.5-incubating-bin.tar.gz](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.gz) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.gz.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.gz.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.gz.sha)]
- * [odftoolkit-0.5-incubating-bin.tar.bz2](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.bz2 ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.bz2.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.bz2.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.tar.bz2.sha)]
- * [odftoolkit-0.5-incubating-bin.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/binaries/odftoolkit-0.5-incubating-bin.zip.sha)]
- * Documentation:
- * [odftoolkit-0.5-incubating-doc.tar.gz](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.gz) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.gz.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.gz.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.gz.sha)]
- * [odftoolkit-0.5-incubating-doc.tar.bz2](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.bz2 ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.bz2.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.bz2.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.tar.bz2.sha)]
- * [odftoolkit-0.5-incubating-doc.zip ](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.zip ) [[asc](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.zip.asc)] [[md5](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.zip.md5)]
- [[sha](http://www.apache.org/dist/incubator/odftoolkit/docs/odftoolkit-0.5-incubating-doc.zip.sha)]
-
-*Note*: All downloads can be verified using the Apache ODF Toolkit code signing [KEYS](http://www.apache.org/dist/incubator/odftoolkit/KEYS).
-When downloading from a mirror please check the [md5sum](http://www.apache.org/dev/release-signing#md5)
-and verify the [OpenPGP](http://www.apache.org/dev/release-signing#openpgp) compatible
-signature from the main [Apache site](http://www.apache.org). Links are provided above (next to the release download link). This [KEYS](http://www.apache.org/dist/incubator/odftoolkit/KEYS) file contains the public
-keys used for signing release. It is recommended that (when possible) a [web of trust](http://www.apache.org/dev/release-signing#web-of-trust) is
-used to confirm the identity of these keys. For more information, please see the [Apache Release FAQ](http://www.apache.org/dev/release.html).
-
-
-**Release Archives**
+**Prior Apache Releases**
Apache ODF Toolkit became an incubator project in August 2011. Prior to that date the ODF Toolkit was a set of projects of [ODF Toolkit Union](http://odftoolkit.org/). Now, all of the legacy ODF Toolkit Union releases are archived at [apache-extras.org](http://code.google.com/a/apache-extras.org/p/odftoolkit-extra/).
-
-
diff --git a/content/odftoolkit/index.mdtext b/content/odftoolkit/index.mdtext
index e94fd07..4b8bf92 100644
--- a/content/odftoolkit/index.mdtext
+++ b/content/odftoolkit/index.mdtext
@@ -1,20 +1,21 @@
Title: Apache ODF Toolkit (Incubating)
-**2014-06-02 - ODF Toolkit 0.6.1-incubating available**
+**2017-04-10 - ODF Toolkit 0.6.2-incubating available**
-The Apache ODF Toolkit (Incubating) team is pleased to announce the release of 0.6.1-incubating. This is our third Apache release.
+The Apache ODF Toolkit (Incubating) team is pleased to announce the release of 0.6.2-incubating. This is our fourth Apache release.
+It will be the last release supporting JDK 6. The upcoming release will be based on JDK 8.
-A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.6.1-incubating.txt). People interested should also follow the [mail list](mailing-lists.html) to track progress.
+A full list of changes is available in the [change log](http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.6.2-incubating.txt). People interested should also follow the [mail list](mailing-lists.html) to track progress.
See the [downloads page](downloads.html) for more details.
**Mission Statement**
-The Apache ODF Toolkit is a set of Java modules that allow programmatic creation,
-scanning and manipulation of [Open Document Format] [1] (ISO/IEC 26300 == ODF)
-documents. Unlike other approaches which rely on runtime manipulation
-of heavy-weight editors via an automation interface, the ODF Toolkit
-is lightweight and ideal for server use.
+The Apache ODF Toolkit is a set of Java modules that allow programmatic creation,
+scanning and manipulation of [Open Document Format] [1] (ISO/IEC 26300 == ODF)
+documents. Unlike other approaches which rely on runtime manipulation
+of heavy-weight editors via an automation interface, the ODF Toolkit
+is lightweight and ideal for server use.
Apache "ODF Toolkit" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator.
@@ -24,4 +25,3 @@
yet to be fully endorsed by the ASF.
[1]: http://opendocument.xml.org/
-
diff --git a/content/odftoolkit/mailing-lists.mdtext b/content/odftoolkit/mailing-lists.mdtext
index 282f555..05696e4 100644
--- a/content/odftoolkit/mailing-lists.mdtext
+++ b/content/odftoolkit/mailing-lists.mdtext
@@ -27,7 +27,7 @@
- [Users Mailing List](#users_mailing_list).
## Participation Guidelines
-We ask all mailing list participants to observe [these guidelines][0].
+We ask all mailing list participants to observe [these guidelines][0].
Specifically note the request "Use sensible and concise email subject headings".
@@ -88,15 +88,14 @@
[1]: mailto:odf-dev-subscribe@incubator.apache.org
[2]: mailto:odf-dev@incubator.apache.org
[3]: mailto:odf-dev-unsubscribe@incubator.apache.org
- [4]: http://markmail.org/search/+list:org.apache.incubator.odf-dev
+ [4]: https://lists.apache.org/list.html?odf-dev@incubator.apache.org
[6]: http://mail-archives.apache.org/mod_mbox/incubator-odf-dev/
[7]: mailto:odf-commits-subscribe@incubator.apache.org
[8]: mailto:odf-commmits-unsubscribe@incubator.apache.org
- [9]: http://markmail.org/search/+list:org.apache.incubator.odf-commits
+ [9]: https://lists.apache.org/list.html?odf-commits@incubator.apache.org
[10]: http://mail-archives.apache.org/mod_mbox/incubator-odf-commits/
[11]: mailto:odf-users-subscribe@incubator.apache.org
[12]: mailto:odf-users-unsubscribe@incubator.apache.org
- [13]: http://markmail.org/search/+list:org.apache.incubator.odf-users
+ [13]: https://lists.apache.org/list.html?odf-users@incubator.apache.org
[14]: http://mail-archives.apache.org/mod_mbox/incubator-odf-users/
-
diff --git a/content/odftoolkit/odfdom/index.mdtext b/content/odftoolkit/odfdom/index.mdtext
index ff3dbc0..e81c471 100644
--- a/content/odftoolkit/odfdom/index.mdtext
+++ b/content/odftoolkit/odfdom/index.mdtext
@@ -1,6 +1,6 @@
Title: ODFDOM - the OpenDocument API
-ODFDOM is a free OpenDocument Format (ODF) library. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language.
+ODFDOM is a free OpenDocument Format (ODF) library. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language.
The current reference implementation is written in Java.
@@ -9,48 +9,21 @@
Quickstart
----------
-Put the odfdom.jar file in your classpath. You will need [Apache Xerces-J][20] as XML parser and DOM implementation as well. Start with the following sample code to create a simple text document.
+Put the odfdom.jar file in your classpath. You will need [Apache Xerces-J][20] as XML parser and DOM implementation as well. Start with the following sample code to create a simple text document.
- // Create a text document from a standard template (empty documents within the JAR)
- OdfTextDocument odt = OdfTextDocument.newTextDocument();
- // Append text to the end of the document.
- odt.addText("This is my very first ODF test");
- // Save document
- odt.save("MyFilename.odt");
+ // Create a text document from a standard template (empty documents within the JAR)
+ OdfTextDocument odt = OdfTextDocument.newTextDocument();
+ // Append text to the end of the document.
+ odt.addText("This is my very first ODF test");
+ // Save document
+ odt.save("MyFilename.odt");
-The Earlier Release
----------
-
-**ODFDOM 0.8.7**
-
-ODFDOM 0.8.7 was on Feb 16th 2011. Major enhancements are coming with this version:
-
- - Full Maven support: ODFDOM is now on the public Maven servers.
- - The sub document handling had been enhanced.
- - ODF Package validation in ODFDOM was enabled. ODFDOM is used by the ODF Validator project of ODF Toolkit.
- - More functionality for source code generation of the ODF 1.2 typed DOM classes by using MultiSchemaValidator as RelaxNG parser and Apache Velocity as template engine
- - A major design clean-up had been archived. The inheritance relationship between DOM and Document layer has been broken up as it was no 1:1 relationship. The convenient methods for text, image and style are moved to incubator package.
- - A new function to extract text from documents, DOMs and elements has been provided.
- - Several bugs related with table and presentation had been fixed.
-
-For more details see [feature summary on the mailing list][3] and [the release notes with the API change list][4].
-
-**Download**
-
-The ODFDOM downloads are now available from [the official Maven repository][5]:
-
- [*KEYS*][6]
-
- - [ODFDOM 0.8.7 binary - jar][7] [[PGP]][8] [[MD5]][9] [[SHA]][10]
- - [ODFDOM 0.8.7 JavaDoc - jar][11] [[PGP]][12] [[MD5]][13] [[SHA]][14]
- - [ODFDOM 0.8.7 sources - jar][15] [[PGP]][16] [[MD5]][17] [[SHA]][18]
-
-For information on working with the source code, please refer to [the development section][19].
+For information on working with the source code, please refer to [the development section][19].
Documentation
-------------
-A good starting point is reading [the project overview][21] and [the ODFDOM Layers][22] will help you to get an overview over the ODFDOM package structure.
+A good starting point is reading [the project overview][21] and [the ODFDOM Layers][22] will help you to get an overview over the ODFDOM package structure.
Javadocs are [viewable online][23] or [downloadable as bundle][24] from the official Maven repository.
@@ -65,34 +38,16 @@
If you're a developer, just dive into [the development section][28]. Here you find information on where to access the source code and how to set up a build environment.
-You can contact us by IRC "[irc://irc.freenode.org/odfdom][29]".
-
[1]: ProjectOverview.html
[2]: Layers.html
- [3]: http://odftoolkit.org/projects/odfdom/lists/users/archive/2011-02/message/6
[4]: ReleaseNotes.html
- [5]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/
- [6]: http://odftoolkit.org/downloads/odfdom/KEYS
- [7]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar
- [8]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar.asc
- [9]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar.md5
- [10]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7.jar.sha1
- [11]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-javadoc.jar
- [12]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-javadoc.jar.asc
- [13]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-javadoc.jar.md5
- [14]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-javadoc.jar.sha1
- [15]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-sources.jar
- [16]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-sources.jar.asc
- [17]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-sources.jar.md5
- [18]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/0.8.7/odfdom-java-0.8.7-sources.jar.sha1
[19]: Development.html
[20]: http://xml.apache.org/dist/xerces-j/
[21]: ProjectOverview.html
[22]: Layers.html
- [23]: /odftoolkit/mvn-site/0.8.9-incubating/odfdom-java/apidocs/
- [24]: https://oss.sonatype.org/content/groups/public/org/odftoolkit/odfdom-java/
+ [23]: /odftoolkit/mvn-site/0.6.2-incubating/odfdom/apidocs/
+ [24]: http://www.apache.org/dist/incubator/odftoolkit/docs/
[25]: http://www.langintro.com/odfdom_tutorials/
[26]: FrequentQuestions.html
[27]: mailto:odf-users@incubator.apache.org
[28]: Development.html
- [29]: irc://irc.freenode.org/odfdom
diff --git a/content/odftoolkit/odftoolkit-release-guide.mdtext b/content/odftoolkit/odftoolkit-release-guide.mdtext
index 1f26625..f02206a 100644
--- a/content/odftoolkit/odftoolkit-release-guide.mdtext
+++ b/content/odftoolkit/odftoolkit-release-guide.mdtext
@@ -17,47 +17,47 @@
under the License.
I. Prerequisites
--------------------
- 1. You should read the document:[A Guide To Release Management During Incubation (DRAFT)][1].
- 2. You must have shell access to people.apache.org, such as [PuTTY][2].
- 3. Release manager must have his public key appended to the KEYS file checked in to SVN. Make sure that a current version is available in the dist folder. The key should be published on one of the public key servers. Also, it should be added to the profile page via id.apache.org.
- ODF Toolkit project KEYS file: [https://svn.apache.org/repos/asf/incubator/odf/trunk/KEYS][3].
- The sign tool, such as [GnuPG][4] should be installed. More info can be found here: [http://www.apache.org/dev/release-signing.html][5].
- 4. You must have [Oracle JDK 1.5/1.6][6] or [Open JDK][7].
- 5. [Subversion client][8] is installed. We suggest you install version 1.7.2 or later.
- 6. The ODF Toolkit build system requires [Maven][9] to perform a build. We suggest you install version later than 2.2.1 or 3.0.4. Make sure that you have set up your Maven installation according to the guide on [Publishing Maven Artifacts][15]
+-------------------
+ 1. You should read the document:[A Guide To Release Management During Incubation (DRAFT)][1].
+ 2. You must have shell access to people.apache.org, such as [PuTTY][2].
+ 3. Release manager must have his public key appended to the KEYS file checked in to SVN. Make sure that a current version is available in the dist folder. The key should be published on one of the public key servers. Also, it should be added to the profile page via id.apache.org.
+ ODF Toolkit project KEYS file: [https://svn.apache.org/repos/asf/incubator/odf/trunk/KEYS][3].
+ The sign tool, such as [GnuPG][4] should be installed. More info can be found here: [http://www.apache.org/dev/release-signing.html][5].
+ 4. You must have [Oracle JDK 1.8][6] or [Open JDK][7].
+ 5. [Subversion client][8] is installed. We suggest you install version 1.9.3 or later.
+ 6. The ODF Toolkit build system requires [Maven][9] to perform a build. We suggest you install version 3.2.5 or later. Make sure that you have set up your Maven installation according to the guide on [Publishing Maven Artifacts][15]
7. All mail adresses the release manager is using should be added to the profile via id.apache.org
-II. Legal Audit
--------------------
- Legal policy and interpretation changes from time to time so it is worth investing a little time reading again the legal release material.
+II. Legal Audit
+-------------------
+ Legal policy and interpretation changes from time to time so it is worth investing a little time reading again the legal release material.
- 1. Check that dependencies (and in particular those dependencies that ship in the packages) comply with Apache policy. Apache projects may distribute artifacts and documents as part of a release which are not Apache Licensed. All such artifacts must comply with [Apache's 3rd party licensing policy][10].
- All the licenses on all the files to be included within a package should be included in the LICENSE document.
- 2. The NOTICE document is for additional copyright and attribution statements those licenses may require. A typical NOTICE document at a minimum includes a copyright and attribution statement for The Apache Software Foundation. Nothing else belongs in the NOTICE document.
- 3. It is good practice to check the provenance of any source documents which do not have license headers. With the help of RAT, you can run Maven command: 'mvn verify -Ppedantic' on the "trunk" to get a report about the license header.
- 4. Make sure every committer have a signed [Contributor License Agreement (CLA)][11] on file. It's a contract between a contributor and Apache granting Apache rights to code contributed.
- 5. If any dependencies are cryptographic libraries then it may be necessary to fill in some [paperwork][12] to make sure they are compliance with US export regulations.
+ 1. Check that dependencies (and in particular those dependencies that ship in the packages) comply with Apache policy. Apache projects may distribute artifacts and documents as part of a release which are not Apache Licensed. All such artifacts must comply with [Apache's 3rd party licensing policy][10].
+ All the licenses on all the files to be included within a package should be included in the LICENSE document.
+ 2. The NOTICE document is for additional copyright and attribution statements those licenses may require. A typical NOTICE document at a minimum includes a copyright and attribution statement for The Apache Software Foundation. Nothing else belongs in the NOTICE document.
+ 3. It is good practice to check the provenance of any source documents which do not have license headers. With the help of RAT, you can run Maven command: 'mvn verify -Ppedantic' on the "trunk" to get a report about the license header.
+ 4. Make sure every committer have a signed [Contributor License Agreement (CLA)][11] on file. It's a contract between a contributor and Apache granting Apache rights to code contributed.
+ 5. If any dependencies are cryptographic libraries then it may be necessary to fill in some [paperwork][12] to make sure they are compliance with US export regulations.
-III. Release Document
+III. Release Document
-------------------------
-Documents a particular release of a product rather than the product itself. For a release manager, the first thing he should do is to consult and correct the project's release documentation. For ODF Toolkit, we should make sure the following items are ready.
+Documents a particular release of a product rather than the product itself. For a release manager, the first thing he should do is to consult and correct the project's release documentation. For ODF Toolkit, we should make sure the following items are ready.
- 1. Ensure the CHANGES.txt is up to date.
- 2. The Cookbook was updated to support the new release, add new content and modify the old parts.
- 3. Make sure all of the demo codes work well under the new release. If necessary, write new demo to introduce the key new features in the new version.
- 4. Remember to update the online Javadoc to the newest version, but don't publish until the vote pass.
- 5. Prepare other website update content, save them as staged, but don't publish until the vote pass.
+ 1. Ensure the CHANGES.txt is up to date.
+ 2. The Cookbook was updated to support the new release, add new content and modify the old parts.
+ 3. Make sure all of the demo codes work well under the new release. If necessary, write new demo to introduce the key new features in the new version.
+ 4. Remember to update the online Javadoc to the newest version, but don't publish until the vote pass.
+ 5. Prepare other website update content, save them as staged, but don't publish until the vote pass.
-IV. Release Candidate
+IV. Release Candidate
--------------------------------
-A release candidate is a set of artifacts upon which a vote is held for a release. The actual nature of the release candidate depends on the release system adopted by a the project. For ODF Toolkit, we supply 3 type of artifacts, binary package, source package and document package. The release candidate jars are deployed to a Maven staging repository. Making release artefacts should follow the following steps:
+A release candidate is a set of artifacts upon which a vote is held for a release. The actual nature of the release candidate depends on the release system adopted by a the project. For ODF Toolkit, we supply 3 type of artifacts, binary package, source package and document package. The release candidate jars are deployed to a Maven staging repository. Making release artefacts should follow the following steps:
1. Make sure that your working copy is clean
Preferrably check out a clean version from https://svn.apache.org/repos/asf/incubator/odf/trunk
- 2. Prepare the release
+ 2. Prepare the release
mvn release:prepare
@@ -66,8 +66,8 @@
mvn release:prepare -Dusername=APACHE_ID -Dpassword=PASSWORD
This will start the interactive release preparation. You need to supply Maven with the versions of the release. "release version" should be the version of the intended release (recommended value should be fine). "SCM release tag or label" should include the RC version (e.g. odftoolkit-0.6.1-incubating-RC3). "new development version" should be the current SNAPSHOT version (don't use the recommended version, e.g. when building 0.6.1-incubating this should be 0.6.1-incubating-SNAPSHOT, not 0.6.2-incubating-SNAPSHOT).
-
- This will update the versions of all modules and create an svn tag. The version should always include incubating (or incubator) to ensure that the artifacts created comply with [Incubator release policy][13].
+
+ This will update the versions of all modules and create an svn tag. The version should always include incubating (or incubator) to ensure that the artifacts created comply with [Incubator release policy][13].
3. Perform the release
@@ -80,7 +80,7 @@
Log in to [the Nexus repository manager][20], click on Staging Repositories, select the current ODFToolkit staging repo and click on close.
You can test the staging repository by adding a snippet like this to your Maven settings (the url to the staged repo can be obtained from the mail you got when closing the repo):
-
+
<profile>
<id>odfstage</id>
<activation>
@@ -94,238 +94,238 @@
</repositories>
</profile>
- 5. Package download artifacts
-
- Switch to the checkout directory that has been created by the release: cd target/checkout. Use the following command to package (replace <YOUR APACHEID> with your apache id, e.g. devinhan):
+ 5. Package download artifacts
- mvn install -Prelease-distribution -pl=. -Duser.name=<YOUR APACHEID>
-
- After package there should be a folder release/$TAG in the "target\"
-
- vote.txt is a draft of the dev vote mail. Each package has its own .asc, .md5 and .sha files.
-
- 6. Upload artifacts for vote.
- Login people.apache.org using your Apache LDAP account. Copy the folder release/$TAG to directory "/public_html/odftoolkit-release/$TAG" using [scp][14]. If the directory does't exist, please create. It is best to scp into the home directory and then copy into position from there.
- Make sure all of the files are owned by the incubator group, group readable and writable, and read only for the world. In short -rw-rw-r--. To do this from the top level:
-
- > find . -type f -exec chmod 664 {} \;
- > find . -type d -exec chmod 775 {} \;
- > chgrp -R incubator *
-
- Then the artifacts can be accessed from Web browser. The link looks like:
-
- http://people.apache.org/~$USER/odftoolkit-release/$TAG
-
+ Switch to the checkout directory that has been created by the release: cd target/checkout. Use the following command to package (replace <YOUR APACHEID> with your apache id, e.g. devinhan):
+
+ mvn install -Prelease-distribution -pl=. -Duser.name=<YOUR APACHEID>
+
+ After package there should be a folder release/$TAG in the "target\"
+
+ vote.txt is a draft of the dev vote mail. Each package has its own .asc, .md5 and .sha files.
+
+ 6. Upload artifacts for vote.
+ Login people.apache.org using your Apache LDAP account. Copy the folder release/$TAG to directory "/public_html/odftoolkit-release/$TAG" using [scp][14]. If the directory does't exist, please create. It is best to scp into the home directory and then copy into position from there.
+ Make sure all of the files are owned by the incubator group, group readable and writable, and read only for the world. In short -rw-rw-r--. To do this from the top level:
+
+ > find . -type f -exec chmod 664 {} \;
+ > find . -type d -exec chmod 775 {} \;
+ > chgrp -R incubator *
+
+ Then the artifacts can be accessed from Web browser. The link looks like:
+
+ http://people.apache.org/~$USER/odftoolkit-release/$TAG
+
Replace $USER with your Apache ID, such as "devinhan".
-
-V. Incubator Release Vote
+
+V. Incubator Release Vote
-----------------------------
-After release candidate is uploaded, the release manager can start vote process. All releases by podlings must be approved by the Incubator PMC. The conventional process is for the podling to follow the usual Apache process release vote and then call for a Incubator PMC VOTE on the general incubator list.
+After release candidate is uploaded, the release manager can start vote process. All releases by podlings must be approved by the Incubator PMC. The conventional process is for the podling to follow the usual Apache process release vote and then call for a Incubator PMC VOTE on the general incubator list.
-1. Vote in ODF Toolkit Development List
-A formal vote on candidate artifacts must be conducted by the release manager on the ODF Toolkit development list. The vote mail can be drafted based on the vote.txt, which is generated with artifacts. A sample looks like this:
+1. Vote in ODF Toolkit Development List
+A formal vote on candidate artifacts must be conducted by the release manager on the ODF Toolkit development list. The vote mail can be drafted based on the vote.txt, which is generated with artifacts. A sample looks like this:
- Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC6)
- To: odf-dev@incubator.apache.org
- Hi all,
- Please vote on releasing the following candidate as Apache ODF Toolkit (incubating) version 0.5.
- This will be the first incubator release for ODF Toolkit in Apache.
-
- This release candidate fixes the following issues found in RC5:
- (1) Reomve JUnit declaration from NOTICE & LICENSE files.
- (2) Fix the "mvn clean" failed issue.
-
- The candidate for the ODF Toolkit 0.5-incubating release is available at:
- http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc6/
-
- The release candidate is a zip archive of the sources in:
- https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.5-incubating/
-
- The SHA1 checksum of the archive is 44e16d8ee39fc0426f96aa7da9cd8eefccaf78e5.
- The MD5 checksum of the archive is c12a87f0ca441f23d945a423e1d4127c.
-
- Besides source code, binary packages and javadoc packages are also listed in:
- http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc6/
-
- All of the artifacts supply three package formats, tar.gz, tar.bz2 and zip.
-
- Keys:
- http://www.apache.org/dist/incubator/odftoolkit/KEYS
-
- Please vote on releasing this package as Apache ODF Toolkit 0.5-incubating.
+ Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC6)
+ To: odf-dev@incubator.apache.org
+ Hi all,
+ Please vote on releasing the following candidate as Apache ODF Toolkit (incubating) version 0.5.
+ This will be the first incubator release for ODF Toolkit in Apache.
+
+ This release candidate fixes the following issues found in RC5:
+ (1) Reomve JUnit declaration from NOTICE & LICENSE files.
+ (2) Fix the "mvn clean" failed issue.
+
+ The candidate for the ODF Toolkit 0.5-incubating release is available at:
+ http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc6/
+
+ The release candidate is a zip archive of the sources in:
+ https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.5-incubating/
+
+ The SHA1 checksum of the archive is 44e16d8ee39fc0426f96aa7da9cd8eefccaf78e5.
+ The MD5 checksum of the archive is c12a87f0ca441f23d945a423e1d4127c.
+
+ Besides source code, binary packages and javadoc packages are also listed in:
+ http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc6/
+
+ All of the artifacts supply three package formats, tar.gz, tar.bz2 and zip.
+
+ Keys:
+ http://www.apache.org/dist/incubator/odftoolkit/KEYS
+
+ Please vote on releasing this package as Apache ODF Toolkit 0.5-incubating.
The vote is open for the next full week, until next Saturday, Dec 31rd 6pm, because of the Christmas holiday, and passes
- if a majority of at least 3 +1 IPMC votes are cast.
- [ ] +1 Release this package as Apache ODF Toolkit 0.5-incubating
- [ ] -1 Do not release this package because...
- To learn more about Apache ODF Toolkit, please access: http://incubator.apache.org/odftoolkit/.
+ if a majority of at least 3 +1 IPMC votes are cast.
+ [ ] +1 Release this package as Apache ODF Toolkit 0.5-incubating
+ [ ] -1 Do not release this package because...
+ To learn more about Apache ODF Toolkit, please access: http://incubator.apache.org/odftoolkit/.
-All votes are welcome, but only those votes by the project's PPMC members (or IPMC members) count towards the final tally. The voting period should be no less than 72 hours, and at the end of the voting the release manager should post a final tally to the list. eg.
+All votes are welcome, but only those votes by the project's PPMC members (or IPMC members) count towards the final tally. The voting period should be no less than 72 hours, and at the end of the voting the release manager should post a final tally to the list. eg.
- Subject: [RESULT][VOTE] Release Apache ODF Toolkit 0.5-incubating-rc7
- To: odf-dev@incubator.apache.org
-
- Hi All,
- The RC7 ballot has ended (due to New Year Holiday, we extended the vote to this Monday ) with the following results:
-
- From PPMC members:
- +1 daisyguo
- +1 devinhan
- +1 robweir
- +1 svanteschubert
-
- From Mentors:
- +1 yegor(IPMC)
-
- Other votes:
- (abstain non-binding [;<) orcmid
-
- I will send a vote mail to incubator-general mail list and collect another 2 IPMC +1's votes.
- Thanks all of the voters.
+ Subject: [RESULT][VOTE] Release Apache ODF Toolkit 0.5-incubating-rc7
+ To: odf-dev@incubator.apache.org
- The vote passes if there are at least 3 +1's from the PPMC/IPMC members and more +1's than -1's. This is what is meant by majority consensus. If you've gotten this far, congratulations, you're nearly ready to upload and announce the release.
- If the vote is failed, the release manager should improve the artifacts based on the comments and prepare new candidate. That means step "III. Release Candidate" need to rework. This process maybe repeat several times until the vote passes.
- **NOTE:** Please remember to delete old release candidates from Apache home space after new candidates are uploaded.
+ Hi All,
+ The RC7 ballot has ended (due to New Year Holiday, we extended the vote to this Monday ) with the following results:
- 2. Vote in General Incubator List
-In the case of the incubator, the IPMC must approve all releases. That means there is an additional bit of voting that the release manager must now oversee on general@incubator in order to gain that approval. The release manager must inform general@incubator that the vote has passed on the project's development list, and should indicate any IPMC votes gained during that process. A new vote on the release candidate artifacts must now be held on general@incubator to seek majority consensus from the IPMC. Previous IPMC votes issued on the project's development list count towards that goal. The sample mail is:
+ From PPMC members:
+ +1 daisyguo
+ +1 devinhan
+ +1 robweir
+ +1 svanteschubert
- Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC7)
- To: general@incubator.apache.org
- Cc: odf-dev@incubator.apache.org
- Hi all,
+ From Mentors:
+ +1 yegor(IPMC)
- The ODF Toolkit 0.5 is ready for release. This will be our first incubator release.
- We had a preliminary vote in the PPMC, which had great results, including a +1 from our mentor, Yegor.
+ Other votes:
+ (abstain non-binding [;<) orcmid
- The PPMC vote result thread is here:
- http://markmail.org/message/tw3juzkak6kdiod2
- The vote thread is here:
- http://markmail.org/message/h6qfmhl4vulyjyhw
+ I will send a vote mail to incubator-general mail list and collect another 2 IPMC +1's votes.
+ Thanks all of the voters.
- We need two more IPMC votes to pass.
+ The vote passes if there are at least 3 +1's from the PPMC/IPMC members and more +1's than -1's. This is what is meant by majority consensus. If you've gotten this far, congratulations, you're nearly ready to upload and announce the release.
+ If the vote is failed, the release manager should improve the artifacts based on the comments and prepare new candidate. That means step "III. Release Candidate" need to rework. This process maybe repeat several times until the vote passes.
+ **NOTE:** Please remember to delete old release candidates from Apache home space after new candidates are uploaded.
- Please vote on releasing the following candidate RC7 as Apache ODF Toolkit (incubating) version 0.5.
+ 2. Vote in General Incubator List
+In the case of the incubator, the IPMC must approve all releases. That means there is an additional bit of voting that the release manager must now oversee on general@incubator in order to gain that approval. The release manager must inform general@incubator that the vote has passed on the project's development list, and should indicate any IPMC votes gained during that process. A new vote on the release candidate artifacts must now be held on general@incubator to seek majority consensus from the IPMC. Previous IPMC votes issued on the project's development list count towards that goal. The sample mail is:
- This release candidate fixes the pom.xml file inconsistant issue found in RC6. Thanks Yegor!
+ Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC7)
+ To: general@incubator.apache.org
+ Cc: odf-dev@incubator.apache.org
+ Hi all,
- The candidate for the ODF Toolkit 0.5-incubating release is available at:
- http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc7/
+ The ODF Toolkit 0.5 is ready for release. This will be our first incubator release.
+ We had a preliminary vote in the PPMC, which had great results, including a +1 from our mentor, Yegor.
+
+ The PPMC vote result thread is here:
+ http://markmail.org/message/tw3juzkak6kdiod2
+ The vote thread is here:
+ http://markmail.org/message/h6qfmhl4vulyjyhw
+
+ We need two more IPMC votes to pass.
+
+ Please vote on releasing the following candidate RC7 as Apache ODF Toolkit (incubating) version 0.5.
+
+ This release candidate fixes the pom.xml file inconsistant issue found in RC6. Thanks Yegor!
+
+ The candidate for the ODF Toolkit 0.5-incubating release is available at:
+ http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc7/
- The release candidate is a zip archive of the sources in:
- https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.5-incubating/
+ The release candidate is a zip archive of the sources in:
+ https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.5-incubating/
- The SHA1 checksum of the zip archive is 4e97a1a79291035d590b5578caf79478dc3f6de8.
- The MD5 checksum of the zip archive is 8883f036ee34282077d3c175329f6257.
+ The SHA1 checksum of the zip archive is 4e97a1a79291035d590b5578caf79478dc3f6de8.
+ The MD5 checksum of the zip archive is 8883f036ee34282077d3c175329f6257.
- Besides source code, binary packages and javadoc packages are also listed in:
- http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc7/
+ Besides source code, binary packages and javadoc packages are also listed in:
+ http://people.apache.org/~devinhan/odftoolkit-release/odftoolkit-0.5-incubating-rc7/
- All of the artifacts supply three package formats, tar.gz, tar.bz2 and zip.
+ All of the artifacts supply three package formats, tar.gz, tar.bz2 and zip.
- Keys:
- http://www.apache.org/dist/incubator/odftoolkit/KEYS
+ Keys:
+ http://www.apache.org/dist/incubator/odftoolkit/KEYS
- The vote is open for 72 hours, or until we get the needed number of votes (3 +1).
+ The vote is open for 72 hours, or until we get the needed number of votes (3 +1).
- [ ] +1 Release this package as Apache ODF Toolkit 0.5-incubating
- [ ] -1 Do not release this package because...
+ [ ] +1 Release this package as Apache ODF Toolkit 0.5-incubating
+ [ ] -1 Do not release this package because...
- To learn more about Apache ODF Toolkit, please access http://incubator.apache.org/odftoolkit/.
+ To learn more about Apache ODF Toolkit, please access http://incubator.apache.org/odftoolkit/.
- Once the 72-hour minimum voting period has ended on general@incubator, the release manager should tally the votes and declare a result. If majority consensus has been achieved with respect to IPMC votes, the release manager may proceed with the release. Otherwise, the release manager need to rework step(III) and step(IV) based on the received comments.
- The vote result mail looks like:
+ Once the 72-hour minimum voting period has ended on general@incubator, the release manager should tally the votes and declare a result. If majority consensus has been achieved with respect to IPMC votes, the release manager may proceed with the release. Otherwise, the release manager need to rework step(III) and step(IV) based on the received comments.
+ The vote result mail looks like:
- Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC7)
- To: general@incubator.apache.org, odf-dev@incubator.apache.org
- Hi all,
-
- The Apache ODF Toolkit 0.5-incubating RC7 ballot has ended. We have received 4 IPMC +1 votes (plus an additional 4 PPMC +1 votes)
- during the release voting on dev and general. The vote passed!
-
- Results:
-
- From IPMC members:
- name apache id
- +1 Yegor Kozlov(mentor) yegor
- +1 Nick Burch(mentor) nick
- +1 Chris Mattmann mattmann
- +1 Christian Grobmeier grobmeier
-
- From PPMC members:
- name apache id
- +1 Ying Chung Guo daisyguo
- +1 Biao Han devinhan
- +1 Rob Weir robweir
- +1 Svante Schubert svanteschubert
-
- Other votes:
- name apache id
- (abstain non-binding [;<) Dennis E. Hamilton orcmid
-
- We will work on releasing ODF Toolkit 0.5. Thank you everyone who worked in this release!
+ Subject: [VOTE] Release Apache ODF Toolkit 0.5-incubating(RC7)
+ To: general@incubator.apache.org, odf-dev@incubator.apache.org
+ Hi all,
-VI. After the Vote
-------------------------------
-1. Distributing Releases
- The distribution upload location (www.apache.org/dist) for all Apache projects is the /www/www.apache.org/dist directory on people.apache.org. Each project (including the Incubator) owns a directory within dist.
- The directory of ODF Toolkit is http://www.apache.org/dist/incubator/odftoolkit/. The release manager should move the release artifacts from /public_html/odftoolkit-release/$TAG to this directory.
+ The Apache ODF Toolkit 0.5-incubating RC7 ballot has ended. We have received 4 IPMC +1 votes (plus an additional 4 PPMC +1 votes)
+ during the release voting on dev and general. The vote passed!
-2. Mirroring
- To avoid excessive use of bandwidth and to increase download speeds, official releases are made available through a global network of volunteer mirrors. Using these mirrors has some notable differences from unmirrored downloads. In particular, a <a href="http://www.apache.org/dev/release-download-pages.html" script</a must be used to direct the download to an appropriate URL. The mdtext format sample is:
-
- \*\*Current Version (0.5-incubating)**
- \* Source:
- \* \[odftoolkit-0.5-incubating-src.tar.gz\](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz)
- \[\[asc\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.asc)\]
- \[\[md5\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.md5)\]
- \[\[sha\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.sha)\]
-
- Users will download the mirrored release artifacts from machines outside Apache control. Users need to verify that the copy downloaded is identical to the original. Mirrored copies of checksums, KEYS and signature files (.asc and .md5 files) will be present on the mirrors but must never be used for verification. So, all links from the podling website to signatures, sums and KEYS need to refer to the original documents on www.apache.org. See release signing guide for more information.
-
-3. Archiving
- All Apache releases form an important part of the history of a project. They are therefore archived with the aim of preserving them indefinitely for future reference. All artifacts within www.apache.org/dist will be automatically archived to http://archive.apache.org/dist. When a new artifact is uploaded, it will be sync'd to the archive. The sync'ing is scheduled to operate several times a day. So it may be some hours before an added artifact is archived. When an (archived) artifact is deleted from the live distribution, it will remain in the archives.
- Please remember that these archives are served from Apache bandwidth. Anyone who wants to obtain a large quantity of data from the archives should contact the Infrastructure Team.
-
-4. Publishing Maven Artifacts
- Log in to [the Nexus repository manager][20] and release the staging repository.
+ Results:
+
+ From IPMC members:
+ name apache id
+ +1 Yegor Kozlov(mentor) yegor
+ +1 Nick Burch(mentor) nick
+ +1 Chris Mattmann mattmann
+ +1 Christian Grobmeier grobmeier
+
+ From PPMC members:
+ name apache id
+ +1 Ying Chung Guo daisyguo
+ +1 Biao Han devinhan
+ +1 Rob Weir robweir
+ +1 Svante Schubert svanteschubert
+
+ Other votes:
+ name apache id
+ (abstain non-binding [;<) Dennis E. Hamilton orcmid
+
+ We will work on releasing ODF Toolkit 0.5. Thank you everyone who worked in this release!
+
+VI. After the Vote
+------------------------------
+1. Distributing Releases
+ The distribution upload location (www.apache.org/dist) for all Apache projects is the /www/www.apache.org/dist directory on people.apache.org. Each project (including the Incubator) owns a directory within dist.
+ The directory of ODF Toolkit is http://www.apache.org/dist/incubator/odftoolkit/. The release manager should move the release artifacts from /public_html/odftoolkit-release/$TAG to this directory.
+
+2. Mirroring
+ To avoid excessive use of bandwidth and to increase download speeds, official releases are made available through a global network of volunteer mirrors. Using these mirrors has some notable differences from unmirrored downloads. In particular, a <a href="http://www.apache.org/dev/release-download-pages.html" script</a must be used to direct the download to an appropriate URL. The mdtext format sample is:
+
+ \*\*Current Version (0.5-incubating)**
+ \* Source:
+ \* \[odftoolkit-0.5-incubating-src.tar.gz\](http://www.apache.org/dyn/closer.cgi/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz)
+ \[\[asc\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.asc)\]
+ \[\[md5\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.md5)\]
+ \[\[sha\](http://www.apache.org/dist/incubator/odftoolkit/sources/odftoolkit-0.5-incubating-src.tar.gz.sha)\]
+
+ Users will download the mirrored release artifacts from machines outside Apache control. Users need to verify that the copy downloaded is identical to the original. Mirrored copies of checksums, KEYS and signature files (.asc and .md5 files) will be present on the mirrors but must never be used for verification. So, all links from the podling website to signatures, sums and KEYS need to refer to the original documents on www.apache.org. See release signing guide for more information.
+
+3. Archiving
+ All Apache releases form an important part of the history of a project. They are therefore archived with the aim of preserving them indefinitely for future reference. All artifacts within www.apache.org/dist will be automatically archived to http://archive.apache.org/dist. When a new artifact is uploaded, it will be sync'd to the archive. The sync'ing is scheduled to operate several times a day. So it may be some hours before an added artifact is archived. When an (archived) artifact is deleted from the live distribution, it will remain in the archives.
+ Please remember that these archives are served from Apache bandwidth. Anyone who wants to obtain a large quantity of data from the archives should contact the Infrastructure Team.
+
+4. Publishing Maven Artifacts
+ Log in to [the Nexus repository manager][20] and release the staging repository.
5. Copy the SVN tag to the release version
-
+
svn cp https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.XX-incubating-RCYY https://svn.apache.org/repos/asf/incubator/odf/tags/odftoolkit-0.XX-incubating/
-
-6. Publish Document
- Publish all of the prepared document on the website and update the download page.
-
-7. Send Announcements
- The release manager need to send announcements to odf-user and odf-dev lists as well as announce@apache.org, general@incubator.apache.org, dev@openoffice.apache.org. Note, announcements should be sent from your @apache.org e-mail address. The sample looks like:
-
- Subject:[ANNOUNCEMENT] Apache ODF Toolkit(Incubating) 0.5-incubating Release
- To: odf-users@incubator.apache.org
- Hi all,
- The Apache ODF Toolkit(Incubating) team is pleased to announce the release of 0.5-incubating. This is our first Apache release.
+6. Publish Document
+ Publish all of the prepared document on the website and update the download page.
- The Apache ODF Toolkit is a set of Java modules that allow programmatic creation, scanning and manipulation of Open Document Format (ISO/IEC 26300 == ODF) documents. Unlike other approaches which rely on runtime manipulation of heavy-weight editors via an automation interface, the ODF Toolkit is lightweight and ideal for server use.
+7. Send Announcements
+ The release manager need to send announcements to odf-user and odf-dev lists as well as announce@apache.org, general@incubator.apache.org, dev@openoffice.apache.org. Note, announcements should be sent from your @apache.org e-mail address. The sample looks like:
- A full list of changes is available in the change log[1]. People interested should also follow the mail list[2] to track progress.
+ Subject:[ANNOUNCEMENT] Apache ODF Toolkit(Incubating) 0.5-incubating Release
+ To: odf-users@incubator.apache.org
+ Hi all,
- The ODF Toolkit source release as well as the pre-built binary deployment packages are listed in the downloads page[3]. Pre-built versions of all ODF Toolkit components are available in the central Maven repository under Group ID "org.apache.odftoolkit" and Version "0.5-incubating".
+ The Apache ODF Toolkit(Incubating) team is pleased to announce the release of 0.5-incubating. This is our first Apache release.
- \[1] http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.5-incubating.txt.
- \[2] http://incubator.apache.org/odftoolkit/mailing-lists.html.
- \[3] http://incubator.apache.org/odftoolkit/downloads.html
-
+ The Apache ODF Toolkit is a set of Java modules that allow programmatic creation, scanning and manipulation of Open Document Format (ISO/IEC 26300 == ODF) documents. Unlike other approaches which rely on runtime manipulation of heavy-weight editors via an automation interface, the ODF Toolkit is lightweight and ideal for server use.
-References
--------------------------
-1. [A Guide To Release Management During Incubation (DRAFT)][16]
-2. [Apache Release Management][17]
-3. [POI Release Guide][18]
-4. [POI Release Checklist][19]
-
+ A full list of changes is available in the change log[1]. People interested should also follow the mail list[2] to track progress.
+
+ The ODF Toolkit source release as well as the pre-built binary deployment packages are listed in the downloads page[3]. Pre-built versions of all ODF Toolkit components are available in the central Maven repository under Group ID "org.apache.odftoolkit" and Version "0.5-incubating".
+
+ \[1] http://www.apache.org/dist/incubator/odftoolkit/CHANGES-0.5-incubating.txt.
+ \[2] http://incubator.apache.org/odftoolkit/mailing-lists.html.
+ \[3] http://incubator.apache.org/odftoolkit/downloads.html
+
+
+References
+-------------------------
+1. [A Guide To Release Management During Incubation (DRAFT)][16]
+2. [Apache Release Management][17]
+3. [POI Release Guide][18]
+4. [POI Release Checklist][19]
+
[1]: http://incubator.apache.org/guides/releasemanagement.html
@@ -347,4 +347,4 @@
[17]: http://www.apache.org/dev/#releases
[18]: https://svn.apache.org/repos/asf/poi/branches/ooxml/src/documentation/release-guide.txt
[19]: https://svn.apache.org/repos/asf/poi/branches/ooxml/src/documentation/Release-Checklist.txt
- [20]: https://repository.apache.org/index.html
+ [20]: https://repository.apache.org/index.html
diff --git a/content/odftoolkit/source.mdtext b/content/odftoolkit/source.mdtext
index a79b51c..2f2cdf5 100644
--- a/content/odftoolkit/source.mdtext
+++ b/content/odftoolkit/source.mdtext
@@ -16,7 +16,7 @@
specific language governing permissions and limitations
under the License.
-We use [Apache Subversion][1] for version control. You can [browse our
+We use [Apache Subversion][1] for version control. You can [browse our
repository][2] in your web browser.
## Getting the source code
@@ -25,27 +25,30 @@
For further information see the [Apache Source Code Repository][3] page.
-## Building and Running
-
+## Build setup
###Linux
+ sudo apt-get install openjdk-8-jdk
+ sudo apt-get install maven
-The following detailed instructions assume a fresh Ubuntu 14.04 installation.
+Note: The previous instructions has been tested with an Ubuntu 16.04 installation.
Other distros and versions should work fine, but might require some slight
modifications.
- svn co https://svn.apache.org/repos/asf/incubator/odf/trunk odf-toolkit
+###Windows
+For the setup of the build environment, please see [Java JDK download for Windows][4] and [Maven setup on Windows][5]
+
+
+## Build
+###Linux / Windows
cd odf-toolkit
- sudo apt-get install openjdk-7-jdk
- sudo apt-get install maven
mvn clean install -Ppedantic
-
-###Windows
-
-To-Do
+Note: The build option pedantic is triggering an Apache tool doing various checks as for unlicensed files.
[1]: http://subversion.apache.org
[2]: http://svn.apache.org/viewvc/incubator/odf/trunk
[3]: http://www.apache.org/dev/version-control.html
+[4]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
+[5]: https://maven.apache.org/guides/getting-started/windows-prerequisites.html
