DECdocument
Command Summary and
Processing Messages

If you do not specify /INDEX on the command line when you process a file that contains an <INDEX_FILE> tag, DECdocument issues a warning message and the most recent version of the index file that already existed is included in your document. This may be an outdated index. If no previous index file exists, the device converter issues a warning message.

The /INDEX qualifier is valid only if text formatting is being done. If you specify /NOTEXT_FORMATTER with the /INDEX qualifier, DECdocument issues a warning message stating that you specified an illegal combination of command elements.

Note that if you process your document with the /NOTAG_TRANSLATOR and /INDEX qualifiers, and the index is included using the <INDEX_FILE> tag, the index is incorporated into your document, placed in the file filename_INDEX, and processed separately.

Note

The maximum length of a VMS file name is 39 characters. If you want to generate an index file, your input file name must have no more than 33 characters, because appending _INDEX to it adds 6 more characters.

The following list describes the optional indexing keywords that you can use with the /INDEX qualifier. For more information on creating and generating a single-document and a master index, see the <X>, <XS>, and <Y> tag descriptions.

Index Keyword Description

GUIDE_HEADINGS
NOGUIDE_HEADINGS
Specifies whether alphabetic headings are created for each letter group in the index. (The entries beginning with "A" have an A at the start of the group, and so on.) The GUIDE_HEADINGS keyword is the default. The NOGUIDE_HEADINGS keyword suppresses guide headings in the index output file.

SORT=( [

LETTER
WORD

[ ,

NONALPHA=AFTER
NONALPHA=BEFORE
NONALPHA=IGNORE
] ) Specifies the sorting method used to order entries in an index.

SORT=LETTER sorts the entry letter by letter and ignores spaces and hyphens. SORT=LETTER is the default.
SORT=WORD sorts the entry letter by letter and treats spaces and hyphens as significant.
SORT=NONALPHA positions an entry with leading nonalphabetic characters in the index based on the keyword supplied with the NONALPHA keyword.

The AFTER keyword causes an entry with leading nonalphabetic characters to be placed at the end of the index.
The BEFORE keyword causes an entry with leading nonalphabetic characters to be placed at the beginning of the index.
The IGNORE keyword causes an entry with leading nonalphabetic characters to be sorted by the first alphabetic characters in the entry. The default is NONALPHA=IGNORE.

OVERRIDE_MASTER
NOOVERRIDE_MASTER
Specifies the inclusion of index entries in both single-document indexes and master indexes; NOOVERRIDE_MASTER is the default keyword for both /INDEX and /MASTER_INDEX. OVERRIDE_MASTER and NOOVERRIDE_MASTER have no effect for Bookreader output.

Use /INDEX=NOOVERRIDE_MASTER to create a single-document index that contains only the index entries that are not marked with the MASTER keyword; this is the default.
Use /INDEX=OVERRIDE_MASTER to create a single-document index that contains both the index entries that are not marked with the MASTER keyword and the entries that are marked with the MASTER keyword.
Use /MASTER_INDEX=NOOVERRIDE_MASTER to create a master index that contains only the index entries that are marked with the MASTER keyword; this is the default.
Use /MASTER_INDEX=OVERRIDE_MASTER to create a master index that contains both the index entries that are not marked with the MASTER keyword and those entries that are marked with the MASTER keyword.

Index Keyword	Description
GUIDE_HEADINGS NOGUIDE_HEADINGS	Specifies whether alphabetic headings are created for each letter group in the index. (The entries beginning with "A" have an A at the start of the group, and so on.) The GUIDE_HEADINGS keyword is the default. The NOGUIDE_HEADINGS keyword suppresses guide headings in the index output file.
SORT=( [ LETTER WORD [ , NONALPHA=AFTER NONALPHA=BEFORE NONALPHA=IGNORE ] )	Specifies the sorting method used to order entries in an index. SORT=LETTER sorts the entry letter by letter and ignores spaces and hyphens. SORT=LETTER is the default. SORT=WORD sorts the entry letter by letter and treats spaces and hyphens as significant. SORT=NONALPHA positions an entry with leading nonalphabetic characters in the index based on the keyword supplied with the NONALPHA keyword. The AFTER keyword causes an entry with leading nonalphabetic characters to be placed at the end of the index. The BEFORE keyword causes an entry with leading nonalphabetic characters to be placed at the beginning of the index. The IGNORE keyword causes an entry with leading nonalphabetic characters to be sorted by the first alphabetic characters in the entry. The default is NONALPHA=IGNORE.
OVERRIDE_MASTER NOOVERRIDE_MASTER	Specifies the inclusion of index entries in both single-document indexes and master indexes; NOOVERRIDE_MASTER is the default keyword for both /INDEX and /MASTER_INDEX. OVERRIDE_MASTER and NOOVERRIDE_MASTER have no effect for Bookreader output. Use /INDEX=NOOVERRIDE_MASTER to create a single-document index that contains only the index entries that are not marked with the MASTER keyword; this is the default. Use /INDEX=OVERRIDE_MASTER to create a single-document index that contains both the index entries that are not marked with the MASTER keyword and the entries that are marked with the MASTER keyword. Use /MASTER_INDEX=NOOVERRIDE_MASTER to create a master index that contains only the index entries that are marked with the MASTER keyword; this is the default. Use /MASTER_INDEX=OVERRIDE_MASTER to create a master index that contains both the index entries that are not marked with the MASTER keyword and those entries that are marked with the MASTER keyword.

/KEEP[=(filetype keyword [,filetype keyword...] )]

/NOKEEP

Specifies whether all intermediate files are kept or deleted. The default qualifier /NOKEEP indicates that the intermediate files are deleted by DECdocument after processing.

You can use the following keywords to specify individual intermediate files that are to be kept:

File Type
Keyword File Contents

DVI Specifies an intermediate output file from the text formatter. You may want to keep this file for reprocessing at a later date, or to process and print only certain pages.
The actual file type is based on the destination you specified on the DOCUMENT command line. These file types and the destination keywords that create them are listed under the description of the /TEXT_FORMATTER qualifier.

INX Specifies an ASCII file that contains index entries in page-number order. You can use this file to create a master index.

TEX Specifies an input file for the text formatter. Note that a TEX file processed with a certain doctype can produce errors if it is reprocessed with a different doctype.

File Type Keyword	File Contents
DVI	Specifies an intermediate output file from the text formatter. You may want to keep this file for reprocessing at a later date, or to process and print only certain pages. The actual file type is based on the destination you specified on the DOCUMENT command line. These file types and the destination keywords that create them are listed under the description of the /TEXT_FORMATTER qualifier.
INX	Specifies an ASCII file that contains index entries in page-number order. You can use this file to create a master index.
TEX	Specifies an input file for the text formatter. Note that a TEX file processed with a certain doctype can produce errors if it is reprocessed with a different doctype.

/LIST[=file-name]

/NOLIST

Specifies whether a listing file is produced. The /NOLIST qualifier is the default and suppresses the generation of a listing file. If you do not specify a file specification as an argument to the /LIST qualifier, a listing file is produced with the file name of the input file specification and a default file type of LIS. If you specify a file specification as an argument, that file specification is used as the output file.

The listing file contains the following information:

All messages generated by the tag translator
All messages generated by the text processor
All messages generated by the device converter
A brief summary section. This summary includes the following information:
- The original command line
- The time and day that processing began
- The total CPU time used

If you are running DOCUMENT as a batch job and want a complete log file (including output from your LOGIN.COM, symbol definitions, and so on), you should use the /LOG qualifier instead of the /LIST qualifier. Do not use /LOG, however, if you are using the symbol generator.

/LOG

/NOLOG

Specifies whether informational messages are issued during processing. The /LOG qualifier is the default and specifies that informational messages are issued. The /NOLOG qualifier suppresses informational messages.

The following example shows the typical informational messages displayed during tag translation:

$ DOCUMENT myarticle ARTICLE LN03 %DOC-I-IDENT, DECdocument V3.0 [ T a g T r a n s l a t i o n ]... %TAG-I-DEFSLOADD, End of Loading of Tag Definitions %TAG-I-ENDPASS_1, End of first pass over the input [ T e x t F o r m a t t i n g ]...

If you are running DOCUMENT as a batch job and do not need a complete log file (including output from your LOGIN.COM, symbol definitions, and so on), you can use the /LIST qualifier instead of the /LOG qualifier.

/MAP[=file spec]

/NOMAP

Specifies whether all the input files processed by DECdocument are listed in a file. This file starts with the SDML input file and includes the tag table and any SDML files specified by the /INCLUDE or /SYMBOLS qualifier or the <ELEMENT> or <INCLUDE> tags. Files that are included by other files are indented under those files in this listing. The default file type is MAP_LIS. The default qualifier is /NOMAP.

The /MAP qualifier is valid only if tag translation is being done. If you specify /NOTAG_TRANSLATOR with the /MAP qualifier, DECdocument issues a warning message stating that you specified an illegal combination of command elements.

/MASTER_INDEX[=(index keyword [,index keyword...])]

/NOMASTER_INDEX

Causes indexing files to be collated into a master index file.

When you specify the /MASTER_INDEX qualifier, DECdocument expects a master index data file as the input file. This data file lists the index output (INX) files generated from the individual books that are being referenced in the master index. The default file type of this input file is INX_LIST.

This qualifier accepts the same optional indexing keywords as the /INDEX qualifier. See the description of the /INDEX qualifier for a list of these keywords and their uses.

This qualifier has no effect for Bookreader output. For more information on generating a master index, see Producing Online and Printed Documentation.

/OUTPUT=file spec

Specifies a new name for the output file. If you do not use the /OUTPUT qualifier, the output file is given the same file name as the input file, but with a file type based on the other qualifiers and destination chosen.

An example of a command line that uses the /OUTPUT qualifier follows:

$ DOC somefile LETTER LN03 /NOTEXT_FORMATTER /OUTPUT=anotherfile

This command line creates the file ANOTHERFILE.TEX, because processing was completed before the text formatter was run. If you omit /NOTEXT_FORMATTER from the preceding command line, the output file is ANOTHERFILE.LN03.

The following table lists the output file types and the default destination keywords that produce them.

Default Destination Keyword Default File Type

BOOKREADER DECW$BOOK

HELP HLP

LINE LINE

LN03 LN03

MAIL TXT

PS PS

TERMINAL TERM

Default Destination Keyword	Default File Type
BOOKREADER	DECW$BOOK
HELP	HLP
LINE	LINE
LN03	LN03
MAIL	TXT
PS	PS
TERMINAL	TERM

/PRINT[=(qualifier keyword [,qualifier keyword...])]

/NOPRINT

Specifies whether the output file is printed. /NOPRINT is the default.

You can use any of the DCL PRINT command qualifiers as keywords to the /PRINT qualifier. For example, if you want to print two copies of a DECdocument file with no flag page, you can use the PRINT command as follows:

$ PRINT/NOFLAG/COPIES=2 somefile.line

You can specify the same options using the following /PRINT qualifier on the DOCUMENT command line:

$ DOC/NOTAG/NOTEXT/NODEV somefile - _$/PRINT=(NOFLAG,COPIES=2) LETTER LINE

You can double-space your output, but only for monospaced destinations: LINE, MAIL, and TERMINAL. For example, the following command produces double-spaced MAIL output:

$ DOCU somefile.mail MAIL MAIL/PRINT=SPACE

You can enter multiple arguments to the /PRINT qualifier keyword on the DOCUMENT command line by enclosing the arguments in three pairs of quotation marks. For example:

$ DOCU somefile.sdml SOFT.REF PS - _$\PRINT=(NOTIFY,PARAMETER="""(MESSAGE=PRINT, - _$DATA=POSTSCRIPT)""", QUEUE=PS_PRINT)

Default print queues for each of the destination keywords available at your site are established when DECdocument is installed. These queues include all DCL PRINT command qualifiers needed for correct printing on that output device.

If you choose to specify a print queue other than SYS$PRINT, the default, you must also specify the correct qualifier keywords needed for that queue. These keywords vary depending on the type of file you want to print (indicated by the file extension) and the type of output device. The following table shows the keywords to use for each file and output device combination.

Output
File Type Print
Device DOCUMENT /PRINT Qualifier-Keywords

LINE Line Printer
LN03 Laser Printer
LN03 PLUS Laser Printer /PRINT=(QUEUE=queuename)

LN03R SCRIPTPRINTER
PRINTSERVER 40 /PRINT=(QUEUE=queuename)

LN03 LN03 Laser Printer
LN03 PLUS Laser Printer /PRINT=(QUEUE=queuename)

LN03R SCRIPTPRINTER
PRINTSERVER 40 /PRINT=(QUEUE=queuename)

PS LN03R SCRIPTPRINTER
PRINTSERVER 40 /PRINT=(QUEUE=queuename)

Output File Type	Print Device	DOCUMENT /PRINT Qualifier-Keywords
LINE	Line Printer LN03 Laser Printer LN03 PLUS Laser Printer	/PRINT=(QUEUE=queuename)
	LN03R SCRIPTPRINTER PRINTSERVER 40	/PRINT=(QUEUE=queuename)

LN03	LN03 Laser Printer LN03 PLUS Laser Printer	/PRINT=(QUEUE=queuename)
	LN03R SCRIPTPRINTER PRINTSERVER 40	/PRINT=(QUEUE=queuename)

PS	LN03R SCRIPTPRINTER PRINTSERVER 40	/PRINT=(QUEUE=queuename)

If you want to print your file using the DCL PRINT command, the following table shows the qualifiers you must use for each supported device.

Output
File Type Print
Device DCL PRINT Command Qualifiers

LINE Line Printer
LN03 Laser Printer
LN03 PLUS Laser Printer $ PRINT filename.LINE
_$ /QUEUE=queuename

LN03R SCRIPTPRINTER
PRINTSERVER 40 $ PRINT/PARAM=(DATA_TYPE=ANSI) filename.LINE
_$ /QUEUE=queuename

LN03 LN03 Laser Printer
LN03 PLUS Laser Printer $ PRINT/NOFEED/PASSALL filename.LN03
_$ /QUEUE=queuename

LN03R SCRIPTPRINTER
PRINTSERVER 40 $ PRINT/PARAM=(DATA_TYPE=ANSI) filename.LN03
_$ /QUEUE=queuename

PS LN03R SCRIPTPRINTER
PRINTSERVER 40 $ PRINT/PARAM=(DATA_TYPE=POST) filename.PS
_$ /QUEUE=queuename

Output File Type	Print Device	DCL PRINT Command Qualifiers
LINE	Line Printer LN03 Laser Printer LN03 PLUS Laser Printer	$ PRINT filename.LINE _$ /QUEUE=queuename
	LN03R SCRIPTPRINTER PRINTSERVER 40	$ PRINT/PARAM=(DATA_TYPE=ANSI) filename.LINE _$ /QUEUE=queuename

LN03	LN03 Laser Printer LN03 PLUS Laser Printer	$ PRINT/NOFEED/PASSALL filename.LN03 _$ /QUEUE=queuename
	LN03R SCRIPTPRINTER PRINTSERVER 40	$ PRINT/PARAM=(DATA_TYPE=ANSI) filename.LN03 _$ /QUEUE=queuename

PS	LN03R SCRIPTPRINTER PRINTSERVER 40	$ PRINT/PARAM=(DATA_TYPE=POST) filename.PS _$ /QUEUE=queuename

Note that if any serious errors are encountered during processing, the file is not sent to the print device.

/PROFILE=file spec

Specifies that the input file is a book element and that a cross-reference data file previously created by a DECdocument bookbuild be used to resolve any cross references in the input file. Specify the cross-reference data file as an argument to the /PROFILE qualifier; it has a file type of XREF. For more information on using the /PROFILE qualifier, see Producing Online and Printed Documentation.

The /PROFILE qualifier is valid only if tag translation is being done. If you specify /NOTAG_TRANSLATOR with the /PROFILE qualifier, DECdocument issues a warning message stating that you specified an illegal combination of command elements.

/SYMBOLS=file spec

/NOSYMBOLS

Controls whether a file of symbol definitions is read automatically during tag translation. The default qualifier is /NOSYMBOLS. The SDML input file accessed through the /SYMBOLS qualifier should contain only symbol definitions created by the <DEFINE_SYMBOL> and the <DEFINE_BOOK_NAME> tags. You can use the /SYMBOLS qualifier on the command line only once. For more information on using the /SYMBOLS qualifier, see Producing Online and Printed Documentation.

The /SYMBOLS qualifier is valid only if tag translation is being done. If you specify /NOTAG_TRANSLATOR with the /SYMBOLS qualifier, DECdocument issues a warning message stating that you specified an illegal combination of command elements.

/TAG_TRANSLATOR

/NOTAG_TRANSLATOR

Controls whether the tag translator is run. If you do not specify this qualifier, the default qualifier is /TAG_TRANSLATOR.

By default, the tag translator produces an output file with the file name of the input file and a file type of TEX. You can then use this file as an input file to the text formatter. Using /NOTAG_TRANSLATOR excludes tag translation and the following related qualifiers: /CONDITION, /ELEMENT, /DIAGNOSTICS, /INCLUDE, /MAP, /PROFILE, and /SYMBOLS. For more information on using the /TAG_TRANSLATOR qualifier, see Producing Online and Printed Documentation.

/TEXT_FORMATTER

/NOTEXT_FORMATTER

Controls whether the text formatting program is run. If you specify /NOTEXT_FORMATTER, DECdocument processing stops after the tag translator completes, and text formatting and the following related qualifiers are excluded: /CONTENTS and /INDEX. /TEXT_FORMATTER is the default.

If you specify /NOTAG_TRANSLATOR and the input file you specify on the command line does not include a file type, the default file type is TEX. The output file from the text formatter can have one of several file types based on the destination entered on the command line. These default output file types and their related destination keywords are given in the following list.

Destination
Keyword Intermediate
Output File Type Final
Output File Type

BOOKREADER DVI_BOOKREADER DECW$BOOK

HELP None. HLP

LINE DVI_LINE LINE

LN03 DVI_LN03 LN03

MAIL DVI_LINE TXT

PS DVI_PS PS

TERMINAL DVI_LINE TERM

You can then use the output file from the text formatter as an input file to the device converter.

Destination Keyword	Intermediate Output File Type	Final Output File Type
BOOKREADER	DVI_BOOKREADER	DECW$BOOK
HELP	None.	HLP
LINE	DVI_LINE	LINE
LN03	DVI_LN03	LN03
MAIL	DVI_LINE	TXT
PS	DVI_PS	PS
TERMINAL	DVI_LINE	TERM

Example

When you process your input file using the DOCUMENT command, you are actually running your file through several processors. The following example shows a typical use of the DECdocument command:

$ DOCUMENT myreport.SDML REPORT LN03 /CONTENTS
 
%DOC-I-IDENT, DECdocument V3.0
[ T a g   T r a n s l a t i o n ]...
%TAG-I-DEFSLOADD, End of Loading of Tag Definitions
%TAG-I-ENDPASS_1, End of first pass over the input
[T e x t   F o r m a t t i n g ]...
%TEX-I-PAGESOUT, 17 pages written.
-TEX-I-OUTFILENAME, 'DUA1:[DOCFILES]MYREPORT.DVI_LN03'
[ C o n t e n t s   G e n e r a t i o n ]...
[ T e x t   F o r m a t t i n g   C o n t e n t s ]...
%TEX-I-PAGESOUT, 1 page written.
-TEX-I-OUTFILENAME, 'DUA1:[DOCFILES]MYREPORT_CONTENTS.DVI_LN03'
[ D e v i c e   C o n v e r s i o n ]...
%DVC-I-PAGESOUT, 18 pages written to file:
   DUA1:[DOCFILES]MYREPORT.LN03
[ C o n t e n t s   D e v i c e   C o n v e r s i o n ]...
%DVC-I-PAGESOUT, 1 page written to file:
   DUA1:[DOCFILES]MYREPORT_CONTENTS.LN03
[ P r i n t i n g   F i l e ]...
Job MYREPORT (queue SYS$LN03, entry 833) started on SYS$LN03
 
[ P r i n t i n g   C o n t e n t s]...
Job MYREPORT_CONTENTS (queue SYS$LN03, entry 834) started on SYS$LN03
$

DOCUMENT/GENERATE_SYMBOL

Starts the DECdocument symbol generator.

Format

DOCUMENT/GENERATE_SYMBOL [/LIST[=file-name]] [/PREFIX=
prefix-name] input-file

Command Qualifier Default

/LIST[=file-name] /NOLIST

/PREFIX=prefix-name Up to 25 characters of the input-file.

Command Qualifier	Default
/LIST[=file-name]	/NOLIST
/PREFIX=prefix-name	Up to 25 characters of the input-file.

restrictions

The /GENERATE_SYMBOL command must immediately follow the DOCUMENT command.

PARAMETERS

input-file
Specifies the input file to be processed. You cannot use wildcards in the input file specification.
The default file type of the input file is SDML.

DESCRIPTION

DOCUMENT/GENERATE_SYMBOL is the command you specify to start the symbol generator. It requires one parameter:

Input File
Specifies the input file for the symbol generator. By default, this file is an SDML file containing SDML tags.

The symbol name that is created consists of a prefix that you supply, with an appended sequential number that DECdocument generates. DECdocument creates a new version of the SDML file with symbol names added to tags that did not already have symbol names. The original SDML file is not deleted.
You can use the symbol generator on your profile file. You can also use the symbol generator on SDML files that use the <INCLUDE> tag; the symbol generator adds symbols to any file that DECdocument includes with the <INCLUDE> tag.
For information on how to use the symbol generator, see Producing Online and Printed Documentation.

QUALIFIERS

/LIST[=file name]

/NOLIST
Specifies whether a listing file is produced. The /NOLIST qualifier is the default and suppresses the generation of a listing file. If you do not specify a file specification as an argument to the /LIST qualifier, a listing file is produced with the file name of the input file specification and a default file type of LIS. If you specify a file specification as an argument, that file specification is used as the output file.
The listing file contains the following information:

All messages generated by the tag translator
A brief summary section. This summary includes the following information:

Original command line
Time and day that processing began
Total CPU time used

/PREFIX=prefix-name
Specifies the prefix you want appended to each symbol name in your file, including any included files. If you do not specify a prefix-name, a default prefix of up to 25 characters of the input-file name is used. If the input-file exceeds a length of 25 characters, the remaining characters are truncated. Any alphanumeric character is valid. Invalid characters are changed to underscores only when the default prefix is used.
For example, you could use the following command:
$ DOCUMENT/GENERATE_SYMBOL/LIST/PREFIX=ABC MYFILE.SDML

Contents

Index

DECdocument Command Summary and Processing Messages

/KEEP[=(filetype keyword [,filetype keyword...] )]

/NOKEEP

/LIST[=file-name]

/NOLIST

/LOG

/NOLOG

/MAP[=file spec]

/NOMAP

/MASTER_INDEX[=(index keyword [,index keyword...])]

/NOMASTER_INDEX

/OUTPUT=file spec

/PRINT[=(qualifier keyword [,qualifier keyword...])]

/NOPRINT

/PROFILE=file spec

/SYMBOLS=file spec

/NOSYMBOLS

/TAG_TRANSLATOR

/NOTAG_TRANSLATOR

/TEXT_FORMATTER

/NOTEXT_FORMATTER

Example

DOCUMENT/GENERATE_SYMBOL

Format

DOCUMENT/GENERATE_SYMBOL [/LIST[=file-name]] [/PREFIX= prefix-name] input-file

restrictions

PARAMETERS

input-file

DESCRIPTION

QUALIFIERS

/LIST[=file name]

/NOLIST

/PREFIX=prefix-name

DECdocument
Command Summary and
Processing Messages

DOCUMENT/GENERATE_SYMBOL [/LIST[=file-name]] [/PREFIX=
prefix-name] input-file