Applications of OpenJade

Many different projects, organizations and companies make use of OpenJade to publish documentation. The SGML/XML backend enables the generation of "world wide web ready" documents while the TeX backend allows high quality "ready for press" output to be obtained. The FreeBSD Handbook (second edition) ISBN: 1571763031 is one such example of a book created using OpenJade.

The OpenSP (and SP) library has been used for the basis of a number of projects. The World Wide Web consortium on-line HTML and XHTML validator is based on the SP library.

Obtaining OpenJade

OpenJade is a project hosted at sourceforge.net and is available from the OpenJade web site at http://openjade.sourceforge.net or directly from the OpenJade project page at http://sourceforge.net/projects/openjade

OpenJade is provided in source code form. However as a courtesy to Win32 users where development tools are not always available, a binary release for the Win32 platform is usually available.

Supported Platforms

OpenJade is intended to be as portable as possible. It should be possible to compile and build on most contemporary UNIX type platforms. In addition OpenJade will also build on Microsoft's Win32 based operating systems.

OpenJade is known to compile with both the GNU gcc c++ compiler and Microsoft Visual C++. Other compilers have not been extensively tested.

OpenJade has been successfully built with the following GNU compilers: egcs++ 1.1.2 (g++ 2.91.66), g++ 2.95.3, g++ 3.0.3 and should also compile with g++ 3.1 when it becomes available

OpenJade has been built on a number of architectures including Intel i386 and ia64, Alpha AXP, Sparc, PPC and S/390, S/390x.

The following table details known successful builds

Please report any successful builds not mentioned above to <openjade-devel@lists.sourceforge.net>, including any diffs/patches you have used.

Building OpenJade from Source

OpenJade requires 40Mb to 50Mb of disk space to build. An installation will require around 15Mb to 20Mb depending on architecture.

OpenJade makes use of the GNU software configuration tools (autoconf, libtool, automake etc). The GNU C++ compiler and make utility should also be used. The steps required to build the OpenJade tools (onsgmls, openjade, osgmlnorm, ospam, ospent, osx) and libraries are as follows:

gzip -d openjade-1.3.1.tar.gz | tar xvf -
cd openjade-1.3.1
./configure [options…]
make

make install

make install-man

./configure --help

onsgmls -s http://www.example.com

Please refer to the system documentation for details on building on the Win32 platform.

Binary Distributions

Although the OpenJade project does not make binary distributions available, OpenJade has been a part of many software distributions, including the major Linux distributions as well as FreeBSD. Expect pre-compiled and packaged versions of the latest version of OpenJade to be available from your distributor in due course.

Installation

In addition to the OpenJade executables and libraries you will also need various DTDs and stylesheets. Some DTDs and associated files (entity definitions) are available in the pubtext directory of the distribution. However, more authoritative sources should be referenced to ensure that up-to-date versions are used. If you wish to process XML files, then suitable SGML declarations for valid XML documents should be used. Again, a sample set of declarations (xml.dcl) is provided in the pubtext, but more complete or recent versions may be available from other sources.

OpenJade supports the standard SGML catalog facility; it is recommended that you set up and use such a catalog system. Generally speaking you will create your own DSSSL stylesheets for use with OpenJade, however, users of the OASIS DocBook DTD should be aware that extensive, and modular, stylesheets are available from the DocBook project at http://docbook.sourceforge.net.

If you wish to make use of the TeX backend you will require an up to date distribution of laTeX such as teTeX, TeXlive or fpTeX. In addition you will also require the jadetex package, available from http://jadetex.sourceforge.net.

Support

If, after reading the documentation, you still have a problem, then you may require some additional help. The OpenJade project is a volunteer effort and as such does not provide any formal support. Instead, you should look to the community for support. Once part of the community, you, in turn, will be able to play your part in helping those that come after you. Here are some pointers to obtaining help:

• If you obtained your OpenJade tools in binary form from your operating system distributor and you have a build related problem - such as openjade crashing, then your first port of call should be your distributor.

• If you have a problem with the usage of openjade and tools, or general queries about DSSSL then you should try the DSSSL mailing list, see http://www.mulberrytech.com/dsssl/dssslist/ for details.

• If you are using the DocBook DTD and especially if you are also using the Modular DocBook DSSSL stylesheets, then the docbook-apps mailing list is the place to go. See http://www.oasis-open.org/docbook/mailinglist/ for details.

• If you have a patch or bug fix for OpenJade, or are trying to use the OpenSP API then the openjade-devel mailing list is the appropriate forum.

Please choose only one mailing list to post to, as cross-posting is generally frowned upon. The various mailing lists are archived and searchable. It is always worth searching for your problem first, as it is often the case that someone has had the same problem before.

Version 1.3.1

The following table details the major improvements in Openjade 1.3.1

  "UNREGISTERED::OpenJade//Characteristic::page-two-side?"

  "UNREGISTERED::OpenJade//Characteristic::two-side-start-on-right?"

    (let loop ( (res (empty-sosofo))
        (nl  (node-list-rest (children (current-node)))))
	    (loop (sosofo-append res (process-node-list
        (node-list-first nl)))
            (node-list-rest nl)))

Version 1.3

• The SGML backend will now emit linebreaks when used as -t sgml-raw.

• Jade can bind variables to arbitrary values on the command line with the -V option.

• The prlabs1 module of the SGML property set is supported.

• Style sheet extensions.dsl lists all known external procedures ready for easy inclusion as an external-specification.

• External procedure with public identifier

    "UNREGISTERED::OpenJade//Procedure::expt"
  

  to provide integral powers of quantities.

• External procedure with public identifier

    "UNREGISTERED::OpenJade//Procedure::sgml-parse"
  

  allows to parse w.r.t. an architecture.

• Jade supports force! for inherited characteristics.

• Jade supports character properties.

• Jade supports special-query-expressions.

• Jade can bind variables to string values on the command line.

• All standard color spaces supported.

• Jade ignores duplicate keywords in make expressions, as mandated by DSSSL.

• External procedure with public identifier

    "UNREGISTERED::OpenJade//Procedure::language"
  

  to create a language object by reference to a POSIX locale.

• Language-dependent procedures of the expression language: language?, current-language, declare-default-language, with-language, define-language, char<?, char>?, char<=?, char>=?, char-ci=?, char-ci<?, char-ci>?, char-ci<=?, char-ci<=?, char-upcase, char-downcase, string-ci=?, string-equiv?, string<?, string>?, string<=?, string>=?, string-ci<?, string-ci>?, string-ci<=?, string-ci>=?.

• The style-sheet.dtd derived from the DSSSL architecture has been extended (in a backward compatible way) to include the declaration element type forms supported by Jade. The public identifier for the dtd is

    "-//OpenJade//DTD DSSSL Style Sheet//EN" 
  

• char-repertoire, add-name-chars and add-separator-chars declaration element type forms are supported. When given the -s command line flag, Jade doesn't use its built in character repertoire.

• Most of the derived procedures in the query language: current-root, node-list-reduce, node-list-contains?, node-list-remove-duplicates, node-list-union, node-list-intersection, node-list-difference, node-list-symmetric-difference, node-list-union-map, node-list-some?, node-list-every?, node-list-filter, node-list->list, node-list-tail, node-list-head, node-list-sublist, node-list-count, node-list-last, node-list-property, origin, origin-to-subnode-rel, tree-root, grove-root, source, subtree, subgrove, ancestors, grove-root-path, rsiblings, ipreced, ifollow, grove-before?, sort-in-tree-order, tree-before?, tree-before, property-lookup, select-by-property, select-by-null-property, select-by-missing-property, attribute, referent, q-element, q-class, q-sdata.

Version 1.2.2

Changes in OpenJade 1.2.2

• The HTML and MIF backends are now enabled by default.

• The TeX backend has support for PDF bookmarks. This is supported by the new version of jadetex which is included.

• Predefined character names line-feed and carriage-return for the character numbers 10 and 13.

• standard-chars and map-sdata-entity declaration element type forms are supported.

• Style language additions: map-constructor.

• + and - return a length-spec if any of there arguments is a length-spec.

• Most of the DSSSL non-core expression language: c...r, assoc, keyword->string, string->keyword, exact?, inexact?, zero?, positive?, negative?, odd?, even?, exp, log, sin, cos, tan, asin, acos, atan, expt, exact->inexact, inexact->exact, quantity->number, string->list, list->string, map, time<?, time>?, time<=?, time>=?.

Jade Version 1.2.1