swirl Guide to OmniMark 4.0
contentsconceptssyntaxlibrariessampleserrorsindex
 
Full text search
alphabetically
by type
by concept
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Aided translation types
Arrays: multi-dimensional
Attribute aliases
Attribute tests on items of the "attributes" shelf
Attributes: list-valued
Attributes: order of indexing
Attributes: type tests

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Base character sets: sources of information
Basic structure of a rule-based program
Bit-oriented arithmetic
Buffers: formatting contents

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Conditional constructs
Context-translations: using XML/SGML as an intermediate form
Counters
Cross-translations: general document translation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Data content: dividing
Declaration-free programs
Down-translation: translating XML/SGML documents

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Elements
Elements: counting
Elements: declaration tests
Elements: default processing
Elements: empty
Elements: names
Elements: qualifiers
Elements: retrieving the names of open elements
Elements: testing open elements
Elements: testing recently closed elements
Elements: testing the status of proper and included elements
Elements: the current stack
Elements: the document element name
Entities: built-in entity replacement text values
Entities: formatting names
Entities: matching based on both name and replacement text
Entities: matching based on names
Entities: matching based on replacement text
Entity manager: built-in
Entity manager: built-in entity manager and external text entities
Entity manager: determining when the built-in entity manager is being used
Entity managers: programmer-defined
Errors: counting markup errors
Errors: handling prolog errors
Errors: the escape character
Event handling
External entity rules
External functions
External functions: declaring
External functions: determining currently associated name or library name
External functions: identifying
External output functions
External text entities: default processing
External text entity rules: additional tests

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

File tests
Files: binary and text-mode
Finite state machines
Format items and the format operator
Function bodies
Function libraries: declaring a default
Function names
Function predefinitions
Function types and anatomy
Functions
Functions and declaration-free programs
Functions: applying "save" to arguments
Functions: argument classes
Functions: argument lists
Functions: argument recognition
Functions: argument separator ambiguity
Functions: argument separators
Functions: argument shelf types
Functions: greedy argument separator recognition
Functions: passing a shelf as a modifiable argument
Functions: passing a shelf as a read-only argument
Functions: passing expressions as arguments
Functions: passing multiple values as a single argument
Functions: recursive
Functions: resolving ambiguous argument separators
Functions: result types
Functions: shelves and arguments
Functions: side effects
Functions: side effects in rule headers
Functions: tail recursion
Functions: the differences between value and read-only arguments
Functions: uses
Functions: using the same argument separator in different definitions

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Global variables: declaring
Global variables: saving values in local scopes
Groups

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Halting an OmniMark program

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

I/O and variables
Including code from other files
Initialization and termination rules: universal
Input functions
Input/Output
Internal entities: combining internal entity and plain-text matching
Internal entity names: matching

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Library declarations
Library rules and the library path
Line breaking
Local variables: declaring
Localized pattern processing
Looking ahead
Loop indices
Looping constructs

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Marked sections: IGNORE
Marked sections: INCLUDE
Marked sections: processing CDATA and RCDATA
Match alternatives: side effects

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Notations

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

OmniMark: running other programs from
Opaque data types
Operators: the precedence of "base" and "binary"
Output

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Parallel processing model
Pattern and markup processors
Pattern variables and local scopes
Patterns: avoiding loops
Processing instructions
Public identifiers at the start of the DTD
Public identifiers in the SGML declaration
Public identifiers: processing

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Record boundaries: default handling
Record boundaries: manipulating
Referent set nesting depth
Referents
Referents and line-breaking
Referents or files: determining names
Referents: allowing referents in main output
Referents: attaching to streams
Referents: copying
Referents: default definitions for a reopened stream
Referents: final destinations
Referents: format of displayed referents
Referents: hypertext linking and cross-referencing
Referents: reopening in a different scope
Referents: silent
Referents: specifying default definitions
Referents: suppressed
Referents: the global referent set
Referents: writing data to a referent in a piecemeal fashion
Referents: writing referents to a stream
Referents: writing to different types of streams
Referents: writing to external output streams

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Scope of variables
Security considerations
SGML document regions
SGML DTDs: creating
Shelves: save declarations mixed with local declarations
Shelves: saving contents
Shelves: the "sgml-dtds" and "xml-dtds" shelves
Skipping input
Streams: attachments
Streams: changing modifiers on #process-output and #error
Streams: name tests
Streams: open streams in local scopes
Streams: reopening
Submitting files
Switches

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Translate rule boundaries
Translate rules: changing current output

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Up-translation: translating documents into XML/SGML

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Variables

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Writing robust macros

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

XML document processing
XML document regions
XML DTDs: creating
XML/SGML comments and marked section boundaries
XML/SGML comments and marked sections
XML/SGML enquiry and comparison: combining
XML/SGML entity managers
XML/SGML error message: retrieving parts of
XML/SGML error rules: predefined pattern variables
XML/SGML errors: processing
XML/SGML parser: controlling input
XML/SGML parser: locking input
XML/SGML parser: specifying input
XML/SGML parsing: built-in shelves

Aided translation types

context-translate
cross-translate
down-translate
up-translate

Arrays: multi-dimensional

%d
key

Attribute aliases

attributes
data-attributes
repeat over

Attribute tests on items of the "attributes" shelf

attributes
is defaulted
is implied
is specified

Attributes: list-valued

attribute
delimiter
has key
item
number of
number of attributes

Attributes: order of indexing

attributes
data-attributes

Attributes: type tests

attribute
data-attribute
is defaulted
is implied
is specified
or

Base character sets: sources of information

#charset

Basic structure of a rule-based program

define function
group
include
macro

Bit-oriented arithmetic

complement
difference
mask
shift
union

Buffers: formatting contents

%g
binary-mode
text-mode

Conditional constructs

do when, do unless
when, unless

Context-translations: using XML/SGML as an intermediate form

context-translate

Counters

global, local

Cross-translations: general document translation

cross-translate

Data content: dividing

data-content

Declaration-free programs

declare heralded-names
pattern

Down-translation: translating XML/SGML documents

down-translate

Elements

element

Elements: counting

element

Elements: declaration tests

element

Elements: default processing

#implied
element

Elements: empty

element

Elements: names

element

Elements: qualifiers

element

Elements: retrieving the names of open elements

element

Elements: testing open elements

element

Elements: testing recently closed elements

element

Elements: testing the status of proper and included elements

element

Elements: the current stack

element

Elements: the document element name

element
new, set new

Entities: built-in entity replacement text values

#libvalue

Entities: formatting names

%q

Entities: matching based on both name and replacement text

translate

Entities: matching based on names

cdata
sdata
translate

Entities: matching based on replacement text

cdata
non-cdata
non-sdata
pcdata
sdata
translate

Entity manager: built-in

library

Entity manager: built-in entity manager and external text entities

external-text-entity

Entity manager: determining when the built-in entity manager is being used

external-text-entity

Entity managers: programmer-defined

external-text-entity
library

Errors: counting markup errors

markup-error

Errors: handling prolog errors

prolog-in-error

Errors: the escape character

escape

Event handling

%c
element
find
suppress

External entity rules

external-data-entity
external-text-entity

External functions

define function

External functions: declaring

define function

External functions: determining currently associated name or library name

external-function

External functions: identifying

define function
set external-function
set function-library of external-function

External output functions

define external output

External text entities: default processing

#libvalue
external-text-entity

External text entity rules: additional tests

external-text-entity

File tests

file
file...exists
file...is directory
file...is file
file...is readable

Files: binary and text-mode

binary
file
text-mode

Finite state machines

find
group
next group is

Format items and the format operator

escape
format

Function bodies

define function
return

Function libraries: declaring a default

declare function-library
define function

Function names

define function

Function predefinitions

define function
elsewhere

Function types and anatomy

define function

Functions

define function

Functions and declaration-free programs

declare heralded-names
define function

Functions: applying "save" to arguments

define function
global, local
save
save-clear

Functions: argument classes

define function
remainder
value

Functions: argument lists

define function

Functions: argument recognition

define function
name of

Functions: argument separator ambiguity

define function
optional

Functions: argument separators

define function

Functions: argument shelf types

define function
remainder
value

Functions: greedy argument separator recognition

define function

Functions: passing a shelf as a modifiable argument

define function

Functions: passing a shelf as a read-only argument

define function

Functions: passing expressions as arguments

define function
remainder
value

Functions: passing multiple values as a single argument

define function
remainder

Functions: recursive

define function

Functions: resolving ambiguous argument separators

define function

Functions: result types

define function
return

Functions: shelves and arguments

define function

Functions: side effects

define function
domain-free

Functions: side effects in rule headers

define function

Functions: tail recursion

define function

Functions: the differences between value and read-only arguments

define function
value

Functions: uses

define function

Functions: using the same argument separator in different definitions

define function
optional
remainder

Global variables: declaring

global, local

Global variables: saving values in local scopes

global, local
save
save-clear

Groups

group
next group is
using group

Halting an OmniMark program

halt, halt-everything

I/O and variables

join
open
output
put
reopen
set
using output as

Including code from other files

include

Initialization and termination rules: universal

process-end
process-start

Input functions

do sgml-parse
external-text-entity

Input/Output

#current-output
#error
#main-input
#main-output
do sgml-parse
do xml-parse
submit

Internal entities: combining internal entity and plain-text matching

translate

Internal entity names: matching

translate

Library declarations

library

Library rules and the library path

#libpath
#library
#libvalue

Line breaking

insertion-break
replacement-break

Local variables: declaring

global, local

Localized pattern processing

submit

Looking ahead

lookahead, lookahead not

Loop indices

#item
repeat over

Looping constructs

repeat
repeat over

Marked sections: IGNORE

marked-section ignore

Marked sections: INCLUDE

marked-section include-end
marked-section include-start

Marked sections: processing CDATA and RCDATA

marked-section cdata
marked-section rcdata

Match alternatives: side effects

do scan
repeat scan

Notations

external-data-entity

OmniMark: running other programs from

system-call

Opaque data types

opaque

Operators: the precedence of "base" and "binary"

base
binary
item

Output

open
output
output-to
put
using output as

Parallel processing model

context-translate
do sgml-parse
do xml-parse
domain-free
up-translate

Pattern and markup processors

do sgml-parse
do xml-parse
submit

Pattern variables and local scopes

pattern

Patterns: avoiding loops

content-end
content-start

Processing instructions

processing-instruction

Public identifiers at the start of the DTD

#dtd
external-text-entity

Public identifiers in the SGML declaration

#capacity
#charset
#dtd
#implied
#syntax
%q
external-text-entity
library

Public identifiers: processing

library

Record boundaries: default handling

#markup-parser
#sgml

Record boundaries: manipulating

#markup-parser
#sgml

Referent set nesting depth

global, local
open
referents-allowed
set referent
using nested-referents

Referents

referents
set referent

Referents and line-breaking

insertion-break
replacement-break

Referents or files: determining names

name of

Referents: allowing referents in main output

#main-output
referents-allowed
referents-displayed
referents-not-allowed
set referent
silent-referent
using nested-referents

Referents: attaching to streams

set referent

Referents: copying

referents-allowed
referents-displayed

Referents: default definitions for a reopened stream

defaulting
open
referents-allowed
reopen
set
set stream

Referents: final destinations

file
referents-allowed
referents-displayed
referents-not-allowed

Referents: format of displayed referents

referents-displayed

Referents: hypertext linking and cross-referencing

set referent

Referents: reopening in a different scope

reopen

Referents: silent

silent-referent

Referents: specifying default definitions

defaulting

Referents: suppressed

#error
#suppress
referents-displayed

Referents: the global referent set

using nested-referents

Referents: writing data to a referent in a piecemeal fashion

open

Referents: writing referents to a stream

open
put...referent
referents-allowed
referents-displayed
referents-not-allowed
reopen
set
set referent

Referents: writing to different types of streams

referents-allowed
referents-displayed

Referents: writing to external output streams

referents-allowed

Scope of variables

global, local

Security considerations

file...exists
file...is directory
file...is file
file...is readable
file...is writable
open
output
put
set
system-call

SGML document regions

dtd-end
dtd-start
epilog-start
prolog-end
sgml-declaration-end

SGML DTDs: creating

creating
do sgml-parse

Shelves: save declarations mixed with local declarations

save
save-clear

Shelves: saving contents

save
save-clear

Shelves: the "sgml-dtds" and "xml-dtds" shelves

do sgml-parse
do xml-parse
sgml-dtds
xml-dtds

Skipping input

do skip

Streams: attachments

file

Streams: changing modifiers on #process-output and #error

#error
#process-output

Streams: name tests

has name

Streams: open streams in local scopes

open
output-to

Streams: reopening

and
break-width
open
referents-allowed
reopen

Submitting files

submit

Switches

global, local
true, false

Translate rule boundaries

markup-comment
sgml-comment
translate

Translate rules: changing current output

output-to
translate

Up-translation: translating documents into XML/SGML

up-translate

Variables

global, local

Writing robust macros

%@
literal
macro

XML document processing

do xml-parse
xml-dtds

XML document regions

dtd-end
dtd-start
epilog-start
prolog-end

XML DTDs: creating

creating
do xml-parse

XML/SGML comments and marked section boundaries

sgml-comment

XML/SGML comments and marked sections

markup-comment

XML/SGML enquiry and comparison: combining

element
occurrence
of ancestor

XML/SGML entity managers

external-text-entity

XML/SGML error message: retrieving parts of

markup-error
sgml-error

XML/SGML error rules: predefined pattern variables

#additional-info
#class
#file-name
#message
#recovery-info
is specified
pattern
sgml-error
true, false

XML/SGML errors: processing

markup-error
prolog-in-error
sgml-error

XML/SGML parser: controlling input

#command-line-names
external-text-entity #document

XML/SGML parser: locking input

#markup-parser
#sgml
attributes
data-attributes
repeat over

XML/SGML parser: specifying input

do sgml-parse
do xml-parse

XML/SGML parsing: built-in shelves

#appinfo
#doctype
#markup-parser
#sgml
do sgml-parse
do xml-parse
 
Generated: April 21, 1999 at 2:00:32 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © OmniMark Technologies Corporation, 1988-1999.� All information on this website is protected under OmniMark Technologies Corporation's copyright.� OmniMark and the SWIRL Logo are registered trademarks of OmniMark Technologies Corporation. Microdocument Architecture, and MDA are trademarks of OmniMark Technologies Corporation. All rights reserved. Trademarks other than those owned by OmniMark Technologies Corporation used in this document belong to their registered owners and appear on this site for reference only.