The PreTeXt Guide

jing /path/to/pretext.rng aota.xml

Clone

🔗

Clone the git repository at github.com/relaxng/jing-trang with the command

git clone https://github.com/relaxng/jing-trang

which assumes you have a command-line version of git installed. You will end up with a new jing-trang directory, which you will certainly want outside of your PreTeXt files and outside of your project files.

🔗

readme.md

🔗

Follow the instructions in the readme.md found at the top level of the jing-trang distribution, observing the following notes keyed to the four steps. These helpful notes come courtesy of the experiences of Jahrme Risner, Mitch Keller, Bruce Yoshiwara, Ken Levasseur, and Jessica Sklar on a variety of operating systems.

🔗

1. It is necessary to have a developer’s version of java on your machine. Try which java to see if one is already available. Any output here might help in the next step. References here to the JDK is the Java Development Kit. There are specific directions for MacOS (Section K.1) and Windows (Section M.6).

   🔗
   🔗
2. You will need to have the JAVA_HOME environment variable set correctly. You can try echo ${JAVA_HOME} in a Linux console to see if it produces anything sensible and/or consistent with Step 1. Ken Levasseur notes that on MacOS you can go

   echo $(/usr/libexec/java_home)
   

   and the output is what you set to the JAVA_HOME variable.

   🔗
   On Windows you may need to set Environmental Variables in the Windows System Properties GUI, both here and in Step 4.

   🔗
   🔗
3. Setting your working directory to the root directory of the jing-trang distribution should not cause any particular difficulties.

   🔗
   🔗
4. You may need to install the ANT tool, almost certainly on Windows. Again, on Windows you may need to set an ANT_HOME environment variable. On Linux, this may be all set for you already as a system tool.

   🔗
   The README suggests changing slashes on Windows. But you may already be using a shell that gives Unix-like behavior. So try both directions, if necessary. Also, the README suggests running ./ant test (or .\ant test). Doing this on Windows may yield a BUILD FAILED message, but jing may still work.

   🔗
   🔗

🔗

Results

🔗

Change into the build subdirectory. You may have more files here, but the two you really want are jing.jar and trang.jar. So if you have these, you are in good shape.

🔗

If you have modularized your source files (Section 5.3) then you need one more library. Look in the top-level lib directory (a peer of build) for xercesImpl.jar. You have two and a half choices now.

• Copy lib/xercesImpl.jar into build.
  🔗
• Or make a “symbolic link” to the third JAR archive. Be sure you are in build and go

  ln -s ../lib/xercesImpl.jar
  

  which will just make your operating system think this third archive is in the build directory.
  🔗
• A third option would be to adjust/augment some classpath information below and send us a report of success. We have not tested this approach.
  🔗

🔗

java -jar jing-trang/build/jing.jar pretext.rng my-book.xml

java -classpath jing-trang/build
-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=
    org.apache.xerces.parsers.XIncludeParserConfiguration
-jar jing-trang/build/jing.jar pretext.rng my-book.xml

ptx-check() {
  java\
    -classpath ~/GitHub/jing-trang/build\
    -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=
        org.apache.xerces.parsers.XIncludeParserConfiguration\
    -jar ~/GitHub/jing-trang/build/jing.jar\
    ~/GitHub/pretext/Schema/pretext.rng "$1"
}

~ $ ptx-check my-book.xml