See the end of this document for information instructing how to specify the locations on your computer in which the required software must be installed.
The required software components are:
GNU tools
The build requires use of GNU make, GNU awk, and GNU grep, GNU tr (from coreutils).
It may be possible to use other variants of these tools but this is not guaranteed to work.
If you are using Windows 10, then the installation of cygwin (see below) will provide suitable
versions.
Saxon-HE (home edition)
Required version is 11.2. There is 11.3 out, which is currently under test.
Available from www.saxonica.com.
Download the appropriate file (whose filename ends with "J.zip").
Copy the .jar files in that .zip file to your Java directory.
XEP
Required version is >= 4.28; 4.30 is most recent and should work just as fine.
Available from www.renderx.com.
Note: a license is required to suppress the Renderx footer stamp.
Contact Jim Melton regarding this.
In the file RENDERX_DIR\xep.bat the path for the java program needs to be removed.
for example, comment out the line in xep.bat:
rem "C:\Program Files\Java\jre1.8.0_191\bin\java" -classpath "%CP%" com.renderx.xep.XSLDriver "-DCONFIG=C:\Program Files\RenderX\XEP\xep.xml" %*
and then add the following line immediately after the one commented out:
java -classpath "%CP%" com.renderx.xep.XSLDriver "-DCONFIG=C:\Program Files\RenderX\XEP\xep.xml" %*
If, when building one or more documents, XEP terminates with an error indicating insufficient virtual memory, modify that line to read:
java -Xmx1024M -Xms1024M -classpath "%CP%" com.renderx.xep.XSLDriver "-DCONFIG=C:\Program Files\RenderX\XEP\xep.xml" %*
Java
Version 8 or above.
Available from www.java.com
XML Editor
Many alternatives are available.
For example: XMLSpy, XMetal, Stylus Studio, Oxygen.
Some are available at no cost, while others are commercial products.
When using Mac OS X, one of the WG3 editors has found Oxygen XML to be the only truly viable option due to the size of some of the XML files (as of late 2020).
An SVG (Scalable Vector Graphics) editor
Several alternatives are available.
Adobe Illustrator is difficult to learn and expensive but may be the most consistent.
Free SVG editors are available but may output invalid SVG syntax under some
conditions, but Inkscape has been used with success for some TRs.
Another alternative is to use the online service at: https://app.diagrams.net/
Arial Unicode MS
Required to display several characters not found in most fonts
Version 1.01
Was supplied free with Microsoft Office prior to 2016.
Can currently be download from ftp://ftp.exlibris-usa.com/Fonts - Cyber/ARIALUNI.TTF -- login: ftpuser ; pw: aleph500 .
The file needs to copied to the directory c:\Windows\Fonts
Font Installation
The following fonts need to be defined in the file RENDERX_DIR\xep.xml:
Add at the end of the last font group the font Cambria and add after the last font group a new font group for ArialUnicodeMS and DejaVuSans.
Old content:
<font-family name="Palatino" embed="true" ligatures="ff fi fl ffi ffl">
<font><font-data ttf="pala.ttf"/></font>
<font style="italic"><font-data ttf="palai.ttf"/></font>
<font weight="bold"><font-data ttf="palab.ttf"/></font>
<font weight="bold" style="italic"><font-data ttf="palabi.ttf"/></font>
</font-family>
</font-group>
New content:
<font-family name="Palatino" embed="true" ligatures="ff fi fl' ffi ffl">
<font><font-data ttf="pala.ttf"/></font>
<font style="italic"><font-data ttf="palai.ttf"/></font>
<font weight="bold"><font-data ttf="palab.ttf"/></font>
<font weight="bold" style="italic"><font-data ttf="palabi.ttf"/></font>
</font-family>
<font-family name="Cambria" embed="true">
<font><font-data ttf="cambria.ttc"/></font>
<font style="italic"><font-data ttf="cambriai.ttf"/></font>
<font weight="bold"><font-data ttf="cambriab.ttf"/></font>
<font weight="bold" style="oblique"><font-data ttf="cambriaz.ttf"/></font>
</font-family>
</font-group>
<font-group xml:base="file:/C:/Windows/Fonts/" label="Windows TrueType">
<font-family name="ArialUnicodeMS">
<font><font-data embed="true" subset="true" ttf="ARIALUNI.TTF"/></font>
</font-family>
<font-family name="DejaVuSans">
<font><font-data embed="true" subset="true" ttf="DejaVuSans.ttf"/></font>
</font-family>
</font-group>
You need to specify the correct file name for the ArialUnicodeMS font.
The name may be different if you had to download it.
node.js and npm
Please install a recent (16+) LTS version of node.js and npm
For Windows users, it is recommended to use the installer available from
http://nodejs.org. This official installer includes npm.
During the installation accept the default options for setup and select (click) the
"Automatically install the necessary tools" box.
Make sure node and npm are on your PATH or, alternatively, set the
environment variables BIN_NODE
and BIN_NPM
to point to the
executables accordingly.
Ruby (Currently optional since clickify has been temporarily disabled)
Required to insert clickable links for terms
Available from www.ruby-lang.org
or for Windows as an installer from rubyinstaller.org
Tested version 2.6.5-1
Note: You do not need to install the MSYS2 toolchain.
Once everything else is installed then you need to run:
gem install bundler
or if in Windows:
gem.cmd install bundler
If any required tools are not on your $PATH (or %PATH%) or have been installed under a non-standard
name on your system, then make may be configured to find them correctly by setting environment
variables in your shell or make variables when invoking make accordingly. Please see Tools.mk
for the set of supported variables.
In addition, some components are Operating System specific, see below.
The additional requirements are:
Cygwin
Use the standard installation mechanism of Cygwin. It is recommended that you accept the default directory (C:\cygwin64).
You need to select and install:
cygwin (The default package)
The tested version is 3.0.2-1
Once the default package has been installed, you will be asked to select the
packages you want to install.
Near the top of the window, select the dropdown list beside the word View and
select Full.
In turn, scroll through the alphabetical list of packages until you locate each
package listed below.
To select a package, use the dropdown list under the column New for each package
and choose the correct version as indicated below.
The following packages you need explicitly to select.
make The tested version is 4.2.1-2
perl
The tested version is 5.26.3-1
zip
The tested version is 3.0-12
When you have selected all of these packages (and the other packages that have
automatically been selected to support them), click on the Next button.
The packages will automatically be installed. (This may take a while.)
You should set the default directory of your cygwin Terminal to the working directory for the SQL sources.
Add at the end of the file C:\cygwin64\home\<user_name>
\.bash_profile the following
line:
cd <sql_source_directory>
Environment variables
The following environment variables need to be set:
Important Note: The directory names that you choose SHOULD NOT not include a space
character.
The inclusion of a space may cause some actions not to perform correctly.
That is: "C:\TEMP\STAGING" is acceptable, but "C:\TEMP\STAGING DIRECTORY" is not.
(Note: If you are reading this in the .md source, the underscore and backslash have
been escaped with a backslash.)
SAXON_DIR
The directory in which the saxon9he.jar file is to be found.
e.g. SAXON_DIR=C:\Saxon
RENDERX_DIR
The directory in which the xep.bat file is to be found.
e.g. RENDERX_DIR=C:\RenderX\XEP
JARFILES_DIR
The directory in which the required JAR files are to be
found.
e.g. JARFILES_DIR=C:\JARfiles
STAGING_DIR
The absolute path to the directory into which the generated files are to be copied
by stage-* targets
e.g. STAGING_DIR=D:\TEMP
PUBLISH_DIR
The absolute path to the directory into which the generated files are to be copied
by publish-* targets
e.g. PUBLISH_DIR=D:\TEMP
XEP_EXT
The extension of the xep.bat file.
Needed to allow the bat file to be called from make under cygwin.
i.e. XEP_EXT=.bat
BUNDLE_EXT
The extension of the bundle.cmd file.
Needed to allow the bundle file to be called from make under cygwin.
i.e. BUNDLE_EXT=.env
ENV_EXT
The extension of the env.exe file.
Needed to allow the env file to be called from make under cygwin.
i.e. ENV_EXT=.exe
TO BE ADDED
PDF compare
You can find the tool confrontapdf at: sourceforge.net
This file: Copyright © 2021 Editors of ISO/IEC JTC 1/SC 32/WG 3: Jim Melton, Stephen Cannan, Jörn Bartels, Stefan Plantikow