Table of Contents


Part IX
Appendixes

A  The SGML CD-ROM
B  Finding Sources for SGML Know-How

Appendix A
The SGML CD-ROM

As you read through this book, there have been numerous discussions on the availability of SGML tools. The last couple of years have witnessed the emergence of a number of exciting new tools in the SGML world. Some of the “tried-and-true” tools continue to evolve, adding more capabilities and “ease-of-use” features that enhance their value as well.

The tools included on the SGML CD-ROM span a variety of functions, from tools to aid in SGML authoring and data conversion, to DTD visualization and SGML document display.

Most of these tools are publicly available from various sources on the Internet. In general, these tools are made available to the public and subject to certain restrictions by their creators.


Note:  
Several of the authors and companies that provided software for the SGML CD-ROM have a notice of their copyright, shareware agreement, or license information included in their software files. The lack of such a statement printed in this book does not mean that the software is not copyrighted or does not have a license agreement. Please see the text or help files for any program for which you need copyright or licensing information. If this is not available or the terms are unclear, you should contact the software provider directly for information on their licensing arrangements.

Using the SGML CD

The CD can be browsed using any Web browser. Simply load the loadme.htm file from the root directory of the CD. If you don’t have a Web browser, you’ll find Microsoft’s Internet Explorer in the MSIE 20 directory. You’ll find a self-extracting file that will install the browser for you. If you wish, you can transfer the files using any file utility program. WINZIP is also on the disc to facilitate decompression of the “zipped” and “tarred” files.

Computer Platforms

The bulk of the software included on the CD-ROM is compatible with personal computers running Microsoft Windows (3.1 or higher). Because many SGML sites also use other computing platforms as well (particularly UNIX-based computers), an attempt has been made to include versions of the software that can be run on other machines as well.

When included, the software for other computer platforms has been stored on the CD-ROM in a compressed format to accommodate the filename length restrictions of MS-DOS and Microsoft Windows 3.1. (In some cases, the compressed version of a software distribution has been included along with the uncompressed version to facilitate data transfer between computers.)

File compression formats used include the ZIP format for PC-based applications and either the GZIP (or GNU compression) or the UNIX Compress format. GZIP compressed files can be identified by their .gz file extension and UNIX Compress files can be identified by a .z extension. Some files may also use the “tar” format in addition to the compression.


Note:  
If you use Windows 95, you can decompress your files using WinZip 6.0, included on the CD-ROM. This decompression software is located in the \winzip directory. For UNIX users, the UNIX Compress software is proprietary and should be available with your UNIX operating system.

For other platforms, you can obtain the appropriate decompression software from publicly available archives on the Internet. Stroud’s CWSApps List, at http://cwsapps.texas.net/, is a good place to start to find other software.



Tip:  
When using PKUNZIP decompression software, you should use the “-d” restore with subdirectories option.

What’s Included on the CD-ROM

The software on the CD-ROM includes a number of tools that are useful in the SGML production process:

  SP/NSGMLS tools, including the NSGMLS parser and SPAM normalizer
  Perl, a text manipulation language
  perlSGML, a set of SGML and DTD development tools
  Near & Far Lite, a DTD visualization program
  DynaText, an electronic SGML book browser/reader
  Panorama, a World Wide Web SGML book browser

SP/NSGMLS Tools

SP consists of the NSGMLS parser and SPAM, an SGML normalizer. The programs both use dos4gw.exe, a royalty-free DOS/4GW 32-bit DOS extender that’s provided with Watcom C++.

Name: SP/NSGMLS
Category: SGML Parser and Tools
Version: 1.0.1
Platform(s): MS-DOS, Solaris 2.3
Notes: Source code included
Supplier: James Clark
Contact: jjc@jclark.com

Software Contents

The following table lists the contents of the SP software distribution.


Files Version Description

Programs
nsgmls.exe 1.0.1 SGML parser
spam.exe 1.0.1 Lists changes in DTD
Libraries
dos4gw.exe 1.97 DOS/4GW 32-bit DOS extender

An executable version for the Solaris operating system (version 2.3) and the source code (in the gz/tar format) are also included.

Installation

Refer to the readme.txt file in the docs subdirectory for information on installing SP.

Perl

The Perl language provides the capability to easily manipulate text and files. Originally available on UNIX machines, it has been converted to run on a wide variety of computer platforms.

Name: Perl
Category: Computer Language
Description: Text, file, and process manipulation language
Version: Perl 4
Platform(s): MS-DOS, MS Windows
Notes: Source code included (and other platform porting notes)
Supplier: Larry Wall, et al
Contact: University of Florida Perl Archives at http://www.cis.ufl.edu/perl/

Software Contents

The following table lists the contents of the Perl software.


Files Version Description

Programs
perl.exe 4.036 Perl program
perlglob.exe 4.036 Perl glob program
wemu387.386 4.036 Coprocessor support
Libraries
(numerous) 4.036 Various Perl support routines

Installation

Refer to the readme.dos and readme files for installation instructions.

perlSGML

perlSGML is a collection of Perl programs and libraries for processing SGML documents. These include programs for generating a content hierarchy (or structure) tree of SGML documents, an SGML DTD documentation/navigation tree, and a utility to remove SGML markup from documents. Also included are a number of Perl libraries to perform SGML-related functions.

Name: perlSGML
Category: SGML Tools
Description: A collection of SGML processing tools written in Perl
Version: 1995Dec08
Platform(s): Multiple (Must have Perl installed)
Notes: Runs under Perl 4 and 5
Supplier: Earl Hood
Contact: ehood@convex.com http://www.oac.uci.edu/indiv/ehood/perlSGML.html

Software Contents

The following table lists the contents of the perlSGML software distribution.


Files Version Description

Programs
dtd2html 1.4.0 SGML DTD documentation/navigation tool
dtddiff 1.1.0 Lists changes in DTD
dtdtree 1.2.0 Generates hierarchy tree of SGML elements
stripsgml 0.1.1 Removes SGML markup from documents
Libraries
dtd.pl 2.2.0 Perl library to parse SGML DTDs
sgml.pl 0.1.0 Perl library to parse SGML instances

Installation

Installation of perlSGML requires that you have Perl installed on your computer. After installation, refer to the readme.1st file for installation instructions.

The subdirectory compress in the perlsgml directory contains compressed collections of perlSGML in ZIP and gz formats.


Note:  
The documentation and Perl source files in perlSGML conform to the MS-DOS filename limitations (eight characters for the name and three characters for the extension). However, the example/sample files do not fit into the naming restrictions. Therefore, if your computer is not subject to these limitations, it is recommended that you use one of the compressed collections of perlSGML that is also included.

Near & Far Lite

Near & Far Lite is a demonstration version of the Near & Far program covered in Chapter 26, “Tools for the PC: Authoring, Viewing, and Utilities.” It is similar in operation to Near & Far in its graphic visualization of DTDs, but it does not have the DTD creation and modification or reporting features of its commercial counterpart.

Name: Near & Far Lite
Category: DTD Visualization Tool
Description: Provides visual diagram/representation of DTD
Version: 1.30
Platform(s): MS Windows (version 3.1+)
Notes: Source code included (and other platform porting notes)
Supplier: Microstar Software Ltd.
Contact: http://www.microstar.com/

Software Contents

The following table lists the contents of the Near & Far Lite software.


Files Version Description

Programs
nflite.exe 1.30 Near & Far Lite program
clipwin.exe 1.30 Near & Far Lite support program
Libraries
(numerous) 1.30 Various support files

Installation

From Windows Program Manager, run the setup.exe program in the nf-lite program directory.

Other Files

A demonstration version of Near & Far—showing the design features available with the full program—is also included on the CD-ROM.

DynaText

DynaText is a document viewer for SGML documents. It differs from Panorama in that documents must be compiled/indexed in order to view them. The compilation process results in higher performance when viewing large document sets.


Note:  
The next release of DynaText, currently in beta test, will support the viewing of uncompiled SGML documents.
Name: DynaText
Category: SGML Document Viewer/Browser
Description: Compiled SGML Document Viewer
Version: 2.3
Platform(s): MS Windows (version 3.1+)
Notes: Includes CIA World Fact Book in SGML
Supplier: Electronic Book Technologies
Contact: http://www.ebt.com/

Software Contents

The following table lists the contents of the DynaText browser software.


Files Version Description

Programs
dtextrw.exe 2.3 DynaText browser program
dynatext.ini 2.3 DynaText ini (parameter) file
dtext.dll 2.3 DynaText dll support
Libraries
dtext.dll 2.3 DynaText dll support library
(various) 2.3 Various support files

Installation

See the install.txt file in the EBT directory on the CD-ROM for installation instructions.

Other Files

Included with the EBT/DynaText software is a copy of the CIA World Fact Book in both compiled format and SGML. Also included are various files related to the Rainbow DTD.

Panorama Free

Panorama Free is the demonstration version of Panorama Pro covered in Chapter 26, “Tools for the PC: Authoring, Viewing, and Utilities.” It differs from Panorama Pro in several significant respects:

  Panorama Free is restricted to viewing documents across the World Wide Web (compared to the local and Web capabilities of Panorama Pro)
  Panorama Free does not include stylesheet creation and editing capabilities (Panorama Pro provides such capabilities)
Name: Panorama Free
Category: SGML Document Viewer/Browser
Description: Views SGML documents across the World Wide Web
Version: 1.11
Platform(s): MS Windows
Notes: Works in conjunction with a Web browser
Supplier: SoftQuad Inc.
Contact: http://www.sq.com/

Software Contents

The Panorama software is supplied in compressed format. When installed, it will include the following components:


Files Version Description

Programs
panorama.exe 1.11 Panorama World Wide Web SGML browser program
Libraries
(various) 1.11 Various support files

Installation

While in Microsoft Windows, start your Web browser program. Then run the program setup.exe from Program Manager or File Manager.


Table of Contents