diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 9f4d5a33f..656b179e8 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -1,37 +1,7 @@ - - - + About Validate Tool @@ -42,15 +12,13 @@ POSSIBILITY OF SUCH DAMAGE.

- -
-
+

The Validate Tool currently supports the following features:

@@ -108,14 +76,12 @@ POSSIBILITY OF SUCH DAMAGE.
-
- -
+

Found a bug? Or want a new feature? We would love your feedback and contributions. Here are some links to our public Github repository for source code and submitting issues:

diff --git a/src/site/xdoc/install/index.xml.vm b/src/site/xdoc/install/index.xml.vm index 9cc6f7d0f..4c5be7e20 100644 --- a/src/site/xdoc/install/index.xml.vm +++ b/src/site/xdoc/install/index.xml.vm @@ -1,38 +1,7 @@ - - - - + Installation @@ -41,17 +10,17 @@ POSSIBILITY OF SUCH DAMAGE.

This document describes how to install the Validate Tool software contained in the ${project.artifactId} package. The following topics can be found in this document:

- + +
-
+

Initially, Validate Tool works out of the box without needing to perform any additional function:

    @@ -66,7 +35,7 @@ POSSIBILITY OF SUCH DAMAGE.
-
+

Download the ${project.artifactId} package from Github. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with one of the following commands:

@@ -110,7 +79,7 @@ or
-
+

If you run into issues attempting to run Validate out of the box, this section details the system requirements for installing and operating the Validate Tool.

@@ -128,14 +97,16 @@ OpenJDK Runtime Environment (build 15.0.1+9) OpenJDK 64-Bit Server VM (build 15.0.1+9, mixed mode, sharing) -

NOTE: Validate requires 64-bit Java in order to enable Java Virtual Machine memory requirements. In version output above, note the line Java HotSpot(TM) 64-Bit Server VM

+

NOTE: Validate requires 64-bit Java in order to enable Java Virtual Machine memory requirements. In version output above, note the line Java HotSpot(TM) 64-Bit Server VM.

+ +

For Windows Users: The 32-bit JRE is the default on Windows, and even the the online installer for Windows on the Java Download All Operating Systems page only installs the 32-bit JRE. If you see an error like that described under this common error, you have the wrong JRE installed.

If the either of these commands fail, it indicates Java is not installed or the version is not at least 1.9. Consult the local system administrator for installation of this software. For the do-it-yourself crowd, the Java software can be downloaded from the Java Download page.

-
+

If you want to run Validate from anywhere on your system, you will need to configure your PATH to know where Validate is located. This section describes how to setup the user environment on UNIX-based and Windows machines.

@@ -179,14 +150,17 @@ OpenJDK 64-Bit Server VM (build 15.0.1+9, mixed mode, sharing)

-C:\> set PATH = %PATH%;C:\Program Files\\${project.artifactId}-${project.version}\bin +C:\> set Path=%Path%;C:\Program Files\\${project.artifactId}-${project.version}\bin

In addition, the batch scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. This may have already been set when Java was installed. However, if it hasn't, then run the following command to set the JAVA_HOME environment variable:

-C:\> set JAVA_HOME = C:\path\to\java\home +C:\> set JAVA_HOME=C:\path\to\java\home + +# For example +C:\> set JAVA_HOME=C:\Program Files\Java\some-jre-version

The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files with the .bat extension) and change the line in the example above to represent the local Java installation. Additional methods for setting Windows environment variables can be found in the Windows System Properties document. diff --git a/src/site/xdoc/operate/errors.xml.vm b/src/site/xdoc/operate/errors.xml.vm index 4a329fab1..044e10137 100644 --- a/src/site/xdoc/operate/errors.xml.vm +++ b/src/site/xdoc/operate/errors.xml.vm @@ -1,41 +1,9 @@ - - - - + Common Errors - Jordan Padams @@ -48,17 +16,19 @@ POSSIBILITY OF SUCH DAMAGE. If you would like to contribute to this page, please create a pull request or issue on our GitHub repository or email the PDS Operator with input. Thanks in advance for helping your fellow users.

- +
-
+

Execution of the Validate Tool may result in the following message appearing in the log:

@@ -72,7 +42,7 @@ FAIL: file:/Users/.../hi0173794441_9080000_001_r.xml

-
+

Exception in thread "main" java.lang.OutOfMemoryError: GC overhead limit exceeded

Running the tool against a large bundle may result in an OutOfMemoryError exception appearing in the standard error similar to the following: @@ -113,7 +83,7 @@ Exception in thread "main" java.lang.OutOfMemoryError: GC overhead limit exceede

-
+

When performing Checksum Manifest file validation, having the wrong base path setting will result in multiple errors like the following:

@@ -128,7 +98,7 @@ FAIL: file:/home/pds4/dph_example_archive_VG2PLS/browse/Collection_browse.xml
-
+

Debugging

The error indicates the fields do not match the table defined in the label. Here are some things you can check to find out where it is failing:

    @@ -138,7 +108,7 @@ FAIL: file:/home/pds4/dph_example_archive_VG2PLS/browse/Collection_browse.xml
-
+

Description

New to Validate 1.16.0, this feature does a performs a check of the name and type values associated with @@ -155,7 +125,7 @@ FAIL: file:/home/pds4/dph_example_archive_VG2PLS/browse/Collection_browse.xml

-
+

Description

When attempting to run validate, you get the following error: @@ -178,7 +148,7 @@ OpenJDK 64-Bit Server VM (build 15.0.1+9, mixed mode, sharing)

-
+

Description

When attempting to validate a Document product as PDF/A, you get an error like: