From d66aa463ca9ce9089248a31e17be263d80f5e2ce Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Sun, 14 May 2023 17:04:52 -0400 Subject: [PATCH] update docs for 1.3.9 release (#204) --- README.md | 8 ++++---- README.txt | 13 ++++++------- RELEASING.md | 10 +++++----- website/history.html | 12 +++++++++--- website/index.html | 24 ++++++++++++------------ 5 files changed, 36 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index edf2452c..bc605b9a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ XOM is fairly unique in that it is a dual streaming/tree-based API. Individual n XOM is very memory efficient. If you read an entire document into memory, XOM uses as little memory as possible. More importantly, XOM allows you to filter documents as they're built so you don't have to build the parts of the tree you aren't interested in. For instance, you can skip building text nodes that only represent boundary white space, if such white space is not significant in your application. You can even process a document piece by piece and throw away each piece when you're done with it. XOM has been used to process documents that are gigabytes in size. -The current version of XOM is 1.3.8 and is backwards compatible with 1.2, 1.1 and 1.0. You should not need to recompile any code to upgrade to 1.3.8. XOM is believed to be quite stable and robust. Future releases should be backwards compatible with the 1.0 API for the foreseeable future. +The current version of XOM is 1.3.9 and is backwards compatible with 1.2, 1.1 and 1.0. You should not need to recompile any code to upgrade to 1.3.9. XOM is believed to be quite stable and robust. Future releases should be backwards compatible with the 1.0 API for the foreseeable future. ## Adding XOM to your build @@ -20,7 +20,7 @@ XOM's Maven group ID is `xom` and its artifact ID is `xom`. To add a dependency xom xom - 1.3.8 + 1.3.9 ``` @@ -28,7 +28,7 @@ To add a dependency using Gradle: ```gradle dependencies { - compile 'xom:xom:1.3.8' + compile 'xom:xom:1.3.9' } ``` @@ -37,7 +37,7 @@ dependencies { XOM is not complete unto itself. It depends on an underlying SAX parser to read documents and feed the data into a tree structure. While theoretically any SAX2 compliant parser should work, Xerces 2.6.1 and later is the only one that I am fairly confident does work. Xerces 2.8.0 is included with the full distribution. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). Piccolo 1.0.3, Crimson, GNU JAXP 1.0b1, the Oracle XML Parser for Java 9.2.0.2.0D and 9.2.0.5.0, and Xerces versions prior to 2.6.1 all have bugs that prevent them from doing what XOM needs them to do. (Note to XML parser vendors: XOM's test suite gives parsers a very thorough workout, and delves into some of the more obscure parts of the XML spec that many parsers get wrong. You could do a lot worse for testing than making sure all the XOM unit tests pass when using your parser.) -Similarly XSLT support depends on a TrAX processor (Xalan-J 2.6.0 is bundled). XInclude and XML canonicalization, however, are native. +Similarly XSLT support depends on a TrAX processor. XInclude and XML canonicalization, however, are native. ## Learning More diff --git a/README.txt b/README.txt index fb2d3f17..b1d6bfc0 100644 --- a/README.txt +++ b/README.txt @@ -2,10 +2,10 @@ XOM is a library. By itself, it doesn't do much of anything. It exists only to be used by other programs. It requires Java 1.6 or later. To install it you'll need to place the XOM JAR archive somewhere in your -CLASSPATH. This archive is the file named something like xom-1.3.8.jar. +CLASSPATH. This archive is the file named something like xom-1.3.9.jar. (The version number may have changed if I've forgotten to update this document.) You can either put it in your jre/lib/ext -directory, add xom-1.3.8.jar to your CLASSPATH environment variable, or +directory, add xom-1.3.9.jar to your CLASSPATH environment variable, or use the -classpath option when invoking javac and java. To check your download you can run one of the sample programs found in @@ -14,17 +14,16 @@ class formats an XML document by inserting and removing white space around element boundaries. You can run it from the command line like this: -$ java -classpath xom-samples.jar:xom-1.3.8.jar nu.xom.samples.PrettyPrinter filename.xml +$ java -classpath xom-samples.jar:xom-1.3.9.jar nu.xom.samples.PrettyPrinter filename.xml XOM's supporting libraries including xalan.jar, xercesImpl.jar, and xml-apis.jar, are found in the lib directory. The versions shipped with XOM are quite a bit faster and less buggy than the ones bundled with the JDK, so you may well want to use them. For example, -$ java -classpath xom-samples.jar:xom-1.3.8.jar:lib/xml-apis.jar:lib/xercesImpl.jar:lib/xalan.jar nu.xom.samples.PrettyPrinter filename.xml +$ java -classpath xom-samples.jar:xom-1.3.9.jar:lib/xml-apis.jar:lib/xercesImpl.jar nu.xom.samples.PrettyPrinter filename.xml -You can leave out xalan.jar if you don't use any of the classes in -nu.xom.xslt. junit.jar is only used for testing, and is +junit.jar is only used for testing, and is not needed for normal operation of XOM. If you want to build XOM from source, you need Apache Ant @@ -33,7 +32,7 @@ should be as simple as typing "ant compile" or "ant jar" in the xom directory. Type "ant help" to see other possible options. ======================================================================= -XOM is Copyright 2004, 2005, 2009, 2018-2022 Elliotte Rusty Harold +XOM is Copyright 2004, 2005, 2009, 2018-2023 Elliotte Rusty Harold This library is free software; you can redistribute it and/or modify it under the terms of version 2.1 of the GNU Lesser General Public diff --git a/RELEASING.md b/RELEASING.md index 42762b48..221bb79a 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -26,13 +26,13 @@ Update the version number in 7. Sign the files: ``` - $ gpg -ab xom-1.3.8.pom - $ gpg -ab xom-1.3.8.jar - $ gpg -ab xom-1.3.8-javadoc.jar - $ gpg -ab xom-1.3.8-sources.jar + $ gpg -ab xom-1.3.9.pom + $ gpg -ab xom-1.3.9.jar + $ gpg -ab xom-1.3.9-javadoc.jar + $ gpg -ab xom-1.3.9-sources.jar ``` -8. `$ jar -cvf bundle.jar xom-1.3.8.pom xom-1.3.8.pom.asc xom-1.3.8.jar xom-1.3.8.jar.asc xom-1.3.8-javadoc.jar xom-1.3.8-javadoc.jar.asc xom-1.3.8-sources.jar xom-1.3.8-sources.jar.asc` +8. `$ jar -cvf bundle.jar xom-1.3.9.pom xom-1.3.9.pom.asc xom-1.3.9.jar xom-1.3.9.jar.asc xom-1.3.9-javadoc.jar xom-1.3.9-javadoc.jar.asc xom-1.3.9-sources.jar xom-1.3.9-sources.jar.asc` 9. Login to [oss.sonatype.org](https://oss.sonatype.org/#welcome). diff --git a/website/history.html b/website/history.html index 88e3b21d..c32cd991 100755 --- a/website/history.html +++ b/website/history.html @@ -43,6 +43,12 @@

XOM Release Notes

that strives for correctness and simplicity.

+

1.3.9

+ +

Xalan is no longer bundled. XOM should work in all JDKs from the last +decade+ without it, though it will still default to it if it's installed.

+ +

1.3.8

Purely internal changes that improve compatibility with Java 17+

@@ -2129,9 +2135,9 @@

Downloads

diff --git a/website/index.html b/website/index.html index cc9959d4..083b22bf 100755 --- a/website/index.html +++ b/website/index.html @@ -48,11 +48,11 @@

XOM

  • JavaDoc
  • What's Wrong with XML APIs (and how to fix them)
  • FAQ
    • -
  • Jar file (Core packages only)
    • -
  • Complete zip (includes source code, prebuilt jars, API documentation, unit tests, sample programs, third party jars)
    • -
  • Complete tar.gz (includes source code, prebuilt jars, API documentation, unit tests, sample programs, third party jars)
    • -
  • Source code zip (includes source code, unit tests, sample programs, third party jars)
    • -
  • Source code tar.gz (includes source code, API documentation, unit tests, sample programs, third party jars)
    • +
  • Jar file (Core packages only)
    • +
  • Complete zip (includes source code, prebuilt jars, API documentation, unit tests, sample programs, third party jars)
    • +
  • Complete tar.gz (includes source code, prebuilt jars, API documentation, unit tests, sample programs, third party jars)
    • +
  • Source code zip (includes source code, unit tests, sample programs, third party jars)
    • +
  • Source code tar.gz (includes source code, API documentation, unit tests, sample programs, third party jars)
  • xom-interest mailing list
  • Source Repository
    • @@ -87,7 +87,7 @@

    XOM

    <dependency>
   <groupId>xom</groupId>
   <artifactId>xom</artifactId>
-  <version>1.3.8</version>
+  <version>1.3.9</version>
 </dependency>

    @@ -96,7 +96,7 @@

    XOM

    gradle
 dependencies {
-  compile 'xom:xom:1.3.8'
+  compile 'xom:xom:1.3.9'
 }

    @@ -124,8 +124,8 @@

    XOM

    -The current version of XOM is 1.3.8 and is backwards compatible with 1.2, 1.1 and 1.0. -You should not need to recompile any code to upgrade to 1.3.8. +The current version of XOM is 1.3.9 and is backwards compatible with 1.2, 1.1 and 1.0. +You should not need to recompile any code to upgrade to 1.3.9. XOM is believed to be quite stable and robust. Future releases should be backwards compatible with the 1.0 API for the foreseeable future.

    @@ -182,9 +182,9 @@

    Downloads

    For Contributors