DIGITAL Software Product Description ___________________________________________________________________ PRODUCT NAME: DECdocument for OpenVMS Systems SPD 27.55.11 This Software Product Description describes the following two prod- ucts: DECdocument Version 3.2 for OpenVMS VAX Systems DECdocument Version 3.2 for OpenVMS Alpha Systems Note: DECdocument for OpenVMS VAX and Alpha are 100% compatible. DESCRIPTION DECdocument is a product of Touch Technologies, Inc. and is licensed under Digital Equipment Corporation's Standard License Terms and Con- ditions. DECdocument is a style-based, batch-oriented, document composition sys- tem. It is designed to aid OpenVMS users in the production of single manuals, large documentation sets, or specifications, and it supports HTML, MANPAGE, Bookreader, and hardcopy output. DECdocument runs on a wide range of Digital Equipment Corporation configurations, includ- ing VAXclusters. It can be used from any of Digital's standard ter- minals, and it can create files for hardcopy output to any Digital line printer or laser printer, Bookreader files for on-line viewing on a DECwindows workstation, HTML files for viewing access on the World Wide Web, and MANPAGE reference files for use on Digital UNIX systems. DECdocument provides a complete, high-end documentation product that automates the production of large, format-intensive, technical doc- umentation - from the first entry of written material to the final out- put of formatted hardcopy or on-line documentation. DECdocument is de- signed for use by members of the team of people who contribute to a May 1997 DECdocument for OpenVMS Systems SPD 27.55.11 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 ef- ficiently. This provides greater control over the entire documenta- tion process while reducing time-to-market and costs. Features HTML Output DECdocument includes the HTML device converter which produces HTML (Hy- perText Markup Language) files from SDML files. This feature is eas- ily invoked - one word in the DECdocument command line. Several SDML tags allow users to control HTML file size, content and on-line ap- pearance. DECdocument automatically optimizes HTML file sizes for fast trans- fer over the Internet. In addition, HTML file sizes can be controlled by users through a logical. DECdocument is very flexible and supports a wide variety of styles and output formats. This includes HTML, Bookreader and Help, for on-line documentation, and hardcopy output styles and formats, such as those meeting military specifications. Note: Support for HTML output is limited to the Software Reference fam- ily of design types. MANPAGE Output DECdocument includes the MANPAGE device converter which produces UNIX MANPAGE reference files (for use on Digital UNIX systems) from SDML files. MANPAGE files are normally used to create UNIX system on-line help documents. The MANPAGE files contain Reference Semantic Markup Language (RSML) tags. 2 DECdocument for OpenVMS Systems SPD 27.55.11 The MANPAGE feature is easily invoked - one word in the DECdocument command line. The output MANPAGE file can be transferred to a UNIX sys- tem and displayed using the command: MAN file_name. Note: Support for MANPAGE output is limited in V3.1 to the HELP doc- type and the Software Reference design types. Generic Markup Language DECdocument uses a device-independent generic markup language for en- tering source text and markup instructions into ASCII text files. Us- ing any OpenVMS editor, the writer creates a documentation source file, enters the text, and inserts markup commands (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 formatting information. DECdocument stores the formatting information in a separate file that is used when the documentation source file is processed. Markup tags enable the writer to include graphic files in the final output document. DECdocument supports Sixel graphic files for the LN03 or LN03 PLUS printers and PostScript[R] graphic files for the LPS40 or LN03R printers. PostScript graphic files must conform to the En- capsulated PostScript File Format published by Adobe[R] Systems In- corporated. The DEC Language-Sensitive Editor can be used in conjunction with DEC- document to simplify the creation of documentation source files and to debug the markup code interactively. Multiple Document Designs and Styles DECdocument supports a variety of document types and designs. The doc- ument type refers to the structure and text elements associated with a particular document, for example a user manual, military specifi- cation, or letter. A design denotes a variation in the style of a doc- ument type and refers to such elements as running heads, running feet, and the typefaces and sizes for titles, headings, and notes. DECdoc- ument provides document types and designs for: 3 DECdocument for OpenVMS Systems SPD 27.55.11 o SOFTWARE - The SOFTWARE document type can be used for producing user manuals containing software-specific information. This document type provides many software-specific 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. DECdoc- ument also provides a design for specifications, as well as designs that are similar to those that Digital uses to produce its own doc- umentation. In addition, the SOFTWARE.REFERENCE design can be used when creating HTML output. o MILITARY SPECIFICATIONS - The MILSPEC document type can be used for producing military specifications according to military standards. It includes a front page with a title and subtitle, a two-column list of signatures, and a listing of information about the spec- ification. A design is provided to produce documents requiring security clas- sifications, numbering of figures and tables by section number, 20 heading levels, one- to four-line running titles, single-line run- ning feet, and the ability to use proportionally spaced fonts within code examples. This design is available in double-spaced format for draft documents. o MANUALS - The MANUAL document type can be used for documenting chapter- oriented material such as a book. DECdocument provides designs for primer, guide, and reference manuals. o OVERHEADS - The OVERHEADS document type lets the user produce over- head 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, running heads and feet, and the capability to control the size of text. o LETTERS - The LETTER document type can be used for producing a per- sonal or business letter, or interoffice memos. The doctype includes markup tags for an inside and outside address, salutation, clos- ing, and enclosures. 4 DECdocument for OpenVMS Systems SPD 27.55.11 o ARTICLES - The ARTICLE document type provides many tags specific to articles, such as author information, back notes, bibliography reference sections, and an acknowledgment section. The design is in two-column format in 8 1/2 inch x 11 inch page size. o REPORTS - The REPORT document type provides features useful for pro- ducing 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 signoff signatures, outlining tags, and the ca- pability 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. o GENERAL - The GENERAL document type is another doctype that can be used to produce manuals and reference material. It is similar to the SOFTWARE.REFERENCE design, but with much less white space. The SOFTWARE tags can be used with this document type. Also, the GEN- ERAL doctype can be used when creating HTML output. o ONLINE Doctypes - The on-line doctypes provide features to support the creation of on-line documentation to be viewed with the DECwin- dows Bookreader. DECdocument supports the BOOKREADER destination and includes the following on-line doctypes: MANUAL.ONLINE SOFTWARE.ONLINE MILSPEC.ONLINE Note: DECdocument offers the on-line MILSPEC doctype that emu- lates DoD standards on the Bookreader. This doctype is not a DoD standard, but only an on-line representation of the above stan- dards. Customizable Document Designs and Styles The system administrator or book designer can customize the document types and/or designs provided with DECdocument. Although the user can- not change the fundamental layout of most text elements, a variety of design parameters can be changed. These include: 5 DECdocument for OpenVMS Systems SPD 27.55.11 o Parameters that control basic page dimensions o Fonts for text elements o Vertical spacing around text elements o Rule thickness o Default text for element identifiers In addition, the positioning of certain text elements, such as fig- ure captions, can be changed. Refer to the DECdocument documentation for a complete list of Digi- tal supported modifications to document types and designs. Page Composition and Pagination Software DECdocument provides a powerful and sophisticated text formatter. These capabilities include: o Automatic numbering of headings, sections, lists, sublists, chap- ters, appendices o Automatic pagination with page numbering o Running headers and footers o Footnotes o Hyphenation and justification (right-justified or ragged-right) o Complex multi-page tables and figures o Multi-column output o Horizontal rules, revision (change) bars, and update pages o Automatic generation of table of contents and index o Automatic cross referencing o Kerning and variable leading o Full multi-national character set 6 DECdocument for OpenVMS Systems SPD 27.55.11 o Formatting of complex mathematical equations, from simple in-line equations to complex matrices Complete Bookbuilding Facilities DECdocument contains software for processing a set of files to build an entire book, including a table of contents and index. The infor- mation required to build a book is contained in a user-created generic markup file that lists the names, the location, and the sequence of all the files. High Quality Output DECdocument can be used to produce high-quality output with merged text and graphics for printing on the LN03, LN03 PLUS, LN03R, LPS20, LPS40, the DEClaser 1000, 2000, 3200, and 3500 family of printers, or for on- line viewing on a DECwindows workstation. PostScript output is produced by taking advantage of the fonts res- ident in the LN03R and LPS40 printers. Fonts for the LN03 and LN03 PLUS printers are available from the DCS Library. Monospaced Output DECdocument can produce output for printing or displaying on any Dig- ital character-cell terminal and monospaced line printer. HTML Output DECdocument produces HTML output files that are accessable and dis- played on the World Wide Web. MANPAGE Output DECdocument produces MANPAGE output reference files for use on Dig- ital UNIX systems. Enhanced HELP Capabilities 7 DECdocument for OpenVMS Systems SPD 27.55.11 DECdocument includes DCL HELP for SDML tags and context-sensitive SDML HELP in LSE. Sophisticated Art-Generating Capabilities DECdocument supports the creation of graphics for compound documents and on-line documentation using the DECdocument graphics editor. The DECdocument graphics editor runs on a DECwindows workstation allow- ing text and graphics to be created and maintained separately. The graph- ics editor includes the following features: o A DECwindows-based user interface to a comprehensive set of object- oriented graphics creation and editing functions. o Full color capabilities. o Screen capture and annotation. o Viewer capability for rapid scanning of graphics files. o Can submit graphics for hardcopy printing or inclusion in on-line documents. o Provides a user-extendable clip-art library. o The graphics editor can create the following types of file images: - CDA DDIF images (import and export) - Sixel (import and export) - Bookreader format (import and export) - PostScript (export) - Xbitmap (import) HARDWARE REQUIREMENTS Processors Supported by DECdocument for OpenVMS VAX: DECdocument V3.2 will run on any processor currently supported by OpenVMS with the ex- ception of those processors specifically listed under Processors Not Supported. 8 DECdocument for OpenVMS Systems SPD 27.55.11 Processors Not Supported MicroVAX I, VAXstation I, VAX-11/725, VAX-11/782, VAXstation 8000, VAX 7000, VAX 10000 Processor Restriction A TK50 tape drive is required for MicroVAX 2000 and VAXstation 2000 systems. Disk Space Requirements (Block Cluster Size = 1) ___________________________________________________________________ TASK_________VAX____________Alpha__________________________________ Installation:88,600 90,100 blocks blocks (44.3MB) (45.1MB) Permanent: 78,000 78,000 blocks blocks _____________(39.0MB)_______(39.0MB)_______________________________ 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. The DECdoc- ument software need not be installed on the system disk. OPTIONAL HARDWARE Appropriately formatted DECdocument files can be printed using any Dig- ital line printer, matrix printer, LN03, LN03 PLUS, LN03R, LPS20, LPS40, DEClaser 1000, 2000, 3200, 3500 family of printers, and PostScript[R] graphic files for the LPS40, LPS20, or LN03R printers and the LF01R Colormate PostScript printer for PostScript color output. The LN03 and LN03 PLUS laser printers require two RAM cartridges. 9 DECdocument for OpenVMS Systems SPD 27.55.11 CLUSTER ENVIRONMENT This layered product is fully supported when installed on any valid and licensed VAXcluster* configuration without restrictions. The HARD- WARE REQUIREMENTS sections of this product's Software Product Descrip- tion detail any special hardware required by this product. * VAXcluster configurations are fully described in the VAXcluster Soft- ware Product Description (29.78.xx) and include CI, Ethernet, and Mixed Interconnect configurations. SOFTWARE REQUIREMENTS For VAX Systems: For Systems Using Terminals (No DECwindows Interface): o OpenVMS VAX Operating System V5.4 - V7.1 For Workstations Running VWS: o OpenVMS VAX Operating System V5.4 - V7.1 o VWS Workstation Software V4.4 - V4.6 For Workstations Running DECwindows: o OpenVMS VAX Operating System V5.4 - V7.1 (and necessary components of OpenVMS DECwindows) Note: OpenVMS DECwindows must be installed to use the DECdocument Graph- ics Editor and associated graphics components. To use the DECdocument Graphics Editor, DECdocument V3.2 requires DECwin- dows/Motif V1.1 or higher. 10 DECdocument for OpenVMS Systems SPD 27.55.11 For Alpha Systems: For Systems Using Terminals: o OpenVMS Alpha Operating System V6.1 - V7.1 For Workstations Running DECwindows: o OpenVMS Alpha Operating System V6.1 - V7.1 For Workstations Running DECwindows Using Motif[R]: o OpenVMS Alpha Operating System V6.1 - V7.1 o DECwindows Motif for OpenVMS Alpha V1.2 OpenVMS Tailoring: The following OpenVMS classes are required for full functionality of this layered product. o OpenVMS Required Saveset o Utilities OPTIONAL SOFTWARE For VAX Systems: o DEC Language-Sensitive Editor/Source Code Analyzer V3.1 - V4.4 o DEC Code Management System V3.0 - V3.8 o VAX DOCUMENT/LN03 Font Package V1.1. This package is required in order to print files on the LN03 and LN03 PLUS laser printers. For Alpha Systems: o DEC Language-Sensitive Editor/Source Code Analyzer for OpenVMS Al- pha Systems V4.2 - V4.4 o DEC Code Management System V3.6 - V3.8 11 DECdocument for OpenVMS Systems SPD 27.55.11 Certain versions of these products depend upon a specific version of the operating system. Please refer to the Software Product Descrip- tion of the product in question to determine which version of the op- erating system is required. GROWTH CONSIDERATIONS The minimum hardware/software requirements for any future version of this product may be different from the requirements for the current version. MEDIA DISTRIBUTION For VAX Systems: This product is available on an individual CD-ROM (QA-VEEAA-H8) or on the OpenVMS Consolidated Software Distribution on CD-ROM (QA-VWJ8A- AA). The software documentation for this product is also available as part of the OpenVMS On-line Documentation Library on CD-ROM. For Alpha Systems: This product is available on an individual CD-ROM (QA-3WKAA-H8) or on the Digital CD-ROM Software Library for OpenVMS Alpha (QA-03XAA-H8). ORDERING INFORMATION DECdocument for OpenVMS VAX Systems Software Licenses: Personal Use: QL-VEEAA-2B (Shared on VAX and Alpha) Concurrent Use: QL-VEEAA-3B (Shared on VAX and Alpha) Software Media/Documentation: QA-VEEAA-H8 Software Documentation (Hard Copy): QA-VEEAA-GZ Software Product Services: QT-VEEA*-** DECdocument for OpenVMS Alpha Systems 12 DECdocument for OpenVMS Systems SPD 27.55.11 Software Licenses: Unlimited Use: QL3WKA*-AA Software Media/Documentation (CD-ROM): QA-3WKAA-H8 Software Documentation (Hard Copy): QA-3WKAA-GZ Software Product Services: QT-3WKA*-** Note: DECdocument for OpenVMS VAX and OpenVMS Alpha are included on the same individual CD-ROM. If you order either QA-VEEAA-H8 or QA-3WKAA- H8 both products will be on the CD-ROM you receive. Appropriate li- censes are required for the use of either or both products. * Denotes variant fields. For additional information on available li- censes, services, and media, refer to the appropriate price book. SOFTWARE LICENSING This software is furnished under the licensing provisions of Digital Equipment Corporation's Standard Terms and Conditions. For more in- formation about Digital's licensing terms and policies, contact your local Digital office. License Terms for Printing On-Line Documentation Electronic Software documentation accompanying the Software may be printed as reasonably necessary to exercise your license to use the Software. License Management Facility Support This layered product supports the OpenVMS License Management Facil- ity. License units for this product are allocated on an Unlimited System Use plus Personal Use and Concurrent Use basis. Each Personal Use license allows one identified individual to use the layered product. Each Concurrent Use License allows any one individual at a time to use the layered product. 13 DECdocument for OpenVMS Systems SPD 27.55.11 For more information on the OpenVMS License Management Facility, re- fer to the appropriate OpenVMS Operating System SPD or the License Man- agement Facility manual of the OpenVMS Operating System documentation set. SOFTWARE PRODUCT SERVICES A variety of service options are available from Digital. For more in- formation, contact your local Digital office. SOFTWARE WARRANTY Warranty for this software product is provided by Digital with the pur- chase of a license for the product. This means that DIGITAL will rem- edy any nonconformance when it is reported to DIGITAL by the customer during the warranty period. The warranty period is one year. It begins when the software is in- stalled or thirty days after delivery to the end user, whichever oc- curs first and expires one year later. All warranty related support for this software will end one year after release of the subsequent version. Warranty is provided in the country of purchase. DIGITAL will provide a service location which will accept reporting (in a format prescribed by DIGITAL) of a nonconformance problem caused when using the licensed software under normal conditions as defined by the SPD. DIGITAL will remedy a nonconformance problem in the current unaltered release of the licensed software by issuing correction information such as: cor- rection documentation, corrected code, or notice of availability of corrected code; or a restriction or a bypass. The customer will be re- sponsible for the preparation and submission of the problem report to the service location. 14 DECdocument for OpenVMS Systems SPD 27.55.11 WARRANTY EXCLUSION DIGITAL DOES NOT WARRANT THAT THE SOFTWARE LICENSED TO CUSTOMER SHALL BE ERROR FREE, THAT THE SOFTWARE SHALL OPERATE WITH ANY HARDWARE AND SOFTWARE OTHER THAN AS SPECIFIED IN THIS SPD, THAT THE SOFTWARE SHALL SATISFY CUSTOMER'S OWN SPECIFIC REQUIREMENTS, OR THAT COPIES OF THE SOFTWARE OTHER THAN THOSE PROVIDED OR AUTHORIZED BY DIGITAL SHALL CON- FORM TO THIS SPD. DIGITAL MAKES NO WARRANTIES WITH RESPECT TO THE FITNESS AND OPERABIL- ITY OF MODIFICATIONS NOT MADE BY DIGITAL. IF THE SOFTWARE FAILS TO FUNCTION FOR REASONS STATED ABOVE, THE CUS- TOMER WARRANTY WILL BE INVALIDATED AND ALL SERVICE CALLS WILL BE BIL- LABLE AT THE PREVAILING PER CALL RATES. This Software Warranty Addendum is effective for licensed software prod- ucts ordered in the United States after October 1988 and supersedes all prior versions. The above information is valid at time of release. Please contact your local Digital office for the most up-to-date information. [R] Adobe and PostScript are registered trademarks of Adobe Systems Incorporated. [R] Motif is a registered trademark of Open Software Foundation, Inc. [TM]The DIGITAL Logo, Bookreader, CDA, CI, DEC, DECdocument, DE- Claser, DECwindows, Digital, LN03, LN03 PLUS, MicroVAX, Open- VMS, TK, VAX, VAXcluster, VAX DOCUMENT, VAXft, VAXserver, VAXstation, VMS, and XUI are trademarks of Digital Equipment Corporation. ©1997 Digital Equipment Corporation. All rights reserved. 15