| Patti,
I pulled the SPD that was pointed to across the net and read it through.
I took the liberty of annotating it. Following this text is the
"blue-pencilled" version. Hope this helps you folks!
BobW
Comments, annotations, and corrections are preceeded by ">>>"
PRODUCT NAME: VAX DOCUMENT, Version 1.0 SPD 27.55.00
DESCRIPTION
VAX DOCUMENT, Version 1.0 is an electronic publishing system
designed to aid VMS users in the production of high quality
technical documentation with integrated text and graphics
>>> period needed .
It is a tool to automate and manage the entire process
of creating technical documentation: from the first
entry of written material to final printed output.
It is designed for use by any one of the team of people who
contribute to a technical document during its life cycle;
engineers, writers, editors, or final production specialists.
Facilities are provided to create, maintain, revise, format,
and print complex technical documents efficiently.
Features
Generic Markup Language
VAX DOCUMENT is based on a simple device-independent generic
markup language for entering source text and markup instructions
into ASCII text files. Utilizing any VMS editor, the writer
creates a documentation source file, enters the text and inserts
markup commands or tags that label the text elements. Text
elements determine the structure of the document and refer to
such things as headers, lists or tables. The markup tags have
no specific format information and are not tied to a specific
device. The format information is stored in a separate file and
is used when the documentation source file is processed. This
allows the writer to concentrate on writing, not on memorizing
complex format codes or page layouts.
Markup tags are provided to include graphic files in the
final output document. VAX DOCUMENT can include sixel graphic
files in documents destined for the LN03 or LN03-Plus and
PostScript (tm) graphic files in documents destined for the LPS40
or LN03R printers.
The VAX Language-Sensitive Editor can be used in conjunction
with VAX DOCUMENT to simplify the creation of documentation
source files and to interactively debug the markup code using
keystrokes familiar to programmers.
Multiple Document Designs and Styles
VAX DOCUMENT supports a variety of document types and designs
>>> period needed .
The document type refers to the structure and text
elements associated with a particular document, for example
a user manual, military specification, or letter.
A design denotes a variation in the style of a document
type and refers to such things as running heads or running
feet and the type faces and sizes for titles, headings
and notes. VAX DOCUMENT provides document types and
designs for:
^ LETTERS - The LETTER document type can be used for producing
a personal or business letter, or for interoffice memos.
>>> "memo": colloquial for memorandum - do we want to be colloquial?
Markup tags are provided for inside and outside address,
salutation, closing and enclosures.
^ ARTICLES - The ARTICLE document type can be used for documenting
articles and provides many tags specific to
articles such as author information, back notes and bibliography
>>> bibliographic
reference sections, and an acknowledgement
>>> spelling acknowledgment
section. The design is in two column format in
size 8 1/2 x 11.
^ GENERAL - The GENERAL document type provides features
>>> REPORT?
useful for producing chapter-oriented material (such
as a book) or nonchapter-oriented material (such as a
report or a study). It includes a front page with lines
for sign-off signatures, outlining tags and the capability
to control numbered or unnumbered heads, running
heads and running feet and sequential or chapter-oriented
page numbering. Designs are provided for
two column text and for text that uses the full page
width.
^ MANUALS - The MANUAL document type can be used for documenting
chapter-oriented material, such as a book. Designs
are provided for primer, guide and reference manuals.
^ MILITARY SPECIFICATIONS - The MILITARY SPECIFICATIONS
document type can be used for producing
military specifications according to military
standards.
>>> Self referential definitions are self defeating. Also, whose Military
>>> and which standards? What about internationalization?
^ OVERHEADS - The OVERHEADS document type can be used for
producing overhead slides for transparencies or camera-ready
masters for 35mm slides. This document type provides
features specific to presentation slides, such
as automatic numbering of slides, title, topic, and running
heads and feet, and the capability to control the
size of text.
^ SOFTWARE - The SOFTWARE document type can be used for
producing user manuals containing software-specific information.
This document type provides many software-specific
formatting features, such as a set of tags to
draw keypad diagrams, a set of tags to format system
messages, and a structured set of tags (called templates)
to document software commands, routines, and programming
language statements. There is a design for specifications, as
well as designs which are similar to those which DIGITAL uses
to produce its own documentation.
Customizable Document Designs and Styles
The system administrator or book designer can customize
the document types and/or designs provided with VAX DOCUMENT.
>>> VAX DOCUMENT does the customizations?
While the fundamental layout of most text elements
cannot be changed, a variety of design parameters can be
changed. These include:
^ Parameters which control basic page dimensions
^ Fonts for text element
^ Vertical spacing around text elements
^ Rule thickness
^ Default text for element identifiers
In addition, the positioning of certain text elements, such
as figure captions, can be changed.
Refer to the VAX DOCUMENT documentation for a complete list
of DIGITAL supported modification to document types and
designs.
Page Composition and Pagination Software
VAX DOCUMENT provides a powerful and sophisticated text
formatter. The capabilities that it provides include:
^ Automatic numbering of headings, sections, lists, sublists,
chapters, appendices
^ Automatic pagination with control of orphans and widows,
page numbering
>>> VAX Document (as pointed out in the notes file) does nothing to
>>> prevent orphans and widows.
^ Running headers and footers
^ Footnotes
^ Hyphenation and justification (right-justified or ragged-right)
^ Complex multi-page tables and figures
^ Multi-column output
^ Horizontal rules, revision (change) bars and update pages
^ Automatic generation of table of contents and index
^ Automatic cross referencing
^ Kerning and variable leading
^ Full multi-national character set
^ Formatting of complex mathematical equations; from simple
in-line equations to complex matrices
Complete Bookbuilding Facilities
VAX DOCUMENT contains software for processing a set of files
to build an entire book, including a table of contents and
index. The information required to build a book is contained
in a user-created generic markup file which lists
the names, the location, and the sequence of all the files.
High Quality Output
VAX DOCUMENT can produce output for printing or displaying on
any DIGITAL character-cell terminal and monospaced line
printer.
VAX DOCUMENT can also be used to produce high quality output
with merged text and graphics for printing on the LN03,
LN03-Plus, LN03R and LPS40 printers.
Fonts for the LN03 and LN03-Plus printers are available
from the DCS Library and fonts for the LN03R and LPS40 are
included with the device.
MINIMUM HARDWARE REQUIRED
Refer to the VAX/VMS System Software Order Table (SPD 28.98.xx)
for processors supported by this product.
Note: An R80/RL02 configuration is required for VAX-11/730 systems.
Block Space Requirements (Block Cluster Size = 1):
Disk space required for installation: 11,000 blocks (5632K bytes)
Disk space required for use (permanent): 10,500 blocks (5376K bytes)
These counts refer to the disk space required on the system
disk. The sizes are approximate; actual sizes may vary
depending on the user's system environment, configuration,
and software options. In particular, the VAX DOCUMENT software
need not be installed on the system disk.
VAXcluster Environment
This layered product is fully supported when installed on
any valid and licensed VAXcluster or Local Area VAXcluster
configuration including VAXcluster configurations accessing
a common system disk, without restrictions.
GROWTH CONSIDERATIONS
The minimum hardware requirements for any future version
of this product may be different than the minimum hardware
requirements for the current version.
OPTIONAL HARDWARE
VAX DOCUMENT files can be printed using any DIGITAL monospaced
line printer, LN03, LN03-Plus, LN03R or the LPS40 laser
printer.
The LN03 and LN03-Plus laser printers require 2 RAM cartridges.
PREREQUISITE SOFTWARE
For VAX Systems:
>>> VMS? VAX/VMS? - this product does not run under either ELN
>>> or ULTRIX
VAX/VMS Operating System (at a minimum of Version 4.4)
For MicroVMS Systems:
>>> do you mean MicroVAX?
MicroVMS Operating System* (at a minimum of Version 4.4)
*Both the MicroVMS Extended Base component and the MicroVMS
Program Development component are required.
Refer to the VAX/VMS System Software Order Table (SPD 28.98.xx)
for the required versions.
OPTIONAL SOFTWARE
VAX Language-Sensitive Editor (at a minimum of Version 2.0)
VAX DEC/CMS
VAX DECslide or VAX DECgraph. VAX DECslide is required to
convert Regis base graphics to sixel graphics.
A font package designed to work especially with VAX DOCUMENT
and the LN03 is available through the DCS library.
SOFTWARE WARRANTY
Warranty for this software product is provided by DIGITAL
with the purchase of a license for the product as defined
in the Software Warranty Addendum of this SPD.
INSTALLATION
This software product can be installed by the customer using
the step-by-step documentation available for this product.
Optionally, you can purchase DIGITAL Installation Services
>>> who is "you"?
which provide for the installation of the software
product by an experienced DIGITAL Software Specialist.
>>> This paragraph changes "voices" - not good written practice.
Courtesy Installation Service
This software product will be installed by DIGITAL at no
additional charge if you purchase it concurrent with a Startup
>>> who?
Service Package that includes installation service. Both
the host operating system and this product must be installed
concurrently.
ORDERING INFORMATION
Single-Use licensed software is furnished under the licensing
provisions of DIGITAL's Standard Terms and Conditions
of Sale, which provide in part that the software
and any part thereof may be used on only the single CPU
on which the software is first installed and may be copied,
in whole or in part (with the proper inclusion of DIGITAL
copyright notice and any proprietary notices on the
software) for use on that same CPU.
You will need a separate license for each CPU on which you
will be using the software product (except as otherwise
specified by DIGITAL). Then, Materials and Service selected
to utilize the product effectively. THE LICENSE OPTIONS
ARE DESCRIBED BELOW. IF YOU ARE NOT FAMILIAR WITH THE SERVICE
OPTIONS, YOU MAY OBTAIN THE APPROPRIATE SOFTWARE PRODUCT
SERVICE DESCRIPTIONS(S) FROM YOUR LOCAL DIGITAL OFFICE.
The base option number for this software product is Q*xxx.
*Denotes processor variant.
LICENSE OPTIONS
Single-Use License Option
The Single-Use License is your right to use the software
product on a single CPU.
For your first installation of this software product, you
must purchase as a minimum:
^ Single-Use License Option, and
^ Distribution and Documentation Option
The license gives you the right to use the software on a
single CPU and the Distribution and Documentation Option
provides the machine-readable software and related documentation.
To use this software product on additional CPUs, you must
purchase for each CPU as a minimum:
^ Single-Use License Option
In addition to the right to use, the license gives you the
one-time right to copy the software from your original CPU
installation to the additional CPU. Therefore, the Distribution
and Documentation Option is not required, but
optional.
VAXcluster License Option
You are eligible for a VAXcluster License Option on your
second or each subsequent CPU that is part of a VAXcluster
system. This is a Single-Use License offered at a reduced
price and provides all of the License rights described
above. A standard Single-Use License Option (example: Qxxxx-UZ)
is required with the first purchase of this software
product and is also required for the first CPU of a VAXcluster
system.
For software configuration purposes, a VAXcluster system
is a set of VAX processors, each running the VAX/VMS Operating
System, where each VAX processor has a direct
path to every other VAX processor via Computer Interconnect
(CI) Bus.
>>> or Network Interconnect (NI) Bus
Distribution and Documentation Option
The Distribution and Documentation Option provides the
machine-readable software in binary form and the basic
documentation. You must have or order, a Single-Use License to
>>> ,
obtain this option. You will need this option to install
the software for the first time. When revised versions of
this software product become available, they may also
be obtained by purchasing this option again.
Software Revision Right-To-Copy Option
The Right-To-Copy Option allows a customer with multiple
CPUs to copy a revised version of a software product from
one CPU to another. Each CPU must be licensed for that product.
You first install the revised software on one CPU,
then you can make copies for additional CPUs by purchasing
ing the Right-To-Copy Option for each additional CPU.
>>>delete ^^^ extraneous word
Documentation-Only Option
The Documentation-Only Option provides one copy of the basic
documentation.
Software Product Services
A variety of service options are available. For more information
on these or other services, please contact your
local DIGITAL office.
July 1987
AE-xxxx-xx
|