Full text search
SGML Open Catalog Format
Functions		Platforms

The SGML Open Catalog loader and handler provides the services described in the SGML Open Technical Resolution 9401:1997, Amendment to TR 9401. These include services to:

• substitute a cataloged system identifier for a system identifier that has been used in a document instance
• resolve public identifiers (from a document instance) to their equivalent system identifiers
• resolve external entities to their equivalent system identifiers
• specify the document at which parsing should begin
• specify an SGML declaration that should be used to parse all documents
• specify, on an individual basis, the SGML declaration to be used with each of several DTDs
• incorporate other catalogs as extensions of the catalogs that have been explicitly requested
• specify which system identifier to use when a system identifier is available from both the document instance and the catalog

Full use of the catalog loader and handler requires external-text-entity and external-data-entity rules.

Provided with this library is an external-text-entity rule, contained in the socatete.xin file. To use this rule in your program, simply include the file in your program:

  ; code to be included in your program
  include "socatete.xin"

The following must be included on the command line to define the "socat" stream as the file name of your catalog:

  omnimark -d socat yourcatalog ...

If you want to revert to the standard OmniMark behavior without changing your code, do not define the stream "socat" on your command line.

To use the SGML Open Catalog loader and handler with your own external-text-entity rule, simply include the socatete.xin files in your code ahead of the file that contains your external-text-entity rule:

  ; code to be included in your program
  include "socat.xin"
  include "yourrule.xin"

Again, the following must be included in your command line in order to define the "socat" stream as the file name of your catalog:

  omnimark -d socat yourcatalog...

If you want to discontinue use of the SGML Open Catalog without changing your code, do not define the "socat" stream on your command line. The behavior of your program will depend on what your external-text-entity rule does when no information can be obtained from the catalog.

For information about writing your own external-text-entity rule, see the comments in the socat.xin, and the example in the file socatete.xin.

Catalog syntax errors are detected when the catalog is loaded, and are reported to the error log (#error).

The switch "socat-error" is set whenever an error is detected.

Failure to find a system identifier when looking up objects in the catalog is not reported as an error. A zero-length system identifier is returned when no system identifier is found in either the catalog or the document, and the switch "socat-entry-found" is activated (true) when a system identifier has been found in the catalog.

The following examples are included as part of this library package:

• "appl.cat" -- an example of an application-specific SGML Open Catalog
• "notation.*" -- an example of an external-data-entity rule and using NOTATION entries
• "public.cat" -- an example of a site-specific SGML Open Catalog
• "socatete.xin" -- an example of an external-text-entity rule that uses SGML Open Catalog
• "socatex1.xin" -- an example using the SGMLDECL and DOCUMENT entries in SGML Open Catalog
• "socatex2.xin" -- an example using the DTDDECL entry in SGML Open Catalog
• "socatlst.xin" -- a diagnostic tool that lists the contents of an SGML Open Catalog

Functions    socat-clear    socat-load-catalog    socat-resolve-doctype    socat-resolve-document    socat-resolve-dtddecl    socat-resolve-entity    socat-resolve-linktype    socat-resolve-notation    socat-resolve-sgmldecl

Platforms    Digital Ultrix    Digital UNIX (Alpha)    HP/UX    IBM AIX    IBM MVS    IBM OpenMVS    IBM VM    OpenVMS Alpha    OS/2    SGI IRIX    SINIX    Solaris    Sun OS    Win 3.x 32 bit    Win 95    Win NT

----

[CONTENTS] [CONCEPTS] [SYNTAX] [LIBRARIES] [SAMPLES] [ERRORS] [INDEX]

Copyright © OmniMark Technologies Corporation, 1988-1999.