Skip to content

Commit 01ea20b

Browse files
Documentation update
1 parent dea8f97 commit 01ea20b

File tree

8 files changed

+62
-9
lines changed

8 files changed

+62
-9
lines changed

docs/ReleaseNotes.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ <h1>TDF</h1>
4848
</div>
4949
<div id="contenta">
5050
<h1 id="odf-toolkit-release-notes">ODF Toolkit Release Notes</h1>
51+
<h2 id="release-0.12.0">Release 0.12.0</h2>
52+
<p><a href="https://repo1.maven.org/maven2/org/odftoolkit/odfdom-java/0.12.0/">ODFDOM 0.12.0</a> is released on December 22th, 2022. Git tag: "odftoolkit-0.12.0".</p>
53+
<h3 id="github-issues-fixed-in-this-release-0.12.0">GitHub issues fixed in this release 0.12.0</h3>
54+
<ul>
55+
<li><a href="https://github.com/tdf/odftoolkit/issues/26">#26</a> Adding ODF 1.3 support to the ODF Toolkit</li>
56+
</ul>
57+
<h3 id="major-updates-with-0.12.0">Major updates with 0.12.0</h3>
58+
<p>The typed ODFDOM DOM model is now based on the XML grammar of the <a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OASIS ODF 1.3 standard</a>. <a href="https://docs.oasis-open.org/office/OpenDocument/v1.3/os/">All deliverables of the OASIS 1.3 standard are downloadable from OASIS</a>.</p>
5159
<h2 id="release-0.11.0">Release 0.11.0</h2>
5260
<p><a href="https://repo1.maven.org/maven2/org/odftoolkit/odfdom-java/0.11.0/">ODFDOM 0.11.0</a> is released on December 21th, 2022. Git tag: "odftoolkit-0.11.0".</p>
5361
<h3 id="github-issues-fixed-in-this-release-0.11.0">GitHub issues fixed in this release 0.11.0</h3>
@@ -65,7 +73,7 @@ <h3 id="github-issues-fixed-in-this-release-0.11.0">GitHub issues fixed in this
6573
<li><a href="https://github.com/tdf/odftoolkit/issues/189">#189</a> org.odftoolkit.odfdom.pkg.OdfName declares static StringBuilder -&gt; potential problem in multi-threaded environments</li>
6674
<li><a href="https://github.com/tdf/odftoolkit/pull/198">#198</a> clean up static Map/Set/etc to avoid races and leaks</li>
6775
</ul>
68-
<h3 id="major-updates-with-this-version">Major updates with this version</h3>
76+
<h3 id="major-updates-with-0.11.0">Major updates with 0.11.0</h3>
6977
<h4 id="generation-&amp;-templates">Generation &amp; Templates</h4>
7078
<ul>
7179
<li>ODFDOM source generation (generator project) was <a href="https://github.com/tdf/odftoolkit/pull/182">completely refactored</a>, allowing to trigger generation from the ODFDOM project (<em><strong>mvn install -Dcodegen</strong></em>) to generate, copy and format the Java classes of the 3 XML grammars:

docs/downloads.html

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,46 @@ <h1>TDF</h1>
4949
<div id="contenta">
5050
<h1 id="downloads">Downloads</h1>
5151
<h2 id="current-version">Current Version</h2>
52-
<p>The current version is the 0.11.0 supporting ODF 1.2. The future development is based on the <a href="https://github.com/tdf/odftoolkit">master branch</a>.<br> The releases of 0.11.0 was on December 21th, 2022.</p>
52+
<p>The current version is the 0.12.0 supporting ODF 1.3. The future development is based on the <a href="https://github.com/tdf/odftoolkit">master branch</a>.<br> The releases of 0.12.0 was on December 22th, 2022.</p>
5353
<h2 id="releases-(latest)">Releases (latest)</h2>
54-
<p>The release 0.11.0 is using JDK 11 implementing <a href="http://docs.oasis-open.org/office/v1.2/os/">ODF 1.2</a>.<br> For more details see the <a href="./ReleaseNotes.html">release notes</a>. People interested should also follow the <a href="mailing-lists.html">mail list</a> to track progress.</p>
54+
<p>The release 0.12.0 is using JDK 11 implementing <a href="http://docs.oasis-open.org/office/v1.3/os/">ODF 1.3</a>.<br> The release 0.11.0 is using JDK 11 implementing <a href="http://docs.oasis-open.org/office/v1.2/os/">ODF 1.2</a>.<br></p>
55+
<p>For more details see the <a href="./ReleaseNotes.html">release notes</a>. People interested should also follow the <a href="mailing-lists.html">mail list</a> to track progress.</p>
5556
<h2 id="project-releases-for-maven-(latest)">Project Releases for Maven (latest)</h2>
57+
<h3 id="project-releases-for-maven-on-odf-1.3">Project Releases for Maven on ODF 1.3</h3>
58+
<ul>
59+
<li><strong><a href="./odfdom/index.html">ODFDOM</a>: <a href="https://repo1.maven.org/maven2/org/odftoolkit/odfdom-java/0.12.0/">0.12.0</a></strong></li>
60+
</ul>
61+
<div class="codehilite">
62+
<pre><code class="language-shell">&lt;dependency&gt;
63+
&lt;groupId&gt;org.odftoolkit&lt;/groupId&gt;
64+
&lt;artifactId&gt;odfdom-java&lt;/artifactId&gt;
65+
&lt;version&gt;0.12.0&lt;/version&gt;
66+
&lt;/dependency&gt;
67+
</code></pre>
68+
</div>
69+
<ul>
70+
<li><strong><a href="./conformance/ODFValidator.html">ODF Validator</a>: <a href="https://repo1.maven.org/maven2/org/odftoolkit/odfvalidator/0.12.0/">0.12.0</a></strong></li>
71+
</ul>
72+
<div class="codehilite">
73+
<pre><code class="language-shell">&lt;dependency&gt;
74+
&lt;groupId&gt;org.odftoolkit&lt;/groupId&gt;
75+
&lt;artifactId&gt;odfvalidator&lt;/artifactId&gt;
76+
&lt;version&gt;0.12.0&lt;/version&gt;
77+
&lt;/dependency&gt;
78+
</code></pre>
79+
</div>
80+
<ul>
81+
<li><strong><a href="./xsltrunner/ODFXSLTRunner.html">XSLT Runner</a>: <a href="https://repo1.maven.org/maven2/org/odftoolkit/xslt-runner/0.12.0/">0.12.0</a></strong></li>
82+
</ul>
83+
<div class="codehilite">
84+
<pre><code class="language-shell">&lt;dependency&gt;
85+
&lt;groupId&gt;org.odftoolkit&lt;/groupId&gt;
86+
&lt;artifactId&gt;xslt-runner&lt;/artifactId&gt;
87+
&lt;version&gt;0.12.0&lt;/version&gt;
88+
&lt;/dependency&gt;
89+
90+
</code></pre>
91+
</div>
5692
<h3 id="project-releases-for-maven-on-odf-1.2">Project Releases for Maven on ODF 1.2</h3>
5793
<ul>
5894
<li><strong><a href="./odfdom/index.html">ODFDOM</a>: <a href="https://repo1.maven.org/maven2/org/odftoolkit/odfdom-java/0.11.0/">0.11.0</a></strong></li>
@@ -89,6 +125,12 @@ <h3 id="project-releases-for-maven-on-odf-1.2">Project Releases for Maven on ODF
89125
</code></pre>
90126
</div>
91127
<h2 id="odf-toolkit-release-bundles-(latest)">ODF Toolkit Release Bundles (latest)</h2>
128+
<h3 id="odf-toolkit-0.12.0-release-bundle-(odf-1.3-using-jdk-11)">ODF Toolkit 0.12.0 Release Bundle (ODF 1.3 using JDK 11)</h3>
129+
<ul>
130+
<li>Sources: <a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-src.zip">odftoolkit-0.12.0-src.zip</a> [<a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-src.zip.sha">sha</a>]</li>
131+
<li>Binaries: <a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-bin.zip">odftoolkit-0.12.0-bin.zip</a> [<a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-bin.zip.sha">sha</a>]</li>
132+
<li>Documentation: <a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-doc.zip">odftoolkit-0.12.0-doc.zip</a> [<a href="https://github.com/tdf/odftoolkit/releases/download/v0.12.0/odftoolkit-0.12.0-doc.zip.sha">sha</a>]</li>
133+
</ul>
92134
<h3 id="odf-toolkit-0.11.0-release-bundle-(odf-1.2-using-jdk-11)">ODF Toolkit 0.11.0 Release Bundle (ODF 1.2 using JDK 11)</h3>
93135
<ul>
94136
<li>Sources: <a href="https://github.com/tdf/odftoolkit/releases/download/v0.11.0/odftoolkit-0.11.0-src.zip">odftoolkit-0.11.0-src.zip</a> [<a href="https://github.com/tdf/odftoolkit/releases/download/v0.11.0/odftoolkit-0.11.0-src.zip.sha">sha</a>]</li>

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ <h2 id="components-of-the-odf-toolkit-(java)">Components of the ODF Toolkit (Jav
6060
</ol>
6161
<p>Find our sources on <a href="https://github.com/tdf/odftoolkit">GitHub</a>. People interested should follow the <a href="mailing-lists.html">mail list</a> to track progress.</p>
6262
<h2 id="history">History</h2>
63+
<h3 id="2021-12-22-odf-toolkit-releases-of-0.12.0">2021-12-22 - ODF Toolkit releases of 0.12.0</h3>
6364
<h3 id="2021-12-21-odf-toolkit-releases-of-0.11.0">2021-12-21 - ODF Toolkit releases of 0.11.0</h3>
6465
<h3 id="2021-11-26-odf-toolkit-releases-of-0.9.0-and-0.10.0">2021-11-26 - ODF Toolkit releases of 0.9.0 and 0.10.0</h3>
6566
<p>See the <a href="downloads.html">downloads page</a> for more details on the releases.</p>

docs/source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ <h3 id="odf-toolkit-==-0.9.0-using-jdk-8">ODF Toolkit == 0.9.0 using JDK 8</h3>
6262
sudo apt-get install maven
6363
</code></pre>
6464
</div>
65-
<h3 id="odf-toolkit->=-0.10.0-using-jdk->=-9">ODF Toolkit &gt;= 0.10.0 using JDK &gt;= 9</h3>
65+
<h3 id="odf-toolkit->=-0.10.0-using-jdk->=11">ODF Toolkit &gt;= 0.10.0 using JDK &gt;=11</h3>
6666
<div class="codehilite">
6767
<pre><code class="language-shell">sudo apt-get install openjdk-11-jdk
6868
sudo apt-get install maven
6969
</code></pre>
7070
</div>
71-
<p><strong>Note:</strong> The previous instructions has been tested with an Ubuntu 20.04 installation. Other distros and versions should work fine, but might require some slight modifications.</p>
71+
<p><strong>Note:</strong> The previous instructions has been tested with an Ubuntu 22.04 installation. Other distros and versions should work fine, but might require some slight modifications.</p>
7272
<h2 id="build-setup-(windows)">Build Setup (Windows)</h2>
7373
<p>For the setup of the build environment, please see <a href="https://openjdk.java.net/install/">Java JDK download for Windows</a> and <a href="https://maven.apache.org/guides/getting-started/windows-prerequisites.html">Maven setup on Windows</a></p>
7474
<h2 id="building-(linux-&amp;-windows)">Building (Linux &amp; Windows)</h2>

docs/xsltrunner/ODFXSLTRunner.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h2 id="uri-resolution/document()-function">URI resolution/document() function</
9999
</code></pre>
100100
</div>
101101
<h2 id="requirements">Requirements</h2>
102-
<p><strong>ODF XSLT Runner</strong> requires <a href="https://openjdk.java.net/install/">Java RE 5</a>, or a later version of Java.</p>
102+
<p><strong>ODF XSLT Runner</strong> requires <a href="https://openjdk.java.net/install/">Java 11</a>, or a later version of Java.</p>
103103
<p>It further requires ODFDOM. This former NetBeans project is pre-configured to build ODFDOM while building <strong>ODF XSLT Runner</strong>. This requires that the ODFDOM sources are located in a folder <strong>odfdom</strong> next to the folder of the <strong>ODF XSLT Runner</strong> project.</p>
104104
<p>Alternatively, the reference to the ODFDOM project in the compile time classpath of the <strong>ODF XSLT Runner</strong> project may be replaced with a reference to an already compiled <strong>odfdom.jar</strong>.</p>
105105
<p>At run time, the <strong>odfdom.jar</strong> file must be either located in folder called <strong>lib</strong> next to the <strong>odfxsltrunner.jar</strong> file, or it must be in the classpath.</p>

src/site/site/content/odftoolkit_website/index.mdtext

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ People interested should follow the [mail list](mailing-lists.html) to track pro
2828

2929
## History
3030

31+
### 2021-12-22 - ODF Toolkit releases of 0.12.0
32+
3133
### 2021-12-21 - ODF Toolkit releases of 0.11.0
3234

3335
### 2021-11-26 - ODF Toolkit releases of 0.9.0 and 0.10.0

src/site/site/content/odftoolkit_website/source.mdtext

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ sudo apt-get install openjdk-8-jdk
1919
sudo apt-get install maven
2020
```
2121

22-
### ODF Toolkit >= 0.10.0 using JDK >= 9
22+
### ODF Toolkit >= 0.10.0 using JDK >=11
2323

2424
```shell
2525
sudo apt-get install openjdk-11-jdk
2626
sudo apt-get install maven
2727
```
2828

2929
**Note:**
30-
The previous instructions has been tested with an Ubuntu 20.04 installation.
30+
The previous instructions has been tested with an Ubuntu 22.04 installation.
3131
Other distros and versions should work fine, but might require some slight
3232
modifications.
3333

src/site/site/content/odftoolkit_website/xsltrunner/ODFXSLTRunner.mdtext

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ relative to a file within an ODF package.
9999

100100
## Requirements
101101

102-
**ODF XSLT Runner** requires [Java RE 5][6], or a later version of Java.
102+
**ODF XSLT Runner** requires [Java 11][6], or a later version of Java.
103103

104104
It further requires ODFDOM. This former NetBeans project is pre-configured to build
105105
ODFDOM while building **ODF XSLT Runner**. This requires that the ODFDOM

0 commit comments

Comments
 (0)