═══ 1. Title Page ═══ BookMaster Online Reference Release 3.0 Mike Temple TEMPLE at RCHVMW2 This information is adapted from the BookMaster User's Guide, SC34-5009 and the BookMaster Messages, SC34-5107. ═══ 2. Tags ═══ This section describes the BookMaster tags. The tags are listed in alphabetic order and the descriptions include the following: o The purpose of the tag o The format and attributes of the tag o Examples of using the tag To view the list of tags, return to the Contents and click on the plus sign (+) or press the + key. ═══ 2.1. ABBREV Abbreviations ═══ ABBREV Abbreviations Purpose The ABBREV tag identifies a special section containing a list of abbreviations. It starts a new page and provides the text for the level-1 heading: "List of Abbreviations" and the running foot. You can specify an alternative to this default heading after any attributes and the period. The list of abbreviations can be included anywhere in a book, but is usually placed with the front or back matter. After the tag, the list of abbreviations can best be entered using the definition list tags. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ABBREV │ abbreviation │ ID= │ Text on same line │ │ │ │ section │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :abbrev stitle='Abbreviations'.Abbreviations used in this book :dl. :dt.ABC :dd.Aarvark Building Center . . . :edl. ═══ 2.2. ABSTRACT Abstract ═══ ABSTRACT Abstract Purpose The ABSTRACT tag identifies a special section containing a summary of the document. It starts a new page and provides the text for the level-1 heading: "Abstract" and the running foot. You can specify an alternative to this default heading after any attributes and the period. An abstract is usually placed in the beginning of a book, following the title page. It can contain any of the basic document elements, and is terminated by another level-1 head tag or equivalent. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ABSTRACT │ abstract │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :abstract. :P.This document contains... ═══ 2.3. ADDRESS Address ═══ ADDRESS Address Purpose When used in the prolog, the ADDRESS tag usually identifies the address of the author or publisher. Address structures can occur anywhere in text. ADDRESS requires a matching end tag. The individual lines containing the text of the address are identified by the ALINE tag. As many address structures can be specified as necessary, and each address structure can contain multiple address lines. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ADDRESS │ address │ │ Text for each │ :EADDRESS │ │ │ │ │ line must be on a │ │ │ │ │ │ separate line │ │ │ │ │ │ with no tags in │ │ │ │ │ │ it. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :address. 10Q/123-4 Publishing Solutions Bookie Town, Colorado 12345 :eaddress. ═══ 2.4. ALINE Address line ═══ ALINE Address line Purpose The ALINE tag identifies each individual line of an address. It can appear only within an address structure, that is, between an ADDRESS tag and its matching end tag. Following the tag is the text for each line of the address. This tag is no longer needed, but can still be used. See the ADDRESS tag for more information. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ALINE │ address line │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :address. :aline.10Q/123-4 :aline.Publishing Systems Business Unit :aline.ISILAND, Colorado 12345 :eaddress. ═══ 2.5. ANNOT Annotation ═══ ANNOT Annotation Purpose The ANNOT tag identifies an annotation or comment that is inserted in the document for the benefit of the author or reviewer. These comments can then be selectively printed in a formatted document. This tag requires a matching end tag. Printing of comments within the ANNOT tag and its matching end tag is controlled by SYSVAR A. To print these comments in a formatted printout, SYSVAR A must be set to YES. For example: SYSVAR (A YES) Because no indicator is automatically generated by the ANNOT tag, it is recommended that you also use something like a labeled box to call attention to your text. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ANNOT │ annotation │ │ No immediate │ :EANNOT │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :annot. :lblbox.Hey Reviewers! :P.Is this really true? :elblbox. :eannot. ═══ 2.6. ANSREF Answer reference ═══ ANSREF Answer reference Purpose The ANSREF tag refers to the answer to a particular question and the page on which the answer occurs. For cross references, the name on the REFID attribute of the ANSREF tag refers to a name on an ID attribute of a QUESTION tag. You must have a corresponding ANSWER tag in your document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ANSREF │ answer refer- │ FORM= │ Self-contained. │ │ │ │ ence │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.Check your answers starting with :ansref refid=jbl1.. ═══ 2.7. ANSWER Answer ═══ ANSWER Answer Purpose The ANSWER tag specifies the location for the correct answer to a question. This answer can be included within the markup for the question itself. To print the answer, just enter the ANSWER tag with a pointer (REFID) to the question. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ANSWER │ answer │ REFID= │ Self-contained. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :answer refid=fil2. ═══ 2.8. APL APL characters ═══ APL APL characters Purpose The APL tag identifies a string of APL text characters that will print in the APL character font. This tag requires a matching end tag. APL characters can occur anywhere in text where tags are allowed. The actual APL character string must be entered with an APL keyboard with APL set on and the appropriate editor setup (in XEDIT, the command "set apl on"). The successful printing of APL characters depends on your having a device that can print them. The NAMEIT macro provides the facility to include APL characters in headings, figure captions, index entries, and other contexts where the APL tag itself is not allowed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :APL │ APL │ │ APL text. │ :EAPL │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :apl. )LOAD :pv.docname:epv. :eapl. ═══ 2.9. APPENDIX Appendix section ═══ APPENDIX Appendix section Purpose The APPENDIX tag identifies a major section of a document that contains explanatory and illustrative material helpful to the reader, but not essential to the main text. The appendix section occurs immediately after the body section. It can contain one or more first-level headings. Each first-level heading in the appendix section is prefixed with the word "Appendix" and lettered serially, starting with "A." Therefore, when entering H1 tags in the appendix section of your document, do not include the phrase "Appendix A" (for example) in the text of the heading. The appendix section is implicitly ended by the back matter (BACKM) tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :APPENDIX │ appendix │ │ No immediate │ │ │ │ section │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :appendix. :h1.Horizontal and Vertical Space Measurement :h1.Characters Available as Symbols :h1.Special Examples ═══ 2.10. ARTALT Art work alternative ═══ ARTALT Art work alternative Purpose The ARTALT tag is mainly for BookManager. It allows a graphic to appear on graphics displays, or text on non-graphics displays. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ARTALT │ artwork │ ADJUST= │ Self-contained. │ :EARTALT │ │ │ alternative │ ALIGN= │ │ │ │ │ │ BOTMAR= │ │ │ │ │ │ DEPTH= │ │ │ │ │ │ LABEL= │ │ │ │ │ │ NAME= │ │ │ │ │ │ NORUNIN │ │ │ │ │ │ REFID= │ │ │ │ │ │ RUNIN │ │ │ │ │ │ TOPMAR= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ADJUST=+vertical-space │ │ Specifies the placement of artwork rela- │ │ -vertical-space │ tive to the baseline. ADJUST is used │ │ │ with the RUNIN attribute. │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of the artwork │ │ LEFT │ on the page. │ │ RIGHT │ │ │ horizontal-space │ │ │ -horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ BOTMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the bottom of the │ │ │ artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEPTH=vertical space │ Specifies that space is to be left to │ │ │ paste or otherwise include artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ LABEL='artwork-name' │ Specifies a label to be printed in the │ │ │ space left by the DEPTH attribute, to │ │ │ identify the piece of art that is to be │ │ │ pasted in at that point. │ +──────────────────────────────+──────────────────────────────────────────+ │ NAME= │ Specifies the name of the artwork to be │ │ │ included. This name must match the name │ │ │ of a PSEGxxxx that is available to the │ │ │ printer. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the top of the artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH= │ Specifies the width of the artwork, or │ │ COLUMN │ the width of the rule to draw. │ │ TEXTLINE │ │ │ horizontal space │ TEXTLINE will set the table or artwork │ │ │ at the current indent. │ +──────────────────────────────+──────────────────────────────────────────+ │ RULE │ Specifies that a horizontal rule the │ │ │ width of the artwork be drawn. │ +──────────────────────────────+──────────────────────────────────────────+ │ NORUNIN │ Specifies that the artwork to be │ │ │ included is put on a new line. │ +──────────────────────────────+──────────────────────────────────────────+ │ RUNIN │ Specifies that the artwork is to be put │ │ │ in the current line. │ +──────────────────────────────+──────────────────────────────────────────+ Examples On a graphics display or printer, display the graphic BIGBEAR, on a non-graphics display or printer, print a description: :artalt name=bigbear. :p.Here's one-thousand words to describe what a big bear looks like. ═══ 2.11. ARTDEF Art definition ═══ ARTDEF Art definition Purpose The ARTDEF tag can be placed in the prolog to set up a "default" definition for the artwork in your book. It can also be used to define the artwork attributes for some art you're going to use more than once. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ARTDEF │ artwork defi- │ ALIGN= │ No immediate │ │ │ │ nition │ BOTMAR= │ text. │ │ │ │ │ DEPTH= │ │ │ │ │ │ ID= │ │ │ │ │ │ LABEL= │ │ │ │ │ │ NAME= │ │ │ │ │ │ TOPMAR= │ │ │ │ │ │ WIDTH= │ │ │ │ │ │ RULE │ │ │ │ │ │ NORUNIN │ │ │ │ │ │ RUNIN │ │ │ │ │ │ ADJUST= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of the artwork │ │ LEFT │ on the page. │ │ RIGHT │ │ │ horizontal-space │ │ │ -horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ BOTMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the bottom of the │ │ │ artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEPTH=vertical space │ Specifies that space is to be left to │ │ │ paste or otherwise include artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ LABEL='artwork-name' │ Specifies a label to be printed in the │ │ │ space left by the DEPTH attribute, to │ │ │ identify the piece of art that is to be │ │ │ pasted in at that point. │ +──────────────────────────────+──────────────────────────────────────────+ │ NAME= │ Specifies the name of the artwork to be │ │ │ included. This name must match the name │ │ │ of a PSEGxxxx that is available to the │ │ │ printer. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the top of the artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH= │ Specifies the width of the artwork, or │ │ COLUMN │ the width of the rule to draw. │ │ TEXTLINE │ │ │ horizontal space │ TEXTLINE will set the table or artwork │ │ │ at the current indent. │ +──────────────────────────────+──────────────────────────────────────────+ │ RULE │ Specifies that a horizontal rule the │ │ │ width of the artwork be drawn. │ +──────────────────────────────+──────────────────────────────────────────+ │ NORUNIN │ Specifies that the artwork to be │ │ │ included is put on a new line. │ +──────────────────────────────+──────────────────────────────────────────+ │ RUNIN │ Specifies that the artwork is to be put │ │ │ in the current line. │ +──────────────────────────────+──────────────────────────────────────────+ │ ADJUST= │ Specifies that runin artwork is to be │ │ +vertical space │ shifted up or down relative to the text │ │ -vertical space │ line. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :artdef topmar=1p botmar=1p label='Artwork not yet defined.' depth=2i. ═══ 2.12. ARTWORK Art work ═══ ARTWORK Art work Purpose The ARTWORK tag either: o Leaves white space for drawing board art to be pasted in to your document. o Imbeds a graphic drawn with DrawMaster (called a PSEG or page segment). o Draws a rule or line across the page for a specified width. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ARTWORK │ artwork │ ALIGN= │ Self-contained. │ │ │ │ │ BOTMAR= │ │ │ │ │ │ DEPTH= │ │ │ │ │ │ REFID= │ │ │ │ │ │ LABEL= │ │ │ │ │ │ NAME= │ │ │ │ │ │ TOPMAR= │ │ │ │ │ │ WIDTH= │ │ │ │ │ │ RULE │ │ │ │ │ │ NORUNIN │ │ │ │ │ │ RUNIN │ │ │ │ │ │ ADJUST= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of the artwork │ │ LEFT │ on the page. │ │ RIGHT │ │ │ horizontal-space │ │ │ -horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ BOTMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the bottom of the │ │ │ artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEPTH=vertical space │ Specifies that space is to be left to │ │ │ paste or otherwise include artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ LABEL='artwork-name' │ Specifies a label to be printed in the │ │ │ space left by the DEPTH attribute, to │ │ │ identify the piece of art that is to be │ │ │ pasted in at that point. │ +──────────────────────────────+──────────────────────────────────────────+ │ NAME= │ Specifies the name of the artwork to be │ │ │ included. This name must match the name │ │ │ of a PSEGxxxx that is available to the │ │ │ printer. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPMAR=vertical space │ Specifies the amount of vertical space │ │ │ to be added to the top of the artwork. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH= │ Specifies the width of the artwork, or │ │ COLUMN │ the width of the rule to draw. │ │ TEXTLINE │ │ │ horizontal space │ TEXTLINE will set the table or artwork │ │ │ at the current indent. │ +──────────────────────────────+──────────────────────────────────────────+ │ RULE │ Specifies that a horizontal rule the │ │ │ width of the artwork be drawn. │ +──────────────────────────────+──────────────────────────────────────────+ │ NORUNIN │ Specifies that the artwork to be │ │ │ included is put on a new line. │ +──────────────────────────────+──────────────────────────────────────────+ │ RUNIN │ Specifies that the artwork is to be put │ │ │ in the current line. │ +──────────────────────────────+──────────────────────────────────────────+ │ ADJUST= │ Specifies that runin artwork is to be │ │ +vertical space │ shifted up or down relative to the text │ │ -vertical space │ line. │ +──────────────────────────────+──────────────────────────────────────────+ Examples: To imbed a PSEG named BIGBEAR: :artwork name=bigbear. To imbed a PSEG named TINYBEAR on the same line as some text: Here's :artwork name=tinybear runin adjust='p4'. tinybear! To draw a line the width of the currect text line: :artwork rule width=textline. ═══ 2.13. ASMLIST Assembly List ═══ ASMLIST Assembly List Purpose The ASMLIST tag gives you an alphabetic listing of the headings from the PARTSASM tags, together with the pages on which those headings appear. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ASMLIST │ assembly list │ │ No immediate │ │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :asmlist. ═══ 2.14. ATTACH Attachment ═══ ATTACH Attachment Purpose The ATTACH tag indicates attachments for a cover letter. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ATTACH │ attachment to │ │ Text on same line │ │ │ │ cover letter │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :attach. ═══ 2.15. AUTHOR Author of document ═══ AUTHOR Author of document Purpose The AUTHOR tag identifies the author or authors of a document. It can be repeated as many times as there are authors. The AUTHOR tag can appear only within the prolog. When printed on the title page, the author's name appears between the document number and the address. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :AUTHOR │ author of │ TEXT= │ Text on same line │ │ │ │ document │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to precede the author's │ │ │ name, like a title. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :author text='Writer'.M R Bill :author text='Editor'.P Q Harbrase ═══ 2.16. AUTOLINK Automatic Hypertext Links ═══ AUTOLINK Automatic Hypertext Links Purpose Identifies BookManager hypertext links from one document to another. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :AUTOLINK │ link iden- │ CLASS= │ No immediate │ │ │ │ tification │ DOCID= │ text. │ │ │ │ for implicit │ │ │ │ │ │ interdocument │ │ │ │ │ │ links │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CLASS=CODE │ GT │ │ Identifies the class of information to │ │ LEN │ MSGNO │ be implicitly linked. │ +──────────────────────────────+──────────────────────────────────────────+ │ DOCID=name │ Specifies the name associated with a │ │ │ DOCDESC tag. The name can be up to │ │ │ seven characters. The first character │ │ │ must be a letter and all letters should │ │ │ be lowercase. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docdesc id=mastglos ... :autolink class=gt docid=mastglos. ═══ 2.17. BACKM Back matter ═══ BACKM Back matter Purpose The BACKM tag identifies the back matter of a document. The back matter usually contains reference material such as a glossary and an index. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BACKM │ back matter │ │ No immediate │ │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :backm. :glossary. :index. :euserdoc. ═══ 2.18. BIBLIOG Bibliography ═══ BIBLIOG Bibliography Purpose The BIBLIOG tag identifies a page devoted to a list of books. It starts a new page and provides the text for the level-1 heading: "Bibliography" and the running foot. You can specify an alternative to this default heading after any attributes and the period. A bibliography usually appears within the back matter of the document and is formatted as a list. Each book title should be identified with a CIT tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BIBLIOG │ bibliography │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPIC= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :bibliog. :ol. :li.:cit.BookMaster User's Guide:ecit., SC34-5009 :eol. ═══ 2.19. BIN Binary number ═══ BIN Binary number Purpose The BIN tag identifies a number that must be recognized as a binary number to prevent confusing it with a decimal number. This tag requires a matching end tag. Binary numbers can occur anywhere in text where a tag is allowed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BIN │ binary number │ │ Numeric binary │ :EBIN │ │ │ │ │ data. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.The program is stored at :BIN.1011:EBIN. through :BIN.1111:EBIN. ═══ 2.20. BINDNUM Binder number ═══ BINDNUM Binder number Purpose The BINDNUM tag specifies the binder number of a document. It is placed in the prolog. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BINDNUM │ binder number │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :bindnum.Volume 3 ═══ 2.21. BLANK Fill-in blank ═══ BLANK Fill-in blank Purpose The BLANK tag puts blank space with an underscore rule in a fill-in-the-blank question. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BLANK │ fill-in blank │ ANS= │ Self-contained. │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ANS='answer text' │ Specifies the text of the answer to a │ │ │ question. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH= │ Specifies the width of the blank line │ │ COLUMN │ for the answer to a question. │ │ horizontal space │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :blank width=7p ans='tennis'. ═══ 2.22. BODY Body of Document ═══ BODY Body of Document Purpose The BODY tag identifies a major element containing the main section of the document. The body section occurs immediately after the front matter section. It contains parts (level-zero headings), Parts (level-one headings), as well as any number of lower-level headings, structures, and other elements. The pages of the body of the document are numbered in Arabic numerals. The body section is implicitly ended by an APPENDIX or BACKM (back matter) tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :BODY │ body of docu- │ │ No immediate │ │ │ │ ment │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :toc. :figlist. :tlist. :body. :h0 id=intro.Introduction ═══ 2.23. C Cell (Table) ═══ C Cell (Table) Purpose The C tag is used after the ROW tag (which defines the table row). The C tag is used to identify the text for each column of the table. It is necessary to use one tag for each column. You may repeat the tag until the 64th column is reached. C is valid only within a table. If the rightmost column or columns are empty, it is not necessary to include the C tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :C │ cell (table) │ n │ Bracketed text. │ [:EC] │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ n │ The number of the current cell. This is │ │ │ optional, but must be used if the next │ │ │ cell to be filled is not the next cell │ │ │ in numeric sequence. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :row. :c.first column :c.next column :c 5.fifth column ═══ 2.24. CAUSE Possible Cause for MAP ═══ CAUSE Possible Cause for MAP Purpose The CAUSE tag identifies the cause of the symptom in a map in a maintenance library document. It generates a compact unordered list. CAUSE must be placed within a MAP quick fix table (MAPQFIX). There may be multiple causes within a MAP quick fix table. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CAUSE │ map of pos- │ │ Implied para- │ │ │ │ sible cause │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :map.... :mapqfix. :xpl.Six-month-old Baby Johnny was sleeping peacefully; suddenly he began to cry. :cause.Johnny is wet. :emapqfix. :step. :ct.Check Johnny's diaper. :emap. ═══ 2.25. CAUTION Caution ═══ CAUTION Caution Purpose The CAUTION tag identifies one or more paragraphs containing a statement about a condition that could cause damage to equipment. The complete caution statement is printed in bold type. It can occur anywhere in your text. The CAUTION tag must be preceded by a paragraph (P), list item (LI), or list part (LP) tag. Within a list, it aligns with the text of a list item. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CAUTION │ caution │ TRANS= │ Any text; any- │ :ECAUTION │ │ │ │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TRANS=number │ Specifies the number of lines to be │ │ │ printed for translation space. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.:caution trans=5. A caution statement warns of anything that could cause equipment loss. :p.Additional paragraphs for the caution statement can be entered with the paragraph tag. :ecaution. ═══ 2.26. CGDEF Character Graphic Definition ═══ CGDEF Character Graphic Definition Purpose This is the definition tag for CGRAPHIC (character graphic). This tag has the same attributes as the CGRAPHIC tag - having specified the attribute on the CGDEF tag, it is not necessary to specify it again on the CGRAPHIC tag. CGDEF also has an ID attribute, which is the means by which a CGRAPHIC tag asks for a particular definition - with a matching REFID attribute. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CGDEF │ character │ SCALE= │ No immediate │ │ │ │ graphic defi- │ WIDTH= │ text. │ │ │ │ nition │ ID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :CGDEF id=luvwx2t scale='.9'. :CGRAPHIC refid=luvwx2t. :ECGRAPHIC. ═══ 2.27. CGRAPHIC Character graphic ═══ CGRAPHIC Character graphic Purpose The CGRAPHIC tag identifies a diagram, chart, or other illustration. This tag requires a matching end tag. The CGRAPHIC tag can also contain a CGRAPHIC description, identified by the CGDEF tag and referred to by the refid attribute. CGRAPHIC can occur anywhere in text, except within other CGRAPHICs, examples or footnotes. Any text between the CGRAPHIC tag and its matching end tag is printed as it is entered. Use the CHARGE (character graphic editor) within XEDIT to draw the diagrams. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CGRAPHIC │ character │ SCALE= │ Bracketed text. │ :ECGRAPHIC │ │ │ graphic │ WIDTH= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :cgraphic refid=luvwx2t. ┌──────┐ │ │ │ Go ├───To Here └──────┘ :ecgraphic. ═══ 2.28. CHAR Character value ═══ CHAR Character value Purpose The CHAR tag identifies a value that must be recognized as a character value to prevent confusing it with something else (hex or bin). This tag requires a matching end tag. Character values can occur anywhere in text where a tag is allowed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CHAR │ character │ │ Character data. │ :ECHAR │ │ │ value │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.Enter the value :CHAR.ABCD:ECHAR.. ═══ 2.29. CHOICE Multiple Choice ═══ CHOICE Multiple Choice Purpose The CHOICE tag identifies a choice in a multiple choice or matching question. o Multiple choice questions The CHOICE tag identifies the choices. You can include a name (ID) to indicate the correct choice and then use the ANSID attribute on the QUESTION tag to refer to the name of this correct choice. Because the correct choice is identified by name, you can add, delete, or rearrange choices without changing your existing markup. You can put any number of choices within a question. o Matching questions The CHOICE tag identifies a choice that must be matched to another item. You can include a name (ID) to indicate the correct choice and then use the ANSID attribute on the MATCH tag to associate each choice with a matching item. Because the correct matches are identified by name, you can add, delete, or rearrange choices and matching items, or rearrange them without changing your existing markup. You can put as many choices and matching items as you need within a question. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CHOICE │ multiple │ ID= │ Implied para- │ │ │ │ choice or │ │ graph. │ │ │ │ matching │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :question form=MC id=muc2 ansid=mucb. After winning a tennis match, the first thing you should do is: :choice.Leap over the net to gloat over your victory. :choice.Fall on your knees and scream. :choice id=mucb.Leap over the net and (with great control) shake the hand of your poor opponent. :equestion. ═══ 2.30. CI Component Item (Assembly List) ═══ CI Component Item (Assembly List) Purpose The CI tag identifies the component item within a component list (COMPL) in a maintenance library document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CI │ component │ ID= │ Implied para- │ │ │ │ item │ IXNUM= │ graph. │ │ │ │ (assembly │ PARTNUM= │ │ │ │ │ list) │ UPA= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ IXNUM=part index number │ Specifies the index number of an item in │ │ │ a part list index. │ +──────────────────────────────+──────────────────────────────────────────+ │ PARTNUM=alphameric │ Specifies the part number associated │ │ │ with the component being being listed. │ +──────────────────────────────+──────────────────────────────────────────+ │ UPA=number │ Specifies the units per assembly in a │ │ │ parts catalog list. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :ci ixnum=2 partnum=5601234 upa=1.Frame assembly ═══ 2.31. CIREF Component Item Reference ═══ CIREF Component Item Reference Purpose The CIREF tag defines the CI tag which identifies the component item within a component list (COMPL) in a maintenance library document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CIREF │ component │ REFID= │ Self-contained. │ │ │ │ item refer- │ PAGE= │ │ │ │ │ ence │ FORM= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Specifies whether page numbers are │ │ NO │ included in cross-references. │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :cmt.For next higher assembly see :ciref refid=fwheel.. ═══ 2.32. CIT Title Citation ═══ CIT Title Citation Purpose The CIT tag identifies the title of a publication. It requires a matching end tag. Title citations are either underscored or printed in italics, depending on the device. They can occur anywhere in the text. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CIT │ title cita- │ DOCID= │ Any text; any- │ :ECIT │ │ │ tion │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DOCID=name │ Specifies the name associated with a │ │ │ DOCDESC tag. The name can be up to │ │ │ seven characters. The first character │ │ │ must be a letter and all letters should │ │ │ be lowercase. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :sl. :li.:cit.BookMaster User's Guide:ecit., SC34-5009 :li.:cit.Roget's International Thesaurus:ecit. :esl. ═══ 2.33. CMT Comment (Component List) ═══ CMT Comment (Component List) Purpose The CMT tag specifies up to one line of additional commentary about a main assembly or component item a maintenance library document. All comments are indented. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CMT │ comment (com- │ │ Any text; any- │ │ │ │ ponent list) │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :ci ixnum=2 partnum=5601234 upa=1.Frame assembly :cmt.These are units used in assembling a frame ═══ 2.34. CODE Code (Code List) ═══ CODE Code (Code List) Purpose The CODE tag identifies a code within a code list. It can be used only within a code list. The code number is highlighted on most devices. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CODE │ code (code │ │ Text on same line │ │ │ │ list) │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel. :code.0C4 :xpl.Occurs when.... : :ecodel. ═══ 2.35. CODEL Code List ═══ CODEL Code List Purpose The CODEL tag and its matching end tag identify a list of return codes, along with their associated documentation. The parts of a code list are identified separately by the tags associated with the CODEL tag. The tags associated with the CODEL tag serve to make corresponding subheadings uniform in each code description in your book. The attributes on the CODEL tag are used when you want to alter the default wording associated with each of these tags. Code lists are generally in the body of a book, although they can occur anywhere a basic document element is allowed. Only those items applicable to the particular code need be included. Code lists cannot be nested. Heading tags are not allowed within a code list. If this tag has not been properly ended when a heading tag is encountered, the code list is terminated and a warning message issued. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CODEL │ code list │ CODESEL= │ No immediate │ :ECODEL │ │ │ │ DEST= │ text. │ │ │ │ │ INDENT= │ │ │ │ │ │ MODULE= │ │ │ │ │ │ NUMBYTES= │ │ │ │ │ │ ORESP= │ │ │ │ │ │ PREFIX= │ │ │ │ │ │ PRESP= │ │ │ │ │ │ PROBD= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SEVERITY= │ │ │ │ │ │ SPRESP= │ │ │ │ │ │ STYLE= │ │ │ │ │ │ SYSACT= │ │ │ │ │ │ URESP= │ │ │ │ │ │ XPL= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CODESEL=NONE │ FIRST │ │ Specifies which codes on the page are to │ │ LAST │ FIRSTLAST │ │ be used as a running heading or footing. │ │ NODUP │ │ +──────────────────────────────+──────────────────────────────────────────+ │ DEST='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the DEST tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ INDENT='horizontal space' │ Specifies the indent to be used for the │ │ │ explanatory text under the message or │ │ │ code. │ +──────────────────────────────+──────────────────────────────────────────+ │ MODULE='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the MODULE tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUMBYTES='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the NUMBYTES │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ ORESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the ORESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=text │ Specifies a common prefix for a group of │ │ │ messages. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROBD='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PROBD tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEVERITY='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SEVERITY │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SPRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=SPACE │ Specifies the style to be used in for- │ │ RULE │ matting messages and codes lists. │ │ BOX │ │ │ LBLBOX │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSACT='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SYSACT tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ URESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the URESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ XPL='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the XPL tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that code lists are to be for- │ │ │ matted with blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I :xpl.Informational message. :severity.3 :module.Golden Gate Bridge :probd.A car is turned crosswise to the traffic. :sysact.Divert traffic at each end of bridge. :spresp.Call police to direct traffic. :oresp.Inform drivers already at the booth of the problem and call a tow truck. :uresp.Write a letter to the editor about drunk drivers. :numbytes.3580 (cars stalled on the bridge) :code.OC414-W :xpl.Warning message. :severity.To be determined. :module.Golden Gate Bridge :probd.A ship has rammed the bridge. :sysact.The bridge is still up, but in possible danger of collapse. :spresp.Inspect the bridge for extent of damage. :oresp.Close toll booths to all traffic. :presp.Take an alternate route. :uresp.Write an article for the newspaper about the bridge. :numbytes.36 (number of broken supports) :code.OC412-E :xpl.Error message. :severity.1 :module.Golden Gate Bridge :probd.An earthquake has split the bridge in two. :sysact.Cars falling in bay, people screaming as they fall into the bay. :spresp.Call a meeting to decide what to do. :oresp.Call a strike of toll booth operators. :presp.Dive under your desk. :uresp.Write a letter to your family about the earthquake. :numbytes.3000 (people in the bay); 2099 (cars) :ecodel. ═══ 2.36. COMPL Component List ═══ COMPL Component List Purpose The COMPL tag indicates the start of a component list for a component within a higher-level assembly in a maintenance library document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :COMPL │ component │ │ No immediate │ :ECOMPL │ │ │ list │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :compl. :ci partnum=5681234.Bicycle, blue : :ecompl. ═══ 2.37. COPREXT Copyright Extension ═══ COPREXT Copyright Extension Purpose The COPREXT tag allows more than one copyright. The COPREXT tag and text should be entered just preceding the VNOTICE end tag. The copyright extension notice appears on the line below the copyright. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :COPREXT │ copyright │ │ Any text; any- │ │ │ │ extension │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :userdoc ibmcopyr='1984, 1985'. :vnotice. :vnhd.Tenth Edition (December 1984) :coprext.Velvetware, Inc. 1985 :evnotice. ═══ 2.38. COPRNOTE Copyright Notice ═══ COPRNOTE Copyright Notice Purpose The COPRNOTE tag specifies alternative wording to the default copyright notice produced from the COPYR or IBMCOPYR attribute of the USERDOC tag. The COPRNOTE tag and text should be entered just preceding the VNOTICE end tag. The copyright notice appears at the bottom of the Version Notice page. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :COPRNOTE │ copyright │ │ Text on same line │ │ │ │ notice │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :coprnote.IBM France 1983, 1984 ═══ 2.39. COVER Cover Placement ═══ COVER Cover Placement Purpose The COVER tag indicates that a front and back cover are to be generated for this document. The cover inforamtion is taken from the document prolog, using the title and document number. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :COVER │ cover place- │ ARTID= │ Self-contained. │ │ │ │ ment │ TEXTIDn= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ARTID=name │ Identifies a peice of art for inclusion │ │ │ on a book cover. │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXTIDn=name │ Identifies up to five files of text for │ │ │ inclusion on a book cover. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :frontm. :tipage. :artdef id=abc name=prodgrph. :cover artid=abc. . . . ═══ 2.40. CT Command Text (Map) ═══ CT Command Text (Map) Purpose The CT tag identifies the command text in a map in a maintenance library document. CT must be placed within a STEP structure in a map. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :CT │ command text │ FIT= │ Any text; any- │ │ │ │ (map) │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIT=vertical space │ Specifies the minimum required for the │ │ │ tag content. The initial FIT setting │ │ │ for the QT tag is 7 lines. The initial │ │ │ FIT setting for the CT, FT, and ST tags │ │ │ is 3 lines. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :map id=babymap. :step. :ct.Check Johnny's diaper. :qt.Is the diaper wet? :estep. :emap. ═══ 2.41. DANGER Danger ═══ DANGER Danger Purpose The DANGER tag identifies one or more paragraphs containing a statement about a condition that could cause injury or death to a person. The complete danger statement is printed in bold type. DANGER can occur anywhere in your text. The DANGER tag must be preceded by a paragraph (P), list item (LI), or list part (LP) tag. Within a list, it aligns with the text of a list item. A danger statement may have additional paragraphs (entered with the paragraph tag). The DANGER tag must be explicitly ended with its matching end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DANGER │ danger │ TRANS= │ Any text; any- │ :EDANGER │ │ │ │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TRANS=number │ Specifies the number of lines to be left │ │ │ for translation space. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.:danger trans=3. A danger statement warns of anything that could cause injury or death. :p.Additional paragraphs for the danger statement can be entered with the paragraph tag. :edanger. :p.A following paragraph ═══ 2.42. DATE Date ═══ DATE Date Purpose The DATE tag identifies the release or printing date of a document. It is placed in the prolog. If you supply a date after the DATE tag, that date will be shown. If no text is entered after the DATE tag, the date the document is formatted is shown. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DATE │ date │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ │ │ │ │ (Optional │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :date. or :date.February 4, 1999 ═══ 2.43. DD Definition Description ═══ DD Definition Description Purpose The DD tag identifies the description of the term or phrase being defined in a definition list. DD tags are valid only within definition lists. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DD │ definition │ │ Implied para- │ │ │ │ description │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dl tsize=5 termhi=0. :dt.IBM :dd.International Business Machines Corporation :edl. ═══ 2.44. DDHD Definition Description Head ═══ DDHD Definition Description Head Purpose The DDHD tag identifies the heading for the description column of the definition list. DDHD tags are valid only within definition lists. The highlight type of the heading is determined by the value of the HEADHI attribute on the DL tag. This value defaults to highlight type 2. Definition description headings can be stacked; that is, they can provide headings for two columns of terms and descriptions. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DDHD │ definition │ │ Text on same line │ │ │ │ description │ │ or next line; no │ │ │ │ head │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dl headhi=0 termhi=0 tsize=5. :dthd.Company :ddhd.Reference :dt.IBM :dd.International Business Machines Corporation :edl. ═══ 2.45. DELIM Syntax Delimiter ═══ DELIM Syntax Delimiter Purpose The DELIM tag describes a delimiter character which is used to delimit the start or end of keywords, variables, operators, or groups. This tag is a TOSL and the delimiter character is required. Note that the delimiter can be more than one character. Format :DELIM REQ|OPT CONSTANT|VAR START|END. LID='id ...'. delimiter-character Parameters REQ|OPT specifies the selectability of the delimiter character, where: REQ indicates the delimiter character is required. OPT indicates the delimiter character is optional. CONSTANT|VAR specifies the class of the delimiter character, where: CONSTANT indicates the delimiter character does not vary. VAR indicates the delimiter character is variable. START|END specifies the position of the delimiter character, where: START indicates this is a starting delimiter and has a matching end delimiter within the same group. END indicates this is a ending delimiter and has a matching start delimiter within the same group. Note: You use the START/END attributes to make sure that delimiters are specified in matched sets (balanced). BookMaster checks if there are an equal number of start and end delimiters within each GROUP tag and issues a message if the delimiters are not in matched sets. If the syntax language does not require that delimiters be specified in matched sets, do not use the START and END attributes. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample delimiters: :syntax. :delim opt.( :group. :kwd.MYKEY :delim start.( :var.value :delim end.) :egroup. :esyntax. Formats like: >>-----------MYKEY---(---value---)--->< | | ---(--- ═══ 2.46. DENTRY Directory Entry ═══ DENTRY Directory Entry Purpose The DENTRY tag defines the text in a directory. DENTRY is valid only within a directory (that is, after a DIRECT tag). If you include blank spaces or special characters in the text of your columns, you must enclose those entries in single quotation marks, for example: 'St. Louis'. The columns in your directory will be lined up according to the specifications on the DIRECT tag. Therefore, it is not necessary, or even desirable, to enter your columns on the DENTRY tag all neatly lined up. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DENTRY │ directory │ │ Text on same line │ │ │ │ entry │ │ or next line; no │ │ │ │ │ │ other tags. │ │ │ │ │ │ (Special Format) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :direct layout=two cols='8 8 8'. :dirhdr.Module Called Entry :dirhdr.Name By Point :dentry.IJK32076 IJK30111 IJK12121 : :edirect. ═══ 2.47. DEST Message or Code Destination ═══ DEST Message or Code Destination Purpose The DEST tag identifies the destination of a message or code. It can be used only within a code list (CODEL) or message list (MSGL). The subheading "Destination" is printed to the left of the text. If the DEST attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Destination." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DEST │ message or │ │ Implied para- │ │ │ │ code destina- │ │ graph. │ │ │ │ tion │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :msgl xpl='Cause' uresp='Recovery' spresp='Administrator Action' tsize=6m. :msg.CLOSET FULL: :xpl.There are too many clothes in it :uresp.Remove some of the clothes :dest.Closet stuffer. ═══ 2.48. DF Display Mode Formula ═══ DF Display Mode Formula Purpose The DF tag identifies a display mode formula. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DF │ display mode │ ALIGN= │ Formula formatter │ :EDF │ │ │ formula │ FRAME= │ input. │ │ │ │ │ ITALIC │ │ │ │ │ │ METRICS= │ │ │ │ │ │ NOITALIC │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of each of the │ │ LEFT │ columns in a display mode formula. │ │ CENTER │ │ │ RIGHT │ │ │ INSIDE │ │ │ OUTSIDE │ │ │ horizontal space │ │ │ -horizontal space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ display mode formula. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ITALIC │ Specifies italic highlighting │ +──────────────────────────────+──────────────────────────────────────────+ │ METRICS='SMFF metrics' │ │ +──────────────────────────────+──────────────────────────────────────────+ │ NOITALIC │ Specifies no highlighting │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dfdef id=l123456. :df refid=l123456 frame=none align=left italic scale='.9'. . . . :edf ═══ 2.49. DFDEF Display Mode Formula Definition ═══ DFDEF Display Mode Formula Definition Purpose The DFDEF tag sets values that control the defaults for any attribute not specified on a DF tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DFDEF │ display mode │ ALIGN= │ No immediate │ │ │ │ formula defi- │ FRAME= │ text. │ │ │ │ nition │ ID= │ │ │ │ │ │ ITALIC │ │ │ │ │ │ METRICS= │ │ │ │ │ │ NOITALIC │ │ │ │ │ │ SCALE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of each of the │ │ LEFT │ columns in a display mode formula. │ │ CENTER │ │ │ RIGHT │ │ │ INSIDE │ │ │ OUTSIDE │ │ │ horizontal space │ │ │ -horizontal space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ display mode formula. 'character' is │ │ NONE │ not valid for tables or grids. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ ITALIC │ Specifies italic highlighting │ +──────────────────────────────+──────────────────────────────────────────+ │ METRICS='SMFF metrics' │ │ +──────────────────────────────+──────────────────────────────────────────+ │ NOITALIC │ Specifies no highlighting │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dfdef id=l123456 frame=none align=left italic scale='.9'. :df refid=l123456. : :edf. ═══ 2.50. DIALDEF Interactive Dialog Description ═══ DIALDEF Interactive Dialog Description Purpose The DIALDEF tag defines a DIALOG tag which illustrates an interactive dialog between, for example, a "user" and a "system." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIALDEF │ interactive │ ID= │ │ │ │ │ dialog │ KEEP= │ │ │ │ │ description │ SCALE= │ │ │ │ │ │ SYS= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ USER= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ KEEP=vertical space │ Specifies the amount of space that must │ │ ALL │ be kept together in a dialog before it │ │ │ can be broken. For DIALOG, the initial │ │ │ setting is no keeping of text together. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SYS='label' │ Specifies the label to be used for the │ │ │ system interaction in dialogs. │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ USER='label' │ Specifies the label to be used for the │ │ │ user interaction in dialogs. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dialdef id=l123456 user=Hepburn sys=Tracy. :dialog refid=l123456. :user.What Katharine says. :sys.What Spencer says. :edialog. ═══ 2.51. DIALOG Interactive Dialog ═══ DIALOG Interactive Dialog Purpose The DIALOG tag illustrates an interactive dialog between, for example, a "user" and a "system." The tag involves three elements: 1. The DIALOG and matching end tag. 2. The DIALOG attribute on the DOCPROF tag. 3. The @DIALOG user option (which you can issue at the time you run your document). It overrides the DIALOG attribute on the DOCPROF tag. A dialog can be portrayed using any one of the following techniques: 1. Labeling the participants 2. Different fonts 3. Different colors Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIALOG │ interactive │ KEEP= │ No immediate │ :EDIALOG │ │ │ dialog │ REFID= │ text. │ │ │ │ │ SCALE= │ │ │ │ │ │ SYS= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ USER= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ KEEP=vertical space │ Specifies the amount of space that must │ │ ALL │ be kept together in a dialog before it │ │ │ can be broken. For DIALOG, the initial │ │ │ setting is to not keep the text │ │ │ together. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SYS='label' │ Specifies the label to be used for the │ │ │ system interaction in dialogs. │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ USER='label' │ Specifies the label to be used for the │ │ │ user interaction in dialogs. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dialog user=You sys=Me. :user.Your question :sys.My answer :edialog. ═══ 2.52. DIRDEF Directory Definition ═══ DIRDEF Directory Definition Purpose The DIRDEF tag defines default settings for a directory. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIRDEF │ directory │ ALIGN= │ │ │ │ │ definition │ ALIGNHD= │ │ │ │ │ │ CHUNK │ │ │ │ │ │ COLS= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ HEADHI= │ │ │ │ │ │ ID= │ │ │ │ │ │ LAYOUT= │ │ │ │ │ │ SCALE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=[FILL fill-character] │ Specifies the alignment of the text in │ │ CENTER │ │ each of the columns and a fill character │ │ LEFT │ │ between columns. The last value speci- │ │ RIGHT │ │ fied applies to any remaining unspeci- │ │ / position character │ fied columns. Multiple ALIGN values │ │ │ must be enclosed in single quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGNHD=[FILL fill-character]│ Specifies the alignment of the headings │ │ CENTER │ │ in each column of a directory. The last │ │ LEFT │ │ value specified applies to all remaining │ │ RIGHT │ │ unspecified columns. Multiple ALIGNHD │ │ / position-character │ values must be enclosed in single │ │ │ quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHUNK │ Specifies the directory have extra space │ │ │ added after every five lines. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='column specs' │ Specifies the widths of each of the │ │ │ columns in a directory, or cells within │ │ │ a table. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that directory entries are to │ │ │ be formatted with no blank lines between │ │ │ them. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directory entries are to │ │ │ be formatted with blank lines between │ │ │ them. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a directory, │ │ . │ definition list, or table. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=SAME │ Specifies the layout in columns of a │ │ ONE │ directory. SAME is the initial setting │ │ TWO │ for directories. │ │ THREE │ │ │ FOUR │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dirdef id=l123456 layout=one cols='20 10 10' compact. :direct refid=l123456. :dentry.'David & Company' Paint East :dentry.'Sam''s' Burgers North :edirect. ═══ 2.53. DIRECT Directory ═══ DIRECT Directory Purpose The DIRECT tag identifies an element containing directory headings, subheadings and entries. This tag requires a matching end tag. The directory entries, headings, and subheadings are identified by the DENTRY, DIRHDR, and DIRSUB tags. Each line of a directory is a separate entry. You can specify up to 20 columns. You have the option of having the text for a particular column aligned to the left or right, and the option of having the heading over each column either aligned to the left or right, or centered over the column. The text of one column is distinguished from the text of another column by one or more spaces. If an individual column contains blanks or special characters ($, # and @ are not considered special characters), you must put single quotation marks around that column entry. If a particular column does not have any text, use the required blank symbol ( ). BookMaster, by default, skips one line after printing 5 entries. If this blank line is not desired, use the COMPACT attribute on the DIRECT tag. If you want ISIL to put a blank space between every entry, use the EXPAND attribute. The DIRSUB tag inserts a directory subheading. This can be used as often as desired. The LAYOUT attribute specifies the layout of the page. (LAYOUT is not the same as the COLS attribute.) The layout can be specified as SAME, which is the default, meaning that if you are using an offset style, the directory will be offset like the rest of the text. You can also specify one-, two-, three-, or four-column layout. The DIRECT tag does not balance columns. For example, if you specify "cols='4p 4p 4p'" and "layout=two", the page will have six columns, in the order of column 1, column 2, column 3, column 1, column 2, column 3. The first group of columns 1-3 will not be automatically balanced with the second set of columns 1-3, but rather the first set of columns will fill to the bottom of the page, before the first entry in the second set. If your directory columns won't fit in your layout column, a warning message is issued and the layout is defined to be one column the full width of the page. Directory elements can occur anywhere in text except in figures and tables. If used in a grid area, the LAYOUT attribute is ignored. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIRECT │ directory │ ALIGN= │ No immediate │ :EDIRECT │ │ │ │ ALIGNHD= │ text. │ │ │ │ │ CHUNK │ │ │ │ │ │ COLS= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ HEADHI= │ │ │ │ │ │ LAYOUT= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=[FILL fill-character] │ Specifies the alignment of the text in │ │ CENTER │ │ each of the columns and a fill character │ │ LEFT │ │ between columns. The last value speci- │ │ RIGHT │ │ fied applies to any remaining unspeci- │ │ / position character │ fied columns. Multiple ALIGN values │ │ │ must be enclosed in single quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGNHD=[FILL fill-character]│ Specifies the alignment of the headings │ │ CENTER │ │ in each column of a directory. The last │ │ LEFT │ │ value specified applies to all remaining │ │ RIGHT │ │ unspecified columns. Multiple ALIGNHD │ │ / position-character │ values must be enclosed in single │ │ │ quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHUNK │ Specifies the directory have extra space │ │ │ added after every five lines. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='column specs' │ Specifies the widths of each of the │ │ │ columns in a directory, or cells within │ │ │ a table. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that directory entries are to │ │ │ be formatted with no blank lines between │ │ │ them. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directory entries are to │ │ │ be formatted with blank lines between │ │ │ them. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a directory, │ │ . │ definition list, or table. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=SAME │ Specifies the layout in columns of a │ │ ONE │ directory. SAME is the initial setting │ │ TWO │ for directories. │ │ THREE │ │ │ FOUR │ │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :direct layout=one cols='20 10 10' compact. :dentry.'David & Company' Paint East :dentry.'Sam''s' Burgers North :edirect. ═══ 2.54. DIRHDR Directory Heading Row ═══ DIRHDR Directory Heading Row Purpose The DIRHDR tag identifies a single heading line for the columns in a directory. The DIRHDR tag is valid only within a directory. The DIRHDR tag can only be used before the first DENTRY tag. If a column heading has any blanks or special characters, that heading must be enclosed in single quotation marks. The characters @ (at sign), # (pound sign), and $ (dollar sign) are not considered special characters. If you put more items in a directory entry than you have directory columns, a warning message is issued and excess items are cut off. You may use multiple DIRHDR tags for multiple lines of heading. A blank line is supplied following the directory header. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIRHDR │ directory │ │ Text on same line │ │ │ │ heading row │ │ or next line; no │ │ │ │ │ │ other tags. │ │ │ │ │ │ (Special Format) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :direct layout=one cols='20 10 10' compact. :dirhdr.Company Product Region :dentry.'David & Company' Paint East :dentry.'Sam''s' Burgers North :edirect. ═══ 2.55. DIRSUB Directory Subhead ═══ DIRSUB Directory Subhead Purpose The DIRSUB tag identifies a directory subheading. It is valid only within a directory. Multiple DIRSUB tags can be used within a directory. The text must be all on the same line as the tag or all on the next line and can't have any tags within it. Because the layout column can be very narrow, your subheading may take several output lines. Everything will come out right as long as the subheading takes no more than three output lines. If it does take more than three, and it happens to fall near the bottom of the column, you may have formatting problems. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DIRSUB │ directory │ │ Text on same line │ │ │ │ subhead │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :direct layout=one cols='10 6 6 10'. :dirhdr.Receives Month Inv 'End Net' :dirsub.Part #363, Model A-35 :dentry.144 May 40 184 :dentry.44 June 20 64 :edirect. ═══ 2.56. DL Definition List ═══ DL Definition List Purpose The DL tag identifies a list of words or phrases and their corresponding definitions, descriptions, or explanations. This tag requires a matching end tag. The terms being defined and their definitions are identified by the DT tag and the DD tag. A heading for the column of terms and the column of definitions can be identified by the DTHD tag and the DDHD tags, respectively. Definition lists can occur anywhere in text; they can be nested within other lists or definition lists, and other lists can be nested within definition lists. Each item in a definition list is identified by a pair of tags: o DT identifies the term being defined. o DD identifies the definition of the term. Headings for each column are identified by another pair of tags: o DTHD identifies the heading for the term column. o DDHD identifies the heading for the description column. You cannot use two DT or DD tags consecutively, but you can use two DTHD or DDHD tags consecutively. You only have the space available that was specified by the TSIZE attribute. If the term is longer than the TSIZE provided (default of 10) it will extend into the description line. This extension is sometimes preferred rather than having a large TSIZE that could make the description too narrow. You can decide how to break the columns with the BREAK attribute. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DL │ definition │ BREAK= │ No immediate │ :EDL │ │ │ list │ HEADHI= │ text. │ │ │ │ │ TERMHI= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ BREAK=NONE │ Specifies the handling of definition │ │ ALL │ terms in a definition list. NONE is the │ │ FIT │ initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a directory, │ │ . │ definition list, or table. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TERMHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for definition terms in a defi- │ │ . │ nition list or glossary. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Separates each entry, item, or statement │ │ │ with a blank line. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Refers to the name on the ID attribute │ │ │ of a tag. name must appear on an ID │ │ │ attribute of a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :dl break=none tsize=12. :dthd.Name :ddhd.List of Favorite Western Cities :dt.Ann Smith :dd.San Francisco, Los Angeles, Fresno, Modesto, San Diego, and Belmont :edl. ═══ 2.57. DLDEF Definition List Definition ═══ DLDEF Definition List Definition Purpose The DLDEF tag defines default settings for a definition list. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DL │ definition │ BREAK= │ No immediate │ │ │ │ list │ HEADHI= │ text. │ │ │ │ │ TERMHI= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ ID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ BREAK=NONE │ Specifies the handling of definition │ │ ALL │ terms in a definition list. NONE is the │ │ FIT │ initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a directory, │ │ . │ definition list, or table. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TERMHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for definition terms in a defi- │ │ . │ nition list or glossary. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Separates each entry, item, or statement │ │ │ with a blank line. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :prolog. . . . :dldef break=fit tsize=12 termhi=3. &egml.prolog. ═══ 2.58. DOCDESC Document Description ═══ DOCDESC Document Description Purpose The DOCDESC tag defines documents that BookManager should create automatic links to. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DOCDESC │ document │ ID= │ No immediate │ │ │ │ description │ LEVEL= │ text. │ │ │ │ │ NUM= │ │ │ │ │ │ DESC= │ │ │ │ │ │ TITLE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ LEVEL=document-level │ Specifies the level of the document. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM='document-number' │ Specifies the document number of the │ │ │ document to be linked to. │ +──────────────────────────────+──────────────────────────────────────────+ │ DESC='text-of-description' │ Describes a revision or a document to be │ │ │ linked to. For informational purposes │ │ │ only. │ +──────────────────────────────+──────────────────────────────────────────+ │ TITLE='string' │ Specifies the title of the document to │ │ │ be linked to. For informational pur- │ │ │ poses only. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docdesc id=bmug desc='Bookie User Guide' num='SC34-5009' ═══ 2.59. DOCNUM Document Number ═══ DOCNUM Document Number Purpose The DOCNUM tag identifies a number associated with a document, such as a form, serial, or order number. It can appear anywhere in the prolog. The text must be on a single line and include no tags. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DOCNUM │ document │ LEVEL= │ Text on same line │ │ │ │ number │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LEVEL=document-level │ Specifies the level of the document. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docnum.SC34-5009-0 ═══ 2.60. DOCPROF Document Profile ═══ DOCPROF Document Profile Purpose The DOCPROF tag, with its more than 20 attributes, describes aspects of the general profile of your document, such as: o Whether you want words hyphenated at the end of lines (HYPHEN) o Whether you want leader dots in your tables of contents. o How many levels of heading you want included in your table of contents (TOC or PTOC). Each of the DOCPROF attributes has a default that will be in effect if you don't use DOCPROF to specify otherwise. DOCPROF changes the defaults that BookMaster has established. The DOCPROF tag must be specified in your prolog. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DOCPROF │ document │ BODYHD0= │ Self-contained. │ │ │ │ profile │ BODYHD1= │ │ │ │ │ │ DIALOG= │ │ │ │ │ │ DUPLEX= │ │ │ │ │ │ EPTOC= │ │ │ │ │ │ FBC= │ │ │ │ │ │ FIGLIST= │ │ │ │ │ │ FTSEP= │ │ │ │ │ │ HDPREF= │ │ │ │ │ │ HEADNUM= │ │ │ │ │ │ HYPHEN= │ │ │ │ │ │ JUSTIFY= │ │ │ │ │ │ LANGUAGE= │ │ │ │ │ │ LAYOUT= │ │ │ │ │ │ LDRDOTS= │ │ │ │ │ │ MINDEXNM= │ │ │ │ │ │ MINDEXPG= │ │ │ │ │ │ PTOC= │ │ │ │ │ │ PUNCT= │ │ │ │ │ │ QRESET= │ │ │ │ │ │ RHRFRULE= │ │ │ │ │ │ STYLE= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJSEL= │ │ │ │ │ │ TIPAGE= │ │ │ │ │ │ TLIST= │ │ │ │ │ │ TOC= │ │ │ │ │ │ VOLPREF= │ │ │ │ │ │ XREFPAGE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ BODYHD0='heading text' │ Specifies the text to be generated for │ │ │ each H0 in the body of the document. │ +──────────────────────────────+──────────────────────────────────────────+ │ BODYHD1='heading text' │ Specifies the text to be generated for │ │ │ each H1 in the body of the document. │ +──────────────────────────────+──────────────────────────────────────────+ │ DIALOG='option(s)' │ Specifies the dialog formatting tech- │ │ │ nique (LABEL, FONT, and/or COLOR) to be │ │ │ used for the DIALOG tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ DUPLEX=YES │ Specifies whether formatting is for one- │ │ NO │ sided (NO) printing or two-sided │ │ SB │ printing (YES or SB), where SB does not │ │ │ force right-hand pages for level 1 seg- │ │ │ ments. Initial setting is YES. │ +──────────────────────────────+──────────────────────────────────────────+ │ EPTOC=INLINE │ Specifies the action to be taken at the │ │ PAGE │ end of a partial table of contents: │ │ RHPAGE │ INLINE to continue the text immediately │ │ LHPAGE │ following the partial table of contents; │ │ │ PAGE to force a new page; and RHPAGE to │ │ │ force a new right hand page. │ +──────────────────────────────+──────────────────────────────────────────+ │ FBC=NO │ Specifies whether the document is to use │ │ YES │ "folio-by-chapter" numbering. Initial │ │ │ setting is no. │ +──────────────────────────────+──────────────────────────────────────────+ │ FIGLIST=PAGE │ Specifies whether the figure list is to │ │ NOPAGE │ start on a new page. The initial │ │ │ setting is to start a new page. │ +──────────────────────────────+──────────────────────────────────────────+ │ FTSEP=YES │ Specifies the figure and table sepa- │ │ NO │ ration. When YES tables and figures are │ │ │ numbered separately; the initial setting │ │ │ is YES. │ +──────────────────────────────+──────────────────────────────────────────+ │ HDPREF=NO │ Specifies whether cross references to │ │ YES │ level 1 headings will be to the full │ │ SUPPRESS │ heading (NO), just the prefix (YES), or │ │ │ the text of the heading without the │ │ │ prefix (SUPPRESS). The initial setting │ │ │ is NO. │ │ │ │ │ │ If general head numbering is requested, │ │ │ applies to all numbered headings. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADNUM=NO │ Specifies that headings are to be auto- │ │ 123456 │ matically numbered, and the levels to be │ │ 12345 │ numbered. The initial setting is no │ │ 1234 │ head numbering. │ │ 123 │ │ │ 12 │ │ │ 1 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ HYPHEN=NO │ Specifies whether hyphenation is to be │ │ YES │ used for the text. The initial setting │ │ │ is NO. │ +──────────────────────────────+──────────────────────────────────────────+ │ JUSTIFY=NO │ Specifies whether justification is to be │ │ YES │ used for the text. The initial setting │ │ │ is NO. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LANGUAGE=ENGLISH │ Specifies the language in which all │ │ BFRENCH │ │ BookMaster-generated words are to be │ │ BPORTUGUESE │ │ expressed. │ │ CENGLISH │ │ │ │ CFRENCH │ │ │ │ DANISH │ │ │ │ DUTCH │ │ │ │ ENGLISH │ │ │ │ FINNISH │ │ │ │ FRENCH │ │ │ │ GERMAN │ │ │ │ ITALIAN │ │ │ │ NORWEGIAN │ │ │ │ PORTUGUESE │ │ │ │ SFRENCH │ │ │ │ SGERMAN │ │ │ │ SITALIAN│ │ │ │ SPANISH │ │ │ │ SWEDISH │ │ │ │ UKENGLISH │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=OFF │ Specifies the layout of the pages in the │ │ 1 │ document. │ │ 2 ... │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LDRDOTS=NO │ Specifies whether leader dots are to be │ │ YES │ used in the table of contents and figure │ │ │ list. The initial setting is NO. │ +──────────────────────────────+──────────────────────────────────────────+ │ MINDEXNM=FULL │ SHORT │ Specifies whether to use the full or │ │ │ short name of a book in master index │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ MINDEXPG=NO │ YES │ Specifies whether page numbers are to be │ │ │ shown in the master index. │ +──────────────────────────────+──────────────────────────────────────────+ │ PTOC=0123456 │ Specifies the levels of headings to be │ │ 012345 │ placed in the partial table of contents. │ │ 01234 │ │ │ 0123 │ │ │ 012 │ │ │ 01 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PUNCT='.,' │ Specifies trailing punctuation to be │ │ '' │ moved inside quotation marks. │ +──────────────────────────────+──────────────────────────────────────────+ │ QRESET=NO │ 1 │ 2 │ 3 ... 20 │ Resets question numbering depending on │ │ │ the heading level. │ +──────────────────────────────+──────────────────────────────────────────+ │ RHRFRULE=BOTH │ Specifies the use of rules separating │ │ TOP │ the body of the page from the running │ │ BOTTOM │ head and/or running foot. │ +──────────────────────────────+──────────────────────────────────────────+ ═══ 2.61. DOCPROF Document Profile (continued) ═══ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=name │ Specifies a named style to be used for │ │ │ this document. If specified, it must be │ │ │ the first attribute. │ │ │ │ │ │ These are the built-in styles for │ │ │ USERDOC: │ │ │ │ │ │ DEFAULT Default style │ │ │ IBMXAGD IBM user guides │ │ │ IBMXBGD IBM PC-sized user guides │ │ │ IBMXARF IBM reference manuals │ │ │ IBMXBRF IBM PC-sized reference manuals │ │ │ IBMXFSM IBM summary booklet or card │ │ │ (3.625 x 7.25 inches) │ │ │ IBMXGGD IBM primer size (7 x 9.5 │ │ │ inches) │ │ │ IBMXJSV IBM top bound │ │ │ IBMX5SV IBM top bound, 4-column (13.5 │ │ │ x 11 inches) │ │ │ IBMXAGD0 IBM previous release release │ │ │ format │ │ │ IBMXBGD0 IBM previous release release │ │ │ PC size │ │ │ IBMXASV0 IBM previous release release │ │ │ reference │ │ │ IBMU4PL IBM A4 size guides │ │ │ IBMUGPL IBM generic device │ │ │ Sample styles include: │ │ │ OVERHEAD For making transparencies or │ │ │ foils │ │ │ SSLIKE GML start set │ │ │ BOOKLET Booklet or reference card │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE=NOPREFIX │ PREFIX │ Specifies whether the heading level-1 │ │ │ prefix is added to the short title when │ │ │ the STITLE attribute is used on a H1 │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJSEL=FIRST │ FIRSTLAST │ │ Specifies which subject on a page is to │ │ LAST │ VERYLAST │ │ be used as a running heading or footing. │ │ NODUP │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TIPAGE=RIGHT │ Specifies the formatting of the title │ │ CENTER │ page. │ │ LEFT │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TLIST=PAGE │ Specifies whether the table list is to │ │ NOPAGE │ start on a new page. The initial │ │ │ setting is to start a new page. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOC=0123456 │ Specifies the levels of headings to be │ │ 012345 │ placed in the table of contents. │ │ 01234 │ │ │ 0123 │ │ │ 012 │ │ │ 01 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ VOLPREF=NO │ YES │ │ Specifies whether the volume identifier │ │ 'value' │ is to be prefixed to each page number, │ │ │ and what character or string is to be │ │ │ used as a separator. │ +──────────────────────────────+──────────────────────────────────────────+ │ XREFPAGE=YES │ Specifies the initial setting treatment │ │ NO │ of page numbers in cross references. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docprof hyphen=yes toc=0123 ldrdots=yes ptoc=12 rhrfrule=both duplex=yes. ═══ 2.62. DT Definition Term ═══ DT Definition Term Purpose The DT tag identifies the term or phrase that is being described in the definition list item. It is valid only within a definition list. The highlighting type of the term is determined by the value of the TERMHI attribute on the DL tag. This value defaults to 2. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DT │ definition │ │ Implied para- │ │ │ │ term │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dl break=none tsize=12. :dthd.Name :ddhd.List of Favorite Western Cities :dt.Ann Smith :dd.San Francisco, Los Angeles, Fresno, Modesto, San Diego, and Belmont :edl. ═══ 2.63. DTHD Definition Term Head ═══ DTHD Definition Term Head Purpose The DTHD tag identifies the heading for the column of terms or phrases being defined. It is valid only within a definition list. In a definition list, headings can be specified to go over the two columns with the definition list term heading (DTHD) and definition list description heading (DDHD) tags. For DTHD, the text must be in a single input record, and can't have any other tags in it. By default, the definition list heading is highlighted in type 2. It can be changed with the HEADHI attribute on the DL tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :DTHD │ definition │ │ Text on same line │ │ │ │ term head │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dl break=none tsize=12. :dthd.Name :ddhd.List of Favorite Western Cities :dt.Ann Smith :dd.San Francisco, Los Angeles, Fresno, Modesto, San Diego, and Belmont :edl. ═══ 2.64. F Formula ═══ F Formula Purpose The F tag identifies an inline formula. It requires an end tag. The formula is formatted according to the current formatting environment. The tag and its matching end tag do NOT have to be on the same line of your file. You can have as many lines of input as you wish. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :F │ inline │ │ Formula formatter │ :EF │ │ │ formula │ │ input. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :f. x + y = z :ef. ═══ 2.65. FIG Figure ═══ FIG Figure Purpose The FIG tag identifies a diagram, chart, or other illustration. This tag requires a matching end tag. A figure can also contain a figure caption and/or a figure description, identified by the FIGCAP and FIGDESC tags, respectively. Figures can occur anywhere in text, except within other figures, examples, footnotes, or tables. Figures can contain any basic document elements (except other figures, examples, footnotes, or tables), lines of text, and character graphics. If the figure is too large to fit on a single page, it can be divided into segments, which can then be split onto several pages; see the FIGSEG tag for information. A figure can also contain a figure caption, identified by the FIGCAP tag, placed within the figure. The caption must occupy a single line in the source document and cannot contain any other tags. The figure must have a caption if you intend to refer to it from any other location in the document. Further descriptive text following the figure caption is identified with the FIGDESC tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIG │ figure │ CONCAT= │ Bracketed text. │ :EFIG │ │ │ │ DWIDTH= │ │ │ │ │ │ FRAME= │ │ │ │ │ │ ID= │ │ │ │ │ │ PLACE= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CONCAT=NO │ YES │ Specifies whether text within a figure │ │ │ is to be placed as entered or is to be │ │ │ formatted. YES causes formatting; text │ │ │ is concatenated. NO turns formatting │ │ │ off. │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ by BookManager. Specifies the display │ │ │ width of a figure, or table, to be │ │ │ viewed on a screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ figure, a table, or a grid; 'character' │ │ NONE │ is not valid for tables or grids. RULE │ │ 'character' │ is the initial setting for figures. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ PLACE=TOP │ Specifies the placement of a figure. │ │ INLINE │ The initial setting is TOP, and means │ │ BOTTOM │ the figure will float to the top of the │ │ │ next column or page; BOTTOM is similar │ │ │ -- the figure floats to the bottom of │ │ │ the next column or page. INLINE means │ │ │ the figure is not to be floated. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=PAGE │ Specifies the width of a figure. The │ │ COLUMN │ initial setting is PAGE for figures. │ │ horizontal space │ │ │ │ If a horizontal space specification is │ │ │ given, the figure will be set in the │ │ │ column if it fits; otherwise, it will be │ │ │ set the width given. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :fig place=inline frame=box width=page. T H I S I S A F U L L - P A G E - W I D T H F I G U R E. T H E F R A M E, I N T H I S C A S E, I S A B O X. :efig. ═══ 2.66. FIGCAP Figure Caption ═══ FIGCAP Figure Caption Purpose The FIGCAP tag provides a figure caption. It is required when cross references are to be made to the figure. FIGCAP can only be used within a figure. The FIGCAP tag can be in either of two places: o Just before the FIG end tag (or the FIGDESC tag, if one is used). or o Immediately after the FIG tag. If the FIGSEG tag is used in the figure, the FIGCAP tag MUST be placed immediately after the FIG tag. The figure caption is printed below the figure in a highlighted font. o With FRAME=RULES on the FIG tag, the caption is printed inside the rules. o With FRAME=BOX on the FIG tag, the caption is printed outside the box. The word "Figure" and an automatically generated number precede the caption you put on the FIGCAP tag. If you use the FIGSEG tag to span your figure over more than one page, "(Part x of y)" is included after the figure number. For example: Figure 17 (Part 1 of 3). Figure Spanning Three Pages Figure 17 (Part 2 of 3). Figure Spanning Three Pages Figure 17 (Part 3 of 3). Figure Spanning Three Pages The figure number and text of the caption are also placed in the list of figures if the FIGLIST tag is used in the document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGCAP │ figure │ │ Text on same line │ │ │ │ caption │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :fig place=inline frame=box width=page. :figcap.Example of a full-page-width figure with a frame T H I S I S A F U L L - P A G E - W I D T H F I G U R E. T H E F R A M E, I N T H I S C A S E, I S A B O X. :efig. ═══ 2.67. FIGDEF Figure Definition ═══ FIGDEF Figure Definition Purpose Used to define all the attributes of several figures just once. Then you can refer to those original settings with a REFID tag on each figure. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGDEF │ figure defi- │ CONCAT= │ No immediate │ │ │ │ nition │ DWIDTH= │ text. │ │ │ │ │ FRAME= │ │ │ │ │ │ ID= │ │ │ │ │ │ PLACE= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CONCAT=NO │ YES │ Specifies whether text within a figure │ │ │ is to be placed as entered or is to be │ │ │ formatted. YES causes formatting; text │ │ │ is concatenated. NO turns formatting │ │ │ off. │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ by BookManager. Specifies the display │ │ │ width of a figure, or table, to be │ │ │ viewed on a screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ figure, a table, or a grid; 'character' │ │ NONE │ is not valid for tables or grids. RULE │ │ 'character' │ is the initial setting for figures; BOX │ │ │ the initial setting for tables; NONE the │ │ │ initial setting for grids. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ PLACE=TOP │ Specifies the placement of a figure. │ │ INLINE │ The initial setting is TOP, and means │ │ BOTTOM │ the figure will float to the top of the │ │ │ next column or page; BOTTOM is similar │ │ │ -- the figure floats to the bottom of │ │ │ the next column or page. INLINE means │ │ │ the figure is not to be floated. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=PAGE │ Specifies the width of a figure. The │ │ COLUMN │ initial setting is PAGE for figures. │ │ horizontal space │ │ │ │ If a horizontal space specification is │ │ │ given, the figure will be set in the │ │ │ column if it fits; otherwise, it will be │ │ │ set the width given. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :figdef id=l123456 place=inline scale='.9' frame=none width=page. :fig refid=l123456. :efig. :fig refid=l123456. :efig. ═══ 2.68. FIGDESC Figure Description ═══ FIGDESC Figure Description Purpose The FIGDESC tag adds a further description of the figure. It is valid only within a figure. The FIGDESC tag should be entered immediately before the FIG end tag. With a FIGCAP tag, the description is printed below the figure following the figure number and caption. The figure description is separated from the caption with a period, and the text font is used rather than a highlighted font. Without a FIGCAP tag, the description is printed below the figure without a figure number. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGDESC │ figure │ │ Implied para- │ │ │ │ description │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :fig width=16p place=inline frame=box. This is an inline figure :figcap.Example of an inline figure :figdesc.This example also has a figure description assoicated with it. :efig. ═══ 2.69. FIGLIST Figure List ═══ FIGLIST Figure List Purpose The FIGLIST tag identifies the place in the front matter where the list of illustrations is to be placed. If the FIGLIST tag is not entered, a list of figures is not created. FIGLIST by default starts a new page and provides the text for the level-1 heading: "Figure List" and the running foot. You can specify an alternative to this default heading after any attributes and the period. If you want you figure list on the same page with your table of contents, instead of on a new page, you can include a DOCPROF tag in your prolog. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGLIST │ figure list │ ID= │ Text on same line │ [:EFIGLIST]│ │ │ │ INITPG= │ or next line; no │ │ │ │ │ MANUAL │ other tags. │ │ │ │ │ NUM= │ │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ MANUAL │ Specifies a manually generated figure │ │ │ list. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :frontm. :tipage. :preface. : :toc. :figlist. :tlist. ═══ 2.70. FIGREF Figure Reference ═══ FIGREF Figure Reference Purpose The FIGREF tag identifies a place in a document where a reference to a figure or a table is made. A figure reference is sometimes called a "figure callout." FIGREF can be used to refer to figures or tables that have a unique ID attribute value and a caption. References to uniquely identified figures or tables can occur anywhere in text. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGREF │ figure refer- │ FORM= │ Self-contained. │ │ │ │ ence │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.Please refer to :figref refid=chklst.. ═══ 2.71. FIGSEG Figure Segment ═══ FIGSEG Figure Segment Purpose For a figure that spans more than one page, the FIGSEG tag identifies points where it can logically be broken into parts. There are two types of multiple-part figures: conditional and unconditional. They CANNOT be mixed. o A CONDITIONAL multiple-part figure is broken into segments at a FIGSEG tag IF there is not room on the current page for the entire next segment (as indicated by the value on the FIT attribute). o An UNCONDITIONAL multiple-part figure is broken into segments at each FIGSEG tag, whether or not there is room on the page for the next segment. The only difference in the coding of conditional and unconditional multiple-part figures is the inclusion of the FIT attribute on the FIGSEG tags in the conditional figures. Note: FIGDESC tags are not permitted in multiple-part figures. Conditional Multiple-Part Figures: When a FIGSEG tag is encountered and the next segment (the number of lines specified on the FIT attribute) will not fit on the current page, that entire segment is placed on the following page. That is, the page break is CONDITIONAL on whether or not there is room for the next segment on the current page. Note: If the value on the FIT attribute is in lines, the space will vary depending on the output device. To code a conditional figure: include a FIT ATTRIBUTE on the FIGSEG tag specifying the maximum depth of the segment. This is required regardless of whether the figure has blank space for art or whether it has text or other graphic content. Unconditional Multiple Part-Figures: When a FIGSEG tag is encountered in a unconditional multiple-part figure, (even when this segment fits on the same page), the entire next segment is separated into another figure with a caption that is assigned the same figure number and contains the phrase "(Part 2 of x)." To code an UNCONDITIONAL figure: do NOT include the FIT attribute on the FIGSEG tags. Steps in Entering Figure Segments: 1. Enter the FIG tag, including the option "PLACE=INLINE". 2. Enter the FIGCAP tag. 3. Enter the first FIGSEG tag (with FIT attribute if conditional). 4. Determine the permissible break points for the figure. None must exceed the text area of the page minus the number of lines for the caption, framing, and spacing, if used. 5. Enter a FIGSEG tag at each of these points (with the FIT attribute if conditional). The FIGSEG tag will end a previously started segment and start a new one. 6. If the segment is to contain space for art to be inserted, it is necessary also to include the ARTWORK tag with a FIT attribute after each FIGSEG tag. 7. Enter EFIG to end the last segment. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FIGSEG │ figure │ FIT= │ Bracketed text. │ │ │ │ segment │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIT=vertical space │ Specifies the minimum number of lines │ │ │ required before splitting to a new │ │ │ segment. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :fig id=cfigseg place=inline width=column frame=box. :figcap.Conditional Multi-Part Figure :figseg fit=5p. :artwork fit=3p label=FIRST. First place this conditional multi-part figure can break. :efig. ═══ 2.72. FILENUM File Number ═══ FILENUM File Number Purpose The FILENUM tag specifies the file number for the cover of a document. It is placed in the prolog. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FILENUM │ file number │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :filenum.XXXX-0001 ═══ 2.73. FLE Figure List Entry ═══ FLE Figure List Entry Purpose When the MANUAL attribute on the FIGLIST tag is used, the FLE tag generates the entries for the FIGLIST. Use of the REFID attribute on an FLE tag is mutually exclusive from the use of FIGNUM, PAGE, and content. If REFID is used, an FLE end tag is not required. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FLE │ figure list │ FIGNUM= │ Implied para- │ [:EFLE] │ │ │ entry │ PAGE= │ graph. (Optional) │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIGNUM='figure number' │ Specifies the figure number in a hand- │ │ │ built figure list entry. │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual, figure │ │ │ list. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :figlist manual. :fle refid=zibs. :efiglist. :fle page=135 fignum=16. Looking at zibbidoos :efle. ═══ 2.74. FN Footnote ═══ FN Footnote Purpose The FN tag identifies a footnote with reference, explanation, or comment information. It is placed below the text on the printed page. FN requires a matching end tag. Footnotes can occur anywhere in text, except within other footnotes. The content of a footnote is composed of all the text between the FN tag and its end tag; it can contain any of the basic document elements. If no ID attribute is included with the FN tag, a footnote reference is inserted into the text following the last word before the footnote was defined. If an ID attribute is given, the location of the footnote reference must be identified with the FNREF tag. The text of the footnote is placed at the bottom of the current page if there is enough room for it, along with a footnote number. It is separated from the rest of the text in the column by a rule. The footnote number is used when referring to the footnote. In multiple column styles, footnotes format across the complete width of the page. They should be entered in the upper half of the first column if they are to appear at the bottom of a multiple column page. If entered too far down in the first column, the footnote may be printed on the following page. A single footnote should not exceed three-quarters of the page depth in size. If a footnote DOES exceed this limit, the excess is placed on the following page and an error message may be issued. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FN │ footnote │ ID= │ Implied para- │ │ │ │ │ CALLOUT= │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ CALLOUT=callout │ Specifies a footnote callout to override │ │ │ the generated footnote number. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.The footnote is placed at the bottom of the current page.:fnref refid=footnt1. :FN id=footnt1.Example of a footnote. If the footnote does not fit on the current page, it is placed at the bottom of the following page. :EFN. ═══ 2.75. FNREF Footnote Reference ═══ FNREF Footnote Reference Purpose The FNREF tag identifies a place in a document where a reference to a footnote is made. References to uniquely identified footnotes can occur anywhere in text. To ensure that the footnote and the reference to the footnote appear on the same page, they should be entered in the source document as close together as possible. The footnote reference may be inserted in the middle of a sentence. The footnote reference is printed in superscript numbers on devices that have such characters. Otherwise, the reference is enclosed in parentheses. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FNREF │ footnote ref- │ REFID= │ Self-contained. │ │ │ │ erence │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.The footnote is normally placed at the bottom of :fn id=footnt3. If the footnote does not fit on the current page, it is placed at the bottom of the next page. :efn. the current page.:fnref refid=footnt3.. ═══ 2.76. FRAGMENT Syntax Diagram Fragment ═══ FRAGMENT Syntax Diagram Fragment Purpose The FRAGMENT tag specifies a fragment of a language element syntax. This tag is a TOSL and the fragment name is optional. Format :FRAGMENT LID='id ...'.fragment-name :EFRAGMENT. Parameters LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample: :syntax. :group. :kwd.MYCMD :fragref.Sample Fragment :var.variable :egroup. :fragment.Sample Fragment :kwd.SOMETHING :var.else :efragment. :esyntax. Formats like: >>--MYCMD--| Sample Fragment |--variable--------------->< Sample Fragment: |--SOMETHING--else--------------------------------------| Usage 1. The KWD, VAR, OPER, DELIM, SEP, FRAGREF, GROUP, SYNNT, and SYNNTREF tags are valid between the FRAGMENT tag and its matching end tag. 2. The FRAGMENT tag cannot be specified inside a GROUP tag and must be the last tag in the syntax language description. 3. There can be zero or more FRAGMENT tags per SYNTAX tag. ═══ 2.77. FRAGREF Syntax Diagram Fragment Reference ═══ FRAGREF Syntax Diagram Fragment Reference Purpose The FRAGREF tag describes a fragment reference (that is, a reference to a fragment of a syntax language description). This tag is a TOSL and the fragment name is required. Note that the fragment name should match the name on the FRAGMENT tag but no check is made by BookMaster. Format :FRAGREF REQ|OPT LID='id ...'. fragment-name Parameters REQ|OPT specifies the selectability of the fragment, where: REQ indicates the fragment is required. OPT indicates the fragment is optional. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample fragment and reference: :syntax. :group. :kwd.MYCMD :fragref.Sample Fragment :var.variable :egroup. :fragment.Sample Fragment :kwd.SOMETHING :var.else :efragment. :esyntax. Formats like: >>--MYCMD--| Sample Fragment |--variable--------------->< Sample Fragment: |--SOMETHING--else--------------------------------------| ═══ 2.78. FRONTM Front Matter ═══ FRONTM Front Matter Purpose The FRONTM tag identifies a major element of a document containing material that serves as a guide to the document's contents and purpose, such as the preface, table of contents, and list of illustrations. If you have front matter (FRONTM) in your document, it is the first section. It contains standard information in a standard order. Not all of these elements are always present in the front matter, but when they are, they usually appear in this order: 1. Title page 2. Special notices 3. Cover 4. Version notices 5. Preface 6. Summary of amendments 7. Safety notices 8. Legend 9. List of abbreviations 10. Table of contents 11. List of figures 12. List of tables The front matter section is implicitly ended by the body section. The pages are numbered in lowercase Roman numerals. (The title page is actually page number "i" but no page number is printed.) Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FRONTM │ front matter │ │ No immediate │ │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples : :eprolog. :frontm. :tipage. : ═══ 2.79. FT Fix Text (Map) ═══ FT Fix Text (Map) Purpose The FT tag identifies the fix text in a map in a maintenance library document. FT must be placed within a STEP structure in a map. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :FT │ fix text │ FIT │ Any text; any- │ │ │ │ (map) │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIT=vertical space │ Specifies the minimum required for the │ │ │ tag content. The initial FIT setting │ │ │ for the QT tag is 7 lines. The initial │ │ │ FIT setting for the CT, FT, and ST tags │ │ │ is 3 lines. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :ft.Johny is sleepy. ═══ 2.80. GD Glossary Definition ═══ GD Glossary Definition Purpose The GD tag identifies the definition of the term or phrase being defined in a glossary list. It can only be used within a glossary list (GL). If preceded by a GDG tag, two or more GD tags can be used consecutively. When printed, glossary definitions are separated from the glossary term by a period. They format as blocked paragraphs. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GD │ glossary │ │ Implied para- │ │ │ │ definition │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :gl. :gt.application processing function (APF) :gd.In GML processing, the processing that is carried out when a document element or attribute is recognized. :gt.spectral response :gd.The variation in sensitivity of a device to light of different wavelengths. :egl. ═══ 2.81. GDG Glossary Definition Group ═══ GDG Glossary Definition Group Purpose When more than one definition is needed for a glossary term, you can use the GDG tag immediately after the GT tag. The GDG tag is then followed by as many GD tags as there are definitions for that term. The GDG tag is valid only within a glossary list. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GDG │ glossary │ │ No immediate │ │ │ │ definition │ │ text. │ │ │ │ group │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :gl. : :gt.markup :gdg. :gd.To determine the markup for a document. :gd.To insert markup into a source document. :egl. ═══ 2.82. GDOC General Document ═══ GDOC General Document Purpose The GDOC tag is the first tag in a GENERAL DOCUMENT. This tag has a matching end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GDOC │ general docu- │ COPYR= │ No immediate │ :EGDOC │ │ │ ment │ LANGUAGE= │ text. │ │ │ │ │ SEC= │ │ │ │ │ │ STYLE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COPYR='year(s)' │ Specifies the year(s) for the copyright │ │ │ notice. │ +──────────────────────────────+──────────────────────────────────────────+ │ LANGUAGE=BDUTCH │ │ Specifies the language in which all │ │ BFRENCH │ │ BookMaster-generated words are printed. │ │ BPORTUGUESE │ │ │ │ CENGLISH │ │ │ │ CFRENCH │ │ │ │ DANISH │ │ │ │ DUTCH │ │ │ │ ENGLISH │ │ │ │ FINNISH │ │ │ │ FRENCH │ │ │ │ GERMAN │ │ │ │ ITALIAN │ │ │ │ NORWEGIAN │ │ │ │ PORTUGUESE │ │ │ │ SFRENCH │ │ │ │ SGERMAN │ │ │ │ SITALIAN│ │ │ │ SPANISH │ │ │ │ SWEDISH │ │ │ │ UKENGLISH │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SEC='security class' │ Specifies a security classification that │ │ │ will be used as a running heading │ │ │ throughout the document. │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=name │ Specifies the named style for a docu- │ │ │ ment. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :gdoc sec='IBM Internal Use Only'. :frontm. :titlep. . . . :etitlep. . . . :body. . . . :backm. :index. :egdoc. ═══ 2.83. GL Glossary List ═══ GL Glossary List Purpose The GL tag identifies a list of glossary words or phrases and their corresponding definitions, descriptions, or explanations. GL requires an end tag. Each item in a glossary list is identified by a pair of tags: o The GT tag identifies the TERM being defined. The term being defined must be entered on a single line and cannot contain any other tags. o The GD tag identifies the DEFINITION of the term. The definition of the term is an implied paragraph, and can contain any of the basic text items. The GDG tag can be placed immediately after the GT tag when several definitions are required for one term. Glossary lists are blocked as paragraphs at the left margin. The glossary usually occurs in the back matter section of the manual. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GL │ glossary list │ COMPACT │ No immediate │ :EGL │ │ │ │ TERMHI= │ text. │ │ │ │ │ TERMSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Formats the content of the tag with no │ │ │ blank lines between entries, list items, │ │ │ or statements. │ +──────────────────────────────+──────────────────────────────────────────+ │ TERMHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for definition terms in a defi- │ │ . │ nition list or glossary. The initial │ │ . │ setting is 2. │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TERMSEL=NONE │ FIRST │ │ Specifies which glossary term on the │ │ FIRSTLAST │ LAST │ │ page is to be used for a running heading │ │ NODUP │ │ or footing. │ │ VERYLAST │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :gl. :grpsep.A :gt.alphameric string :gd.A sequence of characters consisting solely of the letters a through z and the numerals 0 through 9. :gt.ampersand :gd.The :q.&:eq. character. :gt.APF :gd.Application processing function. :gt.application processing function (APF) :gd.In GML processing, the processing that is carried out when a document element or attribute is recognized. :grpsep.B :gt.body :gd.The main section of the manual. :grpsep.C :gt.color :gd.In optical character recognition, the spectral appearance of the image dependent upon the spectral reflectance of the image, the spectral response of the observer, and the spectral composition of incident light. :grpsep.M :gt.markup :gdg. :gd.To determine the markup for a document. :gd.To insert markup into a source document. :grpsep.S :gt.spectral response :gd.The variation in sensitivity of a device to light of different wavelengths. :egl. ═══ 2.84. GLOSSARY Glossary ═══ GLOSSARY Glossary Purpose The GLOSSARY tag identifies the glossary of terms. It starts a new page and provides the text for the level-1 heading: "Glossary" and the running foot. You can specify an alternative to this default heading after any attributes and the period. All basic text elements are allowed in the glossary. The tags associated with the GLOSSARY tag are as follows: o The GL tag begins the glossary list. o The GT tag identifies the term. o The GD tag identifies the definition. o The GL end tag terminates the definition. In the back matter, the glossary is formatted in two-column format, regardless of the style of the body of the manual. A glossary is implicitly ended by another back matter section tag, such as INDEX, or by the appropriate document type end tag, such as the USERDOC end tag. A glossary usually appears within the back matter of the document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GLOSSARY │ glossary │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :glossary id=gloss.Definition of terms ═══ 2.85. GRID Grid ═══ GRID Grid Purpose The GRID tag, and its matching end tag, start and stop a grid. To design a grid: 1. Establish sample page layouts for your material. 2. Determine what the grid must look like to handle the different layouts you require, keeping the following facts in mind: o The grid is an UNDERLYING structure. o Using a "fine" underlying grid structure (that is, small sections, such as 12 by 12) provides greater flexibility in variations of page layout. o Each grid segment causes a complete horizontal break across the page. o Text cannot "flow" from one grid area to another. That is, YOU must control the breaks. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GRID │ grid │ DWIDTH= │ No immediate │ :EGRID │ │ │ │ FRAME= │ text. │ │ │ │ │ HMAX= │ │ │ │ │ │ HUNITS= │ │ │ │ │ │ HGUTTER= │ │ │ │ │ │ REFID= │ │ │ │ │ │ RULES= │ │ │ │ │ │ VMAX= │ │ │ │ │ │ VUNITS= │ │ │ │ │ │ VGUTTER= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ │ by BookManager. Specifies the display │ │ STACK │ width of a grid to be viewed on a │ │ │ screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ grid; NONE is the initial setting for │ │ NONE │ grids. │ +──────────────────────────────+──────────────────────────────────────────+ │ HMAX=number │ Specifies the maximum number of hori- │ │ │ zontal units in the grid structure. The │ │ │ initial setting is 12. │ +──────────────────────────────+──────────────────────────────────────────+ │ HUNITS='num num ...' │ Specifies the grouping of the horizontal │ │ │ units in the grid structure into grid │ │ │ areas. │ +──────────────────────────────+──────────────────────────────────────────+ │ HGUTTER=horizontal space │ In a grid, specifies the width of the │ │ │ gutter between grid areas. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ RULES=BOTH │ For grids, specifies horizontal and ver- │ │ HORIZ │ tical internal rules. BOTH is the │ │ VERT │ initial setting. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ VMAX=number │ Specifies the maximum number of vertical │ │ FIXED │ units in the grid structure. The │ │ 'number FIXED' │ initial setting is 12. │ +──────────────────────────────+──────────────────────────────────────────+ │ VUNITS=FIT │ Specifies the grouping of the vertical │ │ 'number' │ units in the grid structure into grid │ │ FILL │ segments. │ +──────────────────────────────+──────────────────────────────────────────+ │ VGUTTER=vertical space │ In a grid, specifies the width of the │ │ │ gutter between grid segments. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :grid frame=box hunits='3 *'. :gridseg. :gridarea. :p.:hp3.When you type this, . . .:ehp3. :gridarea. :p.:hp3.You get this result. . . .:ehp3. :gridseg. :gridarea. :p.Include fewer grid areas than specified in the HUNITS attribute. :gridarea. :p.We have these remaining grid areas . . . :egrid. ═══ 2.86. GRIDAREA Grid Area ═══ GRIDAREA Grid Area Purpose The GRIDAREA tag defines the areas within a grid segment (GRIDSEG). The entire grid is defined with the GRIDDEF tag. If you have FEWER grid areas than you specify in the HUNITS attribute of the GRIDDEF tag, BookMaster leaves the remaining grid areas in the segment blank and starts a new grid segment with your next GRIDSEG tag. If you have MORE grid areas than you specify in the HUNITS attribute of the GRIDDEF tag, BookMaster issues a warning message and forces a new grid segment for the excess grid areas. You CAN include the following elements in a grid area: o Head levels 2 through 20. o Examples, nonfloating figures, screens, dialogs, tables. o Directories (the LAYOUT attribute is ignored). o Graphics. o Footnotes. Remember to allow space at the bottom of your page for the footnote. o Any "normal" text, such as paragraphs, lists, and so on. You can begin a list in one grid area and continue it to the next. You can split the content of a list item among grid areas. You CANNOT include the following elements in a grid area: o Head levels 0 and 1. o Floating figures (any PLACE=TOP or PLACE=BOTTOM is ignored). GRIDAREA is ended by another GRIDAREA tag, a GRIDSEG tag, or a GRID end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GRIDAREA │ grid area │ │ No immediate │ │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ :grid refid=grid. :gridseg. :gridarea. :p.:hp3.When you type this, . . .:ehp3. :gridarea. :p.:hp3.You get this result. . . .:ehp3. :gridseg. :gridarea.:p.Include fewer grid areas than specified in the HUNITS attribute. . :egrid. ═══ 2.87. GRIDDEF Grid Definition ═══ GRIDDEF Grid Definition Purpose The GRIDDEF defines the GRID tag, which start and stop a grid. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GRIDDEF │ grid defi- │ DWIDTH= │ Self-contained. │ │ │ │ nition │ ID= │ │ │ │ │ │ FRAME= │ │ │ │ │ │ RULES= │ │ │ │ │ │ HMAX= │ │ │ │ │ │ HUNITS= │ │ │ │ │ │ HGUTTER= │ │ │ │ │ │ VMAX= │ │ │ │ │ │ VUNITS= │ │ │ │ │ │ VGUTTER= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ │ by BookManager. Specifies the display │ │ STACK │ width of a grid to be viewed on a │ │ │ screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ figure, a table, or a grid; 'character' │ │ NONE │ is not valid for tables or grids. RULE │ │ 'character' │ is the initial setting for figures; BOX │ │ │ the initial setting for tables; NONE the │ │ │ initial setting for grids. │ +──────────────────────────────+──────────────────────────────────────────+ │ RULES=BOTH │ For tables and grids, specifies hori- │ │ HORIZ │ zontal and vertical internal rules. │ │ VERT │ BOTH is the initial setting. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ HMAX=number │ Specifies the maximum number of hori- │ │ │ zontal units in the grid structure. The │ │ │ initial setting is 12. │ +──────────────────────────────+──────────────────────────────────────────+ │ HUNITS='num num ...' │ Specifies the grouping of the horizontal │ │ │ units in the grid structure into grid │ │ │ areas. │ +──────────────────────────────+──────────────────────────────────────────+ │ HGUTTER=horizontal space │ In a grid, specifies the width of the │ │ │ gutter between grid areas. │ +──────────────────────────────+──────────────────────────────────────────+ │ VMAX=number │ Specifies the maximum number of vertical │ │ FIXED │ units in the grid structure. See -- │ │ 'number FIXED' │ Heading 'DESGRID' unknown -- for more │ │ │ information. The initial setting is 12. │ +──────────────────────────────+──────────────────────────────────────────+ │ VUNITS=FIT │ Specifies the grouping of the vertical │ │ 'number' │ units in the grid structure into grid │ │ FILL │ segments. │ +──────────────────────────────+──────────────────────────────────────────+ │ VGUTTER=vertical space │ In a grid, specifies the width of the │ │ │ gutter between grid segments. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :griddef id=grid frame=none rules=none. :grid refid=grid. :gridseg. :gridarea. :p.:hp3.When you type this, . . .:ehp3. :gridarea. :p.:hp3.You get this result. . . .:ehp3. . :egrid. :grid refid=grid. :gridseg. :gridarea. :p.:hp3.When you type this, . . .:ehp3. :gridarea. :p.:hp3.You get this result. . . .:ehp3. . :egrid. ═══ 2.88. GRIDSEG Grid Segment ═══ GRIDSEG Grid Segment Purpose The GRIDSEG tag defines the beginning of a grid segment. It is followed by the GRIDAREA tag to define the areas within the segment. The entire grid is defined with the GRIDDEF tag. If you have MORE TEXT than will fit in the VUNITS space, your grid segment is extended as if you had specified vunits=fit. No warning message is issued, therefore you must inspect your output to make sure your text fits where you want it. If your segment is TOO DEEP to fit on the current page, BookMaster moves it to the next page. A grid segment is terminated by another GRIDSEG tag or a GRID end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GRIDSEG │ grid segment │ HUNITS= │ No immediate │ │ │ │ │ LHPAGE │ text. │ │ │ │ │ PAGE │ │ │ │ │ │ RHPAGE │ │ │ │ │ │ VUNITS= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ HUNITS='num num ...' │ Specifies the grouping of the horizontal │ │ │ units in the grid structure into grid │ │ │ areas. │ +──────────────────────────────+──────────────────────────────────────────+ │ LHPAGE │ Starts the grid segment on a new left- │ │ │ hand page. │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE │ Specifies that a grid segment is to │ │ │ start on a new page. │ +──────────────────────────────+──────────────────────────────────────────+ │ RHPAGE │ Starts the grid segment on a new right- │ │ │ hand page. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :grid refid=grid. :gridseg. :gridarea. :p.:hp3.When you type this, . . .:ehp3. :gridarea. :p.:hp3.You get this result. . . .:ehp3. :gridseg. :gridarea. :p.Include fewer grid areas than specified in the HUNITS attribute. . :egrid. ═══ 2.89. GROUP Syntax Diagram Group ═══ GROUP Syntax Diagram Group Purpose The GROUP tag defines a group of related language items or sub-groups. This tag is a TOSL and the group name is optional. If a group name is specified, then the group is eligible to be presented out-of-line as a fragment if the group cannot fit within the column width of the syntax diagram. Format :GROUP SEQ|CHOICE|COMPOSITE REQ|OPT|DEF group-name :EGROUP. Parameters SEQ|CHOICE|COMPOSITE specifies the type of relationship among the items and sub-groups, where: SEQ Indicates the relationship among the items and sub-groups is sequential. For example, a sequential group would look like this: ... ───XREF──ctlgname──filename─── ... and would be marked up like this: :group. :kwd.XREF :var.ctlgname :var.filename :egroup. CHOICE Indicates that the user must select one item or sub-group if the group is required (REQ attribute) and may select one item or sub-group if the group is optional (OPT attribute). For example, a required choice group would look like this: ... ─┬─FORM──┬─ ... ├─QUERY─┤ └─TABLE─┘ and would be marked up like this: :group choice. :kwd.FORM :kwd.QUERY :kwd.TABLE :egroup. COMPOSITE Indicates the relationship among the items is sequential and the items are to be next to each other with no intervening space. For example, a composite group would look like this: ... ───//SYSUTnn─── ... and would be marked up like this: :group composite. :kwd.//SYSUT :var.nn :egroup. REQ|OPT|DEF specifies the selectability of this group, where: REQ indicates this group is required. OPT indicates this group is optional. DEF indicates this group is a default. DEF is only allowed with composite and sequential groups. An error message is issued if DEF is used with a choice group. Examples Sample: :syntax. :group composite. :kwd.MYKEY :delim start.( :var.value :delim end.) :egroup. :esyntax. formats like: >>---MYKEY---(---value---)--->< Sample: :syntax style=lblbox.SAA CPI Database Reference :kwd.ERASE :group choice. :kwd.FORM :kwd.PROC :kwd.QUERY :kwd.TABLE :egroup. :var.name :group composite opt. :delim.( :kwd.CONFIRM :oper.= :group choice. :kwd.YES :kwd.NO :egroup. :egroup. :esyntax. formats like: +--- SAA CPI Database Reference ------------------------+ | | | >>--ERASE----FORM-----name--------------------------> | | |-PROC--| | | |-QUERY-| | | --TABLE-- | | | | >-------------------------------------------------->< | | | | | | --(CONFIRM=---YES----- | | | | | | --NO--- | | | +-------------------------------------------------------+ ═══ 2.90. GRPSEP Group Separator ═══ GRPSEP Group Separator Purpose If you want to separate items (for example, glossary terms) into different sections (that is, alphabetically), use the GRPSEP tag followed by the character you wish to have printed. The character or string following the GRPSEP tag will be printed in a box. The group separator formatting results include a preceding space of two blank lines followed by a boxed character or phrase of your choice. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GRPSEP │ group sepa- │ │ Text on same line │ │ │ │ rator │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :gl. :grpsep.A :gt.alphameric string :gd.A sequence of characters consisting solely of the letters a through z and the numerals 0 through 9. :gt.ampersand :gd.The :q.&:eq. character. :gt.APF :gd.Application processing function. :gt.application processing function (APF) :gd.In GML processing, the processing that is carried out when a document element or attribute is recognized. :grpsep.B :gt.body :gd.The main section of the manual. :egl. ═══ 2.91. GT Glossary Term ═══ GT Glossary Term Purpose The GT tag identifies the term or phrase within a glossary list. It is valid only within a glossary list. You cannot use two GT tags consecutively. It must be followed by a GD (glossary definition) or a GDG (glossary definition group) tag. The term is highlighted by default to a highlight level two. It is separated from the definition by a period. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :GT │ glossary term │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :gl. :gt.application processing function (APF) :gd.In GML processing, the processing that is carried out when a document element or attribute is recognized. :gt.spectral response :gd.The variation in sensitivity of a device to light of different wavelengths. :egl. ═══ 2.92. HDREF Head Reference ═══ HDREF Head Reference Purpose The HDREF tag identifies a place in a document at which a reference to a heading is made. A heading reference is sometimes called a "heading callout." References to headings can occur anywhere in text. You can specify whether full heading text (chapter number and title) or just chapter number should be included in heading references. This is done with the HDPREF attribute of the DOCPROF tag. The default is to include the entire heading. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HDREF │ head refer- │ FORM= │ Self-contained. │ │ │ │ ence │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.See :hdref refid=hexa. to find out... ═══ 2.93. HEX Hexadecimal number ═══ HEX Hexadecimal number Purpose The HEX tag identifies a number that must be recognized as a hexadecimal number to prevent confusing it with a decimal number. This tag requires a matching end tag. Hexadecimal numbers can occur anywhere in text where a tag is allowed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HEX │ hexadecimal │ │ Numeric │ :EHEX │ │ │ number │ │ hexadecimal data. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.The program is stored at :HEX.1A7F:EHEX. through :hex.9A7F:ehex. ═══ 2.94. HP0 Highlighted Phrase 0 ═══ HP0 Highlighted Phrase 0 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type zero is the current text font Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP0 │ highlighted │ │ Any text; any- │ :EHP0 │ │ │ phrase 0 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples The :hp0.ordinary:ehp0. text is highlighted HP0. ═══ 2.95. HP1 Highlighted Phrase 1 ═══ HP1 Highlighted Phrase 1 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type one is italic or underscored Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP1 │ highlighted │ │ Any text; any- │ :EHP1 │ │ │ phrase 1 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of :hp1.highlighting:ehp1. is italics or underscored. ═══ 2.96. HP2 Highlighted Phrase 2 ═══ HP2 Highlighted Phrase 2 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type two is boldface Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP2 │ highlighted │ │ Any text; any- │ :EHP2 │ │ │ phrase 2 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This highlighting :hp2.boldfaces:ehp2. words or phrases. ═══ 2.97. HP3 Highlighted Phrase 3 ═══ HP3 Highlighted Phrase 3 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type three is boldface italic or underscored and boldface Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP3 │ highlighted │ │ Any text; any- │ :EHP3 │ │ │ phrase 3 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples Use this :hp3.highlighting:ehp3. for special emphasis to words or phrases. ═══ 2.98. HP4 Highlighted Phrase 4 ═══ HP4 Highlighted Phrase 4 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type four is text font (or small text font) in all uppercase letters Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP4 │ highlighted │ │ Any text; any- │ :EHP4 │ │ │ phrase 4 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of highlighting is often used on :hp4.commands:ehp4. and :hp4.initials:ehp4. ═══ 2.99. HP5 Highlighted Phrase 5 ═══ HP5 Highlighted Phrase 5 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type five appears as an underscored HP0 Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP5 │ highlighted │ │ Any text; any- │ :EHP5 │ │ │ phrase 5 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of highlighting :hp5.underlines:ehp5. text. ═══ 2.100. HP6 Highlighted Phrase 6 ═══ HP6 Highlighted Phrase 6 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type six appears as an underscored HP1 Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP6 │ highlighted │ │ Any text; any- │ :EHP6 │ │ │ phrase 6 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of highlighting :hp6.underlines and italicizes:ehp6. text. ═══ 2.101. HP7 Highlighted Phrase 7 ═══ HP7 Highlighted Phrase 7 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type seven appears as an underscored HP2 Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP7 │ highlighted │ │ Any text; any- │ :EHP7 │ │ │ phrase 7 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of highlighting :hp7.underscores and bolfaces:ehp7. text. ═══ 2.102. HP8 Highlighted Phrase 8 ═══ HP8 Highlighted Phrase 8 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type eight appears as an underscored HP3 Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP8 │ highlighted │ │ Any text; any- │ :EHP8 │ │ │ phrase 8 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This type of highlighting gives the :hp8.ultimate:ehp8. emphasis on your text. ═══ 2.103. HP9 Highlighted Phrase 9 ═══ HP9 Highlighted Phrase 9 Purpose The highlighted phrase tags identify a word or phrase that is to be emphasized. They all require matching end tags. A highlighted phrase can be a complete sentence or paragraph, or only part of a word. Highlight type nine appears as an underscored HP4 Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :HP9 │ highlighted │ │ Any text; any- │ :EHP9 │ │ │ phrase 9 │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples This highlighting :hp9.underscores small block lettering:ehp9. of your text. ═══ 2.104. H0 Head Level 0 - Part Heading ═══ H0 Head Level 0 - Part Heading Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Head 0 is typically used to divid a book with several chapters into parts. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H0 │ head level 0 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docprof rhrfrule=yes . . . :h0 id=intro subject='Introduction' stitle='Introduction'. Part One. Introduction :p. This section... ═══ 2.105. H1 Head Level 1 - Chapter Heading ═══ H1 Head Level 1 - Chapter Heading Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H1 │ head level 1 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docprof rhrfrule=yes fbc=yes . . . :h1 id=intro subject='Introduction' stitle='Introduction'. Introduction :p. This section... ═══ 2.106. H2 Head Level 2 ═══ H2 Head Level 2 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H2 │ head level 2 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :h2 id=ABCD.ABCD Procedure :p. This section... ═══ 2.107. H3 Head Level 3 ═══ H3 Head Level 3 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H3 │ head level 3 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :h3 id=ABCD.ABCD Procedure :p. This section... ═══ 2.108. H4 Head Level 4 ═══ H4 Head Level 4 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H4 │ head level 4 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :h4 id=ABCD.ABCD Procedure :p. This section... ═══ 2.109. H5 Head Level 5 ═══ H5 Head Level 5 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H5 │ head level 5 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples ...previous text sentence. :h5 id=ABCD.ABCD Procedure :p. This section... ═══ 2.110. H6 Head Level 6 ═══ H6 Head Level 6 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H6 │ head level 6 │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples ...previous text sentence. :h6 id=ABCD.ABCD Procedure :p. This section... ═══ 2.111. H7 through H20 Head Levels 7 through 20 ═══ H7 through H20 Head Levels 7 through 20 Purpose The text of a heading must be entered on a single line and cannot contain any tags. The text of headings should be entered in uppercase and lowercase letters because headings appear in the table of contents as you have entered them, regardless of how the heading is formatted in the document itself. These headings format the same as H6. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :H7 - │ head levels 7 │ ID= │ Text on same line │ │ │ :H20 │ through 20 │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples ...previous text sentence. :h12 id=ABCD.ABCD Procedure :p. This section... ═══ 2.112. IBMLPS IBM Licensed Program Specification ═══ IBMLPS IBM Licensed Program Specification Purpose The IBM Licensed Program Specification is used to create the licensed program specifications and licensed information documents for IBM products. See IBM Corporate Standard C-S 0-6020-007 (1989-02) for details on the content of the LPS. A sample of an LPS document is provided in the file SAMPLPS SCRIPT. The two styles available with this document type are: IBMZALP - 8.5x11 Licensed Program Specifications (default) IBMZALI - 8.5x11 License Information Format :ibmlps sec='draft security classification'. Parameters sec='draft security classification' specifies the draft security classification. Examples :ibmlps sec='draft security classification'. :prolog. :title. :library. first line of library part of title second line of library part of title :topic. first line of topic part of title second line of topic part of title :version.version identification :release.release identification :etitle. :pgmnum.program number :docnum level=level.document number :date.product announce date :eprolog. :body. . . . :h1.Warranty :warranty subject=full. :eibmlps. ═══ 2.113. IBMRMAT IBM Restricted Materials ═══ IBMRMAT IBM Restricted Materials Purpose The IBMRMAT (IBM restricted materials) tag is for licensed, restricted, and confidential restricted material. The IBMRMAT tag should be placed in the prolog after the DOCNUM tag. Format :IBMRMAT classif=confres|res|lic ibmcopyr='.copyright'. Parameters CLASSIF Specifies the classification of the restricted materials. CLASSIF can take the following values: CONFRES confidential restricted RES restricted LIC licensed If you use the IBMRMAT tag and omit the CLASSIF attribute, BookMaster uses the most restrictive category (confidential restricted) and issues a warning message. IBMCOPYR This attribute must be used if the classification of the document is RES or LIC and the normal copyright for the document is more than two years. You cannot use the IBMCOPYR attribute if the classification of the document is CONFRES. Note: If the classification of the document is CONFRES, do not use the COPYR attribute on the USERDOC or GDOC tag. The IBMCOPYR attribute on the IBMRMAT tag supplies the first and last years of the copyright (these are used because there isn't room in the restricted material line for lots of copyright years). If you omit the IBMCOPYR attribute, the copyright information from the COPYR or IBMCOPYR attributes on the USERDOC tag are used (which is what you want if it is two years or less). Examples :ibmrmat classif=res ibmcopyr='1974, 1990'. ═══ 2.114. IBMSFTY IBM Safety Section ═══ IBMSFTY IBM Safety Section Purpose The IBMSFTY tag generates a safety notice and prints it in the front matter of the document. Safety notices are composed of standard text that has gone through a complete checkout for relevancy, legal requirements, and World Trade translation requirements. They should not be modified in any way. The safety notice contains information about practices that should be observed when working around hardware equipment. The IBMSFTY tag begins a new page. (If duplexing is requested, the new page is odd-numbered. A level-one heading with the text "Safety" is placed on the new page. The IBMSFTY tag requires no end tag. The notice is implicitly ended by a PREFACE, TOC, FIGLIST, or BODY tag. A shortened title may be requested for the running footing with the STITLE attribute. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IBMSFTY │ safety │ ID= │ No immediate │ │ │ │ section │ INITPG= │ text. │ │ │ │ │ PNKEY= │ │ │ │ │ │ NUM= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :frontm. :notices. :nitem subject=fcca :enotices :preface. :IBMSFTY. :toc. ═══ 2.115. IBMX IBM Extension ═══ IBMX IBM Extension Purpose The IBMX tag indicates an IBM extension to a programming language for which external standards exist (FORTRAN, COBOL, and so on). IBMX requires a matching end tag. This tag is suitable only for qualification at the level of a paragraph or list item or greater. It is not suitable for single-phrase qualifications; neither is it suitable for qualifications of many pages. IBMX is inserted ahead of the discussion of the extension. The text associated with the extension must be at least a paragraph or list item. The IBMX end tag is placed at the end of the discussion. IBMX cannot be used within a table or a figure. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IBMX │ IBM extension │ │ No immediate │ :EIBMX │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.Standard record length is 255 bytes. :IBMX. :p.You can have records up to 32,767 bytes in length. :EIBMX. :p.Records may be fixed or variable length. ═══ 2.116. IH1 Index Entry Heading Level 1 ═══ IH1 Index Entry Heading Level 1 Purpose IH1 identifies a primary index heading to be placed alphabetically in the index. Index headings do NOT generate page numbers. Index headers are most often used when secondary and tertiary index terms (I2, I3) (WITH page numbers) are to follow. The text of an index heading must be entered on a single line and cannot include any other tags. Note: The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IH1 │ index entry │ CIX= │ Text on same line │ │ │ │ heading level │ CIX1= │ or next line; no │ │ │ │ 1 │ . │ other tags. │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ CIX9= │ │ │ │ │ │ ID= │ │ │ │ │ │ INCLUDE= │ │ │ │ │ │ PRINT= │ │ │ │ │ │ SEE= │ │ │ │ │ │ SEEID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CIX='index primary' │ Specifies a primary entry that is to be │ │ │ cross-indexed with the main primary. │ │ CIX1= │ CIX1 through CIX9 are available for │ │ . │ additional cross-indexing with the main │ │ . │ primary. │ │ . │ │ │ CIX9= │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRINT='print text' │ Specifies the text that is to be printed │ │ │ in the index in place of the text fol- │ │ │ lowing the markup, which is used to │ │ │ determine how the entry is sorted. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEE='see/see also text' │ Specifies the text to be used in a "see" │ │ │ or "see also" reference in the index. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEEID=name │ Specifies the name of an index structure │ │ │ (identified in an ID attribute) to be │ │ │ used in a "see" or "see also" reference. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :ih1 print='TIME'.timez :i1.timez . . . :i1.time ═══ 2.117. IH2 Index Entry Heading Level 2 ═══ IH2 Index Entry Heading Level 2 Purpose IH2 identifies a secondary index heading to be placed in the index in association with a primary term or heading. Index headings do NOT generate page numbers. Index headers are most often used when secondary and tertiary index terms (I2, I3) (WITH page numbers) are to follow. Unless you specify otherwise with the REFID attribute, IH2 entries are placed with the most recently specified primary terms. The text of an index heading must be entered on a single line and cannot include any other tags. Note: : The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IH2 │ index entry │ ID= │ Text on same line │ │ │ │ heading level │ INCLUDE= │ or next line; no │ │ │ │ 2 │ PRINT= │ other tags. │ │ │ │ │ REFID= │ │ │ │ │ │ SEE= │ │ │ │ │ │ SEEID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRINT='print text' │ Specifies the text that is to be printed │ │ │ in the index in place of the text fol- │ │ │ lowing the markup, which is used to │ │ │ determine how the entry is sorted. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEE='see/see also text' │ Specifies the text to be used in a "see" │ │ │ or "see also" reference in the index. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEEID=name │ Specifies the name of an index structure │ │ │ (identified in an ID attribute) to be │ │ │ used in a "see" or "see also" reference. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :h3.Indexing :p.There are several forms of indexing. Several will be discussed here. We will begin with indexing chapter headings :ih1.indexing :ih2.types of :i3.chapter headings ═══ 2.118. IH3 Index Entry Heading Level 3 ═══ IH3 Index Entry Heading Level 3 Purpose IH3 identifies a tertiary index heading to be placed in the index in association with a primary and a secondary term or heading. Index headings do NOT generate page numbers. Index headers are most often used when secondary and tertiary index terms (I2, I3) (WITH page numbers) are to follow. Unless you specify otherwise with the REFID attribute, IH3 entries are placed with the most recently specified secondary terms. The text of an index heading must be entered on a single line and cannot include any other tags. Note: : The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IH3 │ index entry │ ID= │ Text on same line │ │ │ │ heading level │ INCLUDE= │ or next line; no │ │ │ │ 3 │ PRINT= │ other tags. │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRINT='print text' │ Specifies the text that is to be printed │ │ │ in the index in place of the text fol- │ │ │ lowing the markup, which is used to │ │ │ determine how the entry is sorted. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p. :ih1.fruit bats :ih2.care and feeding :ih3 print='grain'.apples ═══ 2.119. INDEX Index ═══ INDEX Index Purpose The index tag identifies the place in the document at which the index is to be inserted. The index must be in the back matter of a document. It starts a new page and provides the text for the level-1 heading: "Index" and the running foot. You can specify an alternative to this default heading after the period. The index page will be empty if the INDEX option is not used on the SCRIPT command. The index is composed of index entries identified by the IH1, IH2, IH3, I1, I2, I3, and IREF tags. To aid retrievals, a group separator indicates the start of each new initial character sequence. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :INDEX │ index │ PRIMHI= │ Text on same line │ │ │ │ │ ID= │ or next line; no │ │ │ │ │ INITPG= │ other tags. │ │ │ │ │ NUM= │ (Optional │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PRIMHI=0 │ 1 │ 2 │ ... │ 9 │ Specifies the highlighting used for │ │ │ primary index entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :backm. : :index. :euserdoc. ═══ 2.120. IREF Index Entry Reference ═══ IREF Index Entry Reference Purpose The IREF tag generates an index entry identical to an existing one that contains an ID attribute. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :IREF │ index entry │ INCLUDE= │ Self-contained. │ │ │ │ reference │ REFID= │ │ │ │ │ │ PG= │ │ │ │ │ │ SEEID= │ │ │ │ │ │ SEE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PG=START │ Specifies a page reference for an index │ │ END │ entry other than just the page number. │ │ MAJOR │ START and END are used to specify the │ │ 'string' │ start and end of a page range. MAJOR │ │ │ specifies that this is the most impor- │ │ │ tant entry; the page number will be │ │ │ placed first in a string of entries. │ │ │ string allows specification of text to │ │ │ be used in place of the page reference. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEEID=name │ Specifies the name of an index structure │ │ │ (identified in an ID attribute) to be │ │ │ used in a "see" or "see also" reference. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEE='see/see also text' │ Specifies the text to be used in a "see" │ │ │ or "see also" reference in the index. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :ih1.weasels :i2 id=care.care and feeding . . :iref refid=care. . . :iref refid=care. ═══ 2.121. I1 Index Entry Term Level 1 ═══ I1 Index Entry Term Level 1 Purpose Index TERMS differ from index HEADINGS (IH1, IH2, IH3) in that index terms (I1, I2, I3) generate page numbers. I1 identifies a primary index term to be placed alphabetically in the index. The text of an index term must be entered on a single line and cannot include any other tags. NOTE: The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :I1 │ index entry │ CIX= │ Text on same line │ │ │ │ term level 1 │ CIX1= │ or next line; no │ │ │ │ │ . │ other tags. │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ CIX9= │ │ │ │ │ │ ID= │ │ │ │ │ │ INCLUDE= │ │ │ │ │ │ PG= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CIX='index primary' │ Specifies a primary entry that is to be │ │ │ cross-indexed with the main primary. │ │ CIX1= │ CIX1 through CIX9 are available for │ │ . │ additional cross-indexing with the main │ │ . │ primary. │ │ . │ │ │ CIX9= │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PG=START │ Specifies a page reference for an index │ │ END │ entry other than just the page number. │ │ MAJOR │ START and END are used to specify the │ │ 'string' │ start and end of a page range. MAJOR │ │ │ specifies that this is the most impor- │ │ │ tant entry; the page number will be │ │ │ placed first in a string of entries. │ │ │ string allows specification of text to │ │ │ be used in place of the page reference. │ +──────────────────────────────+──────────────────────────────────────────+ Examples Index tags are designed to help locate subjects within :I1.index tags a book faster and more efficiently. ═══ 2.122. I2 Index Entry Term Level 2 ═══ I2 Index Entry Term Level 2 Purpose Index TERMS differ from index HEADINGS (IH1, IH2, IH3) in that index terms (I1, I2, I3) generate page numbers. I2 identifies a secondary index term to be placed in the index in association with a primary term or heading. The text of an index term must be entered on a single line and cannot include any other tags. Unless you specify otherwise with the REFID attribute, I2 entries are placed with the most recently specified primary terms. Note: The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :I2 │ index entry │ ID= │ Text on same line │ │ │ │ term level 2 │ INCLUDE= │ or next line; no │ │ │ │ │ PG= │ other tags. │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PG=START │ Specifies a page reference for an index │ │ END │ entry other than just the page number. │ │ MAJOR │ START and END are used to specify the │ │ 'string' │ start and end of a page range. MAJOR │ │ │ specifies that this is the most impor- │ │ │ tant entry; the page number will be │ │ │ placed first in a string of entries. │ │ │ string allows specification of text to │ │ │ be used in place of the page reference. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples Index tags are designed to help locate subjects within :ih1.index tags :i2.description of a book faster and more efficiently. ═══ 2.123. I3 Index Entry Term Level 3 ═══ I3 Index Entry Term Level 3 Purpose Index TERMS differ from index HEADINGS (IH1, IH2, IH3) in that index terms (I1, I2, I3) generate page numbers. I3 identifies a tertiary index term to be placed in the index in association with a primary and a secondary term or heading. The text of an index term must be entered on a single line and cannot include any other tags. Unless you specify otherwise with the REFID attribute, I3 entries are placed with the most recently specified secondary terms. Note: The INDEX option of the SCRIPT command must be used for the index to be created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :I3 │ index entry │ ID= │ Text on same line │ │ │ │ term level 3 │ INCLUDE= │ or next line; no │ │ │ │ │ PG= │ other tags. │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCLUDE='ALL BOOK │ Specifies the indexes where specific │ │ DISPLAY MINDEX' │ index entries are to appear. │ +──────────────────────────────+──────────────────────────────────────────+ │ PG=START │ Specifies a page reference for an index │ │ END │ entry other than just the page number. │ │ MAJOR │ START and END are used to specify the │ │ 'string' │ start and end of a page range. MAJOR │ │ │ specifies that this is the most impor- │ │ │ tant entry; the page number will be │ │ │ placed first in a string of entries. │ │ │ string allows specification of text to │ │ │ be used in place of the page reference. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples Index tags are designed to help locate subjects within :IH1.indexing :IH2.index tags :I3.description of a book faster and more efficiently. ═══ 2.124. KWD Syntax Diagram Keyword ═══ KWD Syntax Diagram Keyword Purpose The KWD tag describes a keyword, a command name, or other such literal information. This tag is a TOSL and the keyword name is required. Format :KWD REQ|OPT|DEF LID='id ...'. keyword-name Parameters REQ|OPT|DEF specifies the selectability of the keyword, where: REQ indicates the keyword is required. OPT indicates the keyword is optional. DEF indicates the keyword is a default. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample keywords: :syntax. :kwd.REQUIRED :kwd opt.OPTIONAL :kwd def.DEFAULT :esyntax. Formats like: >>---REQUIRED------------------DEFAULT--->< | | ~~~~~~~ ---OPTIONAL--- ═══ 2.125. L Explicite Document Links ═══ L Explicite Document Links Purpose The L tag identifies a word or phrase that is to cause a BookManager hyperlink to be processed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :L │ explicit link │ LID= │ Any text; any- │ :EL │ │ │ │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LID=name │ Specifies the name associated with a │ │ │ link description (LDESC). The name can │ │ │ be up to seven characters. The first │ │ │ character must be a letter and all │ │ │ letters should be lowercase. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :docdesc id=prog num='SC34-1234' desc='Morning Star Prog Guide'. :ldesc id=mod docid=prog object=how2mod. . . . :p. I went to the woods to learn how to program, but first I needed to :l lid=mod.modify the POND SCRIPT file.:el. ═══ 2.126. LBLBOX Labeled Box ═══ LBLBOX Labeled Box Purpose Labeled boxes set apart special information such as language syntax, chapter summaries, important points to remember, or warnings. The label you include on your LBLBOX tag is printed within the top line of the box and issues a warning message. If you omit the label from the LBLBOX tag, ISIL prints question marks within the top line. If your label is too long, a warning message is issued and the tag ignored. o Offset style can handle about 20 picas. o Double column style can handle about 9 picas. o Full page width style can handle about 30 picas. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LBLBOX │ labeled box. │ │ Text on same line │ :ELBLBOX │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :lblbox.Fact to Remember :p.With tags, you describe :hp2.what an element is:ehp2., not what it will look like on the page. :elblbox. ═══ 2.127. LDESC Explicit Link Description ═══ LDESC Explicit Link Description Purpose The LDESC tag describes the information you want BookManager to create a link to. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LDESC │ explicit link │ DATA= │ No immediate │ │ │ │ description │ DOCID= │ text. │ │ │ │ │ ID= │ │ │ │ │ │ OBJECT= │ │ │ │ │ │ OBJTYPE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DATA='string' │ Specifies data to be passed to │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ DOCID=name │ Specifies the name associated with a │ │ │ DOCDESC tag. The name can be up to │ │ │ seven characters. The first character │ │ │ must be a letter and all letters should │ │ │ be lowercase. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ OBJECT=object-name │ Identifies the information being linked │ │ │ to. In BookMaster, this is the ID │ │ │ attribute of that information. │ +──────────────────────────────+──────────────────────────────────────────+ │ OBJTYPE=ANIMATION │ ANS │ │ Identifies the type of information to be │ │ AUDIO │ BOOK │ CI │ │ linked to. │ │ FIG │ GRAPHIC │ │ │ │ HEAD │ IMAGE │ LI │ │ │ │ 'OTHER category' │ │ │ │ PROGRAM │ QUES │ │ │ │ SPOT │ STEP │ │ │ │ TABLE │ VIDEO │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :prolog. . . . :ldesc id=abc2 object=figabc2 objtype=fig. :ldesc id=abc3 object=hdabc3. :ldesc id=abc4 object=tabc4 objtype=table. :eprolog. . . . :p.Here's an example with a :l lid=abc2.link to a figure.:el. Here's another sample with :l lid='abc3 abc4'.links to a heading and a table.:el. ═══ 2.128. LEDI Language Element Description Item ═══ LEDI Language Element Description Item Purpose The LEDI tag identifies a language element description item. The ID attribute of LEDI can be referred to by the REFID attribute on a HDREF tag. Each "subheading attribute" of LEDI generates a default subheading. Each of these can be overridden by any of the following: o The individual subheading attribute on LERSDEF in the prolog. This affects all the LERS that point to this LERSDEF. o The individual subheading attribute on a LERS tag. This changes the subheading for this item only between this LERS tag and its matching end tag. o The TEXT attribute of LEDI. This changes the subheading for this item only. If there is only one message generated for this item you can make the "Messages" subheading singular. By default, each language element description item (LEDI) is treated as an H4 tag. This head level can be overridden by the LEDIHD attribute on LERS or LERSDEF. LEDIHD can be specified as any level between 3 and 6, but not the same as or higher than the head level of the language element name. LEDI does NOT generate table of contents (TOC or PTOC) entries. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LEDI │ language │ AUTH │ No immediate │ │ │ │ element │ COMMENTS │ text. │ │ │ │ description │ CONTEXT │ │ │ │ │ item │ DEFAULTS │ │ │ │ │ │ ERRCOND │ │ │ │ │ │ EXAMPLES │ │ │ │ │ │ FLAGS │ │ │ │ │ │ FORMAT │ │ │ │ │ │ ID= │ │ │ │ │ │ INTREP │ │ │ │ │ │ MESSAGES │ │ │ │ │ │ OTHER │ │ │ │ │ │ PARMS │ │ │ │ │ │ PROCESS │ │ │ │ │ │ PURPOSE │ │ │ │ │ │ RESTRICT │ │ │ │ │ │ RESULTS │ │ │ │ │ │ RETCODES │ │ │ │ │ │ SYSENV │ │ │ │ │ │ TEXT= │ │ │ │ │ │ USAGE │ │ │ │ │ │ VERSION │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ AUTH │ "Authorization" category. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMMENTS │ Specifies the category of a language │ │ │ element description item (LEDI) -- "com- │ │ │ ments." │ +──────────────────────────────+──────────────────────────────────────────+ │ CONTEXT │ Context │ +──────────────────────────────+──────────────────────────────────────────+ │ DEFAULTS │ Defaults │ +──────────────────────────────+──────────────────────────────────────────+ │ ERRCOND │ Error conditions │ +──────────────────────────────+──────────────────────────────────────────+ │ EXAMPLES │ Examples │ +──────────────────────────────+──────────────────────────────────────────+ │ FLAGS │ Flags │ +──────────────────────────────+──────────────────────────────────────────+ │ FORMAT │ Format (syntax diagrams) │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INTREP │ Internal Representation │ +──────────────────────────────+──────────────────────────────────────────+ │ MESSAGES │ Messages │ +──────────────────────────────+──────────────────────────────────────────+ │ OTHER │ define your own category. │ +──────────────────────────────+──────────────────────────────────────────+ │ PARMS │ Parameters │ +──────────────────────────────+──────────────────────────────────────────+ │ PROCESS │ Processing │ +──────────────────────────────+──────────────────────────────────────────+ │ PURPOSE │ Purpose │ +──────────────────────────────+──────────────────────────────────────────+ │ RESTRICT │ Restrictions │ +──────────────────────────────+──────────────────────────────────────────+ │ RESULTS │ Results │ +──────────────────────────────+──────────────────────────────────────────+ │ RETCODES │ Return codes │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSENV │ system environment │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to override the text │ │ │ normally generated for notes or language │ │ │ element description items. │ +──────────────────────────────+──────────────────────────────────────────+ │ USAGE │ Usage │ +──────────────────────────────+──────────────────────────────────────────+ │ VERSION │ Version │ +──────────────────────────────+──────────────────────────────────────────+ Examples :LERS. (Start a language element reference section) :LEN.name:ELEN. (Identify a language element) :LEDI purpose.text. . . (Language element description items) :LEDI format.text. . . . :LEDI parms.text. . . . :LEDI usage.text. . . . :LEDI examples.text. . . . . . :ELERS. (End language element reference section) ═══ 2.129. LEGEND Legend ═══ LEGEND Legend Purpose The LEGEND tag identifies a page devoted to a list of symbols that are pertinent to the understanding of a manual. The legend usually appears within the front matter of the document. It starts a new page and provides the text for the level-1 heading: "Legend." You can specify an alternative to this default heading after any attributes and the period. The alternative heading must contain text only; that is, no tags can be included. The text must be all on the same line as the tag or all on the next line. A legend is implicitly ended by another front matter section tag such as TOC or FIGLIST, or the BODY tag. All elements that can be used in chapters are usable following the LEGEND tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LEGEND │ legend │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ PNKEY= │ other tags. │ │ │ │ │ NUM= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples : :eprolog. :frontm. :legend. :tipage. : ═══ 2.130. LEN Language Element Name ═══ LEN Language Element Name Purpose The LEN tag names a language element (for example, a command or statement). It requires a matching end tag. The ID attribute on LEN can be referred to by the REFID attribute of the HDREF tag. Multiple lines can be entered with LEN; they will appear in your output as you enter them. By default, LEN treats each language element name as an H2. You can specify a change to this head level with the LEHD attribute on LERS and LERSDEF. It can be set at any head level between 2 and 6. By default, the separation between language elements is the normal spacing for an H2. You can change this default with the SEP attribute of LERS or LERSDEF tag. You can, for example, start a new page for each LEN even though LEN is an H2. Table of contents (TOC and PTOC) entries are generated for LEN entries. You can control which head levels are included in your tables of contents with the TOC and PTOC attributes of DOCPROF. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LEN │ language │ ID= │ Bracketed text. │ :ELEN │ │ │ element name │ INITPG= │ (No other tags.) │ │ │ │ │ PNKEY= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :LERS. (Start a language element reference section) :LEN.name:ELEN. (Identify a language element) :LEDI purpose.text. . . (Language element description items) :LEDI format.text. . . . :LEDI parms.text. . . . :LEDI usage.text. . . . :LEDI examples.text. . . . . . :ELERS. (End language element reference section) ═══ 2.131. LERS Language Element Reference Section ═══ LERS Language Element Reference Section Purpose The LERS tag identifies the start of a language element reference section. It sets up a formatting environment for language element reference information. Headings and text are formatted in the current style of the document, unless otherwise specified. LERS requires a matching end tag. Any of the default subheadings or those specified on LERSDEF can be overridden on the LERS tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LERS │ language │ AUTH= │ No immediate │ :ELERS │ │ │ element ref- │ COMMENTS= │ text. │ │ │ │ erence │ CONTEXT= │ │ │ │ │ section │ DEFAULTS= │ │ │ │ │ │ ERRCOND= │ │ │ │ │ │ EXAMPLES= │ │ │ │ │ │ FLAGS= │ │ │ │ │ │ FORMAT= │ │ │ │ │ │ INTREP= │ │ │ │ │ │ LANG= │ │ │ │ │ │ LEDIHD= │ │ │ │ │ │ LEHD= │ │ │ │ │ │ LENSEL= │ │ │ │ │ │ MESSAGES= │ │ │ │ │ │ OTHER= │ │ │ │ │ │ PARMS= │ │ │ │ │ │ PROCESS= │ │ │ │ │ │ PURPOSE= │ │ │ │ │ │ REFID= │ │ │ │ │ │ RESTRICT= │ │ │ │ │ │ RESULTS= │ │ │ │ │ │ RETCODES= │ │ │ │ │ │ SEP= │ │ │ │ │ │ SYSENV= │ │ │ │ │ │ USAGE= │ │ │ │ │ │ VERSION= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ AUTH='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the AUTH attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMMENTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the COMMENTS attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ CONTEXT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the CONTEXT attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEFAULTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the DEFAULTS attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ ERRCOND='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the ERRCOND attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXAMPLES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the EXAMPLES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ FLAGS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the FLAGS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ FORMAT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the FORMAT attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ INTREP='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the INTREP attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ LANG='language' │ Specifies the programming language about │ │ │ which a language element reference │ │ │ section concerns itself. │ +──────────────────────────────+──────────────────────────────────────────+ │ LEDIHD=4 │ Specifies the heading level the LEDI is │ │ 3 │ to be considered. The initial setting │ │ 5 │ is 4. │ │ 6 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LEHD=2 │ Specifies the heading level the LEN is │ │ 3 │ to be considered. │ │ 4 │ │ │ 5 │ │ │ 6 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LENSEL=NONE │ FIRST │ │ Specifies which language element on the │ │ LAST │ FIRSTLAST │ │ page is to be used for a retrieval │ │ NODUP │ subject. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ MESSAGES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the MESSAGES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ OTHER='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the OTHER attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PARMS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PARMS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROCESS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PROCESS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PURPOSE='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PURPOSE attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ RESTRICT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RESTRICT attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ RESULTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RESULTS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ RETCODES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RETCODES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEP=NORMAL │ Specifies the type of separation to be │ │ PAGE │ used for language element names, LENs. │ ═══ 2.132. LERS Language Element Reference Section (continued) ═══ │ RULE │ │ │ RHPAGE │ │ │ LHPAGE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSENV='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the SYSENV attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ USAGE='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the USAGE attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ VERSION='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the VERSION attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :LERS. (Start a language element reference section) :LEN.name:ELEN. (Identify a language element) :LEDI purpose.text. . . (Language element description items) :LEDI format.text. . . . :LEDI parms.text. . . . :LEDI usage.text. . . . :LEDI examples.text. . . . . . . :ELERS. (End language element reference section) ═══ 2.133. LERSDEF Language Element Reference Section Definition ═══ LERSDEF Language Element Reference Section Definition Purpose The LERSDEF tag specifies subheadings to override the default headings. LERSDEF can be placed in the prolog, or contain an ID attribute for reference by the LERS tags. Any of the default subheadings or those specified on LERSDEF can be overridden on the LERS tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LERSDEF │ language │ AUTH= │ No immediate │ │ │ │ element ref- │ COMMENTS= │ text. │ │ │ │ erence │ CONTEXT= │ │ │ │ │ section defi- │ DEFAULTS= │ │ │ │ │ nition │ ERRCOND= │ │ │ │ │ │ EXAMPLES= │ │ │ │ │ │ FLAGS= │ │ │ │ │ │ FORMAT= │ │ │ │ │ │ ID= │ │ │ │ │ │ INTREP= │ │ │ │ │ │ LANG= │ │ │ │ │ │ LEDIHD= │ │ │ │ │ │ LEHD= │ │ │ │ │ │ LENSEL= │ │ │ │ │ │ SEP= │ │ │ │ │ │ MESSAGES= │ │ │ │ │ │ OTHER= │ │ │ │ │ │ PARMS= │ │ │ │ │ │ PROCESS= │ │ │ │ │ │ PURPOSE= │ │ │ │ │ │ RESTRICT= │ │ │ │ │ │ RESULTS= │ │ │ │ │ │ RETCODES= │ │ │ │ │ │ SYSENV= │ │ │ │ │ │ USAGE= │ │ │ │ │ │ VERSION= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ AUTH='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the AUTH attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMMENTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the COMMENTS attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ CONTEXT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the CONTEXT attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEFAULTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the DEFAULTS attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ ERRCOND='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the ERRCOND attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXAMPLES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the EXAMPLES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ FLAGS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the FLAGS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ FORMAT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the FORMAT attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INTREP='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the INTREP attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ LANG='language' │ Specifies the programming language about │ │ │ which a language element reference │ │ │ section concerns itself. │ +──────────────────────────────+──────────────────────────────────────────+ │ LEDIHD=4 │ Specifies the heading level the LEDI is │ │ 3 │ to be considered. The initial setting │ │ 5 │ is 4. │ │ 6 │ │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LEHD=2 │ Specifies the heading level the LEN is │ │ 3 │ to be considered. │ │ 4 │ │ │ 5 │ │ │ 6 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ LENSEL=NONE │ FIRST │ │ Specifies which language element on the │ │ LAST │ FIRSTLAST │ │ page is to be used for a retrieval │ │ NODUP │ subject. │ +──────────────────────────────+──────────────────────────────────────────+ │ MESSAGES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the MESSAGES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ OTHER='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the OTHER attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PARMS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PARMS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROCESS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PROCESS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PURPOSE='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the PURPOSE attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ RESTRICT='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RESTRICT attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ RESULTS='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RESULTS attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ RETCODES='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the RETCODES attribute. │ │ │ If the value is specified as just two │ │ │ single quotes, no heading is generated. │ ═══ 2.134. LERSDEF Language Element Reference Section Definition (continued) ═══ +──────────────────────────────+──────────────────────────────────────────+ │ SEP=NORMAL │ Specifies the type of separation to be │ │ PAGE │ used for language element names, LENs. │ │ RULE │ │ │ RHPAGE │ │ │ LHPAGE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSENV='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the SYSENV attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ USAGE='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the USAGE attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ │ VERSION='subheading text' │ Specifies the text that overrides the │ │ '' │ usual subheading text generated by the │ │ │ LEDI tag with the VERSION attribute. If │ │ │ the value is specified as just two │ │ │ single quotes, no heading is generated. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :lersdef id=l123456 defaults='System Assigned Values'. :lers refid=l123456. :elers. :lers refid=l123456. :elers. ═══ 2.135. LI List Item ═══ LI List Item Purpose The LI tag identifies an item in any of the following lists: o Simple (SL) o Ordered (OL) o Note (NOTEL) o Unordered (UL) The dingbat (item identifier) preceding the text for LI tags is different depending on which type of list you specify: LI tag used in this list dingbat SL (simple list) Nothing OL (ordered list) A sequential number or letter Notel (note list) A sequential number or letter UL (unordered list) A bullet, em-dash, or en-dash Multiple LI tags may be used within a list. Multiple lines of text associated with the tag are indented. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LI │ list item │ ID= │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :ol. :li.Item one. :li.Item two, composed of: :ul compact. :li.Unordered list item 1. :li.Unordered list item 2. :eul. :li id=gadget.Item three. :sl compact. :li.Simple list item one. :li.Simple list item two. :notel. :li.First note in a note list. :li.Second note :li.These notes are embedded in the simple list, which is embedded in the unordered list, which is embedded in the ordered list. :enotel. ═══ 2.136. LIBRARY Library Name (Cover) ═══ LIBRARY Library Name (Cover) Purpose One of three logical parts of the document title and expands on the document title tag for formal documents. In many cases, would be equivalent to a product name, such as "Publishing Systems BookMaster" In styles that use BookMaster's supported styles, the "library name," if coded, can contain up to two lines of text. The text must be entered on separate lines, after the LIBRARY tag. If the LIBRARY tag is not coded, BookMaster will assume that any lines are topic lines. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LIBRARY │ library name │ SNAME= │ No other tags. │ │ │ │ (cover) │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SNAME='short-name' │ Specifies the name to use in the master │ │ │ index when the short form is requested. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :library. 3764 Framis Version 87 ═══ 2.137. LINES Lines ═══ LINES Lines Purpose The LINES tag identifies an area of user-controlled line entry (that is, the lines are not concatenated). LINES requires a matching end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LINES │ lines │ ALIGN= │ Bracketed text. │ :ELINES │ │ │ │ KEEP= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ │ Specifies the position of the artwork or │ │ LEFT │ │ text on the column or page. │ │ RIGHT │ │ │ │ +horizontal-space │ │ │ │ -horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ │ KEEP=vertical space │ Specifies the amount of space that must │ │ ALL │ be kept together before it can be │ │ │ broken. For LINES, the initial setting │ │ │ is to not keep the text together. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :LINES. With the LINES tag, the lines are not concatenated. :ELINES. ═══ 2.138. LIREF List Item Reference ═══ LIREF List Item Reference Purpose The LIREF tag identifies a place in a document at which a reference to a list item should be made. References to uniquely identified list items can occur anywhere in text. This is only meaningful if the list item is in an ordered list or note list. It is the authors' responsibility to verify that it is used correctly. If the list item is not on the same page as the reference, the page number is included with the list item number. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LIREF │ list item │ FORM= │ Self-contained. │ │ │ │ reference │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.Skip to step :liref refid=gadget. and continue installation. . . . :li id=gadget.To install the Gadget,... ═══ 2.139. LP List Part ═══ LP List Part Purpose The LP tag identifies a comment or explanation that applies to a part of a list. It can be placed anywhere within the list. The text following the LP tag starts at the left margin of the current level of the list. It is not numbered or lettered. When used with OL and NOTEL tags, LP does not interrupt or increase the sequence (1, 2, 3, a, b, c). Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LP │ list part │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :ol. :li.This is the first ordered list item. It is numbered 1. :li.This is the second item. It is numbered 2. :lp.This is the :hp3.list part:ehp3. (LP). It starts at the level where the numbers print, but is not numbered itself. :li.This is the third item. The LP tag did not interrupt the numbering sequence and it isn't numbered itself. :ol. :li.This is a nested ordered list. :lp.Here's another list part. :li.The numbering for the ordered list items has not been interrupted. :li.This is the last of the ordered list items. :eol. :eol. ═══ 2.140. LQ Long Quote (Excerpt) ═══ LQ Long Quote (Excerpt) Purpose The LQ tag identifies an excerpt quoted from another source. This tag requires a matching end tag. Long quotations are sometimes called "block quotations." Long quotations can occur anywhere in text. They are set off from the surrounding text by both right and left indentation. They are not surrounded by quotation marks ("..."), as are quotations identified by the quotation (Q) tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :LQ │ long quote │ │ Any text; any- │ :ELQ │ │ │ (excerpt) │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.This is an example of the some text preceding a long quotation. It extends to both right and left margin and may introduce the quotation to follow as part of some important historical document: :lq. :p.Four score and seven years ago our forefathers brought forth on this continent a new nation, ... :elq. :p.When the quotation is ended (ELQ), the text returns to the original margins. ═══ 2.141. MAP Maintenance Analysis Procedure ═══ MAP Maintenance Analysis Procedure Purpose The MAP tag is structurally similar to a level-3 head tag. It requires a matching end tag. MAP is terminated by the same or higher-level heading as the MAP head level. A MAP is, by default, automatically numbered starting with 0100. This numbering system can be changed with the STEPNUM attribute. If a MAP prefix is present, table of contents (TOC and PTOC) entries are generated. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MAP │ maintenance │ COMPACT │ Bracketed text. │ :EMAP │ │ │ analysis pro- │ EXPAND │ │ │ │ │ cedure │ HD= │ │ │ │ │ │ ID= │ │ │ │ │ │ INCR= │ │ │ │ │ │ INITPG= │ │ │ │ │ │ NUM= │ │ │ │ │ │ PNKEY= │ │ │ │ │ │ PREFIX= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SEP= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directories, maps, or │ │ │ unruled tables are to be formatted with │ │ │ blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ HD='integer' │ Specifies the implied heading level for │ │ │ the MAP tag. The initial setting is 3. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCR='integer' │ Specifies the increment for the next │ │ │ automatically numbered MAP. The initial │ │ │ setting is 10. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=MAP │ Specifies a prefix for a MAP. The │ │ 'prefix' │ initial setting is MAP for │ │ │ language=english. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEP=NORMAL │ Specifies the type of separation to be │ │ PAGE │ used for language element names, LENs. │ │ RULE │ │ │ RHPAGE │ │ │ LHPAGE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :map id=mapex. :mapqfix. :xpl. :cause . . . :cause :emapqfix. :step id=step1. . . . :st. :ct. :qt. :estep. :step id=step2. :st. :ft. :estep. :step id=step3. :st. :ct. :ft. :estep. :qt. . . . :emap. ═══ 2.142. MAPDEF Maintenance Analysis Procedure Definition ═══ MAPDEF Maintenance Analysis Procedure Definition Purpose The MAPDEF tag defines a MAP tag and has similar attributes. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MAP │ maintenance │ COMPACT │ Self-contained. │ :EMAP │ │ │ analysis pro- │ EXPAND │ │ │ │ │ cedure │ HD= │ │ │ │ │ │ ID= │ │ │ │ │ │ INCR= │ │ │ │ │ │ INITPG= │ │ │ │ │ │ NUM= │ │ │ │ │ │ PNKEY= │ │ │ │ │ │ PREFIX= │ │ │ │ │ │ SEP= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directories, maps, or │ │ │ unruled tables are to be formatted with │ │ │ blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ HD='integer' │ Specifies the implied heading level for │ │ │ the MAP tag. The initial setting is 3. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INCR='integer' │ Specifies the increment for the next │ │ │ automatically numbered MAP. The initial │ │ │ setting is 10. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=MAP │ Specifies a prefix for a MAP. The │ │ 'prefix' │ initial setting is MAP for │ │ │ language=english. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEP=NORMAL │ Specifies the type of separation to be │ │ PAGE │ used for language element names, LENs. │ │ RULE │ │ │ RHPAGE │ │ │ LHPAGE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :mapdef id=mapex sep=rule. :map refid=mapex. :mapqfix. . . . :emap. ═══ 2.143. MAPQFIX Map Quick Fix ═══ MAPQFIX Map Quick Fix Purpose The MAPQFIX tag generated a simple table sized according to the current document style. It requires a matching end tag. MAPQFIX is generally followed by only one symptom explanation (XPL) with one or more causes (CAUSE). It may have multiple sets of explanations and causes, in which case each set is formatted as a table row. The causes are formatted as a compact unordered list. MAPQFIX generates cross reference information in the back of the book. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MAPQFIX │ map quick fix │ │ No immediate │ :EMAPQFIX │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :map id=mapex place=inline. :mapqfix. :xpl. :cause . . :emap. ═══ 2.144. MATCH Match Question ═══ MATCH Match Question Purpose The MATCH tag identifies an item on a matching CHOICE tag. Each MATCH tag has an ANSID attribute that refers to the ID attribute on a CHOICE tag. Because the correct matches are identified by name, you can add or delete choices and matching items, or rearrange them, without changing your existing markup. You can put as many matching items as you want within a question. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MATCH │ match ques- │ ANSID= │ Implied para- │ │ │ │ tion │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ANSID=name │ Specifies the name to be associated with │ │ │ this answer. The name can be up to 7 │ │ │ characters long (letters and numbers; │ │ │ first character should be a letter). │ +──────────────────────────────+──────────────────────────────────────────+ Examples :question compact form=MATCH id=mat2. Match the following musical questions with the letter corresponding to the correct answer: :choice id=so.Two :choice id=la.Four :choice id=fa.Nine :MATCH ansid=fa.Number of symphonies Beethoven wrote. :MATCH ansid=so.Number of flats in the key of E flat. :MATCH ansid=la.Number of strings on a violin. :equestion. ═══ 2.145. MCDEF Message and Code List Definition ═══ MCDEF Message and Code List Definition Purpose The MCDEF tag defines the message and code lists once, so that they do not have to be redefined at each occurrence. The tags defined are described below. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MCDEF │ message and │ CODESEL= │ No immediate │ │ │ │ code list │ COMPACT │ text. │ │ │ │ definition │ DEST= │ │ │ │ │ │ EXPAND │ │ │ │ │ │ ID= │ │ │ │ │ │ INDENT= │ │ │ │ │ │ MSGNOSEL= │ │ │ │ │ │ MODULE= │ │ │ │ │ │ NUMBYTES= │ │ │ │ │ │ ORESP= │ │ │ │ │ │ PRESP= │ │ │ │ │ │ PROBD= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SEVERITY= │ │ │ │ │ │ SPRESP= │ │ │ │ │ │ STYLE= │ │ │ │ │ │ SYSACT= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ URESP= │ │ │ │ │ │ XPL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ CODESEL=NONE │ FIRST │ │ Specifies which codes on the page are to │ │ LAST │ FIRSTLAST │ │ be used as a running heading or footing. │ │ NODUP │ │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEST='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the DEST tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directories, maps, or │ │ │ unruled tables are to be formatted with │ │ │ blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INDENT='horizontal space' │ Specifies the indent to be used for the │ │ │ explanatory text under the message or │ │ │ code. │ +──────────────────────────────+──────────────────────────────────────────+ │ MODULE='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the MODULE tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ MSGNOSEL=NONE │ FIRST │ │ Specifies which ones of the message │ │ LAST │ FIRSTLAST │ │ numbers on the page is to be used for a │ │ NODUP │ running heading or footing. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUMBYTES='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the NUMBYTES │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ ORESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the ORESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROBD='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PROBD tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEVERITY='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SEVERITY │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SPRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=SPACE │ Specifies the style to be used in for- │ │ RULE │ matting messages and codes lists. │ │ BOX │ │ │ LBLBOX │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSACT='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SYSACT tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ URESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the URESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ XPL='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the XPL tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :mcdef compact id=l123456 tsize=7. :msg refid=l123456. : : :code refid=l123456. : : ═══ 2.146. MD Marked Deletion ═══ MD Marked Deletion Purpose Sometimes, as part of a revision, you may want to indicate that some text has been deleted, but still leave that text in the document for your reader's convenience. The MD and its matching end tag overstrikes the text between the tags with a horizontal line, so your reviewers can tell that the text will be deleted. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MD │ marked │ │ Bracketed text. │ │ │ │ deletion │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples You may want to eliminate :md.repetitious:emd. redundancies. ═══ 2.147. MINDEX Master Index ═══ MINDEX Master Index Purpose The MINDEX tag creates a master index from several books in a library. The MINDEX tag is valid only within a prolog. The first step in creating a master index is to put a MINDEX tag in the prolog of each book you want to be included in the master index. The content of this tag is the code used to identify this book in the master index. The next step is to format the book. Include SYSVAR M with a unique filename on your SCRIPT command. The filename must be different from the filename of the book. A file is created with the name you use on the SYSVAR M. The master index formats exactly like a regular index, except that in place of page numbers, the contributing book's code (taken from the MINDEX tag) is printed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MINDEX │ master index │ SNAME= │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SNAME='short-name' │ Specifies the name to use in the master │ │ │ index when the short form is requested. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :userdoc sec='IBM Internal Use Only' copyr=1983. :prolog. :mindex sname=V1.Volume I :title.Document Number 1 . . . :index. :euserdoc. ═══ 2.148. MODULE Module ═══ MODULE Module Purpose The MODULE tag identifies the module that generates the message. It can be used only within a code list or message list. The word "Module" is printed to the left of the text. If the MODULE attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of the word "Module." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MODULE │ module │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :msgl tsize=5 xpl='Cause'. :msgno.001 :msg. :mv.FIGSEG:emv.FOUND OUT OF CONTEXT :module.DSET :xpl.The given tag is not valid in the element within which it was encountered. :severity.3 :numbytes.5 . . . Or: :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I :xpl.Informational message. :severity.3 :module.Golden Gate Bridge :probd.A car is turned crosswise to the traffic. :sysact.Divert traffic at each end of bridge. :spresp.Call police to direct traffic. :oresp.Inform drivers already at the booth of the problem . . . ═══ 2.149. MSG Message Text ═══ MSG Message Text Purpose The MSG tag identifies the text of the message being described. MSG is valid only within a message list. The message text is an implied paragraph. It is printed to the right of the message number in highlight type 2. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MSG │ message text │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :MSGL tsize=5 xpl='Cause'. :msgno.001 :msg. :mv.FIGSEG:emv.FOUND OUT OF CONTEXT :module.DSET :xpl.The given tag is not valid in the element within which it was encountered. :severity.3 :numbytes.5 :sysact.The tag is ignored. :uresp.Change the markup of the document to include the tag within the proper document element. ═══ 2.150. MSGL Message List ═══ MSGL Message List Purpose The MSGL tag and its matching end tag identify the information associated with the message (its number, an explanation, any action taken by the system, and so on). The parts of a message list are identified separately by the tags listed below. Any of these tags can be omitted when you don't need them, including the message number (MSGNO). Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MSGL │ message list │ COMPACT │ No immediate │ :EMSGL │ │ │ │ DEST= │ text. │ │ │ │ │ EXPAND │ │ │ │ │ │ INDENT= │ │ │ │ │ │ MODULE= │ │ │ │ │ │ MSGNOSEL= │ │ │ │ │ │ NUMBYTES= │ │ │ │ │ │ ORESP= │ │ │ │ │ │ PREFIX= │ │ │ │ │ │ PRESP= │ │ │ │ │ │ PROBD= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SEVERITY= │ │ │ │ │ │ SPRESP= │ │ │ │ │ │ STYLE= │ │ │ │ │ │ SYSACT= │ │ │ │ │ │ TSIZE= │ │ │ │ │ │ URESP= │ │ │ │ │ │ XPL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ DEST='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the DEST tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that the list is to be for- │ │ │ matted with blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ INDENT='horizontal space' │ Specifies the indent to be used for the │ │ │ explanatory text under the message. │ +──────────────────────────────+──────────────────────────────────────────+ │ MODULE='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the MODULE tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ MSGNOSEL=NONE │ FIRST │ │ Specifies which message numbers on the │ │ LAST │ FIRSTLAST │ │ page are to be used for a running │ │ NODUP │ heading or footing. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUMBYTES='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the NUMBYTES │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ ORESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the ORESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=text │ Specifies a common prefix for a group of │ │ │ messages. │ +──────────────────────────────+──────────────────────────────────────────+ │ PRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROBD='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the PROBD tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEVERITY='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SEVERITY │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPRESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SPRESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=SPACE │ Specifies the style to be used in for- │ │ RULE │ matting messages and codes lists. │ │ BOX │ │ │ LBLBOX │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SYSACT='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the SYSACT tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 10 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ │ URESP='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the URESP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ XPL='subheading text' │ Specifies the text that overrides the │ │ │ usual text generated by the XPL tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :MSGL tsize=5 xpl='Cause'. :msgno.001 :msg. :mv.FIGSEG:emv.FOUND OUT OF CONTEXT :module.DSET :xpl.The given tag is not valid in the element within which it was encountered. :severity.3 :numbytes.5 :sysact.The tag is ignored. :uresp.Change the markup of the document to include the tag within the proper document element. :msgno.002 :msg. :MV.tag-name:EMV. found out of context :xpl.The given tag is not valid in the element within which it was encountered. :sysact.The tag is ignored. :uresp.Change the markup of the document to include the tag within the proper document element. :severity.3 :numbytes.5 :sysact.The tag is ignored. :EMSGL. ═══ 2.151. MSGNO Message Number ═══ MSGNO Message Number Purpose The MSGNO tag identifies the number of a message. It must be entered on a single line and cannot contain any other tags. The MSGNO tag is valid only within a message list. The message number prints as a highlight type 2 at the left margin, to the left of the message. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MSGNO │ message │ │ Text on same line │ │ │ │ number │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :MSGL tsize=5 xpl='Cause'. :msgno.001 :msg. :mv.FIGSEG:emv.FOUND OUT OF CONTEXT :module.DSET : : : :msgno.002 :msg. :MV.tag-name:EMV. found : ═══ 2.152. MV Message Variable ═══ MV Message Variable Purpose The MV tag identifies the variable portion of the message being described. It is used when a part of the message, identified by the MSG tag, varies from one message to another. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :MV │ message vari- │ │ Any text; any- │ :EMV │ │ │ able │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :MSGL tsize=5 xpl='Cause'. :msgno.001 :msg. :mv.FIGSEG:emv.FOUND OUT OF CONTEXT :module.DSET :xpl.The given tag is not valid in the element within which : : :EMSGL. ═══ 2.153. NITEM Notice Item ═══ NITEM Notice Item Purpose The NITEM tag generates several FCC notices. The correct version of the FCC notice must be selected by the author for the particular manual. The notice whose subject is "plug" is for those machines that require only grounded 110V plugs for power source. Refer to the standards on FCC notices for details of when a particular notice is applicable. The NITEM tag is valid only in the range of the NOTICES tag and its matching end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NITEM │ notice item │ SUBJECT= │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT=IBMFCCA │ Specifies the subject of an item in the │ │ IBMFCCB │ notices on the back of the title page. │ │ IBMFCCBIO │ │ │ IBMFCCPC │ │ │ IBMFCCNON │ │ │ IBMPLUG │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples : :notices. :nitem subject=ibmfcca. (additional text, if any) : :enotices. : ═══ 2.154. NOTE Note Paragraph ═══ NOTE Note Paragraph Purpose The NOTE tag identifies a single paragraph. NOTE does not require a matching end tag. Notes can occur anywhere in text. They are implied paragraphs and can contain any of the basic text elements. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NOTE │ note para- │ TEXT= │ Implied para- │ │ │ │ graph │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to override the text │ │ │ normally generated for notes or language │ │ │ element description items. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.This is the last sentence of a preceding paragraph. :note.A note can be inserted anywhere a paragraph can be entered. Any additional lines are aligned with the left margin. ═══ 2.155. NOTEL Note List ═══ NOTEL Note List Purpose The NOTEL tag identifies a list of notes. It requires a matching end tag. Note lists can occur anywhere in text. Note lists are formatted as "hanging" indented lists, with the item identifier placed flush with the left margin, and the word "Notes" preceding the list. Note lists are also identified in the formatted document by sequential numbers or letters, depending on the definition for each level. 1. The first level is identified by 1., 2., 3., . . . 2. The second level by a., b., c., . . . 3. The third level by 1), 2), 3) , . . . 4. The fourth level by a), b), c), . . . Levels beyond that repeat the sequence. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NOTEL │ note list │ COMPACT │ No immediate │ :ENOTEL │ │ │ │ DBSCALE= │ text. │ │ │ │ │ DBHI= │ │ │ │ │ │ TEXT= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBSCALE='scaling factor' │ Specifies the scaling factor for │ │ │ dingbats on a list. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBHI=0 │ Specifies the highlight type for │ │ . │ dingbats on a list. │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to override the text │ │ │ normally generated for notes or language │ │ │ element description items. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :notel. :li.Note list item one. :li.Note list item two. The note list can be extended to as many lines as necessary. :li.Note list item three. :p.You can have a separate paragraph in a note list item. :li.Note list item four. :enotel. ═══ 2.156. NOTICES Notices ═══ NOTICES Notices Purpose The NOTICES tag identifies any notice (other than the edition notice (VNOTICE)) that is placed at the front of the document. Notices include any required notices (such as FCC) that are marked up with the NITEM tag. The NOTICES end tag is required. The NOTICES section may come before the VNOTICE seciton (if the notices are short enough), or after it. Additional paragraphs can be included within the NOTICES tag; however, figures and examples are not valid. If any other notices are required on the same page, they may be included within the notices tag sequence. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NOTICES │ notices (back │ │ No immediate │ :ENOTICES │ │ │ of title │ │ text. │ │ │ │ page) │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples : :notices. :nitem subject=ibmfcca. : :enotice. : ═══ 2.157. NT Note ═══ NT Note Purpose The NT tag identifies a single or multiple paragraph note. NT must have a matching end tag. Notes can occur anywhere in text. They are implied paragraphs and can contain any of the basic text items. The implied paragraph is formatted as an indented block. The word "Note," with a colon ( "Note:"), begins the paragraph. It aligns with the text of a list item when used within a list. Notes made with the NT tag cannot be nested. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NT │ note │ TEXT= │ Implied para- │ :ENT │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to override the text │ │ │ normally generated for notes or language │ │ │ element description items. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.This is the last sentence of a preceding paragraph. :nt. A note can be inserted anywhere a paragraph can be entered. :ent. :p.A note can be inserted in a list. :ol. :li.This is the first item in an ordered list. :nt. In a list, a note is indented and continues to a second line under the word :q.Note:eq.. :ent. :eol. ═══ 2.158. NUMBYTES Number of Error Bytes ═══ NUMBYTES Number of Error Bytes Purpose The NUMBYTES tag identifies the number of error bytes that a code or message generates. It can only be used within a code list or message list. The subheading, "Number of Error Bytes," is printed to the left of the text. If the NUMBYTES attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Number of Error Bytes." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :NUMBYTES │ number of │ │ Implied para- │ │ │ │ error bytes │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. : : :uresp.Write a letter to the editor about drunk drivers. :numbytes.3580 (cars stalled on the bridge) :code.OC414-W : : :ecodel. ═══ 2.159. OL Ordered List ═══ OL Ordered List Purpose The OL tag identifies an ordered list of items. OL requires a matching end tag. Ordered lists can occur anywhere in text, and can be nested within other lists. Heading tags are not allowed within an ordered list. If an ordered list has not been properly ended when a heading tag is encountered, the list ends and a warning message is issued. Ordered lists are formatted as "hanging" indented lists, with the item identifier (1,2,...a,b,...) at the left margin. Ordered lists are identified in the formatted document by sequential numbers or letters, depending on the definition for each level. The levels are as follows: 1. 1., 2., 3., . . . 2. a., b., c., . . . 3. 1), 2), 3), . . . 4. a) ,b), c), . . . 5. i., ii., iii., . . . 6. i), ii), iii), . . . Any additional levels repeat the sequence from "1." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :OL │ ordered list │ COMPACT │ No immediate │ :EOL │ │ │ │ DBSCALE= │ text. │ │ │ │ │ DBHI= │ │ │ │ │ │ PREFIX= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBSCALE='scaling factor' │ Specifies the scaling factor for │ │ │ dingbats on a list. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBHI=0 │ Specifies the highlight type for │ │ . │ dingbats on a list. │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=CHECKOFF │ Specifies that this is a checkoff list │ │ SETUP │ or a customer setup list. SETUP is │ │ 'CHECKOFF SETUP' │ valid only on ordered lists. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :OL compact dbhi=2 dbscale='2.0'. &bml.li.Ordered list Item 1. (DBHI=2; DBSCALE=2.0) :li.Ordered list Item 2. :li id=whats.Ordered list Item 3, composed of: :OL compact. :li.Ordered list item a. :li.Ordered list item b. :li.Ordered list item c, composed of: :OL compact prefix=checkoff. :li.Ordered list item 1). (PREFIX=CHECKOFF) :li.Ordered list item 2). :li.Ordered list item 3), composed of: :OL compact prefix=setup. :li.Ordered list item a). (PREFIX=SETUP) :li.Ordered list item b). :li.Ordered list item c), composed of: :OL compact. :li.Ordered list Item i. :li.Ordered list Item ii. :li.Ordered list Item iii, composed of: :OL compact. :li.Ordered list item i). :li.Ordered list item ii). :li.Ordered list item iii) :OL compact. :li.Ordered list item :li.Ordered list item &vellip. :EOL. :EOL. :EOL. :EOL. :EOL. :EOL. :li.Continuation of original list :EOL. ═══ 2.160. OPER Syntax Diagram Operator ═══ OPER Syntax Diagram Operator Purpose The OPER tag describes an operator (for example, a divide (&div.)). This tag is a TOSL and the operator is required. Format :OPER REQ|OPT|DEF LID='id ...'. operator Parameters REQ|OPT|DEF specifies the selectability of the operator, where: REQ indicates the operator is required. OPT indicates the operator is optional. DEF indicates the operator is a default. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample operators: :syntax. :oper.+ :oper opt.* :oper def./ :esyntax. Formats like: ---/--- | | >>---+--------------------->< | | ---*--- ═══ 2.161. ORESP Operator Response ═══ ORESP Operator Response Purpose The ORESP tag identifies the operator actions which should be taken for a code or message. ORESP can be used only within a code list or message list. The subheading, "Operator Response," is printed to the left of the text. If the ORESP attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Operator Response." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ORESP │ operator │ │ Implied para- │ │ │ │ response │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I : : :spresp.Call police to direct traffic. :oresp.Inform drivers already at the booth of the problem and call a tow truck. :uresp.Write a letter to the editor about drunk drivers. : ═══ 2.162. P Paragraph ═══ P Paragraph Purpose The P tag identifies a paragraph. A paragraph is defined as one or more sentences related by their subject matter. Paragraphs can occur anywhere in text, and can contain any of the basic text items. A matching end tag is not required. A paragraph is implicitly ended by another paragraph or higher level element. Each paragraph is formatted flush left (without indenting the first line). The second and following paragraphs after each heading are separated from each other by one blank line. Paragraphs following level-5 through level-20 headings are formatted inline with the heading, and separated from it by a colon (:). Paragraphs inserted within a list align with the text of the list item. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :P │ paragraph │ │ Paragraph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.A paragraph is implicitly ended by another paragraph or higher-level element. The following is an example of an unordered list in a paragraph: :ul. :li.This is an unordered list item. It can be one line or several lines. The second line will begin under the first word in the text. :li.This is another list item. The second item is set off by a bullet (or other specified dingbat) and the text aligns with the text of the first bullet. :p.This is a paragraph within a list. The first word of this paragraph is aligned under the first word of the text of the list item (not under the bullet). Any continued text is aligned directly under that same first word. :li.This last list item is short. :eul. ═══ 2.163. PARML Parameter List ═══ PARML Parameter List Purpose The PARML tag identifies a list of parameters and their associated descriptions. PARML requires a matching end tag. Parameter lists are frequently used to explain the elements of programming syntax. The elements within a parameter list are identified by: o The PT tag (parameter term) o The PD tag (parameter description) o The PK tag (parameter keyword) o The PV tag (parameter variable) Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PARML │ parameter │ BREAK= │ No immediate │ :EPARML │ │ │ list │ COMPACT │ text. │ │ │ │ │ TSIZE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ BREAK=NONE │ Specifies the handling of definition │ │ ALL │ terms in a definition list. NONE is the │ │ FIT │ initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Formats the content of the tag with no │ │ │ blank lines between terms. │ +──────────────────────────────+──────────────────────────────────────────+ │ TSIZE=horizontal space │ Specifies the space to be left for the │ │ │ definition terms in a definition list │ │ │ and the message number in a message │ │ │ list. The initial setting is 5 char- │ │ │ acter spaces. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :PARML. :PT.ID=:PV.name:EPV. :PD.Provides the identification for cross referencing. :PT.STITLE=&ssq.:PV.short title:EPV.&ssq. :PD.Allows specification of a short title for the footing. :PT.:PK.DEF:EPK. :PD.Highlights the default keyword in a list. :PT.LAYOUT=:PK DEF.SAME:EPK.|ONE|TWO|THREE|FOUR :PD.Specifies the page layout of columns for the directory. :p.:PK DEF.SAME:EPK. is the default. :EPARML. ═══ 2.164. PARTNUM Part Number of Document ═══ PARTNUM Part Number of Document Purpose If your document has a part number, BookMaster's initial setting places it on the back cover. Documents with a part number may have a document number as well. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PARTNUM │ part number │ │ Text on same line │ │ │ │ (cover) │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :partnum.1234567 ═══ 2.165. PARTSASM Parts Assembly ═══ PARTSASM Parts Assembly Purpose Use this tag to begin a parts catalog list and use its matching end tag to end it. When BookMaster formats the parts assembly tag, it provides all of the heading except the name of the assembly; you must choose that. When formating, BookMaster provides the following parts of the heading: o The prefix, "Assembly" o The number of the assembly, beginning with 1 and incrementing succeeding assembly numbers by 1 o The colon following the assembly number. Enter the name you choose for your assembly immediately after the period that ends the PARTSASM tag. That is about all you have to know to start your parts catalog list and get the heading. However, there are several other things you can do with the PARTSASM tag to make your parts catalog list easier to use; things like making the text of your parts catalog list larger or smaller, choosing where your heading and artwork will go, and even creating a sample parts catalog list for demonstration. These can be done with the attributes. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PARTSASM │ parts │ ID= │ Text on same line │ :EPARTSASM │ │ │ assembly │ INITPG= │ or next line; no │ │ │ │ │ LAYOUT= │ other tags. │ │ │ │ │ PNKEY= │ │ │ │ │ │ SAMPLE │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=FACING │ Specifies the layout of the parts │ │ SAME │ catalog list and it's associated │ │ │ graphic. The initial setting is FACING. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :partsasm.Bicycle ═══ 2.166. PC Paragraph Continuation ═══ PC Paragraph Continuation Purpose The PC tag identifies the continuation of a paragraph that has been interrupted by another document element. A paragraph continuation usually occurs after a figure, example, list, or long quotation. It shows that the following text is not a new paragraph, but a continuation of one interrupted by another element. A matching end tag is not required. A paragraph is implicitly ended by another paragraph or higher-level element. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PC │ paragraph │ │ Implied para- │ │ │ │ continuation │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.If you enter the following command :xmp. LISTFILE :exmp. :PC.a listing of all the files on your A-disk appears on your terminal. ═══ 2.167. PD Parameter Description ═══ PD Parameter Description Purpose The PD tag identifies a description of a parameter term in a parameter list. A parameter description occurs in a parameter list. It is preceded by a PARML and a PT tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PD │ parameter │ │ Implied para- │ │ │ │ description │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :PARML. :PT.ID=:PV.name:EPV. :PD.Provides the identification for cross referencing. :PT.STITLE=&ssq.:PV.short title:EPV.&ssq. :PD.Allows specification of a short title for the footing. :EPARML. ═══ 2.168. PGMNUM Program Number (Cover) ═══ PGMNUM Program Number (Cover) Purpose For documents about programs with program numbers, you may enter multiple PGMNUM tags, each defining multiple feature numbers (FEATNUMn attributes) as required. Up to 9 feature numbers can be specified per PGMNUM tag. In styles tha use BookMaster's initial setting, the program numbers and feature numbers will be set on the back cover. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PGMNUM │ Program │ FEATNUM1= │ Text on same line │ │ │ │ Number │ . │ or next line; no │ │ │ │ (cover) │ . │ other tags. │ │ │ │ │ . │ │ │ │ │ │ FEATNUM9= │ │ │ │ │ │ RELEASE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FEATNUM1='feature number' │ Specifies the feature number associated │ │ . │ with a program. │ │ . │ │ │ . │ │ │ FEATNUM9= │ │ +──────────────────────────────+──────────────────────────────────────────+ │ RELEASE=relnum │ Specifies the release and modification │ │ │ numbers of a document. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :pgmnum featnum1='1234-5678' featnum2='1234-9999'.5748-XX9 ═══ 2.169. PK Programming Keyword ═══ PK Programming Keyword Purpose The PK tag identifies a programming keyword. PK requires a matching end tag. A programming keyword can occur anywhere in text. It is used when you need to explain the elements of programming syntax. This tag is frequently used within parameter lists. See the PARML tag for related information and an example of the PK tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PK │ programming │ DEF │ Any text; any- │ :EPK │ │ │ keyword │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DEF │ Specifies that a programming syntax item │ │ │ is the initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.The :pk def.SAME:epk. option is the default of the LAYOUT attribute. :p.The :pk.BOX:epk. option is not the default of the LAYOUT attribute. ═══ 2.170. PNCDOC Part number controlled document ═══ PNCDOC Part number controlled document Purpose Indicates the beginning of a part-number controlled document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PNCDOC │ Part Number │ COPYR= │ No immediate │ :EPNCDOC │ │ │ Controlled │ ECHIST= │ text. │ │ │ │ document │ ECMAX= │ │ │ │ │ │ IBMCOPYR= │ │ │ │ │ │ IBMPROP= │ │ │ │ │ │ SEC= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COPYR='year(s)' │ Specifies the year(s) for the copyright │ │ │ notice. │ +──────────────────────────────+──────────────────────────────────────────+ │ ECHIST=YES │ Specifies whether the "See EC History" │ │ NO │ is printed in the leftmost EC box when │ │ │ there are more ECs than boxes. The │ │ │ initial setting is YES. │ +──────────────────────────────+──────────────────────────────────────────+ │ ECMAX=integer │ Specifies the maximum number of EC boxes │ │ │ in a PNCDOC running footing. The │ │ │ initial setting is 5. │ +──────────────────────────────+──────────────────────────────────────────+ │ IBMCOPYR='year(s)' │ Specifies the year(s) for the IBM copy- │ │ │ right notice. │ +──────────────────────────────+──────────────────────────────────────────+ │ IBMPROP=YES │ Specifies whether the IBM property │ │ NO │ statement will be printed in the running │ │ │ footing of a PNCDOC. │ +──────────────────────────────+──────────────────────────────────────────+ │ SEC='security class' │ Specifies a security classification that │ │ │ will be used as a running heading │ │ │ throughout the document. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :pncdoc ECHIST=yes ECMAX=7 IBMCOPYR=1988 ═══ 2.171. PNINDEX Part Number Index ═══ PNINDEX Part Number Index Purpose The PNINDEX tag begins the index of parts in a maintenance library document. It indicates where in the back matter to print a numeric index of all part numbers in the catalog. Part numbers are arranged in ascending numeric sequence and are essentially framed directories. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PNINDEX │ part number │ ID= │ Text on same line │ │ │ │ index │ INITPG= │ or next line; no │ │ │ │ │ LAYOUT= │ other tags. │ │ │ │ │ NUM= │ │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=FACING │ Specifies the layout of the parts │ │ SAME │ catalog list and it's associated │ │ │ graphic. The initial setting is FACING. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :pnindex layout=3. ═══ 2.172. PREFACE Preface ═══ PREFACE Preface Purpose The PREFACE tag identifies the part of a document that describes its content and usage. A preface appears within the front matter of the document, after the title page or notices, if there are any. It starts a new page and provides the text for the level-1 heading: "Preface" and the running foot. You can specify an alternative to this default heading after any attributes and the period. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PREFACE │ preface │ ID= │ Text on same line │ │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples : :frontm. :tipage. :preface. : :toc. ═══ 2.173. PRESP Programmer Response ═══ PRESP Programmer Response Purpose The PRESP tag identifies the programmer actions that should be taken for a code or message. PRESP can be used only within a code list (CODEL) or message list (MSGL). The subheading, "Programmer Response," is printed to the left of the text. If the PRESP attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Programmer Response." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PRESP │ programmer │ │ Implied para- │ │ │ │ response │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I . . . :oresp.Call a strike of toll booth operators. :presp.Dive under your desk. :uresp.Write a letter to your family about the earthquake. : ═══ 2.174. PROBD Problem Determination ═══ Problem Determination PROBD Problem Determination Purpose The PROBD tag identifies problem determination information for a code list or message list. PROBD can be used only within a code list (CODEL) or message list (MSGL). The subheading, "Problem Determination," is printed to the left of the text. If the PROBD attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Problem Determination." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PROBD │ problem │ │ Implied para- │ │ │ │ determination │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I . . . :module.Golden Gate Bridge :probd.A car is turned crosswise to the traffic. :sysact.Divert traffic at each end of bridge. ═══ 2.175. PROLOG Prolog of Document ═══ PROLOG Prolog of Document Purpose The PROLOG tag identifies an area of the source document that has been set aside to contain information about the document (for example, the title, author, date, and so on). Prologs can also contain symbol settings, comments, special processing requirements, and other information. This information is used throughout the document where needed. The prolog element should be the first element in the document, ahead of the FRONTM tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PROLOG │ prolog of │ │ No immediate │ :EPROLOG │ │ │ document │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :prolog. :title stitle='Creating Named Styles'. : :docnum.SC34-5008-2 :date. :author. :address. : :eprolog. ═══ 2.176. PRTLOC Printing Location ═══ PRTLOC Printing Location Purpose The PRTLOC tag indicates where the document is printed if other than in the United States. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PRTLOC │ printing │ │ Text on same line │ │ │ │ location │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :prtloc.Printed in Denmark ═══ 2.177. PSC Process Specific Controls ═══ PSC Process Specific Controls Purpose The PSC tag identifies markup and/or text that is to be processed only under specific conditions. PSC requires a matching end tag. If the conditions for processing are dependent on the device that is being used for output, you can enter the device name(s) on the PROC attribute. You may use either the 4-character machine type number or, for additional control, use the full logical device name. For example, to restrict it to the 3800 printer use "3800." If you use "3800n8," it will be restricted to the 3800 printer when it is formatting for 8 1/2 x 11 paper at 8 lines per inch. The device or logical device types are automatically specified if that device is selected. With the SYSVAR P option, you can specify process names of your own choosing. If the PROC attribute is not specified, the element is unconditionally processed. The PROC attribute accepts a maximum of 7 characters. Process-specific controls can appear anywhere in a document, and can contain any valid tags, text, and control words. They can be used to change formatting for different output devices, produce formatting results not provided by ISIL, or carry out fine tuning of a document for publication. To define your own conditions for PSC processing, create a value for the PROC attribute that identifies the condition you want to conditionally process. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PSC │ process spe- │ OMIT= │ No immediate │ :EPSC │ │ │ cific con- │ PROC= │ text. │ │ │ │ trols │ XPROC= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ OMIT='cond1 cond2 ....' │ Specifies conditions for processing │ │ │ input lines between the PSC tag and its │ │ │ end tag. The OMIT attribute is used │ │ │ with the PROC or XPROC attribute. │ +──────────────────────────────+──────────────────────────────────────────+ │ PROC=APA │ CHAR │ │ Specifies conditions for processing the │ │ DISPLAY │ │ input lines between the PSC tag and its │ │ PICTORIAL │ │ end tag. │ │ 'cond1 cond2 ....' │ │ +──────────────────────────────+──────────────────────────────────────────+ │ XPROC=APA │ CHAR │ │ Specifies the conditions for processing │ │ DISPLAY │ │ the input lines between the PSC tag and │ │ PICTORIAL │ │ its end tag. │ │ 'cond1 cond2 ....' │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :PSC proc=apa :p.Information for an all-points-addressable device, such as the 4250. . . . :EPSC. :PSC proc='display'. :p.BookManager information... :EPSC. :PSC xproc='display'. :p.Non-BookManager information... :EPSC. ═══ 2.178. PT Parameter Term ═══ PT Parameter Term Purpose The PT tag identifies a parameter term in a parameter list. Parameter terms are used in programming syntax. They occur in a parameter list and are preceded by a PARML tag and followed by a PD tag. PT is valid only within a parameter list. Multiple PT tags may be required to include the complete parameter term with its options. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PT │ parameter │ │ Line can be con- │ │ │ │ term │ │ tinued on mul- │ │ │ │ │ │ tiple input │ │ │ │ │ │ lines; must │ │ │ │ │ │ resolve to only │ │ │ │ │ │ one output line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :PARML. :PT.ID=:PV.name:EPV. :PD.Provides the identification for cross referencing. :PT.LAYOUT=:PK DEF.SAME:EPK.|ONE|TWO|THREE|FOUR :PD.Specifies the page layout of columns for the directory. :p.:PK DEF.SAME:EPK. is the default. :EPARML. ═══ 2.179. PTOC Partial Table of Contents ═══ PTOC Partial Table of Contents Purpose The PTOC tag identifies the place in the document where a partial table of contents is to be created. A PTOC can be automatically generated or user generated. The normal table of contents is described in the TOC tag. Sometimes, in large books, you might want a "partial" table of contents for each part or chapter. The PTOC tag accomplishes this. By default, if the PTOC tag follows: o A level-0 heading, it generates all level-1 through level-4 headings between it and the next H0 (or APPENDIX or BACKM) tag. o A level-1 heading, it generates all level-2 through level-4 headings between it and the next H1 (or APPENDIX or BACKM) tag. You can change this default with the PTOC attribute of the DOCPROF tag. There are no level-0 headings in any automatically generated PTOC. User-Generated PTOC: To create a manual partial table of contents, include the MANUAL attribute with the PTOC tag. PTOC requires an end tag when used-generated. The entries in a user-generated partial table of contents are entered with the TCE0, TCE1, TCE2, TCE3 or TCE4 tags. Formatting appearance using these tags is similar to the automatically formatted PTOC. Note: If a manual PTOC after a H2 follows an automatic PTOC after a H1, the automatic PTOC is lost. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PTOC │ partial table │ LEVELS= │ No immediate │ :EPTOC │ │ │ of contents │ MANUAL │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ LEVELS=1 │ Specifies which heading levels to put │ │ 0 │ into the partial table of contents. The │ │ 2 │ initial setting is: 1 2 3 4 │ │ 3 │ │ │ 4 │ │ │ 5 │ │ │ 6 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ MANUAL │ Specifies that the table of contents, │ │ │ figure list, table list, or partial │ │ │ table of contents will be generated by │ │ │ hand and thus should not be automat- │ │ │ ically generated. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :h1.Language Statement Descriptions :p.A description of each statement is on the page indicated below: :PTOC. OR a User-Generated PTOC :PTOC manual. :tce1 refid=head1. :tce2 refid=head2. :tce3 refid=head3. :tce4 refid=head4. :EPTOC. ═══ 2.180. PV Programming Variable ═══ PV Programming Variable Purpose The PV tag identifies a programming variable. Programming keywords and variables can occur anywhere in text. They are used when you need to explain the elements of programming syntax. They are frequently used within parameter lists. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :PV │ programming │ DEF │ Any text; any- │ :EPV │ │ │ variable │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ DEF │ Specifies that a programming syntax item │ │ │ is the initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :PARML. :PT.ID=:PV.name:EPV. :PD.Provides the identification for cross referencing. :PT.STITLE=&ssq.:PV.short title:EPV.&ssq. :PD.Allows specification of a short title for the footing. :EPARML. ═══ 2.181. Q Quote ═══ Q Quote Purpose The Q tag identifies a phrase in which the exact words of an individual or another document are cited. This tag requires a matching end tag. Quoted phrases are surrounded by double quotation marks ("..."); nested quotations alternate between single and double quotes. Following American punctuation conventions, certain punctuation characters (comma, period) are moved inside the quotation if they immediately follow it. Quotations can occur anywhere in text, and can contain any of the basic text items, including other quotations. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :Q │ quote │ │ Any text; any- │ :EQ │ │ │ │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :p.Lincoln said :Q.As I would not be a slave, so I would not be a master:EQ.. ═══ 2.182. QITEM Question Item ═══ QITEM Question Item Purpose The QITEM tag identifies an item in an ordering question. Each QITEM tag contains an ANS attribute to indicate its actual place in the order so that the correct answer can be shown with an ANSWER tag. Because the correct order is specified on the QITEM tags, you can rearrange items without changing your markup and still get a valid answer. You can put any number of items within an ordering question. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :QITEM │ question item │ ANS= │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ANS='answer text' │ Specifies the text of the answer to a │ │ │ question. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :question compact form=ORDER id=ord2. Place the following American presidents in the correct order of their service: :QITEM ans=5.J. Kennedy :QITEM ans=3.T. Roosevelt :QITEM ans=1.G. Washington :QITEM ans=4.F. Roosevelt :QITEM ans=2.A. Lincoln :equestion. ═══ 2.183. QREF Question Reference ═══ QREF Question Reference Purpose The QREF tag allows you to refer to particular questions and the pages they are on. The QREF tag returns the question number and the page on which the question appears. The name on the REFID attribute on the QREF tag refers to the name on the ID attribute of the QUESTION tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :QREF │ question ref- │ FORM= │ Self-contained. │ │ │ │ erence │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.If you answered :QREF refid=mat2. incorrectly, review the chapter on Beethoven. ═══ 2.184. QT Question Text (Map) ═══ QT Question Text (Map) Purpose The QT tag identifies the question text in a map in a maintenance library document. QT may be placed within or without a STEP structure in a map. When outside a STEP structure, the highlighting is different from when within a STEP structure. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :QT │ question text │ FIT= │ Bracketed text. │ │ │ │ (map) │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIT=vertical space │ Specifies the minimum required for the │ │ │ tag content. The initial FIT setting │ │ │ for the QT tag is 7 lines. The initial │ │ │ FIT setting for the CT, FT, and ST tags │ │ │ is 3 lines. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :step. :qt.Question? :estep. :step. The "No" direction... :estep. :step. the "Yes" direction... :estep. ═══ 2.185. QUALIF Qualification ═══ QUALIF Qualification Purpose The QUALIF tag distinguishes certain information from the rest of the text. The QUALIF tag should be used consistently; that is, it shouldn't be mixed up with other techniques for qualifying text. QUALIF tags CANNOT be nested. The QUALIF tag draws a horizontal rule across the page to set off the statement that is qualified. The QUALIF end tag draws another horizontal rule at the end of the qualified statement. The words "End of" are generated by the end tag. The single line element of the QUALIF tag must be short enough to fit within the limits of the page layout. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :QUALIF │ qualification │ │ Text on same line │ :EQUALIF │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :ol. :li.Turn the little green widget counterclockwise. :QUALIF.Model 77A ONLY :p.The green widget is red. :EQUALIF. :li.Remove the cover. :QUALIF.Model 77C III ONLY :li.Remove the plexiglass shield. :EQUALIF. :li.Turn the little green widget clockwise. :eol. ═══ 2.186. QUESTION Question ═══ QUESTION Question Purpose The QUESTION tag: o Defines the beginning and end of a question o Specifies the type of question o Specifies the correct answer for certain types of questions o Identifies the question so that the correct answer can be indicated by the ANSWER tag QUESTION requires a matching end tag. The FORM=value attribute is required in all forms of questions. Questions are numbered automatically, much like figures. If your document pages and figures are numbered sequentially, then your questions will also be numbered sequentially from the beginning of the document to the end. If your document is numbered by chapter, ISIL restarts question numbering with "1" at the beginning of each chapter. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :QUESTION │ question │ ANS= │ Implied para- │ :EQUESTION │ │ │ │ ANSID= │ graph. │ │ │ │ │ COMPACT │ │ │ │ │ │ FORM= │ │ │ │ │ │ ID= │ │ │ │ │ │ LAYOUT= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ANS='answer text' │ Specifies the text of the answer to a │ │ │ question. │ +──────────────────────────────+──────────────────────────────────────────+ │ ANSID=name │ Specifies the name to be associated with │ │ │ this answer. The name can be up to 7 │ │ │ characters long (letters and numbers; │ │ │ first character should be a letter). │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=FILLIN │ Specifies the form of a question. │ │ TF │ │ │ MC │ │ │ MATCH │ │ │ ORDER │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ LAYOUT=SAME │ Specifies the layout in columns of a │ │ ONE │ directory or a question. SAME is the │ │ TWO │ initial setting for directories. For │ │ THREE │ questions, only ONE or TWO is valid, and │ │ FOUR │ ONE is the initial setting. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.:QUESTION FORM=TF ans=T id=tof1.Always start a new sentence on a new input line.:EQUESTION. :p.:QUESTION FORM=TF ans=F id=tof2.The REFID attribute on the ANSREF tag refers to the ID on the ANSWER tag.:EQUESTION. :p.:QUESTION FORM=TF ans=T id=tof3.An address structure can be entered anywhere in your document.:EQUESTION. OR :p.:QUESTION FORM=FILLIN id=fil1.Music is :blank width=7p ans='food'.for the soul.:EQUESTION. OR :QUESTION FORM=MC ID=EXMP ANSID='JB1 JB2'. Coeur d'Alene, Idaho is best known for: :choice ID=JB1.Cold snowy winter weather. :choice.Long hot summers. :choice.High technology :choice ID=JB2.A big beautiful lake ═══ 2.187. RELEASE Release Label (Cover) ═══ RELEASE Release Label (Cover) Purpose One of the parts of the document title for products that have to distinguish among releases. The "release level" tag gathers release information. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :RELEASE │ release │ │ Text on same line │ │ │ │ numbers │ │ or next line; no │ │ │ │ (cover) │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :release.Release 1.0 ═══ 2.188. REPSEP Syntax Diagram Repeat Separator ═══ REPSEP Syntax Diagram Repeat Separator Purpose The REPSEP tag specifies whether the group of items and sub-groups can repeat. This tag is a TOSL and the repeat separator character is optional. If the repeat separator character is specified, it separates the repeated group of items and sub-groups. Note that the repeat separator can be more than one character, the REPSEP tag can only be specified once per GROUP tag, the REPSEP tag is only valid between the GROUP tag and its matching end tag, and the REPSEP tag only applies to the currently active GROUP tag. Format :REPSEP REQ|OPT CONSTANT|VAR. repeat-separator-character Parameters REQ|OPT specifies the selectability of the repeat separator character, where: REQ indicates the repeat separator character is required. OPT indicates the repeat separator character is optional. CONSTANT|VAR specifies the class of the repeat separator character, where: CONSTANT indicates the repeat separator character does not vary. VAR indicates the repeat separator character is variable. Examples Sample: :syntax. :kwd.TELL :group. :repsep. :var.nickname :egroup. :var.message :esyntax. Formats like: <------------ | >>--TELL----nickname-----message------------------------>< Sample: :syntax. :kwd.MOVE :var.from :group. :repsep opt., :var.to :egroup. :esyntax. Formats like: <-.---.--- '-,-' | >>--MOVE--from----to----------------------------------->< ═══ 2.189. RETKEY Retrieval Key ═══ RETKEY Retrieval Key Purpose The RETKEY tag allow you to specify one or more topics for your document, that BookManager readers can search for. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :RETKEY │ retrieval key │ │ Text on same line │ │ │ │ (for online │ │ or next line; no │ │ │ │ documenta- │ │ other tags. │ │ │ │ tion) │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :prolog. :retkey.BookMaster Online Help :eprolog. :retkey.BookMaster Online Help ═══ 2.190. REV Revision Bar ═══ REV Revision Bar Purpose Revision characters are started and stopped with REV and its matching end tag. The REFID attribute is required. You can nest REV tags inside other REV tags. You can not; however, start the document element, then start a REV tag, end the document element, and then end the REV tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REV │ revision bar │ REFID= │ No immediate │ :EREV │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples This is old material. :REV REFID='aprv'. This is new material. :EREV REFID='aprv'. And now we're back to the old material. ═══ 2.191. REVCW Revision Control Words ═══ REVCW Revision Control Words Purpose Since the revision tags do not cover all possible replacement page update circumstances, there will be times when you will have to enter SCRIPT control words to accomplish all the necessary revision formatting. To ensure that these control words are associated with a particular revision, and thus ignored when you are not formatting for that revision, we have the REVCW (REV control words) tags that allow you to tie the control words to a specific revision. Place the tags around the control words that are for the revision only, and then the control words will be processed only when the RUN attribute for that REVISION ID is "yes". Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVCW │ control words │ REFID= │ No immediate │ :EREVCW │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :revcw refid=name. .cp :erevcw refid=name. ═══ 2.192. REVISION Revision ═══ REVISION Revision Purpose The REVISION tag names a revision or a replacement page update, provides information that is used for building the slug, and also specifies whether or not the other tags associated with this revision/update are to be processed when the book is formatted. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVISION │ technical │ ID= │ No immediate │ │ │ │ newsletter │ DATE= │ text. │ │ │ │ │ DESC= │ │ │ │ │ │ CHAR= │ │ │ │ │ │ NUM= │ │ │ │ │ │ PREFIX= │ │ │ │ │ │ RUN= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ DATE='date of REVISION' │ Specifies the REVISION date to be used │ │ │ in REVISION slugs. │ +──────────────────────────────+──────────────────────────────────────────+ │ DESC='text-of-description' │ Describes a revision; for informational │ │ │ purposes only. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHAR=character │ Specifies the revision character to be │ │ │ used for the revision being defined. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM='REVISION number' │ Specifies the order number of a │ │ │ REVISION. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=revision slug prefix │ For document styles that start with │ │ │ "IBM," the default prefix is "TNL." │ +──────────────────────────────+──────────────────────────────────────────+ │ RUN=YES │ Specifies whether or not the REVISION │ │ NO │ tags named by the ID attribute on this │ │ │ REVISION tag are to be processed in this │ │ │ run. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :REVISION ID='name' RUN=yes DATE='21 Feb 1988' NUM='TNL form number' CHAR='A'. ═══ 2.193. REVPF Revision Point Figures ═══ REVPF Revision Point Figures Purpose When figures are added in a replacement page update, you use the REVPF tags to give decimal point numbers to the added figures. Place the REVPF tag just before the first figure to be added between two existing figures, and the REVPF end tag following the last figure to be added between two existing figures. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVPF │ point figures │ REFID= │ No immediate │ :EREVPF │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :revpf refid=t1. :fig id=new. : :figcap.Text of caption :efig. :erevpf refid=t1. ═══ 2.194. REVPP Revision Point Pages ═══ REVPP Revision Point Pages Purpose When pages are added in a replacement page update, you use the REVPP tags to give the added pages decimal point numbers. The decimal point numbered pages will always be added to an even page number. (Since the point page is numbered xx.1, this enforces the rule that right-hand pages must have an odd page number.) The REVPP tag must be placed just before the page on which you want it to take effect. The REVPP end tag, which causes a page eject, must appear exactly where you want the page eject to occur. If the point pages end on an odd page and you want to print the backup page, put a page eject within REVCW tags just before the REVPP end tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVPP │ point pages │ REFID= │ No immediate │ :EREVPP │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :revpp refid=name. :erevpp refid=name. ═══ 2.195. REVPT Revision Point Tables ═══ REVPT Revision Point Tables Purpose When tables are added in a replacement page update, you use the REVPT tags to give decimal point numbers to the added tables. Place the REVPT tag just before the first table to be added between two existing tables, and the REVPT end tag following the last table to be added between two existing tables. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVPT │ point tables │ REFID= │ No immediate │ :EREVPT │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :revpt refid=t1. :table id=new. width=page cols='* * *'. :tcap.Text of caption :etable. :erevpt refid=t1. ═══ 2.196. REVSLUG Revision Slug ═══ REVSLUG Revision Slug Purpose REVSLUG tags are used in preparing replacement-page updates only. Sample revision supplement slugs are started by using the REVSLUG tag and turned off with the matching REVSLUG end tag. The REVSLUG tags can appear anywhere in the text for the page on which you want them to take effect except, they cannot be specified inside a caution, danger, warning, display formula, formula, figure, footnote, labeled box, notice, edition notice, security notice, question, screen, synopsis, table, example, character graphic, or following a TIPAGE or COVER tag. The slug will be printed on a single line at the top or bottom of the page, depending on your style. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :REVSLUG │ slug │ REFID= │ No immediate │ :EREVSLUG │ │ │ │ │ text. │ REFID= │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :revslug refid='aprv'. :erevslug refid='aprv'. ═══ 2.197. RK Reference Key ═══ RK Reference Key Purpose The RK tag identifies a reference key that is generally used to key text elements to locations in an accompanying diagram. RK requires a matching end tag. Reference keys can occur anywhere in text except when the content is described as "text on same line; no other tags." Reference keys are printed as a square black background with white text or enclosing bold text in bold square brackets, depending on the printer. The characters used as reference keys are usually numeric; however, alphabetic characters are allowed. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :RK │ reference key │ │ numerals and │ :ERK │ │ │ │ │ letters only │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples .im tbl2 :p.This bracket is attached using two screws :RK.12:ERK. and two nuts:RK.15:ERK.. ═══ 2.198. ROW Table Row ═══ ROW Table Row Purpose The ROW tag identifies a new row in a table. It is followed by C tags to specify the columns or cells for the row text. The ROW tag is then repeated for the second row in the column and the same number of C tags as followed the first ROW tag. You may have as many rows in your table as necessary. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ROW │ table row │ REFID= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ TEMP │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPLIT=NO │ YES │ n │ Indicates whether a table can be split. │ │ │ n specifies the number of rows at the │ │ │ beginning of the table to be kept │ │ │ together. │ +──────────────────────────────+──────────────────────────────────────────+ │ TEMP │ Establishes the definition of the row, │ │ │ header, or footer as temporary. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :table cols='* *'. :tcap.A simple table :row. :c.Row 1, Cell 1 :c.Row 1, Cell 2 :etable. ═══ 2.199. SAFETY Safety notices ═══ SAFETY Safety notices Purpose Identifies a safety section in a customer's document. IBM documents should use IBMSFTY. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SAFETY │ safety │ ID= │ No immediate │ │ │ │ section │ INITPG= │ text. │ │ │ │ │ PNKEY= │ │ │ │ │ │ NUM= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :safety. ═══ 2.200. SCHDATE Schedule Date List ═══ SCHDATE Schedule Date List Purpose The SCHDATE tag is use to list the line item dates from the SCHEDULE tag set. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCHDATE │ schedule date │ ACTHD= │ No immediate │ │ │ │ list │ ACTSIZE= │ text. │ │ │ │ │ CMTHD= │ │ │ │ │ │ CMTSIZE= │ │ │ │ │ │ FRAME= │ │ │ │ │ │ LISTREF= │ │ │ │ │ │ ROTATE= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ACTHD='string' │ Specifies the text for the header of the │ │ │ activity column. │ +──────────────────────────────+──────────────────────────────────────────+ │ ACTSIZE='activities-size' │ Specifies horizontal size of the │ │ │ activity column. │ +──────────────────────────────+──────────────────────────────────────────+ │ CMTHD='string' │ Specifies the text for the header of the │ │ │ comment column. │ +──────────────────────────────+──────────────────────────────────────────+ │ CMTSIZE='comment-size' │ Specifies the horizontal size of the │ │ │ comment column for the comments listed │ │ │ with the CMT attribute of the SCHI. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=BOX │ RULES │ Specifies the frame used for a schedule. │ +──────────────────────────────+──────────────────────────────────────────+ │ LISTREF='id ...' │ Specifies the identification of sched- │ │ │ uled dates that you want to include in a │ │ │ schedule date list. │ +──────────────────────────────+──────────────────────────────────────────+ │ ROTATE=0 │ 90 │ 180 │ 270 │ Specifies a schedule rotation in │ │ │ degrees. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling-factor' │ Specifies how the content of the tag is │ │ │ increased or decreased in relation to │ │ │ the normal text size. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPLIT=NO │ YES │ n │ Indicates whether a schedule can be │ │ │ split. n specifies the number of activ- │ │ │ ities at the beginning of the schedule │ │ │ to be kept together. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=COLUMN │ │ Specifies the width of a schedule. │ │ PAGE │ │ │ │ horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :schedule listid=writer legend=yes start='9/87' end='12/87' width=column curdate='12/12/87' scale='.9' frame=box. :schi pstart='9/3/87' pend='10/1/87' astart='9/3/87' aend='10/1/87'.Research :schi pstart='9/10/87' pend='10/15/87' astart='9/10/87' aend='10/7/87'.Design plan :schi pstart='9/17/87' pend='11/12/87' astart='9/17/87'.First draft :schi pstart='11/10/87' pend='11/25/87'.Review and edit :schi pstart='12/3/87' pend='12/3/87' astart='12/10/87' aend='12/10/87'.Final draft presentation :eschedule. :schdate listref='writer'. ═══ 2.201. SCHDEF Schedule Definition ═══ SCHDEF Schedule Definition Purpose The SCHDEF tag is use to set the defaults for use by the SCHEDULE tag. This tag works the same way that all elementDEF tags do. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCHDEF │ schedule │ ACTHD= │ No immediate │ │ │ │ definition │ ACTSIZE= │ text. │ │ │ │ │ CHART= │ │ │ │ │ │ CMTHD= │ │ │ │ │ │ CMTSIZE= │ │ │ │ │ │ CURDATE= │ │ │ │ │ │ DATEFORM= │ │ │ │ │ │ END= │ │ │ │ │ │ FRAME= │ │ │ │ │ │ HOURS= │ │ │ │ │ │ ID= │ │ │ │ │ │ INTERVAL= │ │ │ │ │ │ LEGEND= │ │ │ │ │ │ LISTID= │ │ │ │ │ │ ROTATE= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SHADE= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ START= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters See SCHEDULE... Examples :schdef id=def legend=yes start='9/87' end='12/87' width=column curdate='12/12/87' scale='.9' frame=box. :schedule refid=def. :schi pstart='9/3/87' pend='10/1/87' astart='9/3/87' aend='10/1/87'.Research :schi pstart='9/10/87' pend='10/15/87' astart='9/10/87' aend='10/7/87'.Design plan :schi pstart='9/17/87' pend='11/12/87' astart='9/17/87'.First draft :schi pstart='11/10/87' pend='11/25/87'.Review and edit :schi pstart='12/3/87' pend='12/3/87' astart='12/10/87' aend='12/10/87'.Final draft presentation :eschedule. :schdate listref='writer'. :schedule start='89/5/2 800' end='89/5/3 1400' hours='8 16 2' dateform='yy/mm/dd' interval=hours actsize=6p acthd='Master Series Classes' cmthd='Assigned to' cmtsize=3p. :schi pstart='5/2 800' pend='5/2 1030' astart='5/2 800' aend='5/2 1045' cmt='AJD'.BookMaster :schi pstart='5/2 1300' pend='5/2 1600' astart=' ' aend=' ' cmt='GYR'.DrawMaster :schi pstart='5/3 830' pend='5/3 1200' astart=' ' aend=' ' pstart1='5/3 1300' pend1='5/3 1400' astart1=' ' aend1=' ' cmt='JWT'.ProcessMaster &egml.schedule. ═══ 2.202. SCHEDULE Schedule ═══ SCHEDULE Schedule Purpose The SCHEDULE tag is use to start a specific schedule. The SCHEDULE end tag is used to end the schedule. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCHEDULE │ schedule │ ACTHD= │ No immediate │ :ESCHEDULE │ │ │ │ ACTSIZE= │ text. │ │ │ │ │ CHART= │ │ │ │ │ │ CMTHD= │ │ │ │ │ │ CMTSIZE= │ │ │ │ │ │ CURDATE= │ │ │ │ │ │ DATEFORM= │ │ │ │ │ │ END= │ │ │ │ │ │ FRAME= │ │ │ │ │ │ HOURS= │ │ │ │ │ │ INTERVAL= │ │ │ │ │ │ LEGEND= │ │ │ │ │ │ LISTID= │ │ │ │ │ │ REFID= │ │ │ │ │ │ ROTATE= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SHADE= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ START= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ACTHD='string' │ Specifies the text for the header of the │ │ │ activity column. │ +──────────────────────────────+──────────────────────────────────────────+ │ ACTSIZE='activities-size' │ Specifies horizontal size of the │ │ │ activity column. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHART=YES│NO │ Specifies whether schedule chart is to │ │ │ print. │ +──────────────────────────────+──────────────────────────────────────────+ │ CMTHD='string' │ Specifies the text for the header of the │ │ │ comment column. │ +──────────────────────────────+──────────────────────────────────────────+ │ CMTSIZE='comment-size' │ Specifies the horizontal size of the │ │ │ comment column for the comments listed │ │ │ with the CMT attribute of the SCHI. │ +──────────────────────────────+──────────────────────────────────────────+ │ CURDATE='date' │ Specifies the current date for a │ │ │ schedule in the format specified by the │ │ │ DATEFORM attribute of the SCHEDULE and │ │ │ SCHDEF tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ DATEFORM='MM/DD/YY │ │ Specifies the form of the dates. │ │ DD/MM/YY │ YY/MM/DD' │ │ +──────────────────────────────+──────────────────────────────────────────+ │ END='date' │ Specifies the end date of a schedule in │ │ │ the format specified by the DATEFORM │ │ │ attribute of the SCHEDULE or SCHDEF │ │ │ tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=BOX │ NONE │ │ Specifies the frame used for a figure. │ │ RULES │ 'string' │ │ +──────────────────────────────+──────────────────────────────────────────+ │ HOURS='earliest latest │ Specifies the minimum hour, the maximum │ │ increment' │ hour, and the hour increments of a │ │ │ schedule. │ +──────────────────────────────+──────────────────────────────────────────+ │ INTERVAL │ Specifies the time interval used in the │ │ │ schedule. │ +──────────────────────────────+──────────────────────────────────────────+ │ LEGEND=NO │ YES │ Specifies whether or not a legend │ │ │ explaining symbols, boxes, and rules in │ │ │ a schedule is to be included at the end │ │ │ of the schedule chart. │ +──────────────────────────────+──────────────────────────────────────────+ │ LISTID=id │ Specifies the identification of a │ │ │ schedule for later inclusion into a │ │ │ schedule date list. The id can be up to │ │ │ seven characters. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ ROTATE=0 │ 90 │ 180 │ 270 │ Specifies a schedule rotation in │ │ │ degrees. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling-factor' │ Specifies how the content of the tag is │ │ │ increased or decreased in relation to │ │ │ the normal text size. │ +──────────────────────────────+──────────────────────────────────────────+ │ SHADE=NO │ YES │ Specifies whether the elongated boxes │ │ │ are to be shaded. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPLIT=NO │ YES │ n │ Indicates whether a table or schedule │ │ │ can be split. n specifies the number of │ │ │ rows or activities at the beginning of │ │ │ the table or schedule to be kept │ │ │ together. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ START='date' │ Specifies the start date of a schedule │ │ │ in the format specified by the DATEFORM │ │ │ attribute of the SCHEDULE or SCHDEF │ │ │ tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=COLUMN │ │ Specifies the width of a schedule. │ │ PAGE │ │ │ │ horizontal-space │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :schedule listid=writer legend=yes start='9/87' end='12/87' width=column curdate='12/12/87' scale='.9' frame=box. :schi pstart='9/3/87' pend='10/1/87' astart='9/3/87' aend='10/1/87'.Research :schi pstart='9/10/87' pend='10/15/87' astart='9/10/87' aend='10/7/87'.Design plan :schi pstart='9/17/87' pend='11/12/87' astart='9/17/87'.First draft :schi pstart='11/10/87' pend='11/25/87'.Review and edit :schi pstart='12/3/87' pend='12/3/87' astart='12/10/87' aend='12/10/87'.Final draft presentation :eschedule. :schdate listref='writer'. :schedule start='89/5/2 800' end='89/5/3 1400' hours='8 16 2' dateform='yy/mm/dd' interval=hours actsize=6p acthd='Master Series Classes' cmthd='Assigned to' cmtsize=3p. :schi pstart='5/2 800' pend='5/2 1030' astart='5/2 800' aend='5/2 1045' cmt='AJD'.BookMaster :schi pstart='5/2 1300' pend='5/2 1600' astart=' ' aend=' ' cmt='GYR'.DrawMaster :schi pstart='5/3 830' pend='5/3 1200' astart=' ' aend=' ' pstart1='5/3 1300' pend1='5/3 1400' astart1=' ' aend1=' ' cmt='JWT'.ProcessMaster &egml.schedule. ═══ 2.203. SCHI Schedule Line Item ═══ SCHI Schedule Line Item Purpose The SCHI tag is use to enter a line item in the schedule. The text associated with this tag is the activity description. Different attributes are used to specify the dates associated with the activity. Note: The start and end dates on the SCHI tag may be outside the START and END dates on the SCHEDULE tag. Also, the time will be ignored on the start and end attributes for intervals other than DAY and HOUR. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCHI │ schedule item │ AEND1-n= │ Text on same line │ │ │ │ │ ASTART1-n= │ or next line; no │ │ │ │ │ CMT= │ other tags. │ │ │ │ │ PEND1-n= │ │ │ │ │ │ PSTART1-n= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ AENDn='date' │ Specifies the actual end date of an │ │ │ activity in a schedule in the format │ │ │ specified by the DATEFORM attribute of │ │ │ the SCHEDULE or SCHDEF tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ ASTART1-n='date' │ Specifies the actual start date of an │ │ │ activity in a schedule in the format │ │ │ specified by the DATEFORM attribute of │ │ │ the SCHEDULE or SCHDEF tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ CMT='string' │ Specifies the comment text for the │ │ │ activity column of the schedule chart. │ +──────────────────────────────+──────────────────────────────────────────+ │ PEND1-n='date' │ Specifies the projected end date of an │ │ │ activity in a schedule in the format │ │ │ specified by the DATEFORM attribute of │ │ │ the SCHEDULE or SCHDEF tags. │ +──────────────────────────────+──────────────────────────────────────────+ │ PSTART1-n='date' │ Specifies the projected start date of an │ │ │ activity in a schedule in the format │ │ │ specified by the DATEFORM attribute of │ │ │ the SCHEDULE or SCHDEF tags. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :schedule listid=writer legend=yes start='9/87' end='12/87' width=column curdate='12/12/87' scale='.9' frame=box. :schi pstart='9/3/87' pend='10/1/87' astart='9/3/87' aend='10/1/87'.Research :schi pstart='9/10/87' pend='10/15/87' astart='9/10/87' aend='10/7/87'.Design plan :schi pstart='9/17/87' pend='11/12/87' astart='9/17/87'.First draft :schi pstart='11/10/87' pend='11/25/87'.Review and edit :schi pstart='12/3/87' pend='12/3/87' astart='12/10/87' aend='12/10/87'.Final draft presentation :eschedule. :schedule start='89/5/2 800' end='89/5/3 1400' hours='8 16 2' dateform='yy/mm/dd' interval=hours actsize=6p acthd='Master Series Classes' cmthd='Assigned to' cmtsize=3p. :schi pstart='5/2 800' pend='5/2 1030' astart='5/2 800' aend='5/2 1045' cmt='AJD'.BookMaster :schi pstart='5/2 1300' pend='5/2 1600' astart=' ' aend=' ' cmt='GYR'.DrawMaster :schi pstart='5/3 830' pend='5/3 1200' astart=' ' aend=' ' pstart1='5/3 1300' pend1='5/3 1400' astart1=' ' aend1=' ' cmt='JWT'.ProcessMaster &egml.schedule. ═══ 2.204. SCHNOTE Schedule Note ═══ SCHNOTE Schedule Note Purpose The SCHNOTE tag allows you to put a note in your schedule chart. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCHNOTE │ schedule note │ ALIGN= │ Text on same line │ │ │ │ │ DATE= │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ │ Specifies the alignment of the note text │ │ LEFT │ │ in the schedule chart item. │ │ RIGHT │ │ +──────────────────────────────+──────────────────────────────────────────+ │ DATE='note-date' │ Specifies the date in the schedule chart │ │ │ where the schedule note is placed. │ +──────────────────────────────+──────────────────────────────────────────+ Examples ═══ 2.205. SCRDEF Display Screen Definition ═══ SCRDEF Display Screen Definition Purpose The SCRDEF (screen definition) tag allows you to define your screen attributes just once, then refer to them repeatedly (using the REFID attribute) for producing similar screens. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCRDEF │ display │ ID= │ No immediate │ │ │ │ screen defi- │ VIEW= │ text. │ │ │ │ nition │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ VIEW=FULL │ Specifies the portion of a screen to be │ │ TOP │ illustrated. FULL is the initial │ │ TOPL │ setting. │ │ TOPC │ │ │ TOPR │ │ │ MID │ │ │ MIDL │ │ │ MIDC │ │ │ MIDR │ │ │ BOT │ │ │ BOTL │ │ │ BOTC │ │ │ BOTR │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :scrdef id=l123456 scale='.9'. :screen refid=l123456. : :escreen. ═══ 2.206. SCREEN Display Screen ═══ SCREEN Display Screen Purpose The SCREEN tag illustrates the way your input and the system's output would appear on a terminal screen. When a full-page wide screen is needed, the SCREEN tag can be placed within a FIG tag with the WIDTH=PAGE attribute. You can illustrate a full screen or a portion of one. For devices that support multiple sizes of type, you can scale the text of the screen content up (make it larger) or down (make it smaller). If you use the SCREEN tag without any attributes, you will get a full screen, 80 characters wide, with a full frame around it. (If you are using an output device that cannot handle the full 84 characters needed to illustrate the screen with its frame, the screen will spill over the righthand side of the page.) 1. When you want a full screen, you must provide its full depth (24 lines of text, for example) within the range of the SCREEN tag and its matching end tag. 2. In screens, please use the keyboard quotation marks, hyphens, blank spaces, and so on. Do not use quotation tags (" . . . ") or symbols (-, , . . .). Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SCREEN │ display │ REFID= │ Bracketed text. │ :ESCREEN │ │ │ screen │ VIEW= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ VIEW=FULL │ Specifies the portion of a screen to be │ │ TOP │ illustrated. FULL is the initial │ │ TOPL │ setting. │ │ TOPC │ │ │ TOPR │ │ │ MID │ │ │ MIDL │ │ │ MIDC │ │ │ MIDR │ │ │ BOT │ │ │ BOTL │ │ │ BOTC │ │ │ BOTR │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :screen. :xmp. 00001 .setup docsetup 00002 :h1.How many nests are possible in an ordered list? 00003 :ol compact. 00004 :li.One period (1) 00005 :li.Two period 00006 :li.Three period . . . 00026 :eol. 00027 :eol. :exmp. :escreen. ═══ 2.207. SEP Syntax Diagram Separator ═══ SEP Syntax Diagram Separator Purpose The SEP tag describes a separator character which separates keywords, variables, operators, and/or groups. This tag is a TOSL and the separator character is required. Note that the separator can be more than one character. Format :SEP REQ|OPT CONSTANT|VAR LID='id ...'. separator-character Parameters REQ|OPT specifies the selectability of the separator character, where: REQ indicates the separator character is required. OPT indicates the separator character is optional. CONSTANT|VAR specifies the class of the separator character, where: CONSTANT indicates the separator character does not vary. VAR indicates the separator character is variable. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample separators: :syntax. :sep.+ :sep opt.* :esyntax. Formats like: >>--+-------------------------------------------------->< | | --*-- ═══ 2.208. SEVERITY Message or Code Severity ═══ SEVERITY Message or Code Severity Purpose The SEVERITY tag identifies the severity of a code or message. It can be used only within a code list or message list. The subheading, "Severity," is printed to the left of the text. If the SEVERITY attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Severity." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SEVERITY │ message or │ │ Implied para- │ │ │ │ code severity │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I :xpl.Informational message. :severity.3 :module.Golden Gate Bridge : : :xpl.Warning message. :severity.To be determined. :module.Golden Gate Bridge : ═══ 2.209. SL Simple List ═══ SL Simple List Purpose The SL tag identifies a simple list of items. It requires a matching end tag. Simple lists can occur anywhere in text, and can be nested within other lists. Simple lists are formatted as "hanging" indented lists. The items have no identifier (bullet, number, or letter). Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SL │ simple list │ COMPACT │ No immediate │ :ESL │ │ │ │ PREFIX= │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=CHECKOFF │ Specifies that this is a checkoff list. │ +──────────────────────────────+──────────────────────────────────────────+ Examples gml.SL. :li.Simple list item one. :li.Simple list item two, composed of: :SL COMPACT PREFIX=CHECKOFF. :li.Nested simple list item 1 (PREFIX=CHECKOFF) :li.Nested simple list item 2 :li.Nested simple list item 3 :li.Nested simple list item 4 :ESL. :li.Simple list item three. :lp.This is a :q.list part:eq.; the remainder of the list follows. :li.Next-to-last item. :li.Last item. :ESL. ═══ 2.210. SNOTICE Security Notice ═══ SNOTICE Security Notice Purpose The SNOTICE tag identifies the security notice that is required to appear on the title page of many IBM Confidential documents. SNOTICE requires an end tag. The security notice tag should be placed in the prolog immediately after the TIPAGE tag. The security notice is usually printed on the title page of the manual. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SNOTICE │ security │ │ No immediate │ :ESNOTICE │ │ │ notice │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples . :eprolog. :frontm. :tipage. :SNOTICE. This document contains information of a proprietary nature. All information contained herein shall be kept in confidence. None of this information shall be divulged to persons other than IBM employees authorized by the nature of their duties to receive such information or individuals or organizations authorized by the General Products Division in accordance with existing policy regarding release of company information. :ESNOTICE. :notices. . . . ═══ 2.211. SOA Summary of Amendments ═══ SOA Summary of Amendments Purpose The SOA tag identifies the location of the summary of amendments, which is a summary of the changes to the manual. A summary of amendments page appears within the front matter of the document, after the preface. SOA starts a new page and provides the text for the level-1 heading: "Summary of Changes" and the running foot. You can specify an alternative to this default heading after any attributes and the period. A summary of amendments is implicitly ended by any level 1 heading tag, such as TOC, FIGLIST, or the BODY tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SOA │ summary of │ ID= │ Text on same line │ │ │ │ ammendments │ INITPG= │ or next line; no │ │ │ │ │ NUM= │ other tags. │ │ │ │ │ PNKEY= │ (Optional │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :soa.Things we've changed since the last edition ═══ 2.212. SPOT Any Spot in the Document ═══ SPOT Any Spot in the Document Purpose The SPOT tag makes it possible to refer to any spot in your document. You can refer to a place in your document other than a heading, figure, or table with the SPOT tag. SPOT can appear anywhere in the text; it has no effect on the text around it. SPOT tags are referred to with SPOTREF tags. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SPOT │ any spot in │ ID= │ Self-contained. │ │ │ │ the document │ XREFTEXT= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ XREFTEXT='spot-reference │ Specifies the text to be used in the │ │ text' │ spot reference. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.This text is in the middle of a document where there is no heading or figure. It is desirable to refer to the following paragraph from somewhere else in the document. :p.This is the paragraph we want referred to and we can make :SPOT ID=HERE. sure the spot reference is accurate by putting the SPOT tag right after the first line of the paragraph. :p.Then, when we issue the SPOTREF, we will see that we can refer to anywhere in our document. ═══ 2.213. SPOTREF Reference to a Spot ═══ SPOTREF Reference to a Spot Purpose The SPOTREF tag allows you to refer to the page number of any spot in your document where you've entered a SPOT tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SPOTREF │ reference to │ FORM= │ Self-contained. │ │ │ │ a spot │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.Refer to the paragraph on page :SPOTREF REFID=HERE. for an example of the SPOT tag. ═══ 2.214. SPRESP System Programmer Response ═══ SPRESP System Programmer Response Purpose The SPRESP tag identifies the system programmer actions that should be taken for a code or message. It can only be used in a code list or message list. The subheading, "System Programmer Response," is printed to the left of the text. If the SPRESP attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "System Programmer Response." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SPRESP │ system pro- │ │ Implied para- │ │ │ │ grammer │ │ graph. │ │ │ │ response │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I . . . :sysact.Divert traffic at each end of bridge. :spresp.Call police to direct traffic. :oresp.Inform drivers already at the booth of the problem and call a tow truck. . . . ═══ 2.215. ST Statement Text (Map) ═══ ST Statement Text (Map) Purpose The ST tag identifies supplemental text in a map in a maintenance library document. ST must be placed within a STEP structure in a map. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :ST │ statement │ FIT= │ Bracketed text. │ │ │ │ text (map) │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FIT=vertical space │ Specifies the minimum required for the │ │ │ tag content. The initial FIT setting │ │ │ for the QT tag is 7 lines. The initial │ │ │ FIT setting for the CT, FT, and ST tags │ │ │ is 3 lines. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :map id=mapex place=inline. :mapqfix. :xpl. :cause :emapqfix. :step id=step1. . . . :st. :ct. :qt. :estep. ═══ 2.216. STEP Step (Map) ═══ STEP Step (Map) Purpose The STEP tag begins a structure of steps in a maintenance analysis procedure (MAP) in maintenance library documents. It requires a matching end tag. The REFID attribute on an LIREF tag is used to refer to the ID on STEP. System-supplied ordination is used if the steps are numbered. Each "Yes" leg step may contain only one question. "Yes" leg steps with questions (QT) are followed by "Yes No." The STEP end tag terminates "Yes/No" legs. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :STEP │ step (map) │ ID= │ No immediate │ :ESTEP │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :map id=mapex place=inline. :mapqfix. :xpl. :cause :emapqfix. :step id=step1. . . . :st. :ct. :qt. :estep. :step id=step2. :st. :ft. :estep. ═══ 2.217. STEPREF Step Reference (Map) ═══ STEPREF Step Reference (Map) Purpose The STEPREF tag allows you to refer to a step in a maintenance analysis procedure (MAP) in maintenance library documents. References to uniquely identified steps can occur anywhere in the text. If the step reference precedes the step in the document, the TWOPASS option of the SCRIPT command should be used. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :STEPREF │ step refer- │ FORM= │ Self-contained. │ │ │ │ ence (map) │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.Refer to :stepref refid=step1. for this information. ═══ 2.218. SUB Subscript Expression ═══ SUB Subscript Expression Purpose The SUB tag produces subscripts. SUB requires a matching end tag. The subscript is a small character (or string of characters) that is printed slightly below the line. On devices where the string cannot be printed as a subscript, BookMaster encloses the string in brackets. If your document is in its final form, therefore, you should explain this convention to your readers. If your subscript contains blanks and happens to fall at the end of a line (in formatted mode), it might break in the middle of your subscript. To prevent this, replace the blanks with the symbol. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SUB │ subscript │ │ Any text; any- │ :ESUB │ │ │ expression │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples a = x :sub.2:esub.* log | x:sub.1:esub. y:sub.1:esub. | - y:sub.2:esub.* arctan (y:sub.1:esub. / x:sub.1:esub.) ═══ 2.219. SUBJECT Subject (For Running Heading) ═══ SUBJECT Subject (For Running Heading) Purpose The SUBJECT tag specifies text for a running heading. The running heading specified by the SUBJECT tag runs until it is reset by another attribute or tag. You can turn off the running heading by issuing the SUBJECT tag with no value. If more than one subject (either specified with the tag or the attribute) is defined for a single page, the subject(s) used are specified by the SUBJSEL attribute of the DOCPROF tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SUBJECT │ subject (for │ │ Text on same line │ │ │ │ running │ │ or next line; no │ │ │ │ heading) │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :subject.Introduction ═══ 2.220. SUP Superscript Expression ═══ SUP Superscript Expression Purpose The SUP tag produces superscripts. SUP requires a matching end tag. The superscript is a small character (or string of characters) that is printed slightly above the line. On devices where the string cannot be printed as a superscript, BookMaster encloses the string in parentheses. If your document is in its final form, therefore, you should explain this convention to your readers. If your superscript contains blanks and happens to fall at the end of a line (in formatted mode), it might break in the middle of your superscript. To prevent this, replace the blanks with the symbol. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SUP │ superscript │ │ Any text; any- │ :ESUP │ │ │ expression │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples e:sup.x+loge:esup. v:sup.2:esup. / e:sup.xyz-loge:esup. - e:sup.y-loge+1:esup. ═══ 2.221. SYNDEF Syntax Diagram Definition ═══ SYNDEF Syntax Diagram Definition Purpose The SYNDEF tag defines the syntax default definition. Format :SYNDEF LANGUAGE=text NTHD='text' WIDTH=number-of-characters DWIDTH='*|hspace' ID=name SCALE='factor'|AUTO SETEND=FILL|FILLX|FIT STYLE=SPACE|BOX|RULES|LBLBOX VIEW=FULL|START|END|MIDDLE. Parameters See the SYNTAX tag for descriptions of the attributes. Examples Set a syntax definition: :syndef style=lblbox scale='.9' setend=fillx. ═══ 2.222. SYNNT Syntax Diagram Note ═══ SYNNT Syntax Diagram Note Purpose The SYNNT tag identifies a syntax note description to be referenced and gives it a name with the ID attribute. We can then refer to it by the REFID attribute of the SYNNTREF tag. Also, you can specify a syntax note without an ID, in which case the syntax note reference will be placed at the spot where it found the syntax note in the source file. The syntax note text is placed after the syntax diagram and the associated fragments. Format :SYNNT ID=name CALLOUT='string'. syntax note description :ESYNNT. Parameters ID=name specifies the identifier name for the syntax note description. CALLOUT='string' specifies the string of characters or a single character to be used for the note reference in place of the normal syntax diagram note sequence number. Examples Sample: :syntax. :kwd.MYCMD :synnt. Here's a silly little footnote about the command. It should not be used in any month that contains an R. :esynnt. :var.something :esyntax. Formats like: (1) >>--MYCMD-----something-------------------------------->< Note: (1) Here's a silly little footnote about the command. It should not be used in any month that contains an R. Usage 1. SYNNT tags which use the ID attribute must precede the SYNNTREF tags that reference the syntax note. 2. The name on the ID attribute can only be referenced from within the currently active SYNTAX tag. 3. The name on the ID attribute only needs to be unique within each SYNTAX tag. 4. The SYNNT or SYNNTREF tag can be placed after any KWD, VAR, OPER, SEP, DELIM, FRAGREF, GROUP, or end GROUP tag. Also, the SYNNT tag with an ID attribute can be placed after any SYNTAX or FRAGMENT tag. ═══ 2.223. SYNNTREF Syntax Diagram Note Reference ═══ SYNNTREF Syntax Diagram Note Reference Purpose The SYNNTREF tag identifies a syntax note reference. Format :SYNNTREF REFID=name. Parameters REFID=name specifies the identifier name of the syntax note description. Examples Sample: :syntax. :synnt id=silly callout='*'. Here's a silly little footnote about the command. It should not be used in any month that contains an R. :esynnt. :kwd.MYCMD :synntref refid=silly. :var.something :esyntax. Formats like: (*) >>--MYCMD-----something-------------------------------->< Note: (*) Here's a silly little footnote about the command. It should not be used in any month that contains an R. ═══ 2.224. SYNOPSIS Synopsis ═══ SYNOPSIS Synopsis Purpose The SYNOPSIS tag identifies a brief summary of the document that can be included in the title page. SYNOPSIS requires a matching end tag. The SYNOPSIS tag must come immediately after the TIPAGE tag. The synopsis is printed on the title page of the manual. If too long, it will overflow to a second page. It will not be offset. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SYNOPSIS │ synopsis │ │ No immediate │ :ESYNOPSIS │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :userdoc. :frontm. :tipage. :synopsis. :p.This booklet describes... . . . :esynopsis. ═══ 2.225. SYNTAX Syntax Diagram Start ═══ SYNTAX Syntax Diagram Start Purpose The SYNTAX tag describes a language element syntax. The residual text is used for the label box. Format :SYNTAX LANGUAGE=text NTHD='text' WIDTH=number-of-characters DWIDTH='*|hspace' REFID=name SCALE='factor'|AUTO STYLE=SPACE|BOX|RULES|LBLBOX SETEND=FILL|FILLX|FIT VIEW=FULL|START|END|MIDDLE. text :ESYNTAX. Parameters STYLE=SPACE|BOX|RULES|LBLBOX specifies the frame that is to be printed around the outer edge of the syntax diagram, where: SPACE Indicates only space is used before and after the syntax diagram. BOX Indicates a boxed frame. RULES Indicates a horizontal rule at the top and bottom of the syntax diagram. LBLBOX Uses the residual text as the label and puts the syntax diagram in the labelled box. SETEND=FILL|FILLX|FIT specifies whether the syntax diagram lines are to be filled with a horizontal line to the right textline margin. This includes the main syntax diagram as well as the syntax fragments. The possible values are: FILL All diagram lines are to be filled to the right margin. FILLX Fill all diagram lines to the right margin except the last line. If there is only one line, it will not be filled. FIT Do not fill any diagram lines (ragged right). LANGUAGE=text specifies the computer language that you are describing. SCALE='factor'|AUTO specifies the scaling factor used to change the size of the text in the syntax diagram. WIDTH=number-of-characters specifies the width of the syntax diagram in characters (not in any of the other horizontal space units). This does not include the frame around the syntax diagram. Note: This attribute is required only when using SCALE=AUTO. DWIDTH='*|hspace' specifies the display width of a syntax diagram to be viewed on a screen. Used only with BookManager. * overrides an explicit DWIDTH from a SYNDEF and assumes the width specified by the WIDTH attribute. hspace specifies the width of the syntax diagram as it is to be displayed by BookManager. You may use any of the horizontal space units (maximum of 200 character spaces or equivalent). VIEW=FULL|START|END|MIDDLE specifies the view (starting and ending characters) of the syntax diagram, where: FULL >>---full--->< START >>---start---> END >---end--->< MIDDLE >---middle---> NTHD='text' specifies the header text for the syntax notes. If the document style has used "note header text", then this text is ignored. REFID=name specifies the identifier name of the syntax definition (SYNDEF). Examples Start a syntax diagram with the default style: :syntax. :kwd.MYCMD :esyntax. Formats like: :syntax. :kwd.MYCMD :esyntax. Start a diagram with the labeled box style: :syntax style=lblbox.MYCMD :kwd.MYCMD :esyntax. Formats like: :syntax style=lblbox.MYCMD :kwd.MYCMD :esyntax. Usage 1. The KWD, VAR, OPER, DELIM, SEP, FRAGREF, GROUP, SYNNT, and SYNNTREF tags are only valid between the SYNTAX tag and its matching end tag. 2. The syntax diagram must fit within a single column and page. No automatic overflow from column to column or page to page is performed. If a syntax diagram will not fit within the length of the column, you must create two or more syntax diagrams. Syntax significant blank symbol The symbol &ssbl. is defined only within the SYNTAX tag and is used when a blank is significant within the syntax language text. ═══ 2.226. General Syntax Information ═══ General Syntax Information Purpose When these tags were developed, the acronym NFUBHB (not for use by human beings -- NUF-hub-bub), was created. Don't worry, you know more than you think (Thank-you Dr. Spock). Syntax Guidelines: Here are some guidelines: o The SYNTAX tag starts out the diagram. o All the syntaxing tags are TOSLs - text on the same line or the next line, no other tags. o You can indent the syntaxing tags, to help structure the diagram while you're editing it. The only tag and text that cannot be indented is the SYNNT tag (syntax note). Those tags and text must be flush left. One side affect that no one saw with the tags, is that the tags require you to be very precise in describing the diagram. For example, in converting some of our reference material, we found several situations where the character graphic diagrams were ambiguous or incorrect. Syntax Rules: :syndef id=synsamp setend=fit Here are some quick and dirty rules for reading syntax diagrams: o Start here ┌┌── and end here ──┌│ o When in doubt, follow your finger. o Keywords like this must be entered as shown. >>---KEYWORD--->< o Variables like the following should contain a value entered by you. >>---sample-variable--->< o Diagrams continue from line to line like this: >>---start here---> >---continue here--->< o Some keywords can be shortened. The characters that are optional are in lowercase. In this sample, you can enter TOP, TO, or just T. >>---Top--->< o Some parameters offer choices. In this sample, you can enter CHOICE1 or CHOICE2. >>-----CHOICE1----->< | | --CHOICE2-- o Some parameters are optional and can be skipped. In this sample, you can enter CHOICE1, CHOICE2, or nothing. >>----------------->< | | --CHOICE1-- | | --CHOICE2-- o Some optional parameters have defaults, or values the computer uses when you don't specify something. Defaults are on top of the base line. In this sample, you can enter CHOICE1, CHOICE2, or nothing. If you enter nothing, CHOICE1 is assumed. --CHOICE1-- | | >>----------------->< | | --CHOICE2-- o Some parameters can be repeated. In this sample, you can enter CHOICE1 the first time and CHOICE2 the second time. <------------ | >>-----CHOICE1----->< | | --CHOICE2-- o Some parts of the diagram are shown as fragments. Here, the entire block labeled "Fragment" goes into the break in the top part of the diagram. >>--| Fragment |--------------------------------------->< Fragment: |--.---------.------------------------------------------| |-CHOICE1-| '-CHOICE2-' o Some parts of the diagram have special notes. >>--.------------.------------------------------------->< |-CHOICE1----| | (1)| '-CHOICE2----' Note: (1) Here's a special note about CHOICE2. ═══ 2.227. SYS System (In Dialog) ═══ SYS System (In Dialog) Purpose The SYS tag identifies one of the participants in a dialog, typically, the system or computer. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SYS │ system (in │ │ Implied para- │ │ │ │ dialog) │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dialog user=You sys=Me. :user.Your question :sys.My answer :edialog. ═══ 2.228. SYSACT System Action ═══ SYSACT System Action Purpose The SYSACT tag identifies the system action taken when a code or message is issued. It can only be used within a code list or message list. The subheading, "System Action," is printed to the left of the text. If the SYSACT attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "System Action." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :SYSACT │ system action │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I . . . :probd.A car is turned crosswise to the traffic. :sysact.Divert traffic at each end of bridge. :spresp.Call police to direct traffic. . . . ═══ 2.229. TABDATA Tabbed Data ═══ TABDATA Tabbed Data Purpose The TABDATA tag allow you to easily enter tabbed information into your document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TABDATA │ tabbed infor- │ ABSRACK= │ No immediate │ :ETABDATA │ │ │ mation │ ALIGN= │ text. │ │ │ │ │ CHAR= │ │ &endtag. │ │ │ │ COLS= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ GUTTER= │ │ │ │ │ │ RACK= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ W1= │ │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ W9= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ABSRACK='tab-position ...' │ Specifies the position of tab stops rel- │ │ │ ative to the left side of the page. │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=[FILL fill-character] │ Specifies the alignment of the text in │ │ CENTER │ │ each of the columns and a fill character │ │ LEFT │ │ between columns. The last value speci- │ │ RIGHT │ │ fied applies to any remaining unspeci- │ │ / position character │ fied columns. Multiple ALIGN values │ │ │ must be enclosed in single quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHAR='character' │ Specifies the character used to indicate │ │ │ a tab stop. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='w1 w2 w3 ... ' │ Specifies the width of individual cells │ │ │ in a directory, a table, or a tabbed │ │ │ section. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Formats the content of the tag with no │ │ │ blank lines between entries, list items, │ │ │ or statements. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Separates each entry, item, or statement │ │ │ with a blank line. │ +──────────────────────────────+──────────────────────────────────────────+ │ GUTTER='gutter-space ...' │ Specifies the gutter space between │ │ │ columns in a tabbed section. │ +──────────────────────────────+──────────────────────────────────────────+ │ RACK='tab-position . . .' │ Specifies the position of the tab stops │ │ │ relative to the left margin of the text. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a tag being │ │ │ referred to in a cross reference. To be │ │ │ resolved correctly, name must appear on │ │ │ an ID attribute of a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling-factor' │ Specifies how the content of the tag is │ │ │ increased or decreased in relation to │ │ │ the normal text size. │ +──────────────────────────────+──────────────────────────────────────────+ │ W1='string1' │ Specifies the width of columns in a │ │ . │ tabbed section in terms of the length of │ │ . │ column entries. Up to nine column │ │ . │ widths are allowed per tag. │ │ W9='string9' │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :tabdata cols='7p 5p 14p' align='l c r' char='>'. first>second>third and>some>more :etabdata. ═══ 2.230. TABDDEF Tabbed Data Definition ═══ TABDDEF Tabbed Data Definition Purpose The TABDDEF defines tabbed data. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TABDDEF │ tabbed infor- │ ABSRACK= │ No immediate │ │ │ │ mation defi- │ ALIGN= │ text. │ │ │ │ nition │ CHAR= │ │ │ │ │ │ COLS= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ EXPAND │ │ │ │ │ │ GUTTER= │ │ │ │ │ │ ID= │ │ │ │ │ │ RACK= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ W1= │ │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ . │ │ │ │ │ │ W9= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ABSRACK='tab-position ...' │ Specifies the position of tab stops rel- │ │ │ ative to the left side of the page. │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=[FILL fill-character] │ Specifies the alignment of the text in │ │ CENTER │ │ each of the columns and a fill character │ │ LEFT │ │ between columns. The last value speci- │ │ RIGHT │ │ fied applies to any remaining unspeci- │ │ / position character │ fied columns. Multiple ALIGN values │ │ │ must be enclosed in single quotes. │ +──────────────────────────────+──────────────────────────────────────────+ │ CHAR='character' │ Specifies the character used to indicate │ │ │ a tab stop. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='w1 w2 w3 ... ' │ Specifies the width of individual cells │ │ │ in a directory, a table, or a tabbed │ │ │ section. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Formats the content of the tag with no │ │ │ blank lines between entries, list items, │ │ │ or statements. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Separates each entry, item, or statement │ │ │ with a blank line. │ +──────────────────────────────+──────────────────────────────────────────+ │ GUTTER='gutter-space ...' │ Specifies the gutter space between │ │ │ columns in a tabbed section. │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ RACK='tab-position . . .' │ Specifies the position of the tab stops │ │ │ relative to the left margin of the text. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling-factor' │ Specifies how the content of the tag is │ │ │ increased or decreased in relation to │ │ │ the normal text size. │ +──────────────────────────────+──────────────────────────────────────────+ │ W1='string1' │ Specifies the width of columns in a │ │ . │ tabbed section in terms of the length of │ │ . │ column entries. Up to nine column │ │ . │ widths are allowed per tag. │ │ W9='string9' │ │ +──────────────────────────────+──────────────────────────────────────────+ Examples :tabddef id=mine cols='7p 5p 14p' align='l c r' char='>'. ═══ 2.231. TABLE Table ═══ TABLE Table Purpose The TABLE tag and its matching end tag identify a table structure. This structure consists of cells, arranged in rows. A TABLE can range from very simple to very complex depending on the attributes used or not used. Simple tables are defined as those tables that are drawn with continuous horizontal and vertical lines across the extent of the table. The horizontal lines cannot be interrupted, but must continue from the left to the right boundary. Use an asterisk (*) for any column where an exact width is not required. The asterisk makes that column as wide as necessary to fit the table into the specified width (page or column). Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TABLE │ table │ ALIGN= │ No immediate │ :ETABLE │ │ │ │ ARRANGE= │ text. │ │ │ │ │ COLS= │ │ │ │ │ │ COLUMN │ │ │ │ │ │ COMPACT │ │ │ │ │ │ CONCAT= │ │ │ │ │ │ CROTATE= │ │ │ │ │ │ CWIDTHS= │ │ │ │ │ │ DWIDTH= │ │ │ │ │ │ EXPAND │ │ │ │ │ │ FRAME= │ │ │ │ │ │ HDFRAME= │ │ │ │ │ │ HEADHI= │ │ │ │ │ │ HP= │ │ │ │ │ │ ID= │ │ │ │ │ │ MINDEPTH= │ │ │ │ │ │ PAGE │ │ │ │ │ │ REFID= │ │ │ │ │ │ ROTATE= │ │ │ │ │ │ RULES= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ TALIGN= │ │ │ │ │ │ VALIGN= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of each of the │ │ LEFT │ columns in a table; The last value used │ │ INSIDE │ will apply to any remaining unspecified │ │ JUSTIFY │ cells or columns. │ │ OUTSIDE │ │ │ RIGHT │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ARRANGE='cell arrangement' │ Specifies the cell arrangement of a │ │ │ complex table row. Multiple ARRANGE │ │ │ attributes are allowed on a single TABLE │ │ │ tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='column specs' │ Specifies the widths of each of the │ │ │ columns or cells within a table. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that tables are to be for- │ │ │ matted with no extra space between rows. │ +──────────────────────────────+──────────────────────────────────────────+ │ CONCAT=YES │ Specifies whether the text within a │ │ NO │ table cell is to flow or be placed as │ │ │ entered; Yes to concatenate text, No to │ │ │ turn formatting off. Each cell in a row │ │ │ may have a concatenation value. The │ │ │ last value defined will be used on all │ │ │ remaining undefined cells. │ +──────────────────────────────+──────────────────────────────────────────+ │ CROTATE='cell rotations' │ Specifies the rotation for the cells in │ │ │ a table; 0 90 180 270. The last value │ │ │ will be used for all remaining cell in │ │ │ the row. │ +──────────────────────────────+──────────────────────────────────────────+ │ CWIDTHS='column specs' │ Specifies the width of individual │ │ │ columns, including gutters. │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ by BookManager. Specifies the display │ │ │ width of a table to be viewed on a │ │ │ screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directories, maps, or │ │ │ unruled tables are to be formatted with │ │ │ blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ table; BOX is the initial setting for │ │ NONE │ tables. │ +──────────────────────────────+──────────────────────────────────────────+ │ HDFRAME=RULE │ Specifies the frame to be used for a │ │ NONE │ table heading; RULE is the initial │ │ │ setting. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a table. │ │ . │ The initial setting is 2. │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ HP=0 │ Specifies the level of highlighting to │ │ 1 │ be used for text in cells. │ │ 2 │ │ │ . │ │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ MINDEPTH=vertical space │ Specifies the minimum depth of a table │ │ │ cell. This attribute is required when │ │ │ the cell is rotated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE │ Specifies that a table is to format │ │ │ within the page boundary. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ ROTATE=0 │ Specifies a table rotation. │ │ 90 │ │ │ 180 │ │ │ 270 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ RULES=BOTH │ For tables, specifies horizontal and │ │ HORIZ │ vertical internal rules. BOTH is the │ │ VERT │ initial setting. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPLIT=NO │ Indicates whether the table can be │ │ YES │ split. n specifies the number number of │ │ n │ rows at the beginning of the table to be │ │ │ kept together. │ +──────────────────────────────+──────────────────────────────────────────+ │ TALIGN=CENTER │ LEFT │ │ Specifies the placement of the table │ │ RIGHT │ within the current text line. │ +──────────────────────────────+──────────────────────────────────────────+ │ VALIGN=TOP │ Specifies the vertical alignment of the │ │ BOTTOM │ text in a table cell. Multiple values │ │ CENTER │ must be contained within single quotes. │ │ │ The last value specified will be used │ │ │ for any remaining cells in the row that │ │ │ had no VALIGN assigned; The initial │ │ │ setting is TOP. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=PAGE │ Specifies the width of a table. The │ │ COLUMN │ initial setting is COLUMN for tables. │ │ TEXTLINE │ │ │ horizontal space │ TEXTLINE will set the table at the │ │ │ current indent. │ │ │ │ │ │ If a horizontal space specification is │ │ │ given, the table will be set in the │ │ │ column if it fits; otherwise, it will be │ │ │ set to the width given. │ +──────────────────────────────+──────────────────────────────────────────+ ═══ 2.232. TABLE Table (continued) ═══ Examples :table cols='6p 2* 2i *' id=bigsamp width=page rules=horiz frame=rules. :tcap.A bigger sample table :tdesc.Here's a bit of table description that you might find useful. :etdesc. :thd. :c.Column head 1 :c.Column head 2 :c.Column head 3 :c.Column head 4 :ethd. :row. :c.Row 1, Cell 1 :c.Row 1, Cell 2 :c.Row 1, Cell 3 :c.Row 1, Cell 4 :row. :c.Row 2, Cell 1 :c.Row 2, Cell 2 :c.Row 2, Cell 3 :c.Row 2, Cell 4 :etable. ═══ 2.233. TCAP Table Caption ═══ TCAP Table Caption Purpose The TCAP identifies the caption of a table. You place the TCAP tag after the TABLE tag and before any THD, TFT, or TNOTE tag. The caption will appear at the top of the table, before any table heading. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCAP │ table caption │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :table cols='6p 2* 2i *' id=bigsamp width=page rules=horiz frame=rules. :tcap.Here is my table caption :tdesc.Here's a bit of table description that you might find useful. :etdesc. :thd. . . . ═══ 2.234. TCE0 Table of Contents Entry - Head 0 ═══ TCE0 Table of Contents Entry - Head 0 Purpose When you manually build your table of contents or partial table of contents, you use the TCE0 tag for head level 0 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE0 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE0 │ table of con- │ PAGE= │ Implied para- │ [:ETCE0] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce0 refid=zibbi. : :etoc. OR :tce0 page=132.Zibbidoos:etce0. ═══ 2.235. TCE1 Table of Contents Entry - Head 1 ═══ TCE1 Table of Contents Entry - Head 1 Purpose When you manually build your table of contents or partial table of contents, you use the TCE1 tag for head level 1 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE1 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE1 │ table of con- │ PAGE= │ Implied para- │ [:ETCE1] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce1 refid=zibbi. : :etoc. OR :tce1 page=132.Zibbidoos:etce1. ═══ 2.236. TCE2 Table of Contents Entry - Head 2 ═══ TCE2 Table of Contents Entry - Head 2 Purpose When you manually build your table of contents or partial table of contents, you use the TCE2 tag for head level 2 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE2 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE2 │ table of con- │ PAGE= │ Implied para- │ [:ETCE2] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce2 refid=zibbi. : :etoc. OR :tce2 page=132.Zibbidoos:etce2. ═══ 2.237. TCE3 Table of Contents Entry - Head 3 ═══ TCE3 Table of Contents Entry - Head 3 Purpose When you manually build your table of contents or partial table of contents, you use the TCE3 tag for head level 3 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE3 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE3 │ table of con- │ PAGE= │ Implied para- │ [:ETCE3] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce3 refid=zibbi. : :etoc. OR :tce3 page=132.Zibbidoos:etce3. ═══ 2.238. TCE4 Table of Contents Entry - Head 4 ═══ TCE4 Table of Contents Entry - Head 4 Purpose When you manually build your table of contents or partial table of contents, you use the TCE4 tag for head level 4 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE4 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE4 │ table of con- │ PAGE= │ Implied para- │ [:ETCE4] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce4 refid=zibbi. : :etoc. OR :tce4 page=132.Zibbidoos:etce4. ═══ 2.239. TCE5 Table of Contents Entry - Head 5 ═══ TCE5 Table of Contents Entry - Head 5 Purpose When you manually build your table of contents or partial table of contents, you use the TCE5 tag for head level 5 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE5 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE5 │ table of con- │ PAGE= │ Implied para- │ [:ETCE5] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce5 refid=zibbi. : :etoc. OR :tce5 page=132.Zibbidoos:etce5. ═══ 2.240. TCE6 Table of Contents Entry - Head 6 ═══ TCE6 Table of Contents Entry - Head 6 Purpose When you manually build your table of contents or partial table of contents, you use the TCE6 tag for head level 6 items. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE6 tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE6 │ table of con- │ PAGE= │ Implied para- │ [:ETCE6] │ │ │ tents entry │ REFID= │ graph. (Optional) │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce6 refid=zibbi. : :etoc. OR :tce6 page=132.Zibbidoos:etce6. ═══ 2.241. TCE7 - TCE20 Table of Contents Entry - Heads 7 Through 20 ═══ TCE7 - TCE20 Table of Contents Entry - Heads 7 Through 20 Purpose When you manually build your table of contents or partial table of contents, you use the TCE7 through TCE20 tags for head level items 7 through 20, respecitively. The tag can take two forms, depending on what you need (you can mix up both forms in the same table of contents). Where the heading exists with a normal heading tag and an ID attribute, all you have to do is use the corresponding REFID attribute on the TCE7 through TCE20 tags. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TCE7 │ table of con- │ PAGE= │ Implied para- │ [:ETCE7 │ │ through │ tents entry │ REFID= │ graph. (Optional) │ through │ │ TCE20 │ │ │ │ :ETCE20] │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE='page number' │ Specifies page number for manual table │ │ │ of contents, figure list, and table list │ │ │ entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :toc manual. : :tce9 refid=zibbi. : :etoc. OR :tce9 page=132.Zibbidoos:etce9. ═══ 2.242. TDEF Table Definition ═══ TDEF Table Definition Purpose Table definitions allow you to define the characteristics of a table with the TDEF tag, and then refer back to that TDEF with the REFID attribute of the TABLE tag. That way if you want the same structure for a lot of tables, you only have to define the structure once, on the TDEF tag. You can also use them to establish a structure not only for a table, but for any row in that table. Your table can refer to a TDEF, and also any row (including headers and footers) can refer to a different TDEF. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TDEF │ table defi- │ ALIGN= │ No immediate │ │ │ │ nition │ ARRANGE= │ text. │ │ │ │ │ COLUMN │ │ │ │ │ │ COLS= │ │ │ │ │ │ COMPACT │ │ │ │ │ │ CONCAT= │ │ │ │ │ │ CROTATE= │ │ │ │ │ │ CWIDTHS= │ │ │ │ │ │ DWIDTH= │ │ │ │ │ │ EXPAND │ │ │ │ │ │ FRAME= │ │ │ │ │ │ HDFRAME= │ │ │ │ │ │ HEADHI= │ │ │ │ │ │ HP= │ │ │ │ │ │ ID= │ │ │ │ │ │ MINDEPTH= │ │ │ │ │ │ PAGE │ │ │ │ │ │ REFID= │ │ │ │ │ │ ROTATE= │ │ │ │ │ │ RULES= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ SPLIT= │ │ │ │ │ │ TALIGN= │ │ │ │ │ │ VALIGN= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ALIGN=CENTER │ Specifies the alignment of each of the │ │ LEFT │ columns in a table; The last value used │ │ INSIDE │ will apply to any remaining unspecified │ │ JUSTIFY │ cells or columns. │ │ OUTSIDE │ │ │ RIGHT │ │ +──────────────────────────────+──────────────────────────────────────────+ │ ARRANGE='cell arrangement' │ Specifies the cell arrangement of a │ │ │ complex table row. Multiple ARRANGE │ │ │ attributes are allowed on a single TABLE │ │ │ or TDEF tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLUMN │ Specifies the table be formatted within │ │ │ the column. │ +──────────────────────────────+──────────────────────────────────────────+ │ COLS='column specs' │ Specifies the widths of each of the │ │ │ columns in a directory, or cells within │ │ │ a table. │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that tables are to be for- │ │ │ matted with no extra space between rows. │ +──────────────────────────────+──────────────────────────────────────────+ │ CONCAT=YES │ Specifies whether the text within a │ │ NO │ table cell is to flow or be placed as │ │ │ entered; Yes to concatenate text, No to │ │ │ turn formatting off. Each cell in a row │ │ │ may have a concatenation value. The │ │ │ last value defined will be used on all │ │ │ remaining undefined cells. │ +──────────────────────────────+──────────────────────────────────────────+ │ CROTATE='cell rotations' │ Specifies the rotation for the cells in │ │ │ a table; 0 90 180 270. The last value │ │ │ will be used for all remaining cell in │ │ │ the row. │ +──────────────────────────────+──────────────────────────────────────────+ │ CWIDTHS='column specs' │ Specifies the width of individual │ │ │ columns, including gutters. │ +──────────────────────────────+──────────────────────────────────────────+ │ DWIDTH='*' │ horizontal- │ Used only with documents to be processed │ │ space │ by BookManager. Specifies the display │ │ │ width of a table to be viewed on a │ │ │ screen. │ +──────────────────────────────+──────────────────────────────────────────+ │ EXPAND │ Specifies that directories, maps, or │ │ │ unruled tables are to be formatted with │ │ │ blank lines between entries. │ +──────────────────────────────+──────────────────────────────────────────+ │ FRAME=RULE │ Specifies the frame to be used for a │ │ BOX │ table; BOX is the initial setting for │ │ NONE │ tables. │ +──────────────────────────────+──────────────────────────────────────────+ │ HDFRAME=RULE │ Specifies the frame to be used for a │ │ NONE │ table heading; RULE is the initial │ │ │ setting. │ +──────────────────────────────+──────────────────────────────────────────+ │ HEADHI=2 │ Specifies the level of highlighting to │ │ 0 │ be used for the headings in a table. │ │ . │ The initial setting is 2. │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ HP=0 │ Specifies the level of highlighting to │ │ 1 │ be used for text in cells. │ │ 2 │ │ │ . │ │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ MINDEPTH=vertical space │ Specifies the minimum depth of a table │ │ │ cell. This attribute is required when │ │ │ the cell is rotated. │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE │ Specifies that a table is to format │ │ │ within the page boundary. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ ROTATE=0 │ Specifies a table rotation. │ │ 90 │ │ │ 180 │ │ │ 270 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ RULES=BOTH │ For tables and grids, specifies hori- │ │ HORIZ │ zontal and vertical internal rules. │ │ VERT │ BOTH is the initial setting. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SPLIT=NO │ Indicates whether the table can be │ │ YES │ split. n specifies the number number of │ │ n │ rows at the beginning of the table to be │ │ │ kept together. │ +──────────────────────────────+──────────────────────────────────────────+ │ TALIGN=CENTER │ LEFT │ │ Specifies the placement of the table │ │ RIGHT │ within the current text line. │ +──────────────────────────────+──────────────────────────────────────────+ │ VALIGN=TOP │ Specifies the vertical alignment of the │ │ BOTTOM │ text in a table cell. Multiple values │ │ CENTER │ must be contained within single quotes. │ │ │ The last value specified will be used │ │ │ for any remaining cells in the row that │ │ │ had no VALIGN assigned; The initial │ │ │ setting is TOP. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=PAGE │ Specifies the width of a table. The │ │ COLUMN │ initial setting is COLUMN for tables. │ │ TEXTLINE │ │ │ horizontal space │ TEXTLINE will set the table at the │ │ │ current indent. │ │ │ │ │ │ If a horizontal space specification is │ │ │ given, the table will be set in the │ │ │ column if it fits; otherwise, it will be │ │ │ set the width given. │ ═══ 2.243. TDEF Table Definition (continued) ═══ +──────────────────────────────+──────────────────────────────────────────+ Examples :tdef id=mnrow cols='* 2* 2* 2*' width=column rules=both frame=box. :tdef id=hdrow cols='*' width=column rules=both frame=box. :tdef id=oddrow cols='* 4*' width=column rules=both frame=box. :table refid=mnrow. :thd refid=hdrow temp. :c.Improvement plans by department (all figures approximate) :ethd. :row. :c.Sales . . . :row refid=oddrow temp. :c.Internal Affairs . . . :etable. ═══ 2.244. TDESC Table Description ═══ TDESC Table Description Purpose TDESC identifies text that is to be the description for the table. You put the TDESC tag after the TCAP and before any THD, TFT, TNOTE, or ROW tag. The table description will be printed on the same line as the table caption, and on as many subsequent lines as are needed. You must end your table description with the matching TDESC end tag. TDESC and its matching end tag must both start in column 1. A table description can be quite long - it can consist of multiple lines of marked up text. Any document elements are okay in a table description, except figures, grids, footnotes, and other tables. When you use a table description, BookMaster automatically puts a period after the table caption. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TDESC │ table │ │ Bracketed text. │ :ETDESC │ │ │ description │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :table... :tcap.A caption :tdesc.And a much longer description, :hp2.with some highlighting:ehp2., and some assorted other words. :etdesc. :row. :c.Cell 1. : :etable. ═══ 2.245. TFT Table Footer ═══ TFT Table Footer Purpose The TFT tag identifies a row to be used as a table footer. The table footer is placed at the bottom of each part of the table. The TFT tag must precede any C or ROW tags, and follow any TCAP and TDESC tags. If there is a caption, then TFT must follow THD (if used); otherwise, TFT may follow or precede THD. TFT requires a matching end tag, which must be on a line by itself, and start in column 1. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TFT │ table footer │ REFID= │ Bracketed text. │ :ETFT │ │ │ │ TEMP │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ TEMP │ Establishes the definition of the row, │ │ │ header, or footer as temporary. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :table id=rest refid=selrst. :tcap.Selected Restaurants in the County :thd refid=resthd temp. :c.Restausrant . . . :ethd. :tft refid=cuisin temp. :c.:hp3.Happy Dining!:ehp3. :etft. :row refid=cuisin temp split=yes. :c.Continental . . . ═══ 2.246. THD Table Header ═══ THD Table Header Purpose The THD tag identifies a row to be used as a table header. The THD tag must precede all ROW and C tags and follow any TCAP and TDESC tags. When a table spills over to the next column or page, BookMaster automatically regenerates the heading at the top of the table. THD requires a matching end tag, which must be on a line by itself, and start in column 1. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :THD │ table header │ REFID= │ Bracketed text. │ :ETHD │ │ │ │ TEMP │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ TEMP │ Establishes the definition of the row, │ │ │ header, or footer as temporary. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :table id=rest refid=selrst. :tcap.Selected Restaurants in the County :thd refid=resthd temp. :c.Restausrant :c.Comments :c.$ :ethd. :tft refid=cuisin temp. :c.:hp3.Happy Dining!:ehp3. :etft. :row refid=cuisin temp split=yes. :c.Continental . . . ═══ 2.247. TIPAGE Title Page Placement ═══ TIPAGE Title Page Placement Purpose The TIPAGE tag specifies where the title page is to be printed. It should be the first tag in the front matter. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TIPAGE │ title page │ │ Self-contained. │ │ │ │ placement │ │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :prolog. :title. :author. :docnum. . . . :eprolog. :frontm. :tipage. :preface. ═══ 2.248. TITLE Title of Document ═══ TITLE Title of Document Purpose The TITLE tag identifies the title of a document. It is valid only within the prolog structure. Additional title lines are entered with the TLINE tag. TITLE requires a matching end tag if TLINE tags are used. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TITLE │ title of doc- │ STITLE= │ Text on same line │ [:ETITLE] │ │ │ ument │ │ or next line; no │ │ │ │ │ │ other tags. │ │ │ │ │ │ (Optional │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in some styles. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :userdoc. :prolog. :TITLE stitle='Short Title'. :tline.First Line of Full Title :tline.Second Line of Full Title :tline.Third Line of Full Title :etitle. . . . :eprolog. . . . :euserdoc. ═══ 2.249. TITLEP Title Page ═══ TITLEP Title Page Purpose The TITLEP tag identifies where the title page and its content is to be printed for GDOC (DCF Starter-Set GML) documents. It should be the first element in the front matter. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TITLEP │ Title Page │ │ No immediate │ │ │ │ │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :gdoc. :frontm. :TITLEP. :title. . . . :author. . . . :etitlep. . . . :body. . . . :egdoc. ═══ 2.250. TLE Table List Entry ═══ TLE Table List Entry Purpose The TLE (table list entry) tag is used in a manually generated TLIST (table list) for each entry you want in the TLIST. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TLE │ table list │ PAGE= │ Implied para- │ [:ETLIST] │ │ │ entry │ REFID= │ graph. (Optional) │ │ │ │ │ TNUM= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ TNUM='table number' │ Specifies the table number in a hand- │ │ │ built table list entry. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :table id=zibs. :tcap.Looking at zibbidoos . . . :tlist manual. . . . :tle refid=zibs. . . . :etlist. or :tle page=135 tnum=16. Looking at zibbidoos :etle. ═══ 2.251. TLINE Title Line ═══ TLINE Title Line Purpose The TLINE tag identifies each line of a title. It must appear within a title element, and can be repeated as often as necessary. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TLINE │ title line │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :userdoc. :prolog. :title stitle='Short Title'. :TLINE.First Line of Full Title :TLINE.Second Line of Full Title :TLINE.Third Line of Full Title :etitle. . . . :eprolog. . . . :euserdoc. ═══ 2.252. TLIST Table List ═══ TLIST Table List Purpose The TLIST tag identifies the place in the front matter where the list of illustrations is to be placed. If the TLIST tag is not entered, a list of tables is not created. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TLIST │ table list │ ID= │ Text on same line │ [:ETLIST] │ │ │ │ INITPG= │ or next line; no │ │ │ │ │ MANUAL │ other tags. │ │ │ │ │ NUM= │ (Optional │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :frontm. :tipage. :preface. . . . :toc. :figlist. :tlist. ═══ 2.253. TNOTE Table Note ═══ TNOTE Table Note Purpose The TNOTE tag identifies a cell to be used for table notes. TNOTE must follow any TCAP or TDESC tag. TNOTE works much like the NT (note) tag. TNOTE puts your notes in a new row that contains a single cell as wide as the table. You must provide the notes, using any format you choose. Use the TNOTE matching end tag to end the table notes. Then you must use a ROW tag to start another row in the table. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TNOTE │ table note │ TEXT= │ Bracketed text. │ :ETNOTE │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TEXT='text' │ Specifies text to override the text │ │ │ normally generated for notes or language │ │ │ element description items. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :table id=oddrst refid=selrst concat='y y n n'. . . . :c 4. $ $ :tnote text='Price notes'. :dl compact. :dt.$ :dd.Inexpensive; $5-10 per perosn :dt.$ $ :dd.Moderate; $10-20 per person . . . :edl. :etnote. :etable. ═══ 2.254. TOC Table of Contents ═══ TOC Table of Contents Purpose The TOC tag identifies the place in the document where a table of contents is to be created. The table of contents is normally placed in the front matter of a document, between the abstract or preface and the list of illustrations. If the TOC tag is not entered, a table of contents will not be created. User-Generated Table of Contents: To create a manual TOC, include the MANUAL attribute with the TOC tag. The manual entries should be tagged with the Table of Contents Entry tags TCE0, TCE1, TCE2, TCE3 or TCE4. Formatting appearance, using these tags, is similar to the automatically generated table of contents. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TOC │ table of con- │ ID= │ Text on same line │ [:ETOC] │ │ │ tents │ INITPG= │ or next line; no │ │ │ │ │ MANUAL │ other tags. │ │ │ │ │ NUM= │ (Optional │ │ │ │ │ PNKEY= │ │ │ │ │ │ STITLE= │ │ │ │ │ │ SUBJART= │ │ │ │ │ │ SUBJECT= │ │ │ │ │ │ TOPICID= │ │ │ │ │ │ TOPICSEL= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ INITPG=page number │ Specifies the page number to start the │ │ │ section with. │ +──────────────────────────────+──────────────────────────────────────────+ │ NUM=number │ Controls the numbering of level 0 and │ │ letter │ level 1 headings. │ │ NONE │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PNKEY= │ Specifies a page number key. │ +──────────────────────────────+──────────────────────────────────────────+ │ STITLE='short title' │ Specifies a short title to be used in │ │ │ the running foot in place of the full │ │ │ title, part heading, or chapter heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJART='PSEG name' │ Specifies name (PSEG name) of a piece of │ │ │ artwork that is to be used as a running │ │ │ heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ SUBJECT='topic description' │ Specifies the topic heading to be used │ │ │ as a running heading. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICID='topic' │ Specifies text used in place of automat- │ │ │ ically generated text for a topic in │ │ │ BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ │ TOPICSEL=YES │ NO │ Specifies whether a heading will be used │ │ │ as a topic for BookManager. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :preface. :toc id=tocex. :figlist. :body. ═══ 2.255. TOPIC Topic (Cover) ═══ TOPIC Topic (Cover) Purpose The TOPIC tag is an expansion of the document title tag used in formal documents. It is used in conjunction with the LIBRARY and TOPIC tags which need no special order. In styles that use BookMaster's supported styles, the "document topic," if coded, can contain up to four lines of text. The text must be entered on separate lines, after the TOPIC tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TOPIC │ topic (cover) │ SNAME= │ No other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ SNAME='short-name' │ Specifies a short name to use for the │ │ │ topic of the document. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :title. :library. Book of Wisdom :topic. Customer Setup, Repair and Takedown :etitle. ═══ 2.256. TP Test Point ═══ TP Test Point Purpose The TP tag identifies a test point that is used to key scoping references to locations in an accompanying graphic diagram. TP requires a matching end tag. Scope test points can occur anywhere in text. They are printed as a round black background with a white letter on a photocomposer or similar device. Otherwise a bold letter is enclosed in bold parentheses. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TP │ test point │ │ Single alphabetic │ :ETP │ │ │ │ │ character. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples To check this wave form, attach scope to :TP.D:ETP.. ═══ 2.257. TREF Table Reference ═══ TREF Table Reference Purpose The TREF tag identifies a place in a document where a reference to a table is made. TREF can be used to refer to figures or tables that have a unique ID attribute value and a caption. References to uniquely identified tables can occur anywhere in text. If the table reference precedes the table, the TWOPASS option must be used for the reference to be resolved properly. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :TREF │ table refer- │ FORM= │ Self-contained. │ │ │ │ ence │ PAGE= │ │ │ │ │ │ REFID= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ FORM=NORMAL │ Specifies the form of a cross reference. │ │ FULL │ │ │ TEXTONLY │ │ │ PAGEONLY │ │ │ NUMONLY │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PAGE=YES │ Governs inclusion of page numbers in │ │ NO │ cross references. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of something being │ │ │ referred to in a cross-reference. To be │ │ │ resolved properly, name must appear in │ │ │ an ID attribute on a corresponding tag. │ +──────────────────────────────+──────────────────────────────────────────+ Examples See :tref refid=bigsamp. for more inforamtion. ═══ 2.258. UL Unordered List ═══ UL Unordered List Purpose The UL tag identifies an unordered list of items. UL requires a matching end tag. Unordered lists can occur anywhere in text and can be nested within other lists. Each item in a list is identified by the LI tag; subsets of a list are identified by the LP tag. List items are implied paragraphs, and can contain any of the basic text items. Unordered lists are formatted as "hanging" indented lists, with the item identifier at the left margin. Unordered lists are identified by a special character, such as a bullet, that does not imply sequence. The character for level-1 is a round bullet, for level-2 an en-dash, and for level-3 an em-dash. After that, the sequence repeats. Unordered lists can be nested three times before they repeat, and then you can go on forever--or until you reach the right hand edge of the page. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :UL │ unordered │ COMPACT │ No immediate │ :EUL │ │ │ list │ DINGBAT= │ text. │ │ │ │ │ DBSCALE= │ │ │ │ │ │ DBHI= │ │ │ │ │ │ PREFIX= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COMPACT │ Specifies that lists are to be formatted │ │ │ with no blank lines between list items. │ +──────────────────────────────+──────────────────────────────────────────+ │ DINGBAT=dingbat │ Specifies the dingbat to be used for an │ │ │ unordered list. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBSCALE='scaling factor' │ Specifies the scaling factor for │ │ │ dingbats on a list. │ +──────────────────────────────+──────────────────────────────────────────+ │ DBHI=0 │ Specifies the highlight type for │ │ . │ dingbats on a list. │ │ . │ │ │ . │ │ │ 9 │ │ +──────────────────────────────+──────────────────────────────────────────+ │ PREFIX=CHECKOFF │ Specifies that this is a checkoff list. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :UL COMPACT DBHI=3 DBSCALE='1.5'. :li.Bullet (COMPACT DBHI=3 DBSCALE='1.5') :li.Bullet :li.Bullet :UL COMPACT. :li.Dash :li.Dash :li.Dash :UL COMPACT. :li.Long Dash :li.Long Dash :li.Long Dash :UL COMPACT PREFIX=CHECKOFF. :li.Starts over with bullets (and PREFIX=CHECKOFF added) :li.Bullet with checkoff line :li.Bullet with checkoff line :UL COMPACT DINGBAT='*'. :li.Dash changed to asterisk (DINGBAT='*') :li.Dash changed to asterisk :li.Dash changed to asterisk :UL COMPACT. :li.Long Dash . . . :EUL. :EUL. :EUL. :EUL. :EUL. :EUL. ═══ 2.259. URESP User Response ═══ URESP User Response Purpose The URESP tag identifies the user actions that should be taken for the code or message received. URESP can be used only within a code list or message list. The subheading, "User Response," is printed to the left of the text. If the URESP attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "User Response." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :URESP │ user response │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. . . . :oresp.Inform drivers already at the booth of the problem and call a tow truck. :uresp.Write a letter to the editor about drunk drivers. :numbytes.3580 (cars stalled on the bridge) :code.OC414-W . . . :presp.Take an alternate route. :uresp.Write an article for the newspaper about the bridge. :numbytes.36 (number of broken supports) . . . ═══ 2.260. USER User (In Dialog) ═══ USER User (In Dialog) Purpose The USER tag identifies one of the participants in a dialog, usually a person. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :USER │ user (in │ │ Implied para- │ │ │ │ dialog) │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :dialog user=You sys=Me. :user.Your question :sys.My answer :edialog. ═══ 2.261. USERDOC User Document ═══ USERDOC User Document Purpose The USERDOC tag identifies the beginning of an BookMaster user document. USERDOC requires a matching end tag. The USERDOC tag is the first tag in a user document. The security classification is printed in small type at the bottom of the title page and at the top of every other page. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :USERDOC │ user document │ COPYR= │ No immediate │ :EUSERDOC │ │ │ │ IBMCOPYR= │ text. │ │ │ │ │ LANGUAGE= │ │ │ │ │ │ SEC= │ │ │ │ │ │ STYLE= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ COPYR='year(s)' │ Specifies the year(s) for the copyright │ │ │ notice. │ +──────────────────────────────+──────────────────────────────────────────+ │ IBMCOPYR='year(s)' │ Specifies the year(s) for the IBM copy- │ │ │ right notice. │ +──────────────────────────────+──────────────────────────────────────────+ │ LANGUAGE=BDUTCH │ │ Specifies the language in which all │ │ BFRENCH │ │ BookMaster-generated words are printed. │ │ BPORTUGUESE │ │ │ │ CENGLISH │ │ │ │ CFRENCH │ │ │ │ DANISH │ │ │ │ DUTCH │ │ │ │ ENGLISH │ │ │ │ FINNISH │ │ │ │ FRENCH │ │ │ │ GERMAN │ │ │ │ ITALIAN │ │ │ │ NORWEGIAN │ │ │ │ PORTUGUESE │ │ │ │ SFRENCH │ │ │ │ SGERMAN │ │ │ │ SITALIAN│ │ │ │ SPANISH │ │ │ │ SWEDISH │ │ │ │ UKENGLISH │ │ +──────────────────────────────+──────────────────────────────────────────+ │ SEC='security class' │ Specifies a security classification that │ │ │ will be used as a running heading │ │ │ throughout the document. │ +──────────────────────────────+──────────────────────────────────────────+ │ STYLE=name │ Specifies the named style for a docu- │ │ │ ment. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :userdoc sec='XYZ Corp. Internal Use Only' style=ibmxagd ibmcopyr='1979, 1980 1982, 1984, 1987'. ═══ 2.262. VAR Syntax Diagram Variable ═══ VAR Syntax Diagram Variable Purpose The VAR tag describes a variable, a label, or other such varying information. This tag is a TOSL and the variable name is required. Format :VAR REQ|OPT|DEF LID='id ...'. variable-name Parameters REQ|OPT|DEF specifies the selectability of the variable, where: REQ indicates the variable is required. OPT indicates the variable is optional. DEF indicates the variable is a default. LID='id ...' Identifies the links, described on a LDESC, that are to be associated with the residual text. Multiple LID values can be specified. Examples Sample variables: :syntax. :var.required :var opt.optional :var def.default :esyntax. Formats like: ---default--- | | >>---required--------------------------------->< | | ---optional--- ═══ 2.263. VENDOR Vendor Name (Cover) ═══ VENDOR Vendor Name (Cover) Purpose The VENDOR tag identifies the company that produced the product that now displays the IBM logo. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :VENDOR │ vendor name │ │ Text on same line │ │ │ │ (cover) │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :VENDOR.ABC Inc. ═══ 2.264. VOLNUM Volume Number ═══ VOLNUM Volume Number Purpose You can use the VOLNUM tag to specify the volume number or other volume information for your document. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :VOLNUM │ volume number │ │ Text on same line │ │ │ │ │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :prolog. &vellip. :volnum.II :docprof volpref='-' :eprolog. ═══ 2.265. VNHD Edition Notice Head ═══ VNHD Edition Notice Head Purpose The VNHD tag identifies the heading for the version notice. The heading usually contains the version number and the date the version was released. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :VNHD │ edition │ │ Text on same line │ │ │ │ notice head │ │ or next line; no │ │ │ │ │ │ other tags. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :vnotice. :VNHD.Second Edition (January 1986) :p.This edition applies to Release. . . . . . :evnotice. ═══ 2.266. VNOTICE Edition Notice ═══ VNOTICE Edition Notice Purpose The VNOTICE tag identifies the version notice that normally appears on the bottom of the back of the title page. This notice identifies the version or edition of the manual. VNOTICE requires a matching end tag. The version notice end tag generates normal standing notices and a copyright statement. VNOTICE follows immediately after TIPAGE unless there is included a SYNOPSIS, SNOTICE, or NOTICES tag, in which case it follows after that. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :VNOTICE │ edition │ │ No immediate │ :EVNOTICE │ │ │ notice │ │ text. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :TIPAGE. :vnotice. :vnhd.Second Edition (January 1986) :p.This edition applies to Release. . . . . . :coprext.Velvetware, Inc. 1984, 1985 :evnotice. ═══ 2.267. WARNING Warning ═══ WARNING Warning Purpose The WARNING tag identifies one or more paragraphs containing a statement about a condition that could cause damage to data. WARNING requires a matching end tag. A WARNING tag can occur anywhere in your text. It must be preceded by a paragraph (P), list item (LI), or list part (LP) tag. A warning statement may have additional paragraphs that can be entered with the paragraph tag; therefore, the WARNING tag must be explicitly ended with its matching end tag. The complete warning statement is printed in bold type. It aligns with the text of a list item when used within a list. Warning Tag in Lists: Whenever a warning statement appears within a list, it should appear BEFORE the text of the associated list item so that the reader will not miss it. This ensures that the reader will read the warning statement before carrying out the action that might cause injury. The WARNING tag should be entered immediately after the list item tag. The warning message can then follow. When the warning statement applies to several list items, the WARNING tag should immediately follow the LIST PART tag. This format catches the eye of the reader, but does not disrupt the order sequence of the list items. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :WARNING │ warning │ TRANS= │ Any text; any- │ :EWARNING │ │ │ │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ TRANS=number │ Specifies the number of lines to be left │ │ │ for translation space. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :p.:warning trans=5. A warning statement warns of anything that could cause data loss. It aligns with the text of a list item when used within a list. :p.An additional paragraph for the warning statement. :ewarning. :p.A following paragraph. ═══ 2.268. WARRANTY IBMLPS Warranty ═══ WARRANTY IBMLPS Warranty Purpose The WARRANTY tag is the last tag in the body of the document and is specified right before the IBMLPS end tag. It identifies the warranty statement to be generated. Format :warranty subject=full|nodslo|asis. Parameters subject=full|nodslo|asis specifies the warranty statement to be generated. full Generates the following text: This program is warranted as specified in the Agreement for IBM Licensed Programs. Licensed Program Specifications may be updated from time to time and such updates may constitute a change in specifications. For Distributed Systems License Option (DSLO) Licenses, warranty service, if any, will be provided only through the Basic License location. Following the discontinuance of all program services, this program will be provided "As Is" as specified in the Agreement for IBM Licensed Programs. nodslo Generates the following text: This program is warranted as specified in the Agreement for IBM Licensed Programs. Licensed Program Specifications may be updated from time to time and such updates may constitute a change in specifications. Following the discontinuance of all program services, this program will be provided "As Is" as specified in the Agreement for IBM Licensed Programs. asis Generates the following text: This program is provided "As Is" as specified in the Agreement for IBM Licensed Programs. Examples . . . :h1.Warranty :warranty subject=full. :eibmlps. ═══ 2.269. XMP Example ═══ XMP Example Purpose The XMP tag identifies an example of computer input or output. XMP requires a matching end tag. Examples can occur anywhere in text, except within footnotes or other examples. The body of an example is composed of all the text between the XMP tag and the XMP end tag. It can contain basic document elements (except figures, tables, other examples, or footnotes), lines of text, character graphics, control words, and macros. The normal formatting of text is suspended within an example; that is, the lines are not concatenated. Examples can only be used within a single column width. If an example is wider than a single column, it must be entered within a figure (FIG) or with the .layout 1 macro. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :XMP │ example │ ID= │ Bracketed text. │ :EXMP │ │ │ │ KEEP= │ │ │ │ │ │ REFID= │ │ │ │ │ │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ KEEP=vertical space │ Specifies the amount of space that must │ │ ALL │ be kept together in an example before it │ │ :lm margin=1. │ can be broken. ALL is the initial │ │ │ setting for the XMP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ REFID=name │ Specifies the name of a definition for │ │ │ the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :xmp. 100 CLS 110 FOR A=1 TO 5 120 FOR B=440 to 1000 STEP 5 :exmp. ═══ 2.270. XMPDEF Example Definition ═══ XMPDEF Example Definition Purpose Example definitions allow you to define the characteristics of an example with the XMPDEF tag, and then refer back to that XMPDEF with the REFID attribute of the Example tag. That way if you want the same structure for a lot of examples, you only have to define the structure once, on the XMPDEF tag. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :XMPDEF │ example defi- │ ID= │ No immediate │ │ │ │ nition │ KEEP= │ text. │ │ │ │ │ SCALE= │ │ │ │ │ │ WIDTH= │ │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Parameters +──────────────────────────────+──────────────────────────────────────────+ │ Attribute │ Meaning │ +──────────────────────────────+──────────────────────────────────────────+ │ ID=name │ Specifies the name to be associated with │ │ │ this document element. The name can be │ │ │ up to 7 characters long -- letters and │ │ │ numbers; first character should be a │ │ │ letter; use lowercase letters. │ +──────────────────────────────+──────────────────────────────────────────+ │ KEEP=vertical space │ Specifies the amount of space that must │ │ ALL │ be kept together in an example before it │ │ :lm margin=1. │ can be broken. ALL is the initial │ │ │ setting for the XMP tag. │ +──────────────────────────────+──────────────────────────────────────────+ │ SCALE='scaling factor' │ Specifies a scaling factor to be applied │ │ AUTO │ to the content of the element. │ +──────────────────────────────+──────────────────────────────────────────+ │ WIDTH=characters │ Specifies the width of the text in char- │ │ │ acters. When used with SCALE=AUTO, the │ │ │ text is automatically scaled down if it │ │ │ is too wide for the column. Text is not │ │ │ automatically scaled up. │ +──────────────────────────────+──────────────────────────────────────────+ Examples :xmpdef id=l123456 scale='.9'. :xmp refid=l123456. 100 CLS 110 FOR A=1 TO 5 120 FOR B=440 to 1000 STEP 5 :exmp. ═══ 2.271. XPH Example Phrase ═══ XPH Example Phrase Purpose The XPH tag identifies a word or phrase within a sentence that is an example of computer input or output. XPH requires a matching end tag. It can be used anywhere in a line, just like a highlighted phrase. Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :XPH │ example │ │ Any text; any- │ :EXPH │ │ │ phrase │ │ where on line. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples When the 3279 display screen shows :XPH.MORE... :EXPH. in the bottom corner, the user should press the CLEAR key. ═══ 2.272. XPL Explanation ═══ XPL Explanation Purpose The XPL tag identifies the explanation of a code, message, or map. It can only be used within a code list, message list, or map. The subheading, "Explanation," is printed to the left of the text. If the XPL attribute is included on the CODEL or MSGL tag, the specified subheading is printed in place of "Explanation." Format +───────────+───────────────+────────────+───────────────────+────────────+ │ Tag │ Element │ Attributes │ Content │ Ending │ +───────────+───────────────+────────────+───────────────────+────────────+ │ :XPL │ explanation │ │ Implied para- │ │ │ │ │ │ graph. │ │ +───────────+───────────────+────────────+───────────────────+────────────+ Examples :codel uresp='Writer Response' oresp='Toll Booth Operator Response'. :code.OC413-I :xpl.Informational message. . . . :severity.3 :code.OC414-W :xpl.Warning message. :severity.To be determined. ═══ 3. Utility Macros ═══ This section describes the BookMaster utility macros and DCF control words you can use in BookMaster. The codes and macros are listed in alphabetic order and the descriptions include the following: o The purpose of the macro o The format and attributes of the macro o Examples of using the macro To view the list of macros, return to the Contents and click on the plus sign (+) or press the + key. ═══ 3.1. BOOKMARK Adding items to the cross-reference listing ═══ BOOKMARK Adding items to the cross-reference listing Purpose The BOOKMARK macro allows you to write notes to yourself, or to others who may be working on the document, that will be printed out as part of the cross-reference listing at the end of the document. Format .BOOKMARK book mark text Examples .bookmark This is what a bookmark looks like. . . . .bookmark Remember to change this item for release 3.1 . . . .bookmark Color photo of new terminal to be inserted. ═══ 3.2. CCPTOC Column Control for Partial Table of Contents ═══ CCPTOC Column Control for Partial Table of Contents Purpose The CCPTOC macros allows you to control the automatic column or page breaks in a partial table of contents. Sometimes the breaks separate headings you would like to keep together. You place the CCPTOC macro on the line preceding the first heading you want in the group, then code the appropriate .CC or .CP control word. Format .CCPTOC .CC | .CP vertical-space Parameters CC or CP The conditional column or conditional page control word. vertical space The number of lines or a vertical space measurement for the CC or CP control word. Examples Ensure the headings are kept together: :appendix. :h0.Appendicies :ptoc levels=12. .ccptoc .cc 3i :h1.Caring for your weed-feeder ═══ 3.3. CCTOC Column Control for Table of Contents ═══ CCTOC Column Control for Table of Contents Purpose The CCTOC macros allows you to control the automatic column or page breaks in a table of contents. Sometimes the breaks separate headings you would like to keep together. You place the CCTOC macro on the line preceding the first heading you want in the group, then code the appropriate .CC or .CP control word. Format .CCTOC .CC | .CP vertical-space Parameters CC or CP The conditional column or conditional page control word. vertical space The number of lines or a vertical space measurement for the CC or CP control word. Examples Ensure the appendix headings are kept together: .cctoc .cc 3i :appendix. :h1.Caring for your weed-feeder ═══ 3.4. GETW Calculating the width of a string ═══ GETW Calculating the width of a string Purpose The GETW macro is used to get SCRIPT/VS to calculate the width of a text string and return it as the value of a symbol you name. You can then use your symbol to specify the width you want. (This width is calculated by SCRIPT/VS in horizontal device units, but you never actually have to see this number.) Format GETW macro .GETW SYMBOL=symbol-name GMLTYPE='.gmltype'. TEXT='.character-string'. SCALE='.scale-factor'. Parameters SYMBOL=symbol-name where symbol-name is the name of the symbol you want set with the value (just the name, not the preceding that you will use when you actually use the symbol in a TSIZE or COLS attribute). It can be up to 10 characters long, with no blanks or special characters (not even #, @, or $); the first character must be a letter. GMLTYPE='GML-type' where 'GML-type' is the GML type of the string, so that SCRIPT/VS knows what font to expect it in. The GML types that the GETW macro recognizes are: PK DIALOG HP0 HP5 PV DIRECT HP1 HP6 APL TABLE HP2 HP7 RK XMP HP3 HP8 TP FN HP4 HP9 FIG PARTSASM CGRAPHIC SUP SCREEN SUB You can combine two GML types on a single GMLTYPE= attribute. For example, gmltype='fn hp2' identifies highlight level 2 within a footnote. If GMLTYPE= is omitted or if it is not one of the types the GETW macro recognizes, then GETW uses whatever font we happen to be in to determine the width of the string. TEXT='character-string' where character-string is the character string that you want to know the width of, enclosed in single quotes. It can't have any tags in it. It is required. SCALE='scale-factor' where scale-factor is the scale you want applied to the character string in calculating its width. It is optional. The default for SCALE depends on the GMLTYPE specified and on any global definitions (xxxDEFs) that are set in the document prolog. For example, suppose you have a prolog that has a TDEF in it: :prolog. :tdef scale='.8'. :eprolog. Then, if you use GETW to set a symbol for use in tables, like this: .getw symbol=x gmltype='table' text='Reception Interval' the scale factor will default to '..8'., because TDEF has defined that as the default scale for all tables. Examples Suppose you want to set a TSIZE the width of a string plus a couple of spaces to keep the definition term from slopping over into the definition description area. Because the definition term is highlighted, we want to tell the GETW macro that this string will be a highlighted phrase of type 2. Our markup would look like this: .getw symbol=aga gmltype=hp2 text='A gapanthus' :dl tsize=&aga. :dt.Agapanthus :dd.Lovely.... With GETW, we defined the symbol named "aga" to be the width of "Agapanthus", plus three spaces that we inserted. (If you use spaces like we have, insert them within the text string; spaces that precede or follow the text string will be discarded by SCRIPT/VS.) Next, we used the symbol "&aga." in the TSIZE attribute of our DL tag. (Be sure to include the ampersand before the symbol name, and the period after it.) ═══ 3.5. GETWMAX Finding the Widest of Several Symbols ═══ GETWMAX Finding the Widest of Several Symbols Purpose GETWMAX compares the widths of values from the GETW macro, or the GETWSUM macro, or widths specified in horizontal space units and places the widest in symbol-name. Format .GETWMAX SYMBOL=symbol-name W=width W=width ... Parameters SYMBOL=symbol-name represents the widest of the widths derived from comparing the other symbols or specified widths. The symbol-name does not include the preceding & or the trailing period. W=width ... identifies the symbol for a width already calculated by the GETW macro, or the GETWSUM macro, or specified in horizontal space units. The width value must include the preceding & and the trailing period. You can have as many W=width values as you can fit on a single line. Examples .getw symbol=ulbl gmltype=pk text='LABEL=' .getw symbol=llbl gmltype=pv text='label=' .getwmax symbol=wider w=&ulbl. w=&llbl. :table cols='&wider. 12 30' .... . . . ═══ 3.6. GETWSUM Summing the Widths of Several Symbols ═══ GETWSUM Summing the Widths of Several Symbols Purpose GETWSUM accumulates the widths of values from the GETW macro, adds them up, and places the sum in symbol-name. Format GETWSUM macro .GETWSUM SYMBOL=symbol-name W=width ... Parameters SYMBOL=symbol-name where symbol-name (without the preceding & or the trailing period) represents the sum of the widths accumulated from other symbols. W=width ... where width is the symbol for a width already calculated by the GETW macro. The width value must include the preceding & and the trailing period. You can have as many W=width values as you can fit on a single line. Examples So, to construct our total width for the programming keyword and programming variable, we get the individual widths with GETW, then add them with GETWSUM: .getw symbol=lbl gmltype=pk text='LABEL=' .getw symbol=var gmltype=pv text='artwork-label' .getwsum symbol=total w=&lbl. w=&var. :table cols='&total. 12 30' .... . . . First we set the symbol "&lbl."in the PK font to the width of "LABEL=". Then we set the symbol "&var." in the PV font to the width of "artwork-label". Then we added them together with GETWSUM. Once you've used GETW to set a symbol and used the symbol however you want to use it, you can use the same symbol name again later for something else. GETW simply resets it. This means you don't have to keep thinking up new symbol names all the time; reuse the old ones. ═══ 3.7. IM Imbed -- Creating documents from multiple files ═══ IM Imbed -- Creating documents from multiple files Purpose The IM macro includes and processes other files as if they were part of your first file. Format .IM filename where filename is the name of the file to include. Usage 1. In CMS, the file type must be SCRIPT. If you must us a different file type, or have a TSO file to imbed, use the NAMEFILE macro to specify the full file name before the imbed. Examples :frontm. :tipage. .im preface :toc. :body. .im intro .im learning ═══ 3.8. INWIDTH Indenting the width of a string ═══ INWIDTH Indenting the width of a string Purpose The INWIDTH macro indents text the width of a particular string of text. Format INWIDTH macro .INWIDTH ON|OFF gmltype '.character string'. Parameters ON Turns indentation on. OFF Turns indentation off. gmltype Identifies the GML type of the string, so that SCRIPT/VS knows what font to expect it in. The GML types that the INWIDTH macro recognizes are PK HP0 HP5 PV HP1 HP6 APL HP2 HP7 HP3 HP8 HP4 HP9 If gmltype is omitted or if it is not one of the types the INWIDTH macro recognizes, then INWIDTH uses whatever font we happen to be in to determine the width of the string. character string Specifies the character string that you want to indent the width of, enclosed in single quotes. It can't have any tags in it. This operand is required and must be the last. Examples It is often necessary, say in illustrating programming syntax, to indent text the width of a particular string of text. For example, suppose you had to do something that looked like this: :DIRECT LAYOUT=layout-specification COLS='.w1 w2...[w20]'. ALIGN='.a1 a2...[a20]'. ALIGNHD='.a1 a2...[a20]'. COMPACT EXPAND Here's how you'd get the indentation: :lines. :pk. &gml.DIRECT LAYOUT=:pv.layout-specification:epv. .inwidth on '&gml.DIRECT ' COLS=&pssq.:pv.w1:epv. :pv.w2:epv.... We don't need the second operand on the INWIDTH macro here because we are already in the range of a PK tag. (But it wouldn't hurt.) Usage There are two ways to turn the indention off, depending on where you are: 1. If you are at the end of a figure (FIG tag) or lines (LINES tag), you don't have to do anything to turn it off; it will go away by itself. 2. If you need to just undo the current INWIDTH indention but preserve any other indention that might be going on, you use the OFF operand of INWIDTH with the identical string you used to turn it on, like so: .inwidth off '&gml.DIRECT ' If the width of the string you want to indent involves multiple fonts, you can use multiple INWIDTH macros (which are added to each other), to get the indent to the right point. Each of these INWIDTH macros specifies the GML type that is used for printing the string. For example, suppose you need to get the width of a string that involves both PK and PV tags. It might look something like this: ZORKnnnn = YES NO MAYBE To do this, our markup looked like this: :lines keep=all. :pk.ZORK:pv.nnnn:epv. = YES .inwidth on pk 'ZORK = ' .inwidth on pv 'nnnn' NO MAYBE:epk. :elines. The first INWIDTH macro gets the width of the part of the text that is the programming keyword. Then we use an INWIDTH macro that gets the width of the part of the text that is the programming variable. These are automatically added together to give us the total width of our indention. ═══ 3.9. LAYOUT Varying the page layout ═══ LAYOUT Varying the page layout Purpose The LAYOUT macro allows you to vary the layout of your document. For example, if the default layout of your document is offset, and you need to set chapters containing message and code lists in 2-column, use the LAYOUT macro to change this. Format .LAYOUT layout BALANCE|NOBALANCE NOSPACE|SPACE Parameters layout Specifies the layout to use. offset 5 1 6 2 7 3 8 4 BALANCE|NOBALANCE determines whether the text in the columns of the new layout will be balanced or unbalanced. With BALANCE, BookMaster distributes the text across the layout columns as evenly as possible. With NOBALANCE, each column is filled with text before any text is put in the next column. BALANCE is the default. NOSPACE|SPACE determines whether the text in the new layout will be separated from the preceding text by a paragraph space. NOSPACE is the default. Examples To switch into double column, you enter the LAYOUT macro like so, just before the H1 tag for the chapter: .layout 2 The "2" specifies double column. To return to the layout set for the document as a whole, enter the LAYOUT macro without a value, like so: .layout ═══ 3.10. NAMECTR Named Counters -- Creating and using your own counters ═══ NAMECTR Named Counters -- Creating and using your own counters Purpose The NAMECTR (named counter) macro gives you an easy way to create, increment, and use your own counters in your document. The counters can be arabic numerals (the default), letters (in either upper or lower case), or roman numerals (in either upper or lower case). The NAMECTR macro has five functions: compact. DEFINE creates a named counter; it doesn't print anything. INCREMENT increments the named counter by 1; it doesn't print anything. PRINT prints the current value of the named counter and then increments it by 1. We will show you later that there is another way to print the named counter; the PRINT function is a time-saver when all you want to do is print the counter in a place where a macro can be used and then increment it. RESET resets the value of the named counter. CAPTURE captures the value of the named counter. Format NAMECTR DEFINE macro .NAMECTR DEFINE SYMBOL=name GMLTYPE=type SIZE=size INITVAL=value CTRTYPE=N|n|A|a|R|r NAMECTR INCREMENT and NAMECTR PRINT macros .NAMECTR INCREMENT SYMBOL=name .NAMECTR PRINT SYMBOL=name NAMECTR RESET macro .NAMECTR RESET SYMBOL=name INITVAL=value NAMECTR CAPTURE macro .NAMECTR CAPTURE SYMBOL=name CAPSYM=name Parameters DEFINE is required and specifies that a named counter is to be created. It can be shortened to as little as a single character. SYMBOL=name is required (you can't have a "named counter" without a name) and identifies the name of the counter you want to create. It can be up to 7 characters long, with no blanks or special characters (not even #, @, or $); CTRTYPE=N|n|A|a|R|r is optional and identifies the type of the counter, as follows: N or n arabic numerals (the default) - 1, 2, 3, ... A uppercase letters - A, B, C, ... a lowercase letters - a, b, c, ... Note: Alphabetic counters have a maximum value of &A'65535 (65535). Personally, we think if yours is greater than 26 you're in trouble. R uppercase roman numerals - I, II, III, ... r lowercase roman numerals - i, ii, iii, ... GMLTYPE=type is optional and identifies the GML type of the counter: PK HP0 HP5 PV HP1 HP6 APL HP2 HP7 XMP HP3 HP8 RK HP4 HP9 TP If no GML type is specified, then a type is not associated with this symbol. SIZE=size is optional and identifies the size of the type that the string is to be printed in. If the SIZE operand is omitted, the counter takes on the size characteristic of the context in which the counter is used. You specify the SIZE operand with a specific point size value. INITVAL=value is optional and specifies the initial value for the counter. The default is 1 (although printed as 1, A, a, I, or i, depending on the counter type). INCREMENT or PRINT specifies the action to be taken for the named counter. It can be shortened to as little as a single character. INCREMENT increments the named counter by 1; it doesn't print anything. PRINT prints the current value of the named counter and then increments it by 1. RESET is required and resets the named counter. It can be shortened to as little as a single character. If no initial value is specified on the RESET, the counter is reset to 1. CAPTURE is required and captures the current value of the named counter. It can be shortened to as little as a single character. CAPSYM=name is required and identifies the symbol name that is to be set to the current value of the counter. It can be up to 10 characters long, with no blanks or special characters; the first character must be a letter. Examples .namectr define symbol=ordnum defines a named counter "ordnum" that is an ordinary number. .namectr def symbol=bigal ctrtype=A size=12 defines a named counter "bigal" that is uppercase alphabetic, set in 12-point type. .namectr def symbol=hr ctrtype=R gmltype=hp2 initval=1977 . . . :dl tsize=9m. :dt. .namectr print symbol=hr :dd.ISIL is born. . . . :dt. .namectr print symbol=hr :dd.A colicky baby, . . . Usage 1. The first step in using a named counter is to define it, using the NAMECTR DEFINE function. 2. When to use NAMECTR INCREMENT and the symbol You can use the symbol at any time and in almost any context - it will print the current value in the size and GML type specified. Use NAMECTR INCREMENT when you don't want to print it before you increment it, or when you need to increment it so you can print it in some context where a macro call is not allowed (or is perhaps simply inconvenient). ═══ 3.11. NAMEFILE Defining a file name ═══ NAMEFILE Defining a file name Purpose The NAMEFILE macro lets you assign a name to a CMS file or TSO data set. You can then use that name to imbed the file in a CMS environment or a TSO environment. Format .NAMEFILE NAME=fileid CMS='filename filetype' TSOPART='partial-name' | TSOFULL='full-name' Parameters NAME=fileid specifies the name you assign to the file. CMS='filename filetype' identifies the CMS filename and filetype. TSOPART='partial-name' identifies the TSO partially qualified data set. TSOFULL='full-name' identifies the TSO fully qualified data set. Examples For example, the markup: .namefile name=oldtest cms='test level1' tsopart='test.level1' .im oldtest specifies that either the CMS file "TEST LEVEL1" or the TSO file "userid.TEST.LEVEL1.TEXT" is imbedded when the filename OLDTEST is used, depending on the environment. All attributes and values of the NAMEFILE macro must be entered on a single input line. Usage 1. In CMS, use NAMEFILE when the file you're imbedding has a filetype other than SCRIPT. For example, to imbed a file named EDFUDVC CARPITCH, use: .namefile name=dvc cms='edfudvc carpitch' .im dvc 2. In TSO, use NAMEFILE to identify files when: o The file is a sequential data set. o The file is a member of a partitioned data set (PDS) that is not part of the primary input file. 3. When using NAMEFILE to name a TSO data set, specify the data set as either partially qualified (TSOPART) or fully qualified (TSOFULL) - never both. ═══ 3.12. NAMEIT Making your own symbols ═══ NAMEIT Making your own symbols Purpose You can set up symbols for your own use, to keep from having to rekey a lengthy phrase all the time. It is also useful if the name of the thing you're writing about is likely to change. If you define a symbol with the name and then use the symbol in the text, you will only have to change the symbol definition when the name is changed. Format NAMEITmacro .NAMEIT SYMBOL=name GMLTYPE=type SIZE=size|AUTO TEXT='.string'. Parameters SYMBOL=name identifies the name of the symbol (just the name, without the preceding & or the trailing period) you want to create. It can be up to 10 characters long (A-Z, 0-9), with no blanks or special characters; the first character must be a letter. Do not use symbol names that are defined by BookMaster GMLTYPE=type identifies the GML type of the string, so that SCRIPT/VS knows what font to associate with it. The GML types that NAMEIT recognizes are: PK HP0 HP5 PV HP1 HP6 APL HP2 HP7 XMP HP3 HP8 RK HP4 HP9 TP If no GML type is specified, then a type is not associated with this symbol. (This is different from the use of the GML type operand in the other BookMaster macros where the GML type is "inherited" from the current context.) SIZE=size|AUTO identifies the size of the type that the string is to be printed in. (This operand is ignored for those output devices that do not support multiple sizes of type.) If the SIZE operand is omitted, then the size of XMP, APL, RK, TP, HP0-HP9, PK, and PV take on the size characteristic of the context in which the symbol defined by the NAMEIT macro is used. However if you use APL on any APA device, the size is restricted to 10 point because the APL2 font lacks a full range of point sizes. You can specify the SIZE operand with a relative size or a specific point size value, for example, .nameit symbol=bigld gmltype=xmp size=12 text='RUN' asks for 12-point example characters. When you use the SIZE operand with a point size value, you should make sure that that specific point size is available in the font used for that GML type. If you ask for SIZE=AUTO, the size used will be determined from the size of the type in use in the context in which the symbol defined by the NAMEIT macro occurs. Size can also be expressed as a negative or positive integer (e.g. '.+2'.) to allow for a larger or smaller point size without knowing the current point size. BookMaster will then find the closest size. TEXT='.string'. identifies the content of the value to be assigned to the symbol and is what will be printed, in the form and size dictated by the GMLTYPE and SIZE operands, whenever the symbol is used. The text string can also contain any symbols (except required blanks-&rbl.). It is required (why else would we be doing this?). Examples .nameit symbol=prodname text='Document Composition Facility' and then everywhere you used &prodname. in your document, like so :p.SCRIPT/VS is the formatter component of the &prodname.. you would get SCRIPT/VS is the formatter component of the Document Composition Facility.. Here's an example of how NAMEIT could be used to put example characters in a heading : .nameit symbol=r gmltype=xmp text='RUN' . . . :h4.The &r. Command You would get this result: The RUN Command Usage 1. You may be tempted to create a NAMEIT symbol for each character in the example character set and then create your headings, index entries, etc., by using a long string of NAMEIT symbols. Don't do this. Each NAMEIT symbol has a "control block" associated with it that takes up space in the SCRIPT/VS record. A lot of NAMEIT symbols will quickly exhaust the 256-character limit on SCRIPT/VS records. 2. When using a GMLTYPE of APL, enter the text from an APL keyboard with APL set on and the appropriate editor setup. 3. If GMLTYPE or SIZE is used, in order to avoid raising error conditions with extended cross-reference processing, the NAMEIT macros for any symbols that are to be used in headings, table captions, or figure captions should be placed in the document prolog. 4. Similarly, if symbols created with NAMEIT are used in index entries that will be collected into a master index, then the base file for the master index should contain at least one NAMEIT macro that calls for the same GML type and size as is used in the index entries. ═══ 3.13. PGCHECK Page Check -- Page number verification ═══ PGCHECK Page Check -- Page number verification Purpose The PGCHECK macro checks to see if page numbers differ between the first and the second pass, or among additional formatting passes. This will alert you to the possibility that your cross references, table of contents, and figure, table, and assembly list are wrong. If they are, then using the extended cross-reference facility will probably solve the problem. Format .pgcheck Usage PGCHECK is called automatically by the H1 tag, but you might want to use it yourself in situations where the H1 tags are infrequent and you need to check things yourself. Each time PGCHECK is used, it compares the page number where it is encountered with the page number where it was encountered on the previous pass (except on the first pass, when it just saves the page number). If the page numbers are different, it issues a warning message. The message it gives you when it finds a problem looks like this: +++ EDF238E Page check: stuff on page 103 on pass 1 is on page 104 on pass 2. This will be followed by the normal trace information that tells you the line number and source file it was processing when it stumbled across the PGCHECK macro. Once a PGCHECK gives you a warning message, you will probably get lots of them, as all of the ones following will most likely also be off. Normally, a single problem will start out giving you a one-page difference but that same problem can later be the cause of a two-page difference. This can happen if you have something later in the document (say, an H0) that forces a righthand page. An H0 can also cause your page numbering to come back into line. Similarly, another problem in the opposite direction can cause it to come back into line. ═══ 3.14. SETUP Setup -- Using set-up files ═══ SETUP Setup -- Using set-up files Purpose The purpose of a setup file is to establish an environment for running a document or a portion of one. The SETUP macro executes once (and only once) on each pass through the document. So when you run the whole book, the SETUP macro in the base file imbeds the setup file; the rest of the SETUP macros are ignored (even if, for some reason, they specify different setup files). When you run an individual file, the SETUP macro at the beginning of the file imbeds the setup file. Format .SETUP filename-of-setup-file Usage You would normally put in your setup file 1. The USERDOC tag (needed especially if the document has a security classification). 2. The entire document PROLOG, because it supplies a lot of information about the formatting of the document; for example, the running foot from the TITLE tag (in BookMaster's initial setting style), the document number from the DOCNUM tag, and the tag that defines the ID for revisions from REV, REVSLUG, and so on. The prolog also contains the document profile (DOCPROF) tag, if you are using it, and the definition tags, if you are using them. 3. Symbol definitions for symbols you use throughout the book. You use the SETUP macro in two places: 1. In your base file, in the position where you would normally put the USERDOC tag and the PROLOG (just before the FRONTM tag). 2. At the beginning of each source file that you might want to run independently. For example, in this book each chapter is in a separate source file, and the SETUP macro is used at the beginning of each of those source files. +────────────────────────────────────────────────────────────────────────────────+ │ Using Setup Files │ +──────────────────────────+──────────────────────────+──────────────────────────+ │ The setup file (called, │ The base file for the │ Each imbed file in the │ │ for example, EDF1STUP): │ document: │ document: │ +──────────────────────────+──────────────────────────+──────────────────────────+ │ :userdoc sec= . . . │ .setup edf1stup │ .setup edf1stup │ │ :prolog. │ :frontm. │ :h1.General lists │ │ . │ :tipage. │ . │ │ . │ . │ . │ │ . │ . │ . │ │ :eprolog. │ . │ │ │ │ .im edf1glst │ -----------------------│-------------------------------------------------------- │ │ .im edf1slst │ │ │ │ . │ .setup edf1stup │ │ │ . │ :h1.Special lists │ │ │ . │ . │ │ │ │ . │ │ │ │ . │ +──────────────────────────+──────────────────────────+──────────────────────────+ ═══ 3.15. TABRACK Setting a device-independent tab rack ═══ TABRACK Setting a device-independent tab rack Purpose The TABRACK macro establishes a tab rack based on the widths of character strings that you supply as operands. Because it calculates the widths at formatting time, it is device-independent - the tab rack will be valid for all devices. Format TABRACK macro .TABRACK gmltype '.string'. '.string'. ... Parameters gmltype This operand is optional. It identifies the GML type of the strings, so that the calculation is based on the true widths of the strings. The GML types that the TABRACK macro recognizes are PK HP0 HP5 PV HP1 HP6 APL HP2 HP7 HP3 HP8 HP4 HP9 If the first operand is not one of these types, TABRACK uses whatever font we happen to be in to determine the widths of the strings. Note that only one GML type operand can be specified on the TABRACK macro. If your tabular material involves mixed fonts, use HP0; if necessary with mixed fonts, the tab rack can be "adjusted" by padding some of the strings with extra blanks. Strange as it may seem, on some devices the font used for HP2 is actually narrower than the font used for HP0, so if the strings are mixed HP0 and HP2, use HP0 as the GML type. '.string'. One or more character strings, enclosed in single quotes and separated by one or more blanks. Each string should contain the longest element that will occur in the column. It is not necessary to supply a string for the last column, as its tab position is established by the widths of the preceding strings. If the first operand is omitted, then the first string cannot be one of the values allowed for the first operand. If necessary, however, you can get around this restriction by scrambling the order of the letters, as "1HP" is the same width as "HP1", and width is all we care about. Examples Suppose you had to do something like this: 1. The schedule for the meetings is as follows: Location Hotel Date Phoenix, Arizona Adams Hilton May 22-25, 1983 New York, New York Hilton Aug 21-26, 1983 Salt Lake City, Utah Hotel Utah Nov 13-16, 1983 Anaheim, California Disneyland Mar 4-9, 1984 Miami, Florida Hilton Aug 12-17, 1984 Los Angeles, California Biltmore Feb 24-Mar 1, 1985 2. ... Your markup would look like this: :ol. :li.The schedule for the meetings is as follows: :lines. .tabrack 'Los Angeles, California' 'Adams Hilton' :hp1. Location&tab.Hotel&tab.Date :ehp1. Phoenix, Arizona&tab.Adams Hilton&tab.May 22-25, 1983 New York, New York&tab.Hilton&tab.Aug 21-26, 1983 Salt Lake City, Utah&tab.Hotel Utah&tab.Nov 13-16, 1983 Anaheim, California&tab.Disneyland&tab.Mar 4-9, 1984 Miami, Florida&tab.Hilton&tab.Aug 12-17, 1984 Los Angeles, California&tab.Biltmore&tab.Feb 24-Mar 1, 1985 :elines. :li.... :eol. "&tab." is the BookMaster symbol for a tab. Usage TABRACK will automatically create a 2-character gutter between the tabbed items; if you want a wider gutter, you can add blanks or zeros to the strings you specify. Be aware that on an APA printer blanks may be quite narrow, and would not be equivalent to zeros. The TABRACK macro also takes into account any indention that might be going on when it establishes the tabs. This means that you must use the TABRACK macro after any indention you want is already established (that is, just before the actual tabbed material). It is not always necessary to figure out which precise string is the "widest". For example, if you have a column that always contains, say, the prefix IJK, followed by five arbitrary capital letters, followed by three numeric characters, you can just specify the pattern, like so: 'IJKMMMMM000' The capital M, being the widest single character in any font, will provide room for any possible string; all numeric characters are the same width, so using zeros is sufficient for any numeric characters. Similarly, if you think you've found the widest string, but want a margin for error (and if you're not already squeezing the line), throwing an extra capital M or two into the string will give you some extra space to play with. ═══ 3.16. TABREAK Breaking tables into pieces ═══ TABREAK Breaking tables into pieces Purpose When BookMaster is processing a large table, you might get a message saying something like "machine storage exhausted" and a severe return code. This can happen when you have large tables that continue for several pages. To help fix this problem, you can use the TABREAK macro. Just add the macro before the row that causes the problem. The TABREAK macro can also be used to split a table at a certain point. For example, you have a few rows you want to format together in a long table. You can use the SPLIT attribute on the ROW tag, or you can use the TABREAK macro before the row you want split. Format .tabreak Examples . . . .tabreak :row. :c.Here's a row that causes my computer to hick-up. . . . ═══ 3.17. Script Control Words allowed in BookMaster Documents ═══ Script Control Words allowed in BookMaster Documents Purpose There are six SCRIPT/VS control words that can be used in BookMaster documents. Control words are specified with a period in the leftmost position in the input line. Code Usage .* Comment This control word can be used freely throughout your source documents to make them more readable and to document for future reference what is going on; for instance, an imbed control might be preceded by a comment that describes the content of the file being imbedded. For example, .*------------------------------------------------ .* This file contains the glossary .im edf1glos .*------------------------------------------------ Do not use a comment within the scope of the TITLE or the ADDRESS tags. .BR Break This control word causes a break in the output line -- for example, :p.These four lines are flowed together but .br this one is not. yields These four lines are flowed together but this one is not. The .BR control word is also used following an XMP, CGRAPHIC, SCREEN, or DIALOG tag where the first line contains a symbol (other than the normal character graphic symbols). This ensures that the symbol prints in the correct font. .CC, .CP Conditional Column Eject, Conditional Page Eject These control words are used to "fine-tune" a document's column and page endings. While BookMaster tries to make everything come out right, there are some cases it cannot handle -- for example, if a heading is followed by some largish object such as a figure, it can happen that the heading will be left by itself on the page before the figure. These control words, which are typically used with a space value, can be used to repair those bad breaks. Note that a .CC works the same as a .CP in a single column or offset style; usually the .CC is sufficient for most tasks and the .CP need not be used. These control words can only be used in "open text" and MUST NOT BE USED where BookMaster is managing the column and page breaks directly; that is, in figures, grids, tables, examples (without the KEEP attribute), screens, etc. .DU Dictionary Update This control word can be used to add words to the dictionary used for hyphenation that would not otherwise be hyphenated, or allows you to specify hyphenation points other than those in the dictionary. For example: .du add hy-phen-ation This allows "hyphenation" to be hyphenated at: xxxx xxxxx xxxxxx xxxx xxxxx xxxx xxxxxxx xxx hy- phenation xxxx xxxxxxxxx xxxx Or: xxxxxx xxx xxxxxxx xxxxxxx xxxx xxxxxxx xxx hyphen- ation xxxx xxxxxxxxx xxxx .HW Hyphenate Word This control word specifies the hyphenation to be used for a single occurrence of a word, should that word be subject to hyphenation. ═══ 4. Document Version Control Facility ═══ This section describes the BookMaster Document Version Control Facility macros you can use in BookMaster. The macros are listed in alphabetic order and the descriptions include the following: o The purpose of the macro o The format and attributes of the macro o Examples of using the macro To view the list of macros, return to the Contents and click on the plus sign (+) or press the + key. ═══ 4.1. CONFIG Document Version Control Facility Configuration section ═══ CONFIG Document Version Control Facility Configuration section Purpose For vanilla DVCF, the CONFIG macro delimits the beginning and end of a section in the document that is subject to modification (configuring). The WHEN macro indicates whether text should be inserted or deleted, and under which conditions. For mocha DVCF, the CONFIG macro again delimits text, but also points to a section in a side file with an insert, delete, or remove operation. The USING macro indicates whether text should be inserted, deleted, or replaced, and under which conditions. Format .CONFIG label ON|OFF Parameters label is a user-supplied name that identifies this configuration section. It can be up to 8 alphabetic and numeric characters; the first character must be alphabetic. The label is required, and the labels on the CONFIG ON (delimiting the beginning of the section) and the CONFIG OFF (delimiting the end) must match. The CONFIG ON and its matching CONFIG OFF must be in the same file. It is not required that the labels be unique (the labels are more significant in mocha than they are in vanilla), but you will find that the files are easier to maintain if they are unique. However, nested structures do require unique label names. The label is much more significant in mocha than in vanilla, because it is used to locate the modification text in the side file. ON delimits the start of a configuration section. OFF delimits the end of a configuration section. Examples See the WHEN and USING macros for examples. ═══ 4.2. MOD DVCF Mocha modification section ═══ MOD DVCF Mocha modification section Purpose The MOD macro is used in a DVCF mocha side file to indicate whether text is to be inserted, deleted, or replaced. For insert and replacement text, the MOD macro also indicates the beginning and ending of a block of text. Format .MOD label INSERT|DELETE|REPLACE|OFF Parameters label identifies this modification text. The label must be the same as the one on the CONFIG macro in the base file. This is how the modification text is located. INSERT specifies the beginning of the modification text and that this text is to be inserted when the condition on the USING macro is true. DELETE specifies that the text in the base file is to be deleted when the condition on the USING macro is true. There is no modification text for a delete; the next line in the side file should be a MOD macro with the OFF parameter. REPLACE specifies the beginning of the modification text and that the modification text is to replace the text in the base file when the condition on the USING macro is true. OFF delimits the end of the modification text. Examples .modset .mod label insert This text is to be inserted in addition to text in the base file. .mod label off .mod label2 delete .mod label2 off .mod label3 replace This text replaces the text in the base file. .mod label3 off .modtrap ═══ 4.3. MODSET DVCF Mocha modification setup macro ═══ MODSET DVCF Mocha modification setup macro Purpose The MODSET macro occurs once at the top of each side file. It enables the searching of the MOD macros in a side file, without having the text in the side file format until the MOD is found. Format .MODSET Examples .modset .mod label insert This text is to be inserted in addition to text in the base file. .mod label off .mod label2 delete .mod label2 off .mod label3 replace This text replaces the text in the base file. .mod label3 off .modtrap ═══ 4.4. MODTRAP DVCF Mocha side-file safety net ═══ MODTRAP DVCF Mocha side-file safety net Purpose The MODTRAP macro should be placed once at the bottom of each side file. Format .MODTRAP Usage The MODTRAP macro is a "safety net" - BookMaster suspends formatting before it goes looking for a MOD in the side file. If the MOD is not found in the side file, the MODTRAP macro at the bottom "traps" the condition, turns formatting back on (with a warning message), and resumes processing of the base file. MODTRAP is optional, but if you leave it out and then go looking in the file for a MOD that does not exist, your document is effectively ended, which can be most upsetting if that is not what you had intended. Examples .modset .mod label insert This text is to be inserted in addition to text in the base file. .mod label off .mod label2 delete .mod label2 off .mod label3 replace This text replaces the text in the base file. .mod label3 off .modtrap ═══ 4.5. SETDVCF Set DVCF Conditions On or Off ═══ SETDVCF Set DVCF Conditions On or Off Purpose The SETDVCF generates a symbol and allows you to set DVCF conditions on or off either in a separate file to be passed by SYSVAR 0, or in the file being processed. Format .SETDVCF svmbol-name ON | OFF Parameters symbol-name identifies the condition to be set. It is a name you supply and can be up to ten alphabetic and numeric characters; the first character must be alphabetic. ON sets the condition to true. OFF sets the condition to false. Examples .setdvcf sport on .setdvcf wagon off ═══ 4.6. USING DVCF Mocha condition ═══ USING DVCF Mocha conditions Purpose The USING macro specifies the condition for a mocha DVCF structure. Format .USING file-name 'conditional-expression' Parameters file-name is the name of the side file that contains the modification text. 'conditional-expression' Specifies the condition(s) under which the text is to be inserted, deleted, or replaced. When the condition is true, DVCF goes out to the side file and finds the modification text, as identified by the label in the CONFIG macro preceding this USING macro. 999 times out of a thousand, your condition will be simple - one condition that is either true or false. A simple condition is expressed as just the condition name. A condition name is set using the SETDVCF macro. For example, if your condition name were "dvcf" you would make it true by setting it like this: .setdvcf dvcf on The USING macro, then, looks like this: .using prf10 'dvcf' The single quotes around the condition are required. Mocha INSERT A mocha INSERT looks like this: Base File . . . .config index on .using prf10 'edfprf10' .config index off . . . Side File - PRF10 .modset .mod index insert :p.EDFPRF10 provides indexing support for back-of-the-book indexes. .mod index off . . . .modtrap Mocha DELETE A mocha DELETE looks like this: Base File . . . .config parml on .using prf10 'edfprf10' restrictions: . . . .config parml off . . . Side File - PRF10 .modset . . . .mod parml delete .mod parml off . . . .modtrap Mocha DELETEs aren't very efficient; consider using vanilla deletes when you can. Mocha REPLACE A mocha REPLACE looks like this: Base File . . . :p.IDs can be up to .config idlength on .using prf10 'edfprf10' 5 characters .config idlength off in length. . . . Side File - PRF10 .modset . . . .mod idlength replace 7 characters .mod idlength off . . . .modtrap Usage Sometimes it is necessary to specify fancier conditions, so DVCF allows complex conditions. Suppose we have two conditions, A and B. To have an action (insert, delete, or, for mocha, replace) occur o when (and only when) both conditions are true, enter 'a b' o when either one or both of the conditions is true, enter 'a or b' o when a condition is not true, enter 'not a' These three functions, AND (implicit - you never enter the word "and"), OR, and NOT, can be strung out to the point where only a computer could figure out what to do. Just don't forget to begin and end the string with single quotes. (Needless to say, you can't have a condition named OR or NOT.) DVCF also supports a condition of `TRUE' for those cases (such as extracting command statement formats for both a user's guide and a reference manual) where you want the action taken unconditionally. ═══ 4.7. WHEN DVCF Vanilla condition ═══ WHEN DVCF Vanilla condition Purpose The WHEN macro specifies the condition for a vanilla DVCF structure. Format .WHEN '.conditional-expression'. INSERT|DELETE Parameters '.conditional-expression'. Specifies the condition(s) under which the text is to be inserted or deleted. When the condition is true, the action following the condition is taken. 999 times out of a thousand, your condition will be simple - one condition that is either true or false. A simple condition is expressed as just the condition name. You set the condition using the SETDVCF macro. For example, if your condition name were "dvcf" you would make it true by setting it like this: .setdvcf dvcf on The WHEN macro, then, looks like this: .when 'dvcf' insert The single quotes around the condition are required. INSERT When the condition is true, the text following the WHEN up to the next WHEN, or up to the matching CONFIG label OFF, is printed. Otherwise, it is deleted. DELETE When the condition is true, the text following the WHEN up to the next WHEN, or up to the matching CONFIG label OFF, is deleted. Otherwise, it is printed. Vanilla INSERT A vanilla INSERT looks like this: . . . .config index on .when 'edfprf10' insert :p.EDFPRF10 provides indexing support for back-of-the-book indexes. .config index off . . . When `edfprf10' is true, we can advertise the new indexing feature. Vanilla DELETE A vanilla DELETE looks like this: . . . .config parml on .when 'edfprf10' delete restrictions: . . . .config parml off When `edfprf10' is true, we can get rid of the odious restrictions on parameter lists. Vanilla REPLACE A vanilla REPLACE looks like this (we don't actually have a "REPLACE", but all a REPLACE is is a DELETE and an INSERT): . . . :p.IDs can be up to .config idlength on .when 'edfprf10' delete 5 characters .when 'edfprf10' insert 7 characters .config idlength off in length. . . . When `edfprf10' is true, we will delete the 5 character limit on IDs and insert the 7 character limit on IDs. Usage Sometimes it is necessary to specify fancier conditions, so DVCF allows complex conditions. Suppose we have two conditions, A and B. To have an action (insert, delete, or, for mocha, replace) occur o when (and only when) both conditions are true, enter 'a b' o when either one or both of the conditions is true, enter 'a or b' o when a condition is not true, enter 'not a' These three functions, AND (implicit - you never enter the word "and"), OR, and NOT, can be strung out to the point where only a computer could figure out what to do. Just don't forget to begin and end the string with single quotes. (Needless to say, you can't have a condition named OR or NOT.) DVCF also supports a condition of `TRUE' for those cases (such as extracting command statement formats for both a user's guide and a reference manual) where you want the action taken unconditionally. ═══ 4.8. INCLUDE DVCF Mocha Include ═══ INCLUDE DVCF Mocha Include Purpose The INCLUDE macro is a shortened version of the USING "true" condition: It tells DVCF to find the modification text in a side file. In effect, the INCLUDE macro works by processing the following configuration in one step: .CONFIG label ON .USING filename 'TRUE' .CONFIG label OFF The INCLUDE macro looks like this: Format INCLUDE macro .INCLUDE label filename Parameters label identifies the configuration section. It is used to locate the modification text in the side file, just as it is used on the CONFIG macro. filename identifies the filename of the side file, just as filename does on the USING macro. Examples To see how the INCLUDE macro works, let's look at two files: EDFINC SCRIPT and MSGS SCRIPT. EDFINC SCRIPT is our base file. MSGS SCRIPT is our side file. EDFINC SCRIPT :p.If you receive the following messages: :msgl. :msgno.EDF055W :msg.Named style :mv.style-name:emv. uses itself via :mv.stylelist:emv.. :xpl.A named style cannot refer to itself. :uresp. Rename your style file and change all uses of it in your source files. .include seeadm msgs :msgno.EDF089E :msg.Font :mv.'font-name':emv.required. :xpl.The :mv.font-name:emv. font must be installed to use BookMaster. :uresp. .include seesys msgs :emsgl. MSGS SCRIPT .*User Responses .modset .mod seesys insert Report the error to your system administrator. .mod seesys off .mod seeadm insert Refer to :cit.Creating Named Styles:ecit. for more information. .mod seeadm off .modtrap When the EDFINC SCRIPT file is processed, the INCLUDE macro tells DVCF to find the modification text in MSGS SCRIPT. The following output is then produced: ---------- Formatted Example If you receive the following messages: EDF055W Named style style-name uses itself via stylelist Explanation: A named style cannot refer to itself. User Response: Rename your style file and change all uses of it in your source files. Refer to Creating Named Styles for more information. EDF089E Font 'font-name' required. Explanation: The font-name font must be installed to use BookMaster. User Response: Report the error to your system administrator. ---------- End of Formatted Example ═══ 5. Using Bookie, Messages, Symbols, Etc. ═══ This section describes BookMaster topics; such as error messages, common problems and solutions, symbols, and system variables. To view the list of topics, return to the Contents and click on the plus sign (+) or press the + key. ═══ 5.1. General rules for markup entry ═══ General rules for markup entry Purpose The general rules for markup entry are: 1. Document elements are identified with GML tags. The tags begin with the GML delimiter, which in BookMaster is the colon (:). End tags use the GML end tag delimiter, which in BookMaster is the two characters ":e" (colon followed by an E). 2. For some elements, additional characteristics can be specified with attributes, either single words (such as COMPACT on the list tags) or labels with an equal sign and a value. When using labeled attributes, values that include blanks, special characters, or symbols must be enclosed in single quotes. For example: :userdoc sec='ABC Company Confidential'. If the value itself includes a single quote, then you enter the symbol for the character you need (&odq., &ssq., &cdq., &osq., &csq., &apos.) so that SCRIPT/VS does not think the first one ends the value, like this: :title stitle='Mrs. O&apos.Leary&apos.s Cow'. The actual value that will then be used by SCRIPT/VS is Mrs. O'Leary's Cow 3. End the markup with a period. 4. Start all input lines at the left margin. 5. When you end a sentence, do not enter any more text on that line. 6. Do not start text lines with a period. SCRIPT/VS will assume that the line is either a control word or a macro, and will give you an error message if it is not (and will not print the line). Use the &period. symbol to get a period in the first position of a line. 7. Maximum input line length is 256 character positions, after all symbols are substituted with their values. 8. Begin a new input line for all tags except inline quotes, title references, cross-references, and highlighted phrases. 9. Do not mark an element with a tag that does not correctly describe it, even if it apparently results in the correct processing. Through the magic of GML, your document administrator or text programmer may someday change the way that particular tag formats, and you may find your document all messed up. 10. Enter tags and attribute labels in lower case. 11. Do not enter blank lines. If you need a blank line in a figure, screen, character graphic, or an example, just put an &rbl. symbol on the line you want to have blank. ═══ 5.2. BookMaster Messages ═══ BookMaster Messages Purpose This is an alphabetic listing of the BookMaster messages by message number. Use the Script options MESSAGE(ID DELAY TRACE) to get a listing of message numners and descriptions stored in a file. ═══ 5.2.1. EDF000E ═══ Unassigned error message number (n). Explanation: Indicates an incorrect call to the message macro. This should never occur. User Response: Report the error to your system administrator. ═══ 5.2.2. EDF001W ═══ tag-name tag found out of context. Explanation: The tag-name tag was used in a place where it doesn't make sense. For example, COPRNOTE and COPREXT tags can only be used between a VNOTICE tag and its end tag. User Response: Check &users. for proper usage of the tag-name tag. ═══ 5.2.3. EDF002W ═══ tag-name1 tag found outside tag-name2. Explanation: The tag-name1 tag, which must be used within a tag-name2 tag, was found outside the tag-name2 tag. For example, a ROW tag must be used within a TABLE. User Response: The tag-name1 or tag-name2 tag may have been mistyped or misplaced. A start tag needs to be placed before the tag-name1 tag, or a tag-name2 end tag needs to be placed before the tag-name1. Check your source file and correct as necessary. ═══ 5.2.4. EDF003W ═══ Missing Etag-name1 tag assumed before this tag-name2 tag. Explanation: A tag-name1 end tag was missing before the tag-name2 tag. Processing continues as if the end tag had been entered just before the tag-name2 tag. This may not be the correct place for the end tag. For example, if you forget to end an ordered list (OL), BookMaster will assume it ends before the next major document element, such as a heading. User Response: Check the source file to see where the tag-name1 end tag should be placed. ═══ 5.2.5. EDF004W ═══ tag-name1 tag found within tag-name2 and ignored. Explanation: A tag-name1 tag was found where it may not be used. For example, a GRID tag was found within a TABLE. User Response: The tag-name1 tag may have been mistyped. Check your source file and enter a valid tag or move the tag-name1 and its related tags outside the tag-name2 tag. ═══ 5.2.6. EDF005W ═══ Extraneous GT value 'term' ignored. Explanation: Multiple glossary term (GT) tags were found consecutively in a glossary list. For example: :GL. :GT. :GT. :GD. :EGL. Each GT tag must be followed by a glossary definition (GD) tag. Only the last GT tag is used. The output file will not contain the extraneous GT values. User Response: Make sure there is a GD tag following each GT tag in your source file. ═══ 5.2.7. EDF006W ═══ GT tag missing. Explanation: A glossary definition (GD) tag was found without a glossary term (GT) tag. For example: :GL. :GT. :GD. :GD. :EGL. A question mark is used for the term in the output. User Response: Check your source file for a missing or mistyped GT tag. Make sure there is a GT tag for each GD tag in your source file. If your GT tag has multiple definitions, insert a glossary definition group (GDG) tag after the GT tag. ═══ 5.2.8. EDF007W ═══ Unrecognized List type: filetype. Explanation: The EDFLIST macro was called with a type parameter that is not defined by BookMaster. User Response: This message should not occur in an unmodified BookMaster system. One of the list tags may have been modified incorrectly. Contact your system administrator for valid list tags. ═══ 5.2.9. EDF008W ═══ tag-name ID 'id' truncated to seven characters. Explanation: The ID attribute value may not exceed seven characters. Processing will continue using the first seven characters to set ID. For example, if you enter this markup: :FIG ID=abcdefghij. BookMaster issues this warning message and uses "abcdefg" as the ID. Although this is not a BookMaster error, your references may be wrong. User Response: Enter a valid ID attribute value. A valid ID is any combination of letters and numbers of seven or fewer characters beginning with a letter. If you change an ID attribute, be sure to change any REFID attributes on associated reference tags to match the new ID. ═══ 5.2.10. EDF009W ═══ Duplicate ID 'id' was ignored on tag-name tag. Explanation: An ID value may only be specified once for a given category of tags. For example, for all the heads (H0 to H20) there may be only one ID=yourid. User Response: Rename one of the duplicate ID values. Make sure all tag REFID values that refer to the duplicate value are changed to refer to the corrected ID. ═══ 5.2.11. EDF010E ═══ DOCNUM tag required with tag-name tag. Explanation: The IBM cover and restricted materials require a document number. User Response: Enter a DOCNUM tag in the prolog. ═══ 5.2.12. EDF011W ═══ tag-name end-tag found outside tag-name and ignored. Explanation: An end tag was used without a corresponding start tag. A tag may have been mistyped. User Response: Make sure your source file has start and end tags in the correct sequence. Check for a mistyped tag-name. Remove any extraneous end tags. ═══ 5.2.13. EDF014E ═══ Missing term for index-tag entry. Explanation: An index entry (I1-I3) or index head tag (IH1-IH3) was entered without a term for one of the levels. o There is no text for the tag. o The tag skips a level in the index, such as when an I3 tag follows an IH1 tag. o The tag refers to a nonexistent ID attribute value for an index head. o The REFID value was referenced before the ID value was identified. For example, :I2 REFID=abcd.text . . . :IH1 ID=abcd.text header User Response: Make sure that all index entry tags have text following them, that the index entry tags don't skip any levels, and that all REFID attributes match an ID attribute on another index entry tag. ═══ 5.2.14. EDF015W ═══ The param-name parameter was missing from the macro-name macro. Explanation: The param-name parameter is required for the macro-name macro. The param-name is missing or invalid. For example, the TEXT parameter may have been missing from the GETW macro. User Response: Check for a missing or mistyped parameter and correct it. If the param-name parameter is a symbol name of a macro-name macro, make sure all uses of the symbol name have been changed. ═══ 5.2.15. EDF018W ═══ MAPDEF tag not allowed within MAP. Explanation: There may not be a MAPDEF tag within a MAP. User Response: Move the MAPDEF tag before the MAP tag or to the PROLOG section. ═══ 5.2.16. EDF023W ═══ Invalid syntax for SYSVAR F. Explanation: An invalid syntax value was entered. This error occurs with the SYSVAR F option only. User Response: Enter a valid value for SYSVAR F: FBC, YES, NO, CHAPn, or APPx where n is a number and x is a letter. For example, to specify folio-by-chapter page numbering, use SYSVAR (F FBC). ═══ 5.2.17. EDF024W ═══ Invalid value 'xxxxx' for attribute-name attribute of tag-name tag. Explanation: The value entered for the attribute is not allowed. User Response: Enter a valid attribute value. An attribute value that is not a single word must be enclosed within single quotes. Check the &users. or &named. for valid values. ═══ 5.2.18. EDF028W ═══ xxxDEF tag without ID attribute used outside of Prolog section. Explanation: An xxxDEF tag without an ID may only be used in the PROLOG section. User Response: Move the xxxDEF tag to the PROLOG section or add an ID attribute. ═══ 5.2.19. EDF030W ═══ tag-name1 REFID=id does not match any ID on tag-name2 tag. Explanation: There is no tag-name2 tag with the ID referred to. For example, BookMaster found a :FIGREF REFID=myfig. but did not find a :FIG ID=myfig. User Response: Do one or more of the following: o Check for a mistyped REFID value. o Add a tag-name2 with an ID attribute value of id. o Remove the REFID attribute from the tag-name1 tag if the tag-name1 tag refers to a XXXDEF tag. ═══ 5.2.20. EDF031W ═══ Nesting of REV tags greater than 8. Explanation: REV tags may only be nested eight levels deep. This REV tag and all subsequent REV tags over eight levels are ignored. User Response: Try to begin and end your revision levels instead of nesting them. ═══ 5.2.21. EDF032W ═══ Previous tag-name tag not ended. Explanation: A tag-name may not be placed within a CAUTION, DANGER, or WARNING. Also, an NT tag may not be placed within a note. User Response: Check your source file for a mistyped or missing end tag, or move the imbedded tag after the previous tag-name end tag. ═══ 5.2.22. EDF033W ═══ Unable to start basefont font-name. Explanation: This basefont font-name is not installed on your system. User Response: Make sure that the basefont was entered correctly. If so, report the error to your system administrator to determine basefonts installed on your system. ═══ 5.2.23. EDF034W ═══ Symbol name more than 10 characters on macro-name macro. Explanation: A symbol name may not exceed 10 characters. Processing will continue using the first 10 characters to set the symbol name. For example, if you enter this markup: .NAMEIT SYMBOL=a1234567890 TEXT='messages' BookMaster issues this warning message and uses "a123456789" as the symbol name. Although this is not a BookMaster error, your references may be wrong. User Response: Enter a valid symbol name. A valid symbol name is any combination of letters and numbers of 10 or fewer characters beginning with a letter. If you change a symbol name, be sure to change any symbol values associated with it. ═══ 5.2.24. EDF035W ═══ attribute-name attribute missing from tag-name tag. Explanation: The attribute-name attribute is required for the tag-name tag. For example in a parts catalog list, as shown below: :CI PARTNUM=12345.Part 1 The PARTNUM attribute and its value are required with a CI tag. User Response: Add the attribute and its value to the tag. Check the &users. or &named. for the correct syntax of the tag-name tag. ═══ 5.2.25. EDF036W ═══ text will not fit in column. Explanation: The text entered for the QUALIF tag is too long to fit in the column. The string "??????" is used instead. User Response: Shorten the text used with the QUALIF tag or increase the column width. The text used must also allow room for the words "End of" and some blank space on both sides of the text. If a two-column layout is being used, the text may have to be shortened. ═══ 5.2.26. EDF038W ═══ MOD statement parameter ignored. Explanation: The second parameter for the MOD statement was either mistyped or an invalid parameter was entered. User Response: Check your source file for a mistyped parameter or enter a valid statement: .MOD label OFF]INSERT]REPLACE]DELETE ═══ 5.2.27. EDF039W ═══ Required parameters missing, macro-name statement ignored. Explanation: There are not enough parameters in this macro-name statement. A CONFIG or MOD statement must have exactly two parameters, as shown below: .CONFIG label ON]OFF or, .MOD label OFF]INSERT]REPLACE]DELETE User Response: Correct the CONFIG or MOD statement. Check the &users. for correct use of the CONFIG or MOD macro statements. ═══ 5.2.28. EDF041W ═══ Excess parameters specified on macro macro-name statement. Explanation: There are too many parameters specified in this macro-name statement. A CONFIG or MOD statement must have exactly two parameters, as shown below: .CONFIG label ON]OFF or, .MOD label OFF]INSERT]REPLACE]DELETE User Response: Correct the CONFIG or MOD statement. Check the &users. for correct use of the CONFIG or MOD macro statements. ═══ 5.2.29. EDF042W ═══ Too many columns specified on tag-name. Maximum of 20 used. Explanation: A directory (DIRECT) or directory definition (DIRDEF) may have up to 20 columns. Any columns over 20 are ignored. User Response: Change your directory to 20 or fewer columns. If more than 20 columns are needed, convert the DIRECT or DIRDEF into a table format. ═══ 5.2.30. EDF043W ═══ USING with missing parameters ignored. Explanation: Either no parameters were entered on the USING statement or the parameters were specified incorrectly. User Response: Enter a valid USING statement. For example: .USING filename 'conditional-expression' Make sure the conditional-expression has been enclosed within single quotes. Refer to the &users. for correct use of the USING statement. ═══ 5.2.31. EDF045W ═══ DIRECT tag COLS widths are too wide for current column. Explanation: The sum of the widths of the columns for the directory is too large to fit in the current text column. BookMaster sets the layout to a full-page column. User Response: If you don't want the directory to use the full page, change the COLS specification to fit in the column. ═══ 5.2.32. EDF046W ═══ Too many items on the DENTRY tag. Truncated at cols. Explanation: A directory was specified with cols, but has a directory entry (DENTRY) tag with too many elements. User Response: This can be solved by one or all of the following: o Make sure the number of elements entered within the DENTRY tag matches the number of columns specified. o Make sure single quotes have been entered around items containing blanks or special characters. o Increase the number of layout columns to equal the number of elements entered. Check the &users. for correct usage of a DENTRY tag. ═══ 5.2.33. EDF047W ═══ Required WHEN parameters not found. Text included by default. Explanation: A WHEN statement must have two parameters: a condition name first and either INSERT or DELETE second. For example: .WHEN 'conditional-expression' INSERT]DELETE User Response: Enter a valid WHEN statement. Make sure the conditional-expression has been enclosed within single quotes. Refer to the &users. for correct usage of a WHEN statement. ═══ 5.2.34. EDF048W ═══ Second WHEN parameter isn't INSERT or DELETE. Text included by default. Explanation: The second parameter on the WHEN statement must be INSERT or DELETE. For example: .WHEN 'conditional-expression' INSERT]DELETE User Response: Enter a valid parameter. Make sure the conditional-expression has been enclosed within single quotes. Refer to the &users. for correct usage of a WHEN statement. ═══ 5.2.35. EDF049W ═══ Excess parameters on WHEN statement. Text included by default. Explanation: There are too many parameters in this statement. There must be exactly two parameters on a WHEN statement, as shown below: .WHEN 'conditional-expression' INSERT]DELETE User Response: Enter a valid WHEN statement. Make sure the conditional-expression has been enclosed within single quotes. Refer to the &users. for correct usage of the WHEN statement. ═══ 5.2.36. EDF051W ═══ ON or OFF CONFIG parameter not found. Statement ignored. Explanation: A CONFIG statement must have two parameters: a label name first and either ON or OFF second. For example: .CONFIG label ON]OFF User Response: Enter a valid parameter. Make sure the CONFIG macro starts and ends with matching labels. ═══ 5.2.37. EDF052W ═══ EXPLODE report suspended. tag-name not processed. Explanation: This message is for BookMaster development use only. An error was found within a CONFIG section; another message should be received that will help to isolate the exact error. User Response: Report the error to your system administrator. ═══ 5.2.38. EDF053W ═══ attribute-name1 attribute invalid on tag-name tag with attribute-name2. Explanation: attribute-name1 and attribute-name2 attributes are incompatible. Both attributes may not be used on the same tag-name tag. For example, the following erroneous markup will cause this message because both RULE and NAME cannot be used on the same ARTWORK tag: :ARTWORK RULE NAME=myart. User Response: Check your source file and remove one of the conflicting attributes from tag-name. ═══ 5.2.39. EDF054W ═══ attribute-name1 attribute required on tag-name tag with attribute-name2. Explanation: If there is an attribute-name2 attribute on a tag-name tag, there must also be an attribute-name1 attribute. User Response: Check your source file and add a valid attribute-name1 attribute. Refer to your &users. for compatible attributes. ═══ 5.2.40. EDF055W ═══ Named style style-name uses itself via stylelist. Explanation: A named style may not refer to itself. For example, you cannot have :ZSTYLE REFSTYLE=style1. in a style called STYLE1. Also, a named style cannot refer to a second style that refers to itself. For example: STYLE1 :ZSTYLE REFSTYLE=style2. STYLE2 :ZSTYLE REFSTYLE=style1. User Response: Rename your style file and change all uses of it in your source files. Refer to &named for correct use of ZSTYLE. ═══ 5.2.41. EDF056W ═══ Style name style-name longer than 8 characters. Explanation: The name of a style file may not exceed eight characters. The style is not recognized or processed. User Response: Enter a valid style name up to eight characters. A valid style name is any combination of letters and numbers of eight or fewer characters beginning with a letter. If you change a style name, be sure to change any style name values associated with it. ═══ 5.2.42. EDF057W ═══ Invalid value 'value' for attribute-name attribute of tag-name tag with CLASS='class'. Explanation: The value entered is incompatible with the CLASS value defined. User Response: Check &named. for the valid values and correct your style file. ═══ 5.2.43. EDF058W ═══ Invalid document number on DOCNUM tag for an IBM manual. Explanation: The text in a document number on a DOCNUM tag in a document with a style beginning with IBM must conform to xxxx-nnnn-nn. User Response: Verify that the document number conforms to xxxx-nnnn-nn. ═══ 5.2.44. EDF059W ═══ Invalid character for barcode. Explanation: This should not occur unless the application has made its own call to the barcode macro. User Response: Replace the invalid character with a valid barcode character of A-Z, 0-9, *, $, %, -, ., +, /, or blank. ═══ 5.2.45. EDF060W ═══ Document type is not in @dtyp@nam array -- document type ignored. Explanation: This message is for BookMaster development use only. A user should never receive this message. User Response: Report the error to your system administrator. ═══ 5.2.46. EDF061W ═══ FILENAME missing on SETUP macro. Explanation: The SETUP macro must specify the filename of the setup file. For example: .SETUP filename-of-setup-file User Response: Enter a filename on the SETUP macro. ═══ 5.2.47. EDF062W ═══ User option opt unknown. Explanation: The opt option is not a valid BookMaster user option as specified in the user options file (SYSVAR U). User Response: Check that the name of the user option was spelled correctly. Refer to the &users. for valid user options. ═══ 5.2.48. EDF063E ═══ CONFIG label label is unknown or out of sequence, section section is still active. Statement ignored. Explanation: An attempt was made to end a configuration section, but the label specified (label) was not the same as the label on the last configuration section that was started (section). One of the following probably happened: o The label was mistyped. o The label from a configuration section was not ended before the current configuration section. For example, the following erroneous markup would cause this error: .CONFIG mylabel ON . . . .CONFIG mylabelm OFF User Response: Do one or all of the following: o Correct the mistyped label. o End the previous configuration section. o Make sure the CONFIG section starts and ends appropriately throughout your source file. ═══ 5.2.49. EDF064W ═══ COVER ARTID=id does not match any ID on ARTDEF tag. Explanation: There is no ARTDEF tag that has the same ID value as the ARTID attribute on the COVER tag. One of the following probably happened: o The ID on the ARTDEF tag or the ARTID on the COVER tag may have been mistyped. o An ARTDEF tag was not entered. User Response: Do one of the following: o Correct the mistyped ID or ARTID tag. o Enter an ARTDEF tag. ═══ 5.2.50. EDF065W ═══ cw control word not allowed in GRID. Explanation: The cw control word is not valid within a GRID and was ignored. User Response: Check your source file. Remove the control word. ═══ 5.2.51. EDF066W ═══ Unable to define horizontal units for tag-name. Explanation: There is not enough room on the page for the horizontal units defined for the GRID or GRIDDEF tags. User Response: Correct the values on the HMAX and HUNITS attributes on the GRID or GRIDDEF tags. ═══ 5.2.52. EDF067W ═══ NAME attribute not allowed with CLASS attribute on the ZRULE tag. Explanation: The NAME and CLASS attribute are incompatible on the same ZRULE tag. User Response: Do one or both of the following: o Remove one of the attributes. o Define NAME and CLASS on separate ZRULE tags. ═══ 5.2.53. EDF068W ═══ Invalid value 'attribute-value' for value attribute of tag-name tag. Explanation: attribute-value is not a valid attribute value for the tag-name tag. This message would occur if the value attribute RULE was mistyped on the ARTWORK tag, for example: :ARTWORK ule. User Response: Check your &users. for the list of valid value attributes to correct your source file. ═══ 5.2.54. EDF069E ═══ CONFIG section section already active. The label of a nested CONFIG section must be unique. Explanation: This error occurs in two situations: o The CONFIG was entered as ON instead of OFF. o An attempt was made to create a nested configuration section with the same name as the section that contains it. User Response: Determine the cause of the error: o Change ON to OFF. o Rename the nested configuration section. ═══ 5.2.55. EDF070E ═══ Because of CONFIG error, your document will not format correctly. Section section is still active. Statement ignored. Explanation: This message follows message EDF069E. User Response: Correct the error identified by message EDF069E. ═══ 5.2.56. EDF071E ═══ macro-name macro ignored because no section section is active. Explanation: This error occurs in two situations: o The .CONFIG label OFF statement occurred outside a configuration section. This can occur if there was an error on a previous CONFIG statement. o A WHEN statement was found outside a CONFIG section. User Response: Determine the cause of the error: o Check for a misplaced CONFIG statement. If there is no misplaced statement, remove the statement or correct the section by starting a CONFIG statement before the CONFIG OFF statement. o Move the WHEN statement into a CONFIG section. ═══ 5.2.57. EDF072E ═══ tag-name tag used more than once - tag ignored. Explanation: Only one PROLOG and one ASMLIST tag are allowed per document. User Response: Include only one PROLOG or ASMLIST tag in your document. ═══ 5.2.58. EDF073W ═══ Revision for REFID=id already active -- REV tag ignored. Explanation: There is already a revision active that uses the same REFID as the REV tag. User Response: Do one or more of the following: o Check for a mistyped ID. o Locate and remove the extra REV tag. o Define a new REFID for this REV tag and its matching end tag. o Make sure that all REV tags have been ended with a matching REV end tag (remember to include a REFID attribute on the end tag). ═══ 5.2.59. EDF074W ═══ Revision for REFID=id out of sequence -- EREV tag ignored. Explanation: A revised section that contained a REV end tag was not the last active revision and can't be ended. The probable cause is either: o The REFID id was mistyped. o A nested REV tag wasn't ended before this REV end tag. User Response: Do one or more of the following: o Check for a mistyped ID. o Make sure there are matching REFID id tags for each REV tag listed. o Make sure that all REV tags have been ended with a matching REV end tag and that they have been nested correctly (remember to include a REFID attribute on the REV end tag). ═══ 5.2.60. EDF075W ═══ tag-name tag for line n with alignment 'align' already defined. Explanation: A running heading or footing line was already defined for this line number and alignment (L-left, C-center, R-right). User Response: Either create one definition for the running heading and footing lines or enter them on two separate lines. ═══ 5.2.61. EDF076W ═══ font-name font required for symbol definitions. Explanation: For the symbol definitions to work correctly on the 6670, font-name must be specified in your CHARS option. User Response: Specify a valid CHARS SCRIPT/VS option or report the error to your system administrator. ═══ 5.2.62. EDF077W ═══ tag-name REFID 'id' truncated to seven characters. Explanation: The REFID attribute value may not exceed seven characters. Processing will continue using the first seven characters to set REFID. For example, if you enter this markup: :FIGREF REFID=abcdefghij. BookMaster issues this warning message and uses "abcdefg" as the ID. Although this is not a BookMaster error, your references may be wrong. User Response: Enter a valid REFID attribute value. A valid REFID is any combination of letters and numbers of seven or fewer characters beginning with a letter. If you change a REFID attribute, be sure to change any ID attributes associated with the reference tag to match the new REFID. ═══ 5.2.63. EDF078W ═══ Unable to start headfont font-name. Explanation: The headfont font-name is not installed on your system. User Response: Make sure that the headfont was entered correctly. If so, report the error to your system administrator to determine headfonts installed on your system. ═══ 5.2.64. EDF079E ═══ No safety procedure text available in SAFETY tag. Explanation: The SAFETY tag should generate installation-dependent text. This text should be added to the EDFSAFE macro when BookMaster is installed. User Response: Have your system administrator modify the EDFSAFE macro to meet your organization's needs. ═══ 5.2.65. EDF080W ═══ More RESETS than SETS on skip save array. Explanation: This message is for BookMaster development use only. A user should never receive this message. User Response: Report the error to your system administrator. ═══ 5.2.66. EDF081W ═══ Invalid value 'xxxxx' for param-name parameter of macro-name macro. Explanation: xxxxx is not a valid value for the param-name parameter. User Response: Enter a valid value. Refer to your &users. for allowed values. ═══ 5.2.67. EDF083W ═══ Invalid symbol name 'xxx' for macro-name macro. Explanation: The symbol name for macro-name may not contain the characters: #, $, or @. These characters are reserved for BookMaster use. User Response: Change the symbol name in the macro statement and wherever else it is used in the document. ═══ 5.2.68. EDF084E ═══ Macro which processes the end-tag-name tag is not restoring the state. Explanation: This message is for BookMaster development use only. A user should never receive this message. User Response: Report the error to your system administrator. ═══ 5.2.69. EDF085W ═══ Unable to re-execute running heading/footing from current element for tag-name tag. Explanation: A running heading or footing cannot be changed within another document element. User Response: Move the tag-name tag outside the current element. ═══ 5.2.70. EDF086W ═══ attribute-name 'id' invalid for tag-name tag. Explanation: An ID or REFID may not be blank or have the value @@ISIL@. User Response: Enter a valid ID or REFID of up to seven characters. The first character must be alphabetic. ═══ 5.2.71. EDF087E ═══ Use of F and DF tags or NAMEF macro requires the SCRIPT Mathematical Formula Formatter. Explanation: The SCRIPT/VS module identified for formatting does not contain the SCRIPT Mathematical Formula Formatter (SMFF). Formula tags or macros cannot be used without SMFF. User Response: Ask your system administrator about the availability of SMFF. ═══ 5.2.72. EDF088W ═══ ADJUST value of 'adj' greater than line spacing for tag-name tag. Explanation: The baseline of the page segment may be adjusted by no more than one line space up or down. User Response: Correct the ADJUST value. If you are trying to make your artwork rest on the baseline, use the RUNIN attribute with the ADJUST attribute and adjust the artwork using smaller increments (such as point sizes). ═══ 5.2.73. EDF089E ═══ Font 'font-name' required. Explanation: The font-name font must be installed to use BookMaster. User Response: Report the error to your system administrator. ═══ 5.2.74. EDF090W ═══ F and FPART attribute-name are both specified on NAMEF macro. Using F attribute value. Explanation: Either the F or FPART attribute, but not both, must be specified on a NAMEF macro. The FPART attribute is ignored. A NAMEF macro requires the following operands: .NAMEF SYMBOL=name F='formula' or, .NAMEF SYMBOL=name FPART='formula fragment' User Response: Specify a NAMEF macro for each F and FPART attribute. Make sure that single quotes have been entered around the formula or formula fragment in the statement. ═══ 5.2.75. EDF091W ═══ Symbol name less than 2 characters on NAMEF macro. Explanation: The symbol name used for NAMEF must contain at least two characters, and cannot exceed 10 characters. User Response: Enter a valid symbol name in the macro statement and wherever else it is used in the document. ═══ 5.2.76. EDF092W ═══ The save and restore values may not be used in the METRICS attribute of the tag-name tag. Explanation: The save and restore values, which are allowed for the EQ SCRIPT/VS control word, are not allowed as values for the METRICS attribute of the DF and DFDEF tags. User Response: Remove the values. Check &users. for correct values on the METRICS attribute. ═══ 5.2.77. EDF093W ═══ Invalid fileid file-id for NAME attribute of NAMEFILE macro. Explanation: An invalid value for fileid, file-id, was entered for the NAME attribute. The NAME fileid may not start with DSM. User Response: Enter a valid value for the fileid. ═══ 5.2.78. EDF094W ═══ NAMEFILE fileid file-id truncated to 8 characters. Explanation: The NAMEFILE fileid may not exceed eight characters. Processing will continue using the first eight characters to set file-id. For example, if you enter this markup: .NAMEFILE NAME=a123456789 BookMaster issues this warning message and uses "a1234567" as the fileid. Although this is not a BookMaster error, your references may be wrong. User Response: Enter a valid fileid value. A valid NAMEFILE fileid is any combination of letters and numbers of eight or fewer characters beginning with a letter. ═══ 5.2.79. EDF095W ═══ Style macro style-name not in specified macro library. Explanation: The referenced style macro style-name is not installed on your system. User Response: Check your source file for a misspelled style name. If style-name is spelled correctly, check with your system administrator for valid styles installed on your system. ═══ 5.2.80. EDF096W ═══ attribute-name1 'id' of tag-name1 does not match any attribute-name2 on tag-name2. Explanation: There is no tag-name2 tag with tag-name1 id referenced. For example, there is a SCHDATE tag with a LISTREF attribute, such as: :SCHDATE LISTREF=mylist. but there is no SCHEDULE tag with a matching LISTID attribute, such as: :SCHEDULE LISTID=mylist. User Response: Do one or more of the following: o Make sure the values for ID and REFID on the indicated attributes match. o Add an id for the value of ID for the tag-name2 tag. o Remove the reference made to the tag-name2 tag. ═══ 5.2.81. EDF097E ═══ tag-name tag not allowed within a table. Explanation: The tag-name tag is not allowed within a table element. For example, a schedule or schedule date tag is not allowed within a table. User Response: Remove the tag-name tag or move it outside the table element. Refer to your &users. for proper usage of the indicated tag and of table elements. ═══ 5.2.82. EDF098W ═══ attribute-name 'id' of tag-name truncated to seven characters. Explanation: The ID specified for the attribute-name may not exceed seven characters. Processing will continue using the first seven characters to set ID. Although this is not a BookMaster error, your references may be wrong. User Response: Enter a valid ID attribute value of up to seven characters. ═══ 5.2.83. EDF101W ═══ Missing tag-name tag assumed after step stepnum of MAP mapnum. Explanation: A MAP-related tag was used out of context. Processing continues as if the missing tag had been entered. This may not be the proper place for the tag. The probable cause is either: o There was a STEP end tag missing before a STEP or MAP end tag. o There was a STEP tag missing before a CT, FT, QT or ST tag. o There was a MAP end tag processed before nesting within the file was completed. Your output may not show the effect of this error since BookMaster inserts the missing tags. User Response: Check that all start tags of STEP are ended with an end tag, or enter the missing tag. ═══ 5.2.84. EDF102W ═══ Extraneous end-tag-name tag ignored after step stepnum of MAP mapnum. Explanation: A STEP end tag was not preceded by a STEP tag. User Response: Check that all STEP tags are ended with an end tag. Remove the extraneous STEP end tag or add the missing STEP tag. ═══ 5.2.85. EDF103W ═══ Extra QT tag ignored in step stepnum of MAP mapnum. Explanation: Only one question text (QT) tag is allowed in a step. User Response: Do one or both of the following: o End the step and add another step to use the QT tag. o Remove the extra QT tag and add its information to another QT tag. ═══ 5.2.86. EDF104W ═══ Nested too deep. QT tag ignored in step stepnum of MAP mapnum. Explanation: Only three levels of nested MAPs are allowed with a question text (QT) tag. The extra QT tags are ignored. User Response: Try to redo the MAP so there aren't as many levels of nesting. ═══ 5.2.87. EDF105W ═══ xxxxx value of attribute-name is not a positive integer. Explanation: The xxxxx value must be a positive integer. User Response: Enter a valid value. Refer to the &users. for valid values of the attribute indicated. ═══ 5.2.88. EDF106W ═══ Step stepnum of MAP mapnum is not referenced. Explanation: A step must be branched to in a map. After step 001, a step with no entering trace lines must be referenced by a STEPREF tag or there is no logical path for the reader. User Response: Check your source file for a misspelled ID or REFID value. Also, be sure that one or more STEPREF tags reference this step. ═══ 5.2.89. EDF107W ═══ A tag-name tag PARTNUM attribute value over n digits truncated to n. Explanation: In a parts catalog list, the PARTNUM attribute value may not exceed n digits. BookMaster allows a maximum of seven characters. If you are using a style file, a maximum of ten characters can be defined using the PNDIGITS attribute in the ZDOCPROF. Processing continues using the number of digits to which BookMaster truncated. User Response: Correct the value for the PARTNUM attribute using up to seven characters. If more than seven digits are needed, increase the number of PNDIGITS digits in your style file. ═══ 5.2.90. EDF108W ═══ A PARTSASM tag LAYOUT attribute value must be SAME or FACING, not xxxxx. Explanation: A value of SAME or FACING must be specified on the LAYOUT attribute. User Response: Enter a valid attribute value of SAME or FACING. ═══ 5.2.91. EDF109W ═══ Extraneous ECOMPL tag ignored. Explanation: There is a component list (COMPL) end tag without a COMPL start tag. Processing continues ignoring the extra COMPL end tag. Your output may not show the effect of this error since BookMaster inserts the missing tag. User Response: Check that all start tags of COMPL have matching end tags, and remove any extraneous COMPL end tags. ═══ 5.2.92. EDF110W ═══ Missing ECOMPL tag assumed at end of Assembly n. Explanation: A parts assembly section was ended without ending the previous COMPL tag. Processing continues assuming the COMPL end tag has been entered. User Response: Enter a COMPL end tag before the PARTSASM end tag. ═══ 5.2.93. EDF111W ═══ Values on attribute-name attribute of the tag-name too wide for column. Explanation: The width of the text column dictates the number of items allowed within the column. User Response: Specify only the items that you want printed or shorten the items that are tagged. Check the &users. for proper use of the attributes. ═══ 5.2.94. EDF112W ═══ attribute-name attribute of the tag-name tag is not valid within a state. Explanation: The attribute defined for the tag-name tag is not valid within the defined state. For example, the ROTATE attribute of a TABLE tag is not valid within a GRID. User Response: Enter a valid attribute for the tag-nametag that can be used within the defined state. Check the &users. for valid attributes. ═══ 5.2.95. EDF113I ═══ tag-name1 ended by tag-name2 end tag. Explanation: Another structure was started between the start tag for tag-name2 and the end tag, and either was not entered or was not ended correctly. For example: :OL. :SL. :EOL. In this example, a simple list (SL) was found within an ordered list (OL) but the simple list was not ended. Processing continues with the simple list being ended implicitly by the ordered list end tag. User Response: Check your source file for a missing or mistyped end tag. Make sure there is an end tag for each start tag in your source file. ═══ 5.2.96. EDF151E ═══ More COLS/ARRANGE values than ARRANGE/COLS defined on the TDEF tag. Explanation: The number of ARRANGE values must equal the number of values used on the COLS or CWIDTHS attribute. The mismatch may be less obvious when chaining is used, that is, when the errant TDEF has a REFID to bring in a previous TDEF's settings as a base. For example, if the number of arrange parameters on the ARRANGE attribute changes when chaining is used and no COLS or CWIDTHS is specified, there will be a mismatch. User Response: Define the same number of cells on the COLS/CWIDTHS attribute as ARRANGE values on the TDEF tag line or between slashes on the arrange attribute. ═══ 5.2.97. EDF153T ═══ Missing TDESC end tag has terminated processing. Explanation: The table description end tag (ETDESC) is missing. If the table description is at the top of the table markup and the TDESC end tag is missing, all text and markup until a TDESC end tag is encountered is saved as a description. If there are no TDESC end tags in the rest of the document, the end-of-document processing issues this message. User Response: Add a TDESC end tag at the end of the table description. ═══ 5.2.98. EDF154E ═══ Value of WIDTH attribute on the TABLE/TDEF tag exceeds page width. Explanation: The requested width is too wide for the page. If no WIDTH attribute was specified the cell widths may add up to a sum that is wider than the page. User Response: Reduce the value set on the WIDTH attribute. If no WIDTH attribute was given, reduce the cell widths on the COLS or CWIDTHS attribute. ═══ 5.2.99. EDF157E ═══ Too many cells requested for THD or TFT definition. Explanation: Too many cell tags are used in the table header (THD) or table footer (TFT). The TFT and THD are limited to one row and therefore cannot generate a new row for extra cells. User Response: Redefine the table definition (TDEF) attributes so that the value of COLS matches the number of cell tags, or reduce the number of cells to match the value of COLS defined in the TFT or THD tag. ═══ 5.2.100. EDF159W ═══ Residual text not allowed on tag-name. C tag is required. Explanation: A table header (THD), table footer (TFT) or a ROW tag does not allow any text following it. User Response: Either remove the text following the tag-name tag or insert a C tag after the tag-name tag and place the text following the C tag. ═══ 5.2.101. EDF160W ═══ TABLE]TDEF COLS and CWIDTHS attributes used together. COLS is used. Explanation: The TABLE or TDEF has both a COLS and a CWIDTHS attribute. These attributes cannot be used together. BookMaster will use the values specified on the COLS attribute only. User Response: Use either the COLS or the CWIDTHS attribute, but not both. ═══ 5.2.102. EDF161E ═══ THD must precede TFT. THD not processed. Explanation: The table header (THD) tag, follows a table footer (TFT) tag. The THD tag was not processed. User Response: Move the THD tag and its elements ahead of the TFT tag. ═══ 5.2.103. EDF162I ═══ FIG/TABLE had an ID, but did not have a FIGCAP/TCAP. Explanation: A caption is required for a table or figure that has an ID. A reference to the table or figure causes an error because no caption is used. User Response: If this is a table, add a caption with the TCAP tag following the TABLE tag, or remove the ID attribute from the TABLE tag. If this is a figure, add a caption with a FIGCAP tag after the FIG tag, or remove the ID attribute from the FIG tag. Remember, if the ID attributes are removed, any TREF or FIGREF tags that are referred to this ID also need to be removed. ═══ 5.2.104. EDF163W ═══ tag-name REFID=refid refers to a TABLE or FIG that didn't have a caption. Explanation: If you use a table reference (TREF) or a figure reference (FIGREF) tag to refer to a table or a figure then the table or figure must have a caption. User Response: Add a caption to the table or figure referred to. ═══ 5.2.105. EDF164W ═══ TABLE tag within tag-name is not supported. Output may be incorrect. Explanation: Tables may not format correctly within screens and examples. User Response: If the output is incorrect, use tags that work correctly within a screen or example, or move the table outside of the screen or example. ═══ 5.2.106. EDF165E ═══ TCAP tag not allowed in captioned figure when DOCPROF FTSEP=NO. Explanation: When a table tag is inside a captioned figure, and tables and figures are not counted separately, do not caption the table. The figure numbering is not valid under that condition. This occurs when the FIGCAP tag follows the FIG tag. User Response: Do one or more of the following: o Set DOCPROF FTSEP=YES. o Remove the caption from the table that is within the figure. o Remove the figure caption. ═══ 5.2.107. EDF166E ═══ FIGCAP tag not allowed with captioned table when DOCPROF FTSEP=NO. Explanation: A FIGCAP tag was placed in the figure after a table with a caption (TCAP) tag, had been encountered within the figure. The first caption is used, so the second is not valid. User Response: Do one or more of the following: o Set DOCPROF FTSEP=YES. o Remove the captions from any tables that are within the figure. o Remove the figure caption. ═══ 5.2.108. EDF167E ═══ Number of ARRANGE and COLS/CWIDTHS values differ on tag-name tag. Explanation: There is a difference between the number of values on the ARRANGE attribute and the number of values on the COLS or CWIDTHS attributes. The number of values must be the same. User Response: Compare the number of values used between slashes or on each ARRANGE attribute to the number of values on the COLS or CWIDTHS attribute of the TABLE tag. If no COLS or CWIDTHS attribute is used, check the TDEF referred to for the table. ═══ 5.2.109. EDF199E ═══ TDESC not supported on xxx operating system. Explanation: The xxx operating system doesn't support the table description (TDESC) tag at the top of a table. The TDESC tag is supported only under CMS and TSO. User Response: Move the TCAP and TDESC tags to the bottom of the table. ═══ 5.2.110. EDF200E ═══ Resetting passed defined highlight fonts. Explanation: This message is for BookMaster development use only. A user should never receive this message. User Response: Report the problem to your system administrator. ═══ 5.2.111. EDF201E ═══ kp/fl already enabled -- disable/enable sequence error. Explanation: This message is for BookMaster development use only. A user should never receive this message. User Response: Report the problem to your system administrator. ═══ 5.2.112. EDF202E ═══ Label box text too long. Explanation: The text for a label box may not be wider than the column. The string "??" is used instead. User Response: Reduce the length of the text or redefine the width of the label box. Check your &users. for proper use of label box text. ═══ 5.2.113. EDF205E ═══ HUNITS has nonnumeric value for tag-name tag. Explanation: The HUNITS values must be numeric or '*'. User Response: Enter valid numeric values enclosed in single quotes. ═══ 5.2.114. EDF206E ═══ HUNITS exceed HMAX for tag-name tag. Explanation: The sum of the values of HUNITS must equal the value of HMAX, or if any of the values are '*', the sum of the numeric values must be less than the value of HMAX. User Response: Enter valid numeric values for HUNITS enclosed in single quotes, the sum of which does not exceed the HMAX value. ═══ 5.2.115. EDF207E ═══ VUNITS exceed VMAX -- using VUNITS=units. Explanation: The value of VUNITS must be less than or equal to the value of VMAX, or the value must be FIT or FILL. User Response: Enter a valid numeric value for VUNITS or a value of FIT or FILL. ═══ 5.2.116. EDF208W ═══ VUNITS invalid -- using VUNITS=units. Explanation: An invalid value of VUNITS was entered. The value of VUNITS must be less than or equal to the value of VMAX, or the value must be FIT or FILL. User Response: Enter a valid numeric value for VUNITS or a value of FIT or FILL. ═══ 5.2.117. EDF209W ═══ TRANS attribute on tag-name tag must be numeric. Explanation: The value of the TRANS attribute must be numeric. User Response: Enter a valid numeric value for the TRANS attribute. ═══ 5.2.118. EDF210E ═══ ID=id on CHOICE tag has no matching ANSID on a MATCH tag. Explanation: The ID on a CHOICE tag must have a matching ANSID on a MATCH tag. User Response: Check your source file and make sure that the id entered on the CHOICE and MATCH tags match. ═══ 5.2.119. EDF211E ═══ tag-name may not be nested within another message or code list. Explanation: A message or code list may not be nested within a message or code list. User Response: Check your source file for a mistyped or missing end tag, or move the imbedded tag after the previous tag-name end tag. ═══ 5.2.120. EDF212E ═══ Component list nested too deeply, COMPL tag ignored. Explanation: A component list may not be nested more than three levels deep. User Response: Try to redo the component list to reduce the levels of nesting. ═══ 5.2.121. EDF214E ═══ Missing DD tag for previous DT tag. Explanation: A definition description (DD) tag was found without a definition term (DT) tag. User Response: Check your source file for a missing or mistyped DD tag. Make sure there is a DT tag for each DD tag in your source file. ═══ 5.2.122. EDF215W ═══ End tag missing on previous tag-name tag. Explanation: The end tag for the previous tag-name tag is missing. This tag is ignored. User Response: The missing end tag was either mistyped or not entered. Correct the mistyped end tag or insert an end tag. ═══ 5.2.123. EDF217E ═══ macro-name macro requires two operands. Explanation: The macro-name statement must have two operands. User Response: Check the &users. for the valid operands and enter them in your source file. ═══ 5.2.124. EDF219E ═══ Too many operands on macro-name macro. Explanation: The macro-name statement must have two or three operands. User Response: Make sure that multiword operands are enclosed in single quotes. Check the &users. for the valid operands and enter them in your source file. ═══ 5.2.125. EDF220W ═══ Too many GRIDAREA tags in segment -- starting new GRIDSEG. Explanation: There are more GRIDAREA tags in a grid segment than defined by the HUNITS attribute for this grid. A new GRIDSEG is started. User Response: Correct the GRID, GRIDDEF or GRIDSEG tag that defines the HUNITS attributes for this grid or insert a missing GRIDSEG tag. ═══ 5.2.126. EDF221E ═══ Unable to define horizontal units. Explanation: There is not enough room on the page for the horizontal units defined for the GRID or GRIDDEF tags. User Response: Correct the GRID or GRIDDEF tag that defines the HMAX and HUNITS attribute for this grid. ═══ 5.2.127. EDF222E ═══ Missing text on heading tag. Explanation: Text must be specified for an H0 to H20 heading tag, unless the headings are being numbered. User Response: Add the heading text after the heading tag. There are valid attributes you can specify in your heading tag, but remember, the text may not contain any tags. Also, if you are using a style file and want to number your headings, identify the NUMBER attribute value as YES in the ZHEADDEF. ═══ 5.2.128. EDF223E ═══ First INWIDTH operand must be ON or OFF. Explanation: The first operand on INWIDTH specifies whether you want to indent away from (ON) or toward (OFF) the left margin. An INWIDTH statement must have the following operands: .INWIDTH ON]OFF gmltype 'character-string' User Response: Enter a valid statement as described above. Make sure the character-string has been enclosed within single quotes. ═══ 5.2.129. EDF224E ═══ Unknown REFID for IREF tag. Explanation: The IREF tag referred to an ID on an unidentified index entry tag. User Response: This can occur in two situations: o There is a misspelled REFID or a misspelled ID. o An index entry tag was not given an ID. ═══ 5.2.130. EDF225E ═══ LBLBOX does not have a label. Explanation: A label box was specified without text to insert in the label area. A series of question marks is inserted for the label. User Response: Enter the label text following the LBLBOX tag. Remember that the text may not contain tags. ═══ 5.2.131. EDF226W ═══ LEDIHD not lower than LEHD -- LEDIHD set to lower head level. Explanation: The head level value for LEDIHD must be less than the head level value for LEHD. The LEDIHD value was reset to one head level lower than the LEHD value. User Response: Enter a lower heading level value for LEDIHED or readjust the value for LEHD. ═══ 5.2.132. EDF227E ═══ ANSID=id on MATCH tag has no matching choice. Explanation: Each ANSID on a MATCH tag must have an ID on a CHOICE tag to refer to. User Response: Make sure that the id value on the ANSID attribute of the MATCH tag has not been mistyped, or add an ID on a CHOICE tag to be referred to. ═══ 5.2.133. EDF230E ═══ MOD modname not found in side file filename -- continuing processing but results unpredictable. Explanation: As you were creating a DVCF mocha structure, a MOD was specified that doesn't exist in a side file. The MOD name should not match the name of the side file. User Response: The MOD name may have been mistyped or not defined in a side file. Identify and correct the modname. ═══ 5.2.134. EDF231E ═══ Capture symbol longer than 10 characters for NAMECTR macro. Explanation: A capture symbol name cannot exceed 10 characters. The first 10 characters are used as the symbol name and the remaining characters are ignored. User Response: Enter a valid capture symbol name and make sure that all uses of the symbol name have been changed. ═══ 5.2.135. EDF233E ═══ Function for NAMECTR macro invalid or missing. Explanation: The first operand on the NAMECTR macro statement must be the function name. User Response: Enter a valid function name of INCREMENT, PRINT, RESET, DEFINE, or CAPTURE. ═══ 5.2.136. EDF234W ═══ parm invalid on macro-name macro. Explanation: parm is not a valid parameter on the macro-name macro. User Response: Enter a valid parameter for the macro. Refer to your &users for allowed values. ═══ 5.2.137. EDF236E ═══ Symbol name has not been defined for NAMECTR macro. Explanation: The symbol name being used on the SYMBOL attribute of the NAMECTR macro has not been previously defined with the DEFINE function of the NAMECTR macro. User Response: The symbol name may have been mistyped or the DEFINE function was not identified with the NAMECTR macro. ═══ 5.2.138. EDF237E ═══ Symbol name longer than 7 characters on macro-name macro. Explanation: A macro-name symbol may not exceed seven characters nor contain blanks or special characters. Processing continues using the first seven characters to set the symbol name. User Response: Enter a valid symbol name. A valid symbol name is any combination of letters and numbers of seven or fewer characters that do not contain blanks or special characters. If you change a symbol name, be sure to change any symbol values associated with it. ═══ 5.2.139. EDF238W ═══ Page check: stuff on page n on pass n is on page n on pass n. Explanation: There were differences in pagination between the last two formatting passes of the document. This may be caused by extensive cross-referencing. See &users. for proper use of a PGCHECK macro. User Response: Try using one more pass (FPASSES option) to format the document, or use the extended cross reference facility. ═══ 5.2.140. EDF239W ═══ Two column layout for question invalid on multi-column page. Explanation: Questions may have a two-column layout only if the page layout is single column. The question is formatted in the current column. User Response: Either change the LAYOUT attribute for the question, or change the layout for the page. ═══ 5.2.141. EDF240E ═══ No strings on TABRACK macro. Explanation: The width strings on a TABRACK macro statement must be specified. No tab rack is defined. A TABRACK statement must have the following operands: .TABRACK gmltype 'string' 'string'... User Response: Enter one or more character strings on the TABRACK macro. Be sure to enclose each string in single quotes. ═══ 5.2.142. EDF241E ═══ TABRACK macro with no operands ignored. Explanation: The TABRACK statement must have some operands. No tab rack is defined. A TABRACK statement must have the following operands: .TABRACK gmltype 'string' 'string'... User Response: Enter a valid TABRACK statement. Check the &users. for correct use of the TABRACK statement. Be sure to enclose each string within single quotes. ═══ 5.2.143. EDF242W ═══ cw control word used in this document. Explanation: A SCRIPT/VS control word was used which may affect the formatting of this document. This is not a valid BookMaster control word. User Response: Try to find a way to avoid using the control word. ═══ 5.2.144. EDF243I ═══ Explode report suspended. MOD not processed. Section section in file filename. Explanation: This message is for BookMaster development use only. Another message should be received to help isolate the exact error. User Response: Report the error to your system administrator. ═══ 5.2.145. EDF261E ═══ attribute-name month on tag-name tag is wrong: month. Explanation: On the schedule-related tag, the month specified on the indicated attribute of the tag is not a number from 1 to 12. User Response: Specify the correct month on the indicated attribute of the tag. ═══ 5.2.146. EDF262E ═══ attribute-name year on tag-name tag is wrong: year. Explanation: The year specified on the attribute-name attribute of the schedule-related tag is not two numeric digits. User Response: Specify the correct year on the indicated attribute of the tag. ═══ 5.2.147. EDF263E ═══ END year is earlier than START year on tag-name tag. Explanation: The end year on the END attribute is earlier than the start year on the YEAR attribute of the schedule-related tag. User Response: Specify an end year that is the same or later than the start year on the indicated tag. ═══ 5.2.148. EDF264E ═══ attribute-name date is earlier than attribute-name date on tag-name tag. Explanation: On the schedule-related tag, the end date is earlier than the start date. User Response: Specify an end date that is the same or later than the start date on the indicated tag. ═══ 5.2.149. EDF265E ═══ Scheduled months cannot exceed 37 on tag-name tag. Explanation: The number of months from the start date to the end date on the indicated tag cannot exceed 37 in a schedule-related tag. User Response: Specify start and end dates that do not include more than 37 months for the schedule. ═══ 5.2.150. EDF266W ═══ Too many months, schedule chart will print off the column. Explanation: There are too many months to fit within the column of a schedule-related tag. Part of the schedule chart will print off the column. User Response: Do one or more of the following: o Specify WIDTH=PAGE on the SCHEDULE tag. o Scale the size of the schedule down with the SCALE attribute of the SCHEDULE tag. o Reduce the number of months in the schedule with the START and END attributes of the SCHEDULE tag. o Use a document style that has a wider page dimension. ═══ 5.2.151. EDF267W ═══ Missing day on attribute-name attribute of tag-name tag. Explanation: In the schedule-related tag, a day was missing from the indicated attribute of the tag. A day of "1" was used. User Response: Specify a day on the indicated attribute of the tag. ═══ 5.2.152. EDF268E ═══ Missing month on attribute-name attribute of tag-name tag. Explanation: In the schedule-related tag, a month was missing from the indicated attribute of the tag. User Response: Specify a month on the indicated attribute of the tag. ═══ 5.2.153. EDF269E ═══ Missing year on attribute-name attribute of tag-name tag. Explanation: In the schedule-related tag, a year was missing from the indicated attribute of the tag. User Response: Specify a year on the indicated attribute of the tag. ═══ 5.2.154. EDF270W ═══ attribute-name day on tag-name tag is wrong: day. Explanation: The day was wrong on the indicated attribute of the tag for the specified month and year in the schedule-related tag. A day of "1" is used. User Response: Specify a correct day on the indicated attribute of the tag. ═══ 5.2.155. EDF271E ═══ Date given on attribute-name attribute of tag-name tag not on schedule chart. Explanation: The date on the indicated attribute of the tag is not within the start and end dates of the schedule-related tag. User Response: Specify a date that occurs between the start and end dates of the schedule. ═══ 5.2.156. EDF272W ═══ ASTART without AEND for tag-name tag, but today's date is not in schedule. Explanation: There was no actual end date specified on the tag. BookMaster attempted to use the current date as an end date, but found that the current date was not specified within the schedule start and end dates. Therefore current activity could not be shown. User Response: Do one of the following: o Specify an actual end date. o Specify the current date on the CURDATE attribute of the SCHEDULE or SCHDEF tag. ═══ 5.2.157. EDF273W ═══ Today's date is earlier than ASTART date on tag-name tag. Explanation: An attempt to use the current date found that the current date was earlier than the actual start date and therefore could not be used to show current activity. User Response: Do one of the following: o Specify an actual end date on the tag. o Specify an actual start date that is the same as or earlier than today's date. ═══ 5.2.158. EDF990S ═══ The $FNAM profile requires the use of DCF Release 3.2. Explanation: The profile was called using an incorrect version of SCRIPT/VS. User Response: Use the correct SCRIPT/VS module for DCF release 3.2 or above. If you are unsure of the module name, ask your system administrator. ═══ 5.2.159. EDF991S ═══ The $FNAM profile requires EDFLIB20 MACLIB. Explanation: EDFLIB20 macro library was not specified with the SCRIPT LIB option. User Response: Change your command line or options file to identify EDFLIB20 as one of your macro libraries. ═══ 5.3. SCRIPT/VS Messages ═══ SCRIPT/VS Messages Purpose This is an alphabetic listing of the SCRIPT messages by message number. Use the Script options MESSAGE(ID DELAY TRACE) to get a listing of message numners and descriptions stored in a file. Script messages are identified by: DSMxxxnnn s where 'DSM' is the product code for Script, 'xxx' is the Script module that issued the message, 'nnn' is the message number, and 's' is the message's severity. Only the message number and severity are shown here. ═══ 5.3.1. 301 S ═══ INCORRECT FORM OF SCRIPT COMMAND. Explanation: A syntax error was found on the command line between the command and the beginning of the options list (if any). System Action: Processing stops. User Response: Correct the syntax error and reissue the SCRIPT command. ═══ 5.3.2. 302 W ═══ INVALID COMMAND OPTION - `option'. Explanation: The option named on the command line is invalid. System Action: The invalid option and any suboptions or values following it are ignored and processing continues. User Response: Correct the option and reissue the SCRIPT command. ═══ 5.3.3. 303 S ═══ INVALID DEVICE SPECIFIED WITH `DEVICE' OPTION. Explanation: The device type specified with the DEVICE option on the command line is invalid. System Action: Processing stops. User Response: Specify a valid device type and reissue the SCRIPT command. ═══ 5.3.4. 304 S ═══ I/O ERROR ON OUTPUT FILE - RC = nn. Explanation: An I/O error occurred while attempting to write to the formatted output file. nn is the return code from the CMS FSWRITE macro. System Action: Processing stops. User Response: Check the description of possible errors for the CMS FSWRITE macro in the IBM Virtual Machine Facility/370: CMS Command and Macro Reference and correct the problem if possible. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.5. 305 S ═══ UNABLE TO OPEN OUTPUT OR UTILITY FILE `filename filetype filemode' Explanation: An error was indicated by the CMS system during an attempt to create the output file or a system utility file filename filetype filemode. System Action: Processing stops. User Response: Check the indicated filename, filetype, and filemode. An invalid character may have been specified in one of the fields. Correct any errors and reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.6. 306 S ═══ DEVICE ERROR ON PRINTED OUTPUT. Explanation: A device error occurred while attempting to write a record to the output device. System Action: Processing stops. User Response: Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.7. 307 S ═══ LOGICAL DEVICE INCOMPATIBLE WITH OUTPUT DESTINATION. Explanation: Output for the logical device specified in the SCRIPT command cannot be written to the destination specified. System Action: Processing stops. User Response: Reissue the SCRIPT command specifying a destination that is compatible with the logical device. ═══ 5.3.8. 308 S ═══ INVALID SUBOPTION SPECIFIED ON `FPASSES' OPTION. Explanation: The number of formatting passes specified on the FPASSES(n) option of the SCRIPT command is invalid. The number must be greater than zero but not greater than the allowed maximum. The IBM-supplied maximum is 4 unless changed by your installation. System Action: Processing stops. User Response: Specify a valid value and reissue the SCRIPT command. The systems programmer at your installation can change the maximum value. ═══ 5.3.9. 309 S ═══ MORE THAN 16 FILES ACCESSED. Explanation: The total number of files currently being accessed by the formatter has exceeded 16. This total includes the file currently being processed, all files at higher nesting levels, and any files for which processing has been suspended by the .EF control word without the CLOSE parameter. An imbedded file that reaches end-of-file is closed and is not counted as accessed. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Restructure the input document to leave fewer files inactive but still accessed. Use the CLOSE parameter with .EF whenever possible. Reissue the SCRIPT command. ═══ 5.3.10. 310 E ═══ DISALLOWED .DD REDEFINITION. Explanation: A .DD [Define Data File-id] control word, was encountered, but redefinition of the indicated utility file-id is not allowed by the NODDUT command option. System Action: The input line is printed, and an imbed trace is printed if MESSAGE (TRACE) was specified. If the CONTINUE option was specified, the .DD control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Study and evaluate the input source to determine the effect of processing the .DD control word. If the .DD control word is to be processed, reissue the SCRIPT command with the DDUT command option. ═══ 5.3.11. 311 E ═══ UNABLE TO REDEFINE A CURRENTLY ACTIVE FILE. Explanation: An attempt was made to redefine a file (with the .DD [Define Data File-id] control word) that is currently active either as the file being processed or as a file at a higher nesting level. System Action: The input line is printed, and an imbed trace is printed if MESSAGE (TRACE) was specified. If the CONTINUE option was specified, the .DD control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Structure the input document to ensure that a file is the subject of a .DD control word only when the file is inactive. Reissue the SCRIPT command. ═══ 5.3.12. 312 E ═══ MESSAGE DELAY CANCELLED, [DISK `filemode' IS READ-ONLY OR NOT ACCESSED | UTILITY MESSAGE FILE CAN NOT BE OPENED]. Explanation: The MESSAGE(TRACE) option of the SCRIPT command was specified, but the utility file DSMUTMSG cannot be opened because the disk specified is either not accessed or is read-only. System Action: The MESSAGE(TRACE) option is cancelled. If the CONTINUE option was specified, processing continues and all messages are written to the terminal. If the CONTINUE option was not specified, processing stops. User Response: In CMS, the default filemode of the DSMUTMSG file is A1 and can be changed with the .DD control word. Correct the filemode so that an accessed read/write disk is specified, and reissue the SCRIPT command. In TSO, some of the possible causes are: The DD name on the .DD [Define Data File-id] control word does not exist, the data set organization may be incorrect when DSMUTMSG is preallocated, or allocation, de-allocation may have failed. Correct the problem and reissue the SCRIPT command. ═══ 5.3.13. 313 S ═══ DISALLOWED SYSTEM COMMAND. Explanation: The .SY [System Command] control word was encountered, but system command processing is not allowed. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Study and evaluate the input source to determine the effect of processing the system command. If the system command is to be processed, reissue the SCRIPT command with the SYON command option. ═══ 5.3.14. 314 W ═══ UNABLE TO EXECUTE .SY COMMANDS - `STACK' RC = nn. Explanation: An error occurred while attempting to pass the command lines that were specified on .SY [System Command] control words to the TSO system. nn is the TSO stack service routine return code. System Action: No commands are passed and processing continues. User Response: Check the description of possible errors for the TSO STACK macro in the OS/VS2 TSO Guide to Writing a Terminal Monitor Program or a Command Processor. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.15. 315 S ═══ I/O ERROR ON DATA SET `ddname'. Explanation: An error occurred while attempting to open or write to the data set ddname. System Action: Processing stops. User Response: Check the JCL listing for error indications and correct any that appear. In particular, ensure that there is a DD statement for the data set. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.16. 316 S ═══ `BIND' OPTION SPECIFIED INVALID SPACE UNITS. Explanation: Either the space units specified as parameters with the BIND option were invalid, or a numeric parameter exceeded the arithmetic capability of SCRIPT/VS when it was converted to device units. System Action: Processing stops. User Response: Correct the invalid specification. Ensure that the value specified is not too large to be converted to device units. Reissue the SCRIPT command. ═══ 5.3.17. 317 S ═══ DISK `filemode' IS READ-ONLY OR NOT ACCESSED. Explanation: While attempting to create the output file on disk or a system utility file, it was found that the filemode specified a disk that was read-only or not accessed. System Action: Processing stops. User Response: Check the filemode of the file specified with the FILE option and any .DD [Define Data File-id] control words for the system utility files. Correct any filemode that may have caused the problem, ensure that all required disks are accessed, and reissue the SCRIPT command. ═══ 5.3.18. 318 I ═══ UNABLE TO READ FILEID ASSIGNED TO TERMINAL. Explanation: An attempt was made to imbed or append a file that had been assigned (with the .DD [Define Data File-id] control word) to the terminal. System Action: Message 520 will always follow. The input line is printed and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: The .TE [Terminal Input] control word should be used to imbed a file from the terminal. Correct any misuse of the .DD control word and reissue the SCRIPT command. ═══ 5.3.19. 319 R ═══ OUTPUT FILE `filename filetype filemode' ALREADY EXISTS - Explanation: The output file filename filetype filemode specified with or implied by the FILE option of the SCRIPT command already exists. This message will be followed by message 320. System Action: Message 320 is issued to ask the user whether the file should be erased or if processing should be stopped. User Response: Reply to message 320. ═══ 5.3.20. 320 R ═══ ENTER "E" TO ERASE IT AND CONTINUE, OR "Q" TO QUIT. Explanation: The output file specified with or implied by the FILE option of the SCRIPT command already exists. You can cancel the formatting job if you wish. System Action: If the reply is E, processing continues and the new file replaces the existing one. If the reply is Q, processing stops. User Response: Reply E if the existing file should be replaced with the new one. Reply Q to halt processing and retain the existing file. Note: The old Y and N forms of response are still acceptable. ═══ 5.3.21. 321 I ═══ DSORG OF FILE `filename' IS INCORRECT. Explanation: An attempt was made to imbed or append the file filename with an incorrect data set organization. This occurs when a member is specified for a sequential data set or when no member is specified for a partitioned data set. System Action: Message 334, 337, or 520 follows. User Response: Ensure that the data set name specified on the command line or with a .DD control word agrees with the data set organization of the existing file. ═══ 5.3.22. 322 S ═══ ILLEGAL USE OF IMPLIED DSNAME WITH `FILE' OPTION. Explanation: The FILE option was specified without a data set name, but the rightmost qualifier of the primary input document is not text. System Action: Processing stops. User Response: Specify an explicit data set name with the FILE option and reissue the SCRIPT command. ═══ 5.3.23. 323 I ═══ STARTING PASS n OF x. Explanation: The next formatting pass has begun. The pass being started is pass n of x total passes. This message is useful in determining which messages were generated during each pass. If the MESSAGE option is specified with the DELAY parameter (which is the default in background systems) and no other messages are generated, this message is suppressed. System Action: Processing continues. User Response: None. ═══ 5.3.24. 324 E ═══ UNABLE TO ACCESS MACRO/SYMBOL LIBRARY. Explanation: An error occurred while attempting to open the macro/symbol library. System Action: If the CONTINUE option was specified, processing continues although all references to macros and symbols that reside in the library are unresolved. If the CONTINUE option was not specified, processing stops. User Response: Ensure that proper file names are specified for the LIB option and reissue the SCRIPT command. If the LIB option was not explicitly used, report the problem to the systems programmer at your installation. ═══ 5.3.25. 325 S ═══ DSORG OF UTILITY FILE `file-id' CONFLICTS WITH EXISTING DATA SET. Explanation: The data set organization specified with the .DD [Define Data File-id] control word for the system utility file file-id differs from an existing data set with the same name. Either a member was specified for a sequential data set, or none was specified for a partitioned data set. System Action: Processing stops. User Response: Correct the .DD control word to match the existing data set or delete the existing data set. Reissue the SCRIPT command. ═══ 5.3.26. 326 W ═══ TOO MANY PARAMETERS SPECIFIED FOR `option'. Explanation: The command option named was specified with extraneous parameters. System Action: The extraneous parameters are ignored and command analysis continues. User Response: Correct the parameters. Reissue the SCRIPT command if desired. ═══ 5.3.27. 327 W ═══ PARAMETER(S) MUST BE SPECIFIED FOR `option'. Explanation: The command option named requires at least one parameter, and no parameters were found. System Action: The command option is ignored and processing continues. User Response: Provide the required parameter(s). Reissue the SCRIPT command if desired. ═══ 5.3.28. 328 W ═══ RIGHT PARENTHESIS ASSUMED FOLLOWING `aaaa'. Explanation: Following the characters aaaa in the command line, valid syntax requires a right parenthesis and none was found. This may have been caused by other command option errors. System Action: A right parenthesis is inserted and command analysis continues. User Response: Correct any command line errors. Reissue the SCRIPT command if desired. ═══ 5.3.29. 329 W ═══ EXTRANEOUS LEFT PARENTHESIS BEGINNING AT `aaaa'. Explanation: An extraneous left parenthesis precedes the characters aaaa in the command line. This may be indicative of other command option errors. System Action: The parenthesis is ignored and command analysis continues. User Response: Correct any command option errors. Reissue the SCRIPT command if desired. ═══ 5.3.30. 330 W ═══ INVALID PARAMETERS FOUND IN `optionlist'. Explanation: In the command line, the option preceding optionlist requires only certain keyword parameters and a specified parameter was not one of the recognized keywords. System Action: The invalid parameter is ignored and command analysis continues. User Response: Correct the invalid keyword parameter. Reissue the SCRIPT command if desired. ═══ 5.3.31. 331 W ═══ INVALID SYSVAR SPECIFICATION - `parameterlist'. Explanation: The parameterlist following the SYSVAR command option was found to have unpaired parameters or the first in a pair of parameters was not a single character. System Action: The invalid parameters are ignored and processing continues. User Response: Correct the invalid parameters and reissue the SCRIPT command if desired. ═══ 5.3.32. 332 E ═══ UNABLE TO ASSIGN FILE-ID TO DATA SET. Explanation: An attempt was made to assign (with the .DD [Define Data File-id] control word) a file-id to a preallocated ddname, and that ddname had not been allocated. System Action: The input line is printed and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the .DD control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct any typographical errors on the .DD control word or use the TSO ALLOCATE command to preallocate the ddname and reissue the SCRIPT command. ═══ 5.3.33. 333 W ═══ COMMAND OPTIONS FILE `filename filetype filemode' NOT FOUND. Explanation: The file filename filetype filemode, specified as a parameter with the OPTIONS option, could not be found. System Action: The OPTIONS option is ignored and processing continues. User Response: Correct the name of the file or ensure that the specified file is accessible at the time the command is issued. Reissue the SCRIPT command. ═══ 5.3.34. 334 E ═══ UNABLE TO FIND REQUESTED PROFILE. Explanation: The file specified as a parameter with the PROFILE option could not be found. System Action: If the CONTINUE option was specified, the PROFILE option is ignored and processing continues with no profile document. If the CONTINUE option was not specified, processing stops. User Response: Correct the name of the file or ensure that the specified file is accessible at the time the command is issued. Reissue the SCRIPT command. ═══ 5.3.35. 335 S ═══ SEARCH OR MACRO/SYMBOL LIBRARY IS NOT A PDS. Explanation: An attempt was made to access the data set specified with the SEARCH or LIB option and that data set did not have partitioned organization. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Specify a partitioned data set with the SEARCH or LIB option and reissue the SCRIPT command. If neither option was specified explicitly, report the problem to the systems programmer at your installation. ═══ 5.3.36. 336 S ═══ UNABLE TO ALLOCATE OUTPUT FILE. Explanation: An error occurred or an incompatibility was found while attempting to allocate the output file. System Action: Processing stops. User Response: If the FILE command option specified an existing data set (either implicitly or explicitly), check the data set's record format (RECFM). If the document is being formatted for a printer device, the record format must be FM, FBM, VM, or VBM. For terminal devices the record format must be F, FB, V, or VB. If the record format is in error, correct it or specify a different data set with the FILE option. Reissue the SCRIPT command. When the FILE option is used in an OS/VS2 MVS environment, and the Document Library Facility is installed, the primary document name must be different from the DD statement name referred to in the FILE option. If the record format is not in error, report the problem to the systems programmer at your installation. ═══ 5.3.37. 337 S ═══ TERMINAL INPUT FILE NOT FOUND. Explanation: An attempt was made to read from the terminal after file-id DSMTERMI had been assigned (with the .DD [Define Data File-id] control word) to a file, and that file could not be found. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Correct any typographical errors on an earlier .DD control word for DSMTERMI and ensure that the file is accessible. Reissue the SCRIPT command. ═══ 5.3.38. 338 S ═══ UNABLE TO OPEN TERMINAL OUTPUT FILE. Explanation: An attempt was made to write to the terminal after file-id DSMTERMO had been assigned (with the .DD [Define Data File-id] control word) to a disk file, and an error occurred while attempting to open that file for output. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Ensure that DSMTERMO was not currently open for input and that a valid filename was specified for it on the .DD control word. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.39. 339 W ═══ `fileid' CAN NOT BE REDEFINED WHILE IT IS OPEN FOR OUTPUT. Explanation: An attempt was made to assign a utility file fileid to a disk file (with the .DD [Define Data File-id] control word), and the file was already open for output. This utility file remains open. If fileid is DSMUTDIM, it will remain open for output from the point that a .DI control word is encountered until the next page eject is effected. System Action: The control word .DD is ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Move the .DD control word in the document so that it will not be encountered while the utility file is open. Reissue the SCRIPT command. ═══ 5.3.40. 340 W ═══ `DSMUTTOC' CAN NOT BE REDEFINED WHILE IT IS OPEN. Explanation: An attempt was made to assign the file-id DSMUTTOC to a disk file (with the .DD [Define Data File-id] control word), and the file was already open for output. This utility file (DSMUTTOC) is opened at the first occurrence of a .PT control word (perhaps through use of .H0 - .H6). System Action: The .DD control word is ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: If it is desirable to assign DSMUTTOC to a particular file, it must be done before the first use of this file. Move the .DD control word to a point earlier in the document and reissue the SCRIPT command. ═══ 5.3.41. 341 E ═══ UNABLE TO CONTINUE READING INPUT FILE - RC = nn. Explanation: An error return was received from the CMS system while attempting to read the current file. nn is the return code from the CMS FSREAD macro. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Check the description of possible errors for the CMS FSREAD macro in the IBM Virtual Machine Facility/370: CMS Command and Macro Reference and correct the problem if possible. In particular, ensure that the .SY control word has not been used to erase the file. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.42. 342 S ═══ FORMATTER REQUIRED FOR THE SPECIFIED DEVICE IS NOT LOADED. Explanation: The device type specified with the DEVICE option requires a function that is not part of the generated SCRIPT/VS system. System Action: Processing stops. User Response: Specify a device type appropriate for the SCRIPT/VS system in use. Reissue the SCRIPT command. ═══ 5.3.43. 343 W ═══ UNABLE TO OPEN UTILITY MESSAGE DATA SET. Explanation: An error occurred while attempting to open the utility message file, DSMUTMSG, for output. System Action: Processing continues with all messages being output to DSMLIST. User Response: Check the JCL listing for error indications and correct any that appear. In particular, ensure that there is a DD statement for the data set. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.44. 344 S ═══ service routine REQUESTED SERVICE NOT AVAILABLE. Explanation: The host services routine for the requested service is not available. System Action: Processing stops. User Response: Issue the correct command; the option you are using is not supported by the host system. ═══ 5.3.45. 345 E ═══ INVALID DATA SET NAME FOUND ON .DD CONTROL WORD. Explanation: A .DD [Define Data File-id] control word with the DSN parameter specified an invalid data set name. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the .DD control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the data set name specification and reissue the SCRIPT command. ═══ 5.3.46. 346 S ═══ DATA SET IS SEQUENTIAL. Explanation: An included member name and a data set name are in conflict. The given data set name included a member name, indicating that the data set is partitioned. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Reformat the document specifying the correct form of the data set name. Reissue the SCRIPT command. ═══ 5.3.47. 347 S ═══ DATA SET IS PARTITIONED. Explanation: An included member name and a data set name are in conflict. The given data set name did not include a member name, indicating that the data set is sequential. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Reformat the document specifying the correct form of the data set name. Reissue the SCRIPT command. ═══ 5.3.48. 348 W ═══ UNABLE TO LOAD REQUIRED DICTIONARY name - RC = nn. Explanation: The dictionary name, specified with the .DL [Dictionary List] control word, cannot be found in the text library specified with the TLIB option of the SCRIPT command returned by the system from the LOAD command. nn is the return code returned by the system from the LOAD command. System Action: Processing continues without loading the dictionary. User Response: Correct the dictionary name specified on the .DL control word or the TLIB option. Reissue the SCRIPT command. ═══ 5.3.49. 349 E ═══ UNABLE TO ACCESS TEXT LIBRARY. Explanation: The CMS text library used for spelling verification and hyphenation could not be located. System Action: If the CONTINUE option was specified, processing continues even though references to programs or dictionaries in the missing text library are unresolved. If the CONTINUE option was not specified, processing stops. User Response: Ensure the proper library names are specified for the TLIB option and reissue the SCRIPT command. If the TLIB option was not explicitly used, report the problem to the system programmer at your installation. ═══ 5.3.50. 351 S ═══ DATA SET dsname NOT RESOLVED, SYSTEM ERROR+. Explanation: An unexpected return code was received from the default service routine while attempting to fully qualify the indicated data set name. System Action: Processing stops. User Response: Report the problem to the systems programmer at your installation. ═══ 5.3.51. 352 S ═══ `DEFAULT ROUTINE' - RC = nn. Explanation: This message gives the return code nn received from the default service routine that caused message 351. System Action: Processing stops. User Response: Ensure the proper library names are specified for the TLIB option and reissue the SCRIPT command. If the TLIB option was not explicitly used, report the problem to the system programmer at your installation. ═══ 5.3.52. 354 S ═══ DATA SET dsname IS SEQUENTIAL BUT A MEMBER NAME WAS SPECIFIED. Explanation: The indicated data set dsname is sequential, but a member was specified for it when referenced on the command line. System Action: Processing stops. User Response: Specify the correct data set name. Reissue the SCRIPT command. ═══ 5.3.53. 355 S ═══ DATA SET dsname IS PARTITIONED BUT NO MEMBER NAME WAS SPECIFIED. Explanation: The indicated data set dsname is partitioned, but a member name was not specified for it when referenced on the command line. System Action: Processing stops. User Response: Specify the correct data set name and member. Reissue the SCRIPT command. ═══ 5.3.54. 356 S ═══ DSORG OF DATA SET dsname IS NOT SEQUENTIAL OR PARTITIONED. Explanation: The indicated data set dsname has an organization other than sequential or partitioned and cannot be accessed. System Action: Processing stops. User Response: Specify the correct data set name and reissue the SCRIPT command. ═══ 5.3.55. 357 S ═══ DATA SET dsname NOT FOUND IN CATALOG+. Explanation: The indicated data set dsname was not found in the catalog and was specified as an input data set on the command line. System Action: Processing stops. User Response: Specify the correct data set name or catalog the desired data set. Reissue the SCRIPT command. ═══ 5.3.56. 358 S ═══ `LOCATE' RC = nn. Explanation: This message gives the return code nn received from the LOCATE macro that caused message 357. System Action: Processing stops. User Response: Correct the problem indicated by message 357. Reissue the SCRIPT command. ═══ 5.3.57. 359 S ═══ DATA SET dsname NOT FOUND ON VOLUME+. Explanation: The indicated data set dsname was not found on the volume specified by the catalog. System Action: Processing stops. User Response: Ensure that the data set is correctly cataloged. Reissue the SCRIPT command. ═══ 5.3.58. 360 S ═══ `OBTAIN' RC = nn. Explanation: This message gives the return code nn received from the OBTAIN macro that caused message 359. System Action: Processing stops. User Response: Correct the problem indicated by message 359. Reissue the SCRIPT command. ═══ 5.3.59. 361 S ═══ COMMAND LINE EXCEEDS 255 CHARACTERS. Explanation: The command line exceeds 255 characters. System Action: Processing stops. User Response: Before reissuing the SCRIPT command, ensure that the total length of the command line, including blanks, does not exceed 255 characters. ═══ 5.3.60. 363 T ═══ I/O ERROR: `cuu,dev-type,ddname,op, error,loc,acc-meth'. Explanation: An I/O error occurred. The error message gives the following information: cuu is the address of the failing device dev-type is the failing device type ddname specifies the failing DD name op indicates the operation requested error is the system generated description of the error loc for a direct access device, specifies the disk address of the failing record (BBCCHHR); for a tape, specifies the relative block number (in decimal) of the failing physical record; for a unit record device, asterisks are given acc-meth: specifies the name of the access method. The information contained in this message is extracted from the message buffer generated by the MVS SYNADAF macro. For further explanation of the field contents see the description of the SYNADAF macro in OS/VS2 MVS Data Management Macro Instructions, (GC26-3873). System Action: Processing stops. User Response: Correct the problem causing the I/O error. Reissue the SCRIPT command. ═══ 5.3.61. 364 S ═══ UNABLE TO LOAD REQUIRED MODULE: `modulename'. Explanation: An unsuccessful attempt was made by SCRIPT/VS to load modulename. System Action: Processing stops. User Response: Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.62. 365 S ═══ UNABLE TO IMBED/APPEND CURRENTLY ACTIVE FILE `filename'. Explanation: User attempted to imbed or append a file filename that was already active on the imbed stack. System Action: Processing stops. An imbed trace is printed, if MESSAGE(TRACE) was specified. User Response: Remove the imbed or append of the file that is causing the error. If necessary, use the .IT [Input Trace] control word to locate and identify the file causing the error. Reissue the SCRIPT command. ═══ 5.3.63. 368 S ═══ MIXED PATTERN TECHNOLOGY IDS NOT ALLOWED Explanation: The specified font library contains fonts with mixed pattern technology IDs, when the current output device requires that only one pattern technology ID be used for all fonts. System Action: Processing stops. User Response: Rerun the Font Library Index program on font objects of only one pattern technology id. ═══ 5.3.64. 369 S ═══ FONT OBJECT STRUCTURED FIELDS IN `fontname' NOT IN REQUIRED SEQUENCE. Explanation: The structured fields in a font object specified as fontname were not in the required order. System Action: Processing stops. User Response: Verify that the named font object is valid before reformatting the document. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.65. 370 S ═══ I/O ERROR READING FONT LIBRARY MEMBER membername. Explanation: An I/O error occurred while reading a member membername of the font library. System Action: Processing stops. User Response: Verify that the font library is intact and that the named member is valid before reissuing the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.66. 371 S ═══ FONT LIBRARY NOT FOUND OR INVALID. Explanation: The font library specified with the FONTLIB option of the SCRIPT command either does not exist or exists, but does not have an acceptable format. System Action: Processing stops. User Response: Verify the font library exists and is valid. Ensure the font library contains a valid DCFINDEX member. For PostScript devices, ensure the keyword `DCFINDEX' is the first record in the DCFINDEX file. ═══ 5.3.67. 372 E ═══ FONT LIBRARY MEMBER `membername' NOT FOUND. Explanation: A member of the font library could not be found. System Action: If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: If the membername was specified with the CHARS option or the .DF [Define Font] control word, correct any misspellings and reformat the document. If formatting for a PostScript device, ensure that the necessary codepage and AFM files reside in the font library. If formatting for a page printer and the member name was contained in a coded font section, report the problem to the systems programmer at your installation. ═══ 5.3.68. 373 S ═══ FONT LIBRARY FORMAT IS INVALID. Explanation: The font library specified with the FONTLIB option of the SCRIPT command does not have the proper data set attributes. System Action: Processing stops. User Response: Verify that the font library exists and is a partitioned data set before reissuing the SCRIPT command. ═══ 5.3.69. 374 E ═══ INVALID FONT LIBRARY MEMBER `membername'. Explanation: When formatting for a page printer, a required structured field was not found in the specified library member membername. When formatting for a PostScript device, this message can be issued when invalid data is detected in an Adobe Font Metrics (AFM) file or codepage file. The AFM file could contain nonnumeric values where numeric values are required or required font information could be missing from the AFM file. This message can also be issued when a PostScript codepage file contains a character identifier that does not begin in column 4 or a character identifier that does not contain a codepoint between hexadecimal 00 and hexadecimal FF in columns 1-2. System Action: If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: If the member name was specified with the CHARS option or the .DF [Define Font] control word, check for and correct any misspelling. Reissue the SCRIPT command. If formatting for a page printer and the member name was contained in a coded font section, report the problem to the systems programmer at your installation. If formatting for a PostScript device, verify that the file follows the AFM Interchange Format as defined by Adobe Systems. Ensure that the values specified on the key words are appropriate for the key: numeric, string, or Boolean. Ensure that the codepage file contains codepage values in the range from hexadecimal 00 to hexadecimal FF in columns 1-2 and a character identifier beginning in column 4. ═══ 5.3.70. 375 E ═══ FONT INVALID FOR OUTPUT DEVICE. Explanation: The font specified is not valid for the output device. System Action: If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Reissue the SCRIPT command, specifying a valid font. ═══ 5.3.71. 376 E ═══ FONT DEFAULT CHARACTER NOT IN CODED FONT SUBSECTION. Explanation: The font default character specified in the codepage is not in the coded font subsection. System Action: If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: The codepage is determined by: 1. The font specification if .DF with the FONT option was used to define the font 2. The CODEPAGE parameter of the .DF control word 3. The current font if .DF with type options but no codepage option was used to define the font. In item 2 or 3, ensure that a codepage that is compatible with the coded font subsection is specified and reissue the SCRIPT command. In item 1 report the problem to the systems programmer at your installation. ═══ 5.3.72. 378 S ═══ NO `DCFINDEX' MEMBER IN FONT LIBRARY. Explanation: The font library does not contain a DCFINDEX member. System Action: Processing stops. User Response: Ensure that the correct library was specified with the FONTLIB option of the SCRIPT command. If it was, then rerun the Font Library Index Program. ═══ 5.3.73. 379 E ═══ CODEPAGE codepagename DOES NOT MATCH FONT fontname. Explanation: A character was found in the codepage codepagename that does not match any of the entries in the font fontname. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the correct codepage and font description have been used. Reissue the SCRIPT command. ═══ 5.3.74. 381 E ═══ REQUESTED CHARACTER ROTATION NOT AVAILABLE IN FONT `fontname'. Explanation: The character rotation requested is not available in the requested font fontname. The character rotation was requested explicitly with a subparameter on the TYPE parameter of the .DF control word; or implicitly, but using the current character rotation (character rotation was not specified). System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Look in your font listing, see what character rotations are available with your desired font, and use only those character rotations. ═══ 5.3.75. 382 E ═══ UNABLE TO RESTORE REQUESTED FONT, ORIENTATION IS INCORRECT. Explanation: A .PF [Previous Font] control word was specified, but the font to be restored has a different orientation than that of the current area. This can occur when the .PF specified within a rotated area attempts to restart a font that was in effect outside the area and does not have the same orientation as the area. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option is specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check that there are only as many .PF [Previous Font] control words in an area as you have .BF [Begin Font] control words. ═══ 5.3.76. 384 W ═══ MISSING AFM FILE NAME IN DCFINDEX FOR TYPEFACE, typeface family name. Explanation: Column 46 of the PostScript DCFINDEX file is blank. No AFM filename is associated with the typeface family name in the DCFINDEX record. System Action: Processing continues. The DCFINDEX record containing the error will not be processed. User Response: Report the problem to the font administrator or systems programmer. ═══ 5.3.77. 385 W ═══ DCFINDEX CONTAINS INVALID WIDTH OR WEIGHT FOR TYPEFACE, typeface family name. Explanation: The PostScript DCFINDEX file contains invalid data for the width or weight attributes. Valid values are 1-9 or blank. System Action: Processing continues. If invalid width was specified, the default of normal is used. If invalid weight was specified, the default of medium is used. User Response: Report the problem to the font administrator or systems programmer. ═══ 5.3.78. 389 T ═══ APPARENT BRANCH TO LOCATION 0 FROM OFFSET X`nnnn' IN ROUTINE `DSMxxxxx'. Explanation: This message follows message 396 if the program interrupt occurred in low storage and it seems likely that the interrupt resulted from a branch to location 0 from within a formatter module. X`nnnn' is the offset of the branch within module DSMxxxxx. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Report the problem to your IBM support center representative. ═══ 5.3.79. 390 T ═══ ERROR MAY HAVE ORIGINATED IN ROUTINE `DSMxxxxx'. Explanation: This message follows message 396 if the program interrupt occurred in an area not within a formatter module, but the last formatter module to execute, DSMxxxxx, was the indicated module. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Report the problem to your IBM support center representative. ═══ 5.3.80. 391 I ═══ FORMATTING ENDED BY MESSAGE `messagetext'. Explanation: A message messagetext was issued which caused processing to stop, but the MESSAGE option had been specified with the DELAY parameter. Message 391 appears at the terminal while all other messages, including the message causing the stop, go to the same destination as the formatted output. System Action: If the destination for formatted output is other than the terminal, processing stops immediately. If output is coming to the terminal, processing stops only after all messages have been displayed. User Response: Correct the error that caused the stop. Reissue the SCRIPT command. ═══ 5.3.81. 392 T ═══ ERROR OCCURRED AT OFFSET X`nnnn' IN ROUTINE `DSMxxxxx'. Explanation: This message follows message 396 if the program interrupt occurred at offset X`nnnn' within a formatter module named DSMxxxxx. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Report the problem to your IBM support center representative. ═══ 5.3.82. 395 I ═══ `file-id' LINE nnnn: inputtext. Explanation: This message is displayed after another message to indicate the line on which an error was found. This message gives the file identification file-id, the line number nnnn, and the entire text of the input line inputtext. System Action: As indicated by preceding message. User Response: Correct the problem indicated by the preceding message. Reissue the SCRIPT command. ═══ 5.3.83. 396 I ═══ PROGRAM INTERRUPT HAS OCCURRED. OLD PSW = xxxxxxxx xxxxxxxx. Explanation: A program interrupt occurred, and the NOSPIE option was not specified. The program status word xxxxxxxx xxxxxxxx is given. System Action: Message 389, 390, or 392 follows. User Response: Report the problem to your IBM support center representative. ═══ 5.3.84. 397 I ═══ `file1' WAS IMBEDDED AT LINE nnnn OF `file2'. Explanation: This message is one line of the imbed trace that can be obtained after some messages. It indicates the line nnnn at which the file file1 was nested in the file file2. System Action: As indicated for the original message. User Response: Correct the problem indicated by the original error message. Reissue the SCRIPT command. ═══ 5.3.85. 400 T ═══ UNRECOVERABLE PROGRAM ERROR IN routinename. Explanation: An unrecoverable program error was encountered in the indicated routine during formatting. routinename is the name of the failing routine. System Action: Processing stops. User Response: Report the problem to your IBM support center representative. ═══ 5.3.86. 401 W ═══ COLUMN BALANCING OVERFLOWED xxx LINE(S) ON PAGE n. Explanation: Column balancing put xxx more lines than would fit in the column on page n. System Action: Processing continues. User Response: Report the problem to your IBM support center representative. ═══ 5.3.87. 402 T ═══ UNRECOVERABLE PROGRAM ERROR IN routinename. Explanation: An unrecoverable program error was encountered in the indicated routine during formatting. routinename is the name of the failing routine. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Report the problem to your IBM support center representative. ═══ 5.3.88. 403 S ═══ FPASSES VALUE EXCEEDS MAXIMUM OF xxx. Explanation: The number of formatting passes specified on the FPASSES(n) option of the SCRIPT command is greater than the allowed maximum xxx. The IBM-supplied maximum is 4 unless changed by your installation. System Action: Processing stops. User Response: Either specify a value equal to or less than the maximum value at your installation or have the systems programmer at your installation change the maximum value. ═══ 5.3.89. 404 W ═══ INDEX SORT LANGUAGE ALREADY SPECIFIED. Explanation: An attempt was made to specify the .DL [Dictionary List] INDEX control word when the index sort language was already defined. System Action: The .DL INDEX control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: If the .DL INDEX control word is specified more than once, delete all but one of the .DL INDEX control words. If a .PI [Put Index] control word precedes the .DL INDEX control word, move the .DL INDEX control word ahead of the .PI control word. Reissue the SCRIPT command. ═══ 5.3.90. 440 W ═══ MINPT PLUS MAXPT EXCEEDS MINWORD. Explanation: Processing of the control word would have caused .HY MAXPT plus .HY MINPT to exceed .HY MINWORD. System Action: The MINWORD, MAXPT, or MINPT value is not changed. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Use either a larger MINWORD value or a smaller MAXPT or MINPT value. Reissue the SCRIPT command. ═══ 5.3.91. 441 W ═══ HORIZONTAL DISPLACEMENT FOR TABLE PLUS WIDTH OF [TABLE|ROW] IS TOO LARGE. Explanation: An attempt was made to start a table or row when the sum of the width of the table or row, plus the table displacement, plus the current margin value (page margin and adjust margin) is larger than the current page-width value. System Action: The values are unchanged and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either increase the page width or decrease the table width, row width, table displacement, page margin, or adjust margin value. Reissue the SCRIPT command. ═══ 5.3.92. 442 E ═══ COMPOSITE ROTATION `xxx' NOT ALLOWED FOR LOGICAL DEVICE `zzz'. Explanation: An attempt was made to rotate a table, cell, or named area that results in the composite rotation xxx that is not allowed for device zzz. System Action: A rotation of zero is used. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either change the cell, table, or named area definition to request a different rotation or change the page rotation so the composite rotation is allowed for device zzz. Reissue the SCRIPT command. ═══ 5.3.93. 443 W ═══ ENDING CURRENT TABLE TO START THE NEW ONE. Explanation: An attempt was made to start a new table before ending the current table. System Action: The current table is ended, and the new one is started. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: End the previous table before starting the new one. Reissue the SCRIPT command. ═══ 5.3.94. 444 E ═══ [TABLE|ROW] NOT ACTIVE, CONTROL WORD IGNORED. Explanation: An attempt was made either to start a row, table header, or table footer when no table was active or to start a cell when no row was active. System Action: The control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that you start the table before the row, table header, or table footer. Also ensure that you start the row before the cell. This problem may also occur if a prior table or row was not ended. Reissue the SCRIPT command. ═══ 5.3.95. 445 S ═══ RESULTANT CELL WIDTH IN ROW TOO SMALL. Explanation: A cell in a table is too small for anything to fit in it. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Increase the width of either the cell or the row. If you are using proportional width cells, ensure that you have allowed enough space for them. Reissue the SCRIPT command. ═══ 5.3.96. 446 W ═══ CANNOT PLACE ANYTHING BETWEEN CELLS OR ROWS IN TABLE - object ENDED. Explanation: An attempt was made to place text, a rule, horizontal or vertical white space, or a page segment in an object when a cell or a row is not active. The objects are: o Table o Table header o Table footer System Action: If the object is a table, the table is ended and the text, rule, white space, or page segment is processed. If the object is a table header or table footer, the text, rule, white space, or page segment is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues. User Response: Either end the table or start a row and cell. Then enter text, rule, white space, or the page segment. This problem may also occur if a prior table or row was not ended. Reissue the SCRIPT command. ═══ 5.3.97. 447 E ═══ INVALID SPECIFICATION ON ARRANGE PARAMETER. Explanation: The values specified for the ARRANGE parameter on the .TD [Table Definition] control word are incorrect. An attempt was made to: o Use a different number of ARRANGE values on different lines of the arrangement o Create a cell that is not rectangular o Use the same cell number for more than one cell in an arrangement o Specify more than 64 values in one line of the arrangement. System Action: The control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Enter the correct ARRANGE parameter values. Reissue the SCRIPT command. ═══ 5.3.98. 448 W ═══ TOO MANY CWIDTHS VALUES, EXTRA VALUES IGNORED. Explanation: More CWIDTHS values than needed are specified on the .TD [Table Definition] control word. This message will also occur if more than 64 CWIDTHS values (the maximum) were specified. System Action: The extra CWIDTHS values are ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Enter the correct number of CWIDTHS values. Reissue the SCRIPT command. ═══ 5.3.99. 449 E ═══ CELL `n' DOES NOT EXIST IN ROW `rowname'. Explanation: An attempt was made to define a (.TD [Table Definition]) or start a (.TA [Table]) cell n in row rowname when the cell does not exist in that row. System Action: The control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Enter either the correct cell number or the correct row name. Reissue the SCRIPT command. ═══ 5.3.100. 450 W ═══ TABLE HEADER AND FOOTER TOO LARGE ON PAGE n - IGNORED. Explanation: The combined depth of the table header and footer is so large that nothing else can fit on page n. System Action: The table header and footer are omitted on this page and processing continues. An imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either decrease the depth of the table header or the table footer, or increase the page length. Reissue the SCRIPT command. ═══ 5.3.101. 451 W ═══ TABLE SPLIT ON PAGE n. Explanation: The table was split on page n, because a portion of the table defined to fit a single page would not fit on a single page. System Action: The table is split, placing as much as will fit on the current page. The table footer is not placed on the current page. The rest of the table, without the table header, is placed starting on the next page. An imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues. User Response: Either change the dimensions of the page or the size of the table, or use the SPLIT parameter on the .TA ROW control word. Reissue the SCRIPT command. ═══ 5.3.102. 452 W ═══ TEXT OVERLAP IN ROTATED CELL `n'. Explanation: The text for rotated cell n is too deep and overlaps another cell in the table. System Action: The cell is formatted as specified. The printed text may overflow into an adjacent cell, flow out of the table, or exceed the page boundary. An imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues. User Response: Either make the cell larger by increasing the CWIDTHS value or changing the rotation of the cell, or decrease the amount of text in the cell. Reissue the SCRIPT command. ═══ 5.3.103. 453 W ═══ WIDTH OF ROTATED ROW OR TABLE TOO LARGE FOR PAGE. Explanation: During an attempt to start a row or table (in a table that is rotated either 90 or 270 degrees), it was determined that the width of the table or row is larger than the available vertical space. The available vertical space is the page length minus the top margin, the bottom margin, the running heading, and the running footing. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues using the values as specified. User Response: Either increase the available vertical space or decrease the row or table width. Reissue the SCRIPT command. ═══ 5.3.104. 454 W ═══ .TD CONTROL WORD NOT ALLOWED WHEN TABLE IS ACTIVE - IGNORED. Explanation: An attempt was made to redefine a table, row, or cell with the .TD [Table Definition] control word while a table is active. System Action: The .TD control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues. User Response: Either move the .TD control word outside the table or end the table before changing the definition with a .TD control word. Reissue the SCRIPT command. ═══ 5.3.105. 455 W ═══ OBJECT TOO DEEP FOR FOOTNOTE ON PAGE n - DISCARDED. Explanation: An attempt was made to include a non-splittable object in a footnote such that the footnote could not fit on page n. System Action: The footnote is printed on page n without the object. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing continues. User Response: Either make the discarded object smaller or make the page length larger. Reissue the SCRIPT command. ═══ 5.3.106. 457 W ═══ INVALID CHARACTERS IN WORDS: wordlist Explanation: An attempt was made to add one or more words that contain invalid characters to the dictionary. The words with invalid characters are listed in wordlist. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The words are not added to the dictionary and processing continues. User Response: Correct the words. Reissue the SCRIPT command if desired. ═══ 5.3.107. 458 S ═══ TRS SYSTEM ERROR - RC = nn. Explanation: The text review subsystem was unable to process a request due to a program error. nn is the return code. System Action: Processing stops. User Response: Report the problem to your IBM support center representative. ═══ 5.3.108. 459 I ═══ WORDS NOT FOUND: wordlist Explanation: The word or words in wordlist were not found in the permanent, addenda, or algorithmic dictionaries. System Action: Message 395 is produced and processing continues. The input line is printed. User Response: Either correct the misspelled words or add them to the addenda dictionary (by using the .DU [Dictionary Update] control word). Reissue the SCRIPT command if desired. ═══ 5.3.109. 460 W ═══ ADDENDA DICTIONARY SIZE HAS BEEN EXCEEDED. Explanation: Use of the .DU [Dictionary Update] control word has exceeded the maximum size of the addenda dictionary work area. System Action: The excess word(s) are not added to the addenda dictionary. User Response: Reduce the number of words or .DU control words used. Reissue the SCRIPT command. ═══ 5.3.110. 472 S ═══ FONT STORAGE SIZE FOR LOGICAL DEVICE EXCEEDED. Explanation: The fonts specified with the CHARS option do not fit into the font storage size specified for the logical device. System Action: Processing stops. User Response: Ensure that the document does not attempt to reference more fonts than the logical device can accommodate. Reissue the SCRIPT command. ═══ 5.3.111. 474 W ═══ FONT SAVE STACK EMPTY - DEFAULT ASSUMED. Explanation: An attempt was made to restore a font that either had never been saved or was pushed off the font saved stack. That is, the number of .PF [Previous Font] control words found exceeds the number of .BF [Begin Font] control words found. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The font is set to what it was before the first line was processed and processing continues. User Response: Either find and correct the missing half of a .BF/.PF pair of control words or stack fewer than 17 fonts. Reissue the SCRIPT command if desired. ═══ 5.3.112. 475 W ═══ INVALID FONT SPECIFIED WITH NAMED AREA `areaname'. Explanation: The font specified with the .DA [Define Area] control word is not a valid font for the area areaname. System Action: Processing continues, but the specified font is not started in the area. User Response: Define the font properly. Reissue the SCRIPT command. ═══ 5.3.113. 476 W ═══ FONT `fontname' DUPLICATED IN `CHARS' OPTION. Explanation: Font fontname was found twice in the CHARS option of the command line. System Action: The font is ignored and processing continues. User Response: Remove the duplicate fontname. ═══ 5.3.114. 477 E ═══ INVALID FONT SPECIFIED WITH .DH. Explanation: The font specified with the .DH [Define Head Level] control word is not a valid font. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Define the font correctly. Reissue the SCRIPT command. ═══ 5.3.115. 478 E ═══ INVALID FONT SPECIFIED WITH .BF. Explanation: All fonts specified with the .BF [Begin Font] control word are not valid. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Define at least one of the fonts correctly. Reissue the SCRIPT command. See the Document Composition Facility SCRIPT/VS User's Guide for more information on selecting and defining fonts. ═══ 5.3.116. 479 S ═══ INVALID FONT `fontname' SPECIFIED WITH `CHARS' OPTION. Explanation: The font fontname, specified with the CHARS option on the command line, is invalid for this logical device. Valid fonts must be defined in module DSMTFFIB for line devices, or included in the font library for page printers or PostScript devices. Note: If formatting for a page printer, the font is invalid if its orientation does not match the orientation of the logical device specified. System Action: Processing stops. User Response: Specify a font recognized by the formatter or see that the font is added to DSMTFFIB for line devices or included in the font library for page printers and PostScript devices. If formatting for a PostScript device, ensure that DCFINDEX is correct. Reissue the SCRIPT command. ═══ 5.3.117. 480 W ═══ FONT `fontname' DOES NOT CONTAIN PROPORTIONAL BLANKS. Explanation: A combination of fonts that requires the presence of multi-pitch required blanks in all fonts has been specified, but font fontname does not meet this requirement. All fonts in a combination must meet this requirement if at least one of the fonts has multi-pitch required blanks, or the fonts are not all monospace and of identical pitch. System Action: Processing continues, but misalignment of output can result. User Response: To correct any misalignment that might have resulted, substitute a font that meets the requirements stated above. Reissue the SCRIPT command if desired. See the Document Composition Facility: SCRIPT/VS Language Reference for more information on the font information block (FIB) macro. ═══ 5.3.118. 481 S ═══ PROPORTIONAL BLANKS IN FONT `fontname' ARE IN ERROR. Explanation: Font fontname is marked as having multi-pitch required blanks, but the characters X`11', X`12', and X`13' are not 18, 15, and 12 pel respectively. System Action: Processing stops. User Response: Either correct the font or specify a different font. Reissue the SCRIPT command. See the Document Composition Facility: SCRIPT/VS Language Reference for more information on the font information block (FIB) macro. ═══ 5.3.119. 482 W ═══ FIRST [line|n lines] TOO DEEP FOR NAMED AREA `areaname' ON PAGE n -- DISCARDED. Explanation: A named area areaname is being placed on page n, and the first pending line(s) will not fit in the space available for the area. The line is discarded, and a new line becomes the first line. The new first line also might not fit. The message indicates how many lines were discarded. System Action: Named area placement continues with the next line. User Response: Either use a smaller font or increase the depth of the page that can be used for the named area. Reissue the SCRIPT command. ═══ 5.3.120. 483 E ═══ STARTING LOCATION FOR NAMED AREA `areaname' IS OFF PAGE n. Explanation: A named area areaname is being placed on page n and will fall outside the valid space available for the area. Either the horizontal or the vertical starting point is off the page. System Action: If the CONTINUE option was specified, then this area is discarded and processing continues with the next area. If the CONTINUE option was not specified, processing stops. User Response: Place the area somewhere else on the page. Reissue the SCRIPT command. ═══ 5.3.121. 484 S ═══ DEFAULT FONT `fontname' NOT AVAILABLE FOR LOGICAL DEVICE `ldevname'. Explanation: The CHARS option was not specified. Either the default font fontname obtained from the logical device ldevname for the device specified on the DEVICE option does not exist or the corresponding codepage file was not available. System Action: Processing stops. User Response: Either check with your system programmer to ensure that the default font for this logical device exists or use the CHARS option to specify a different font. Ensure that the codepage file exists in the fontlib. Reissue the SCRIPT command. ═══ 5.3.122. 485 E ═══ FONT `fontname' HAS DIFFERENT PATTERN TECHNOLOGY ID. Explanation: The coded font, fontname, specified on a .DF [Define Font] control word with the FONT parameter, points to a font character set that has a different pattern technology identifier than the font library. System Action: If the CONTINUE option was specified, then the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Use either a different coded font name on the .DF [Define Font] control word or the FONTLIB command option to refer to a different font library. ═══ 5.3.123. 486 S ═══ NO USABLE ENTRIES IN DCFINDEX FOR LOGICAL DEVICE `ldname' AND DEFAULT FONT `fontname'. Explanation: The DCFINDEX in the font library is out of synchronization with the font objects in the font library. The logical device being formatted for is ldname, and the default font being used is fontname. System Action: Processing stops. User Response: If formatting for a page printer, rerun the font library index program for the font library being used. If formatting for a PostScript device, ensure that the PostScript DCFINDEX file correctly reflects the AFM files in the font library. ═══ 5.3.124. 500 S ═══ PRIMARY INPUT FILE MISSING FROM COMMAND LINE. Explanation: The primary input document, the one that should immediately follow the command, was not given. System Action: Processing stops. User Response: Reissue the SCRIPT command with the name of your primary input file included on the command line. ═══ 5.3.125. 501 E ═══ INVALID CONTROL WORD OR MACRO ENCOUNTERED. Explanation: A line beginning with a period (.) is not a valid control word or a recognized macro. A macro may be unrecognized if the .MS [Macro Substitution] or .LY [Library] control words have not been used. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was not specified, processing stops. If the CONTINUE option was specified, the control word is ignored and processing continues. User Response: If a control word has been incorrectly entered, correct it and reissue the SCRIPT command. If a macro has not been recognized, ensure that the control words .MS and .LY have been correctly used and that the correct macro or symbol library and profile document have been used. If the line beginning with the period (.) is not intended to be interpreted as a control word or macro, use the .LI [Literal] control word. ═══ 5.3.126. 502 E ═══ INVALID NUMERIC CONTROL WORD PARAMETER. Explanation: A control word parameter was not a decimal number (valid numbers are 0-9), was not a valid space unit specification, or exceeded the arithmetic capability of SCRIPT/VS when it was converted to device units. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the invalid parameter, ensuring that the value specified is not too large to be converted to device units. Reissue the SCRIPT command. ═══ 5.3.127. 503 W ═══ NEGATIVE INTER-CHARACTER SPACING NOT AVAILABLE ON SPECIFIED OUTPUT DEVICE. Explanation: The specified device, because of hardware limitations, cannot produce negative inter-character space specified on the .IC [Intercharacter Space] control word. System Action: The requested negative space is set to zero and processing continues. User Response: Either remove the .IC [Intercharacter Space] control word or set the request for inter-character space to either zero or a positive value. Reissue the SCRIPT command. ═══ 5.3.128. 504 E ═══ CONTROL WORD PARAMETER MUST BE `ON' OR `OFF'. Explanation: A control word that allows only the parameters ON or OFF, or nothing, was encountered with an invalid parameter. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct or remove the invalid parameter. Reissue the SCRIPT command. ═══ 5.3.129. 505 E ═══ CONTROL WORD PARAMETER MISSING. Explanation: A required parameter was missing on a control word line. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Add the required parameter and reissue the SCRIPT command. ═══ 5.3.130. 506 E ═══ INCORRECT NUMBER OF PARAMETERS SPECIFIED. Explanation: The number of parameters specified with a control word differed from the number expected for that control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. In some cases, such as .TR, where the parameters are in pairs, the message indicates the presence of an unpaired parameter and all previous parameters will have been processed correctly. If CONTINUE was not specified, processing stops. User Response: Correct the control word parameters. Reissue the SCRIPT command. ═══ 5.3.131. 507 E ═══ NUMERIC PARAMETER OUTSIDE VALID RANGE. Explanation: A numeric control word parameter either exceeded the arithmetic capability of SCRIPT/VS when it was converted to device units or was specified with a value less than or greater than the range that was defined or currently available for the control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the invalid parameter, ensuring that the value specified is not too large to be converted to device units. Reissue the SCRIPT command. ═══ 5.3.132. 508 E ═══ INVALID CONTROL WORD PARAMETER. Explanation: A specified parameter is not valid for the control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the remainder of the control word is ignored and processing continues (though earlier parameters may have been processed). If the CONTINUE option was not specified, processing stops. User Response: Correct the invalid parameter. Reissue the SCRIPT command. ═══ 5.3.133. 509 W ═══ TOO MANY TOKENS OR TOKEN TOO LONG. Explanation: Either a single token on a line exceeded 8 characters, or more than 16 tokens were on the line. System Action: Either the first 8 characters of the token are used and the other characters are ignored, or any token over 16 is ignored. Processing continues. Message 395 is produced. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Correct the tokens. Reissue the SCRIPT command. ═══ 5.3.134. 510 E ═══ ATTEMPT TO SET INDENTION EQUAL TO OR LEFT OF LEFT MARGIN - ZERO ASSUMED. Explanation: Processing of the control word would have caused the indention to be set equal to or left of the current left margin. This will occur if an attempt is made to undent more spaces than the current indention or to indent less than the current undent. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, indention is set to 0 and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the indicated control word. Reissue the SCRIPT command. ═══ 5.3.135. 511 E ═══ ATTEMPT TO SET INDENTION EQUAL TO OR GREATER THAN COLUMN LINE LENGTH - ZERO ASSUMED. Explanation: Processing of the control word would have caused the indention to be set equal to or greater than the column line length. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the indention is set to 0 and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct either the indicated control word or the column line length. Reissue the SCRIPT command. ═══ 5.3.136. 512 E ═══ HEADING MARGIN PLUS HEADING SPACE GREATER THAN TOP MARGIN - `[.HM|.HS|.TM]' IS UNCHANGED. Explanation: Processing of the control word would have caused the size of the heading margin .HM and heading space .HS to exceed the top margin .TM. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the size of the indicated area remains unchanged and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either decrease the size of the heading margin or heading space or increase the size of the top margin. Reissue the SCRIPT command. ═══ 5.3.137. 513 E ═══ FOOTING MARGIN PLUS FOOTING SPACE GREATER THAN BOTTOM MARGIN - `[.FM|.FS|.BM]' IS UNCHANGED. Explanation: Processing of the control word would have caused the size of the footing margin .FM and footing space .FS to exceed the bottom margin .BM. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the size of the indicated area remains unchanged and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either decrease the size of the footing margin or footing space or increase the size of the bottom margin. Reissue the SCRIPT command. ═══ 5.3.138. 514 E ═══ PAGE LENGTH NOT GREATER THAN TOP MARGIN PLUS BOTTOM MARGIN - `[.PL|.TM|.BM]' IS UNCHANGED. Explanation: Processing of the control word would have caused the size of the top margin .TM plus the bottom margin .BM to equal or exceed the depth of the page .PL. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the size of the indicated area remains unchanged and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either decrease the size of the top margin or bottom margin or increase the page length. Reissue the SCRIPT command. ═══ 5.3.139. 515 W ═══ .RC MODE WAS ON OR OFF ALREADY. Explanation: Either `.RC n ON' was encountered at a time when the .RC mode was ON, or a `.RC n OFF' was encountered when the .RC mode was OFF. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The control word is ignored and processing continues. User Response: Either remove the extraneous .RC, add a matching .RC, or check the control flow and correct any problem that may have caused a preceding .RC to be skipped. Reissue the SCRIPT command. ═══ 5.3.140. 516 W ═══ INVALID .RC DEFINITION. Explanation: An attempt was made to define or redefine a revision code character while that revision code was ON. System Action: The control word is ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either move the .RC to a point outside the range of the `.RC n ON' for the same revision code, add a `.RC n OFF' if one was missing, or correct any control flow problem that may have caused an earlier `.RC n OFF' to be skipped. Reissue the SCRIPT command. ═══ 5.3.141. 517 W ═══ .RC STACK OVERFLOW. Explanation: An attempt was made to stack more than nine revision codes. More than nine `.RC n ON' control words were encountered without an intervening `.RC n OFF'. System Action: The control word is ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Restructure the document to avoid the problem. Reissue the SCRIPT command. ═══ 5.3.142. 518 E ═══ LEVEL n INDEX ENTRY: aaaa TOO LONG. Explanation: An index entry aaaa for index level n causes the length of the .IE [Index Entry] control word to exceed 256 characters. Either the index entry has too many page numbers, or the combination of the system symbol string (&SYSPRS or &SYSPLS) and the page numbers is too long. System Action: If the CONTINUE option was specified, processing continues; but this index entry will be truncated at the maximum allowable length. If the CONTINUE option was not specified, processing stops. User Response: Either remove some of the index entries for the index term or decrease the length of the &SYSPRS or &SYSPLS system symbols. Reissue the SCRIPT command. ═══ 5.3.143. 520 E ═══ IMBED OR APPEND FILE NOT FOUND. Explanation: Either an .IM [Imbed] or .AP [Append] control word was encountered for a file that could not be found. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: If the name of the file to be imbedded or appended is misspelled, correct the name. Reissue the SCRIPT command. If the file is not located in the default imbed/append library, ensure that a correct .DD [Define Data File-id] control word is processed and that the SEARCH option is properly specified if needed. Also ensure that the file resides in a place accessible at the time the document is formatted. ═══ 5.3.144. 521 W ═══ [TOP|BOTTOM] TITLE 1-6 DEFINED WITH [RT|TT|ET|OT|BT|EB|OB|HE|FT] NOT PRINTED ON PAGE n [HS|FS] SPACE TOO SMALL. Explanation: A running title was defined but could not be placed on page n, because the heading or footing space was too small. System Action: The title is not put on the page. User Response: Increase either the heading or the footing space to get the title printed on the page. Reissue the SCRIPT command. ═══ 5.3.145. 522 S ═══ PRIMARY INPUT FILE `file-id' NOT FOUND. Explanation: The input document named file-id could not be located. The maximum length of file-id is eight characters. System Action: Processing stops. User Response: Correct any misspelling of the document name and ensure that the document is accessible. Reissue the SCRIPT command. ═══ 5.3.146. 523 E ═══ ATTEMPT TO SET PAGE NUMBER OUTSIDE VALID RANGE. Explanation: An attempt was made to set the page number to a value not in the range 1-9999. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the value specified for the page number is within the valid range. Reissue the SCRIPT command. ═══ 5.3.147. 524 E ═══ FRACTIONAL PAGINATION WAS ALREADY ON. Explanation: At least two .PN FRAC control words were encountered without an intervening .PN NORM. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either add a .PN NORM if one was missing or correct any other problem that might have caused an earlier .PN NORM to be ignored or skipped. Reissue the SCRIPT command. ═══ 5.3.148. 525 W ═══ NEGATIVE VALUE COMPUTED FOR `.xx' - ZERO ASSUMED. Explanation: A negative value was computed for a parameter on control word .xx, for which only 0 and positive values are allowed. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The parameter is assumed to be 0 and processing continues. User Response: Either correct any typographical errors on the control word or correct any earlier errors that might have affected the value of the parameter. Reissue the SCRIPT command if desired. ═══ 5.3.149. 526 W ═══ PAGE NUMBER HAS WRAPPED FROM 9999 to 1. Explanation: The page number counter was at 9999 when an implicit or explicit page eject occurred. System Action: The page number counter is reset to 1 and processing continues. User Response: None. ═══ 5.3.150. 527 W ═══ .SA/.RE STACK EMPTY - INITIAL SETTINGS RESTORED. Explanation: An attempt was made to restore an unnamed environment that had not been saved. The number of .RE control words encountered exceeded the number of .SA control words encountered. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The .RE control word is ignored, and the environment is restored to the one that existed before the first control word was processed. User Response: Either add a missing .SA control word or correct any other error that may have caused an earlier .SA to be ignored or skipped (unless the intent was to restore original settings). Reissue the SCRIPT command if desired. ═══ 5.3.151. 528 W ═══ object ENDED BY DISALLOWED CONTROL WORD `.xx'. Explanation: The control word .xx is not permitted within the range of object. The objects are: o Table o Table Header o Table Footer o Area o Float o Footnote o Keep System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the object is a table, area, float, footnote or keep, the object is ended and processing continues with the current control word. If the object is a table header or table footer, the object is ended and the rest of the table header and table footer definition is ignored. User Response: Restructure the document so that the disallowed control word is not within the range of the object. Correct any other error that may have caused an earlier .AR OFF, .FL OFF, .KP OFF, .FN OFF, .TA HEAD OFF, .TA FOOT OFF, or .TA TABLE OFF to be ignored or skipped. Reissue the SCRIPT command if desired. ═══ 5.3.152. 529 E ═══ [KP|FL] WOULD EXCEED MAXIMUM SIZE. Explanation: The amount of material specified in the given .KP [Keep] or .FL [Float] control word exceeds the amount that can be kept together at this point in the document. System Action: If the CONTINUE option was specified, the keep or float is ended. The output line following the keep or float may be out of order in the output. If the CONTINUE option was not specified, processing stops. User Response: Either restructure the pages so that sufficient space is available to process the .KP or .FL properly, or correct any error that may have caused an earlier .KP OFF or .FL OFF to be ignored or skipped. Reissue the SCRIPT command if desired. ═══ 5.3.153. 530 W ═══ `.xx' CONTROL WORD IGNORED IN RH/RF/FN. Explanation: A control word .xx that is not permitted within the range of a running heading, running footing, or footnote leader was encountered. Control words that cause (or could cause) a page eject are not allowed in a running heading, running footing, or footnote leader. System Action: The control word and its associated text are ignored. The input line is printed. User Response: Restructure the document so that the disallowed control word is not within the range of the running heading, running footing, or footnote leader. Correct any other error that may have caused an earlier .RH OFF, .RF OFF, .FN OFF to be ignored or skipped. Reissue the SCRIPT command if desired. ═══ 5.3.154. 531 W ═══ UNEXPECTED END OF INPUT DURING `object' DEFINITION. Explanation: An end-of-file (EOF) was encountered before the end of the object. The objects are: o Inline macro o Running heading o Running footing o Footnote leader o Table header o Table footer System Action: The object is ended and processing continues. User Response: Correct the document to end the macro definition with the proper control word. Reissue the SCRIPT command. ═══ 5.3.155. 532 S ═══ NO ROOM FOR TEXT ON PAGE n. Explanation: The current page, number n, is unable to accommodate at least one line of body text along with the top margin, bottom margin, running heading, running footing, and floating keep. One of these conditions may apply: 1. All available text space has been used by .RH [Running Heading] and .RF [Running Footing] control words. 2. A floating keep postponed from the previous page will not fit on the current page. 3. An output line has been defined to be so deep that no room remains on the page for even one line of text. 4. A nobreak PostScript image or a nobreak page segment could cause the line to be so deep that no room remains on the page for even one line of text. System Action: Processing stops. User Response: Restructure the document to avoid the problem. Reissue the SCRIPT command. ═══ 5.3.156. 533 S ═══ LABEL `labelname' NOT FOUND IN [MACRO `macroname'| FILE `filename']. Explanation: The label labelname was specified on a .GO [Goto] control word in the indicated macro macroname or file filename and was not found in that macro or file. System Action: Processing stops. User Response: Either add the missing label to the macro or file or correct any typographical error on the .GO control word. Reissue the SCRIPT command. ═══ 5.3.157. 534 S ═══ I/O ERROR READING PAGE SEGMENT segname. Explanation: An I/O error occurred while attempting to read a page segment segname file. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing stops. User Response: Ensure that the correct page segment library was identified with the PSEGLIB option of the SCRIPT command before reissuing the SCRIPT command. ═══ 5.3.158. 535 E ═══ DUPLICATE LABEL FOUND. Explanation: A duplicate label was encountered within a file. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the label is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either remove the label or rename it, and ensure that all .GO [Goto] control words in the file refer to the correct label. Reissue the SCRIPT command. ═══ 5.3.159. 536 W ═══ LABELS AND GOTOS DISALLOWED DURING TERMINAL INPUT. Explanation: A label or .GO [Goto] control word was encountered while receiving input from either the terminal or the file assigned to file-id DSMTERMI. System Action: The label or .GO control word is ignored and processing continues. User Response: Do not attempt to perform label processing with terminal input. ═══ 5.3.160. 537 E ═══ INVALID KEYWORD FOR CONDITION ON .IF. Explanation: An invalid comparison keyword was found on a .IF [If] control word. The .IF control word requires a keyword such as EQ, GT, =, and so on, for comparison. This error can occur if the first comparand is a null symbol. For example, .if &x eq no .go end becomes .if eq no .go end if &x is null. Because no is not a valid keyword, this message is issued. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either correct any typographical errors on the .IF control word, or restructure the comparison to avoid the problem. Reissue the SCRIPT command. If the problem resulted from a null symbolic comparand, the symbol can be changed as follows: .if /&x eq /no .go end This prevents the first comparand from being null even if &x is null. ═══ 5.3.161. 538 E ═══ PAGE SEGMENT segname CONTAINS INVALID DATA. Explanation: The page segment segname named with a .SI [Segment Include] control word does not contain valid data. This may be due to one of several problems: o A record does not contain a valid structured field introducer. o The first record is not a begin page segment structured field. o The second record is not a begin image block structured field. o The file does not contain an image input descriptor. System Action: If the CONTINUE option was not specified, processing stops. User Response: Ensure that the correct page segment library was identified with the PSEGLIB option of the SCRIPT command before reissuing the SCRIPT command. ═══ 5.3.162. 539 W ═══ TITLE OVERLAP ON PAGE n, TITLE LINE x. Explanation: Two or three sections of title-line number x overlapped on page n. The current line length is too short to permit correct processing. System Action: A title line is produced and processing continues. The text of the title line is unpredictable. User Response: Specify either a shorter title line or a longer line length. Reissue the SCRIPT command. ═══ 5.3.163. 540 R ═══ ENTER PAGE RANGE `FROM ' OR RETURN: Explanation: As a result of the PAGE option with PROMPT, the formatter is requesting the next range of pages to be printed. (See the Document Composition Facility: SCRIPT/VS Language Reference for more information.) System Action: If valid syntax is entered, processing continues. If not, message 548 results and message 540 is redisplayed. If a valid specification has not been provided after three attempts, processing stops. User Response: Specify the range of pages desired. ═══ 5.3.164. 541 E ═══ TAB POSITIONS NOT IN SEQUENCE. Explanation: The tab positions specified as parameters with the .TB [Tab Setting] control word do not form an increasing sequence. Note: When a tab position is calculated, the position is rounded to the nearest device unit available on the specified device type. SCRIPT/VS may round down. Rounding down may result in SCRIPT/VS attempting to set the tab to a previously established tab or in the case of the first tab to zero. These results are invalid. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either correct any typographical errors or rearrange the tab positions in the correct sequence. Reissue the SCRIPT command. ═══ 5.3.165. 542 E ═══ LABEL TOO LONG. Explanation: A label was encountered that exceeded eight characters. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the label is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Specify a valid label and ensure that all .GO control words that refer to this label are specified correctly. Reissue the SCRIPT command. ═══ 5.3.166. 543 E ═══ RULES NOT IN SEQUENCE OR OVERLAPPING. Explanation: The positions specified as parameters with the .HR [Horizontal Rule], .BX [Box], or .VR [Vertical Rule] control word either do not form an increasing sequence or are overlapping. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either correct any typographical errors or rearrange the positions in proper sequence. Reissue the SCRIPT command. ═══ 5.3.167. 544 E ═══ PAGE SEGMENT segname NOT FOUND. Explanation: A page segment segname name given with a .SI [Segment Include] control word was not found in the page segment library. System Action: If the CONTINUE option was specified, processing continues. For a non-inline page segment, the page segment name will be placed in the output for potential processing by the printer. For an inline page segment, the .SI control word is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the correct page segment library was identified with the PSEGLIB option of the SCRIPT command and that the named page segment exists in that library before reissuing the SCRIPT command. ═══ 5.3.168. 545 E ═══ PAGE SEGMENT segname IS NOT VALID FOR devname DEVICE. Explanation: The page segment segname named with a .SI control word is not valid for use with the current physical device devname, because the page segment measurement units do not match the physical device measurement units. System Action: If the CONTINUE option was specified, the page segment name will be placed in the output for potential processing by the printer, but SCRIPT/VS assumes that the page segment will have no depth or width. If the CONTINUE option was not specified, processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Ensure that the correct page segment library was identified with the PSEGLIB option of the SCRIPT command before reissuing the SCRIPT command. ═══ 5.3.169. 546 E ═══ SPLIT TEXT OVERLAP. Explanation: Two or more parts of a split text control word overlap when aligned in the available column space. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, processing continues, but the content of the line is unpredictable. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the column line length is sufficient to allow processing of the .SX [Split Text] control word. Reissue the SCRIPT command. ═══ 5.3.170. 547 S ═══ UNABLE TO OPEN UTILITY FILE FOR WRITING. Explanation: An unsuccessful attempt was made to open a system utility file for output. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Correct any earlier errors that may have caused the problem. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.171. 548 W ═══ SYNTAX ERROR IN PAGE RANGE REQUEST. Explanation: The page range requested in response to message 540 was not valid. System Action: Message 540 is redisplayed. User Response: See message 540. ═══ 5.3.172. 549 W ═══ .DI ENDED BY END-OF-FILE. Explanation: An end-of-file condition was reached for an input file before an expected .DI [Delay Imbed] OFF control word was encountered. System Action: The delay-imbed is ended and is inserted immediately (this delay-imbed now contains all of the document from .DI ON to the end). An imbed trace is printed if MESSAGE(TRACE) is specified. User Response: Either add a missing .DI OFF or correct any error that may have caused an earlier .DI OFF to be ignored or skipped. Reissue the SCRIPT command if desired. ═══ 5.3.173. 550 S ═══ TEXT EXCEEDS BUFFER SIZE. Explanation: The output line buffer has overflowed. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: If the text is a series of continued lines, end continuation before the output buffer is filled. Reissue the SCRIPT command. ═══ 5.3.174. 551 E ═══ MISSING INDEX TERM OR KEY. Explanation: A required index term or key has been omitted. This message may be issued for one of several reasons: o An incomplete index key specification was found o No index terms were found o A null primary index term preceded a secondary index term o A null primary or secondary index term preceded a tertiary index term o A null secondary index term was found for an index reference. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check the .PI [Put Index] control word specification to ensure that the required terms and keys are present and that all term and key delimiter characters are consistently specified before reissuing the SCRIPT command. ═══ 5.3.175. 552 E ═══ INDEX TERM OR KEY TOO LONG. Explanation: An index term or key longer than 120 characters was found. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Make all index terms and keys less than 120 characters long before reissuing the SCRIPT command. ═══ 5.3.176. 553 E ═══ TOO MANY INDEX TERMS OR KEYS. Explanation: More than three index keys or more than four index terms were found. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that exactly four index key delimiter characters follow the key specification and that they delimit three index keys or that no more than five index term delimiter characters follow the key specification and that they delimit, at the most, four index terms. Reissue the SCRIPT command. ═══ 5.3.177. 554 E ═══ INDEX KEY REDUCED TO NULL OR BLANKS. Explanation: While an index key was being created from a corresponding index term, the key was reduced to either zero length or all blanks. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check the index term specifications and the characters given with the .DC IXI and .DC IXB control words. Either change the index term to include characters that will not be ignored or treated as blanks, or change the .DC [Define Character] control word to leave some characters in the index term alone. Reissue the SCRIPT command. ═══ 5.3.178. 555 S ═══ INVALID .DD DEFINITION. Explanation: An unsuccessful attempt was made to associate a system utility file with either the current imbed file or the primary input file. System Action: Processing stops. The input line is printed and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Specify a different filename for the internal system utility file with the .DD [Define Data File-id] control word and reissue the SCRIPT command. ═══ 5.3.179. 556 E ═══ TOO MANY TABS SPECIFIED. Explanation: More than 64 tab positions were defined. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option of the SCRIPT command was specified, the .TP [Tab Position] or .TB [Tab Setting] control word that caused the message is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check the .TP or the .TB control word that caused the error. Reduce the number of active tab stops to 64 or less. Reissue the SCRIPT command. ═══ 5.3.180. 557 S ═══ PAGE SEGMENT LIBRARY NOT FOUND OR INVALID. Explanation: The page segment library specified with the PSEGLIB option of the SCRIPT command either does not exist or exists but does not have an acceptable format. System Action: Processing stops. User Response: Verify that the page segment library exists and is valid before reissuing the SCRIPT command. ═══ 5.3.181. 558 S ═══ I/O ERROR READING PAGE SEGMENT segname. Explanation: An I/O error occurred while attempting to read a page segment file to include in the DCF output (the inline parameter of the SI control word was specified). System Action: Processing stops. User Response: Ensure that the correct page segment library was identified with the SEGLIB option of the SCRIPT command before reissuing the SCRIPT command. ═══ 5.3.182. 559 W ═══ LINE LENGTH OR ADJUST MARGINS TOO LARGE, NOT RESTORED. Explanation: The current line length or adjust margin value changed because the environment was restored. The new line length plus page margin plus adjust margin is greater than the page width. System Action: The line length and the adjust margin values are not restored. The input line is printed. User Response: Check the line length and the adjust margin values that were active when the environment was saved to ensure that they are compatible with the current page margin and page width when the environment is restored. Correct the line length, adjust margin values, or both. Reissue the SCRIPT command if desired. ═══ 5.3.183. 560 W ═══ LINE LENGTH + PAGE MARGINS EXCEEDS PAGE WIDTH. Explanation: The sum of the line length and page margin values is larger than the defined page width. System Action: If the message is issued during initialization, an attempt is made to reduce line length and page margins to fit the page width. Otherwise, the .LL [Line Length], .PM [Page Margins], or .PW [Page Width] control word causing the problem is ignored. The input line is printed. User Response: If the error occurred in initialization, correct the dimensions either in the logical device table (LDT) or as specified with the BIND option of the SCRIPT command, so that line length plus page margins do not exceed the page width. Otherwise, correct the .LL, .PM, or .PW control word causing the problem. Reissue the SCRIPT command if desired. ═══ 5.3.184. 561 E ═══ FONT `fontname' IS NOT DEFINED. Explanation: A font fontname has been specified, and that font has not been defined either with the .DF [Define Font] control word or with the CHARS option of the SCRIPT command. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the font you have named is defined. Reissue the SCRIPT command. You can define fonts either with the .DF [Define Font] control word or with the CHARS option of the SCRIPT command. ═══ 5.3.185. 562 W ═══ OBJECT EXCEEDS PAGE DEPTH ON PAGE n. Explanation: The linespacing (total depth) of an object (a line of text, horizontal rule, page segment, PostScript image, skip, or space) on page n exceeds the depth of the page body. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The linespacing depth is set equal to the page body depth. User Response: Do one or more of the following: o Correct the size of the object o Use a smaller linespacing value (.LS NORMAL, .LS BY, .LS EXTRA) o Use a larger page length (.PL). Reissue the SCRIPT command. ═══ 5.3.186. 563 W ═══ EXTRA LEADING RESET ON PAGE n. Explanation: Extra leading would result in a negative linespacing depth for an object on page n. System Action: Extra leading is reset to 0. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Do one or more of the following: o Change the extra leading specification (.LS EXTRA) o Correct the size of the object o Use a larger font (changes normal linespacing) o Use a larger linespacing value (.LS NORMAL, .LS BY). Reissue the SCRIPT command if desired. ═══ 5.3.187. 564 W ═══ EXTRA LEADING IGNORED ON PAGE n. Explanation: Extra leading would result in a negative linespacing depth if applied to a rule, page segment, skip, or space on page n. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Extra leading is not applied. User Response: Do one or more of the following: o Change the extra leading specification (.LS EXTRA) o Correct the size of the object o Use a larger font (changes normal linespacing) o Use a larger linespacing value (.LS NORMAL, .LS BY). Reissue the SCRIPT command if desired. ═══ 5.3.188. 565 S ═══ PAGE SEGMENT segname CONTAINS INVALID DATA. Explanation: The page segment segname used with a .SI [Segment Include] control word using the INLINE parameter contains invalid data. A record in the page segment contains an invalid structured field introducer. System Action: Processing stops. User Response: Ensure that the correct page segment library was identified with the SEGLIB option of the SCRIPT command before reissuing the SCRIPT command. ═══ 5.3.189. 566 W ═══ `LIST' IGNORED - NOT FIRST KEYWORD ON .DF. Explanation: The LIST keyword appeared after the other parameters on .DF [Define Font] control word. If a list is used, the LIST keyword and list of fontnames must be the only parameters following fontname. System Action: The LIST keyword and list of fontnames are ignored. All other parameters on the input line are processed. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either remove the LIST keyword and list of fontnames or remove all the other parameters. ═══ 5.3.190. 567 W ═══ PARAMETERS FOLLOWING LIST KEYWORD AND LIST OF FONTNAMES ARE IGNORED. Explanation: Extra parameters appear following the LIST keyword and list of fontnames. System Action: The LIST keyword and list of fontnames are processed, and all other parameters are ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either remove LIST keyword and list of fontnames or remove all other parameters. ═══ 5.3.191. 568 S ═══ FONT SPECIFIES INVALID BOX CHARACTER SET. Explanation: This message is issued when processing the .DF [Define Font] control word, if the box character set (BCS) specified in the font information block (FIB) does not exist in the BCS table. System Action: The input line is printed, and processing stops. User Response: The BCS name coded in the FIB was not found in the font table. Check modules DMSTFFIB and DSMLPBCS, and correct the problem. ═══ 5.3.192. 569 W ═══ TAG PARAMETER OF [WF|EQ] IS VALID ONLY IN AN APF FOR A START TAG. Explanation: The TAG parameter of either a .WF [Write To File] or .EQ [Equation] control word is valid only when it is issued from an application processing function (APF) for a start GML tag. In all other cases, the control word is ignored. System Action: The control word is ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Check to see if the control word was issued from a start APF and, if it was not, use the ON form of the control word instead. Reissue the SCRIPT command if desired. ═══ 5.3.193. 570 W ═══ INVALID ATTEMPT TO SET SYSTEM SYMBOL. Explanation: An attempt was made to change the value of a read-only system symbol (a symbol beginning with &$). System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The control word is ignored and processing continues. User Response: If a modification to the value is required, set a user-defined symbol to the value of the system symbol. Then either modify the user-defined symbol or change the system symbol, using the appropriate control word (for example, use the .LL [Line Length] control word to change the value of &$LL). Reissue the SCRIPT command if desired. ═══ 5.3.194. 571 W ═══ EQUAL SIGN MISSING - ONE IS ASSUMED. Explanation: An equal sign was expected, but not found, to the right of the symbol name on a .SE [Set Symbol] control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. An equal sign is assumed to be in that position and processing continues. User Response: Either correct any typographical errors or add an equal sign. Reissue the SCRIPT command if desired. ═══ 5.3.195. 572 E ═══ LEFT HAND SIDE SYNTAX ERROR IN `.xx' CONTROL WORD. Explanation: A syntax error was discovered on the left-hand side of control word .xx. The left-hand side refers to the symbol or macro name in the control word given. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the error. Reissue the SCRIPT command. ═══ 5.3.196. 573 E ═══ RIGHT HAND SIDE SYNTAX ERROR IN `.xx' CONTROL WORD. Explanation: A syntax error was discovered on the right-hand side of control word .xx. The right-hand side refers to the value being set into a symbol or macro with the control word given. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the error. Reissue the SCRIPT command. ═══ 5.3.197. 574 E ═══ INVALID CHARACTER IN aaa NAME. Explanation: An invalid character was found in a variable object name. Valid characters are: a-z, A-Z, 0-9, #, @, $, +, =, and for symbols, *. The name aaa identifies the type of name that is in error. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Specify a correct name and ensure that all references to the same symbol or macro are also changed. Reissue the SCRIPT command. ═══ 5.3.198. 575 E ═══ UNDEFINED SYMBOL USED IN SUBSCRIPT. Explanation: An attempt was made to use an undefined symbol as a subscript for an array symbol name or a macro line number. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either correct any typographical errors in the subscript or ensure that the symbol is defined before using it as a subscript. Reissue the SCRIPT command. ═══ 5.3.199. 576 E ═══ INVALID NUMBER IN SUBSCRIPT. Explanation: An attempt was made to use an invalid number in a subscript for an array symbol or a macro line number. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct any typographical errors in the subscript. Reissue the SCRIPT command. ═══ 5.3.200. 577 E ═══ INVALID NUMBER IN EXPRESSION. Explanation: An attempt was made to use an invalid number in an expression. This can result from an attempt to set a symbol to a value that contains imbedded blanks or arithmetic operators, when the value was intended to be a single string of data, not an arithmetic expression. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: If the value was intended to be a single string of data, enclose it within single quotation marks. Ensure that quotation marks within the string are represented by two quotation marks. For example: .se symname = 'Mrs. O''Grady''s cat' Reissue the SCRIPT command. ═══ 5.3.201. 578 E ═══ UNDEFINED SYMBOL IN EXPRESSION. Explanation: An attempt was made to use an undefined symbol in an expression. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either correct any typographical errors in the expression, or ensure that the symbol is defined before using it in the expression. If the value was intended to be a quoted string, and not an arithmetic expression, enclose the values within quotation marks. Reissue the SCRIPT command. ═══ 5.3.202. 579 W ═══ TOKEN TOO LONG - TRUNCATION OCCURRED. Explanation: During symbol substitution, a token was found to exceed the maximum length. A token, or word, can be up to 16 characters long, unless it is part of a quoted string. An entire quoted string is treated as a single token that can be up to 256 characters long. System Action: The token is truncated and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Ensure that the token does not exceed the maximum length and reissue the SCRIPT command. ═══ 5.3.203. 580 S ═══ TOO MANY TOKENS IN CONTROL LINE. Explanation: The total area required to hold the tokenized control line has exceeded the maximum allowable. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either reduce the number of tokens on the line or shorten the length of individual tokens. Reissue the SCRIPT command. ═══ 5.3.204. 581 S ═══ SYMBOL SUBSTITUTION LOOP. Explanation: A symbol was encountered whose definition, either directly or indirectly, is itself. An infinite substitution loop would have resulted. System Action: Processing stops. The input line is printed and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Correct the loop situation. Reissue the SCRIPT command. ═══ 5.3.205. 582 E ═══ RESULT OF SUBSTITUTION TOO LONG. Explanation: The string resulting from a substitution exceeded the maximum size allowable. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the problem. Reissue the SCRIPT command. ═══ 5.3.206. 583 S ═══ MACRO RECURSION LOOP. Explanation: A macro was encountered that, either directly or indirectly, called itself more than 99 times. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Ensure that a macro does not call itself directly, or call other macros that might result in a call to the original macro, unless this process is carefully controlled. Reissue the SCRIPT command. ═══ 5.3.207. 584 S ═══ MACRO NESTING LEVEL TOO DEEP. Explanation: The number of nested macro calls has exceeded 255. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Restructure the macros to require fewer nesting levels. Reissue the SCRIPT command. ═══ 5.3.208. 585 E ═══ SYMBOL VALUE LONGER THAN 256 CHARACTERS. Explanation: An attempt was made to set a symbol to a value exceeding 256 characters in length. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the total length to be assigned does not exceed 256 characters after substitution. Reissue the SCRIPT command. ═══ 5.3.209. 586 E ═══ INVALID PARAMETER IN `SUBSTR' FORM OF .SE. Explanation: An invalid value was found in the starting position or length parameter for the `substr' form of the .SE [Set Symbol] control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the parameters. Reissue the SCRIPT command. ═══ 5.3.210. 587 E ═══ SYMBOL/MACRO NAME LONGER THAN 10 CHARACTERS - TRUNCATED. Explanation: The name of a symbol or a macro exceeded 10 characters. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the name is truncated to 10 characters and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the name of the symbol or macro and ensure that all other references to it reflect the change. Reissue the SCRIPT command. ═══ 5.3.211. 588 W ═══ NO APF FOUND FOR `xxxx' [TAG|ATTRIBUTE|USER-OPTION]. Explanation: No application processing function (macro or control word) could be found for the xxxx GML tag, attribute, or user-specified command option. System Action: Processing continues. If the missing APF was for a GML tag, the tag is left in the line as text. Attributes or command options without APF support are ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Define an APF or ignore the message. Reissue the SCRIPT command if desired. ═══ 5.3.212. 589 I ═══ ATTRIBUTES NOT USED FOR `xxxx': attributes. Explanation: Attributes for the xxxx GML tag were ignored during tag processing. System Action: The attributes are ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Ensure that the attribute spelling is correct. If the spelling is correct, the associated APF can be changed to recognize the attribute, or the attribute can be removed from the input line. ═══ 5.3.213. 590 W ═══ xxxx TAG HAS INVALID ATTRIBUTE . Explanation: Attribute yyyy for the xxxx GML tag is not valid. System Action: The attribute is ignored. Processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Verify that the GML markup and attribute were specified correctly. The associated APF can be changed to recognize the attribute, or the attribute can be removed from the input file. Reissue the SCRIPT command if desired. ═══ 5.3.214. 591 E ═══ TOO MANY VALUE ATTRIBUTES - SCAN ENDED. Explanation: The total line length of all attribute values exceeds the maximum allowable. System Action: Attribute scanning ends, and the remainder of the line is treated as text. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Reduce the length of the attribute value or insert a markup/content separator (.) following the attribute. Reissue the SCRIPT command. ═══ 5.3.215. 592 W ═══ NOT AN ATTRIBUTE - TREATED AS TEXT. Explanation: Attribute xxxx is invalid because it was incorrectly entered; GML processing for this line has ended. An attribute can be invalid for the following reasons: o An attribute was misspelled o A labeled attribute was entered with no value o A labeled attribute was entered with more than eight characters o A value attribute was entered when a value attribute was not allowed o No markup content separator was put before residual text. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. The invalid attribute and the remainder of the input line are treated as residual text. User Response: Insert an equal sign (=) in the labeled attribute and/or an explicit markup/content separator (.) preceding the text. Reissue the SCRIPT command if desired. ═══ 5.3.216. 593 E ═══ NAMED object `objectname' NOT FOUND. Explanation: A user-named object objectname was requested when it did not exist. The request was to use an existing object, not create a new one. The objects are: o Stack o Environment o Rule o Area o Table o Row. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the continue option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check to see that the name was spelled correctly. Either use the correct name or define the object. Reissue the SCRIPT command. Note: Can also be caused if object is a numeric value that, when converted to device units, exceeds the arithmetic capability of SCRIPT/VS. ═══ 5.3.217. 594 S ═══ RESULT OF SUBSTITUTION TOO LONG. Explanation: The string resulting from a substitution exceeded the maximum allowable. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing stops. User Response: Correct the error. Reissue the SCRIPT command. ═══ 5.3.218. 595 E ═══ SUGGESTED object NAME IS LONGER THAN 16 CHARACTERS - REJECTED. Explanation: The proposed object name is longer than sixteen characters, which is not permitted. The objects are: o Stack o Environment o Rule o Area o Table o Row. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Shorten the name. Reissue the SCRIPT command. ═══ 5.3.219. 596 E ═══ INVALID CONTROL WORD PARAMETER: xxx. Explanation: Either an invalid control word parameter xxx was specified, or the parameter, when converted to device units, exceeded the arithmetic capability of SCRIPT/VS. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the control word parameter is spelled correctly. Correct the invalid parameter and ensure that the value specified is not too large to be converted to device units. Reissue the SCRIPT command. ═══ 5.3.220. 597 E ═══ INVALID NUMERIC CONTROL WORD PARAMETER: xxx. Explanation: Either an invalid numeric value xxx was specified, or the parameter, when converted to device units, exceeded the arithmetic capability of SCRIPT/VS. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Ensure that the values specified for the control word parameter are correct and are not too large to be converted to device units. Reissue the SCRIPT command. ═══ 5.3.221. 598 E ═══ CONTROL WORD PARAMETER MISSING: xxx. Explanation: The required control word parameter xxx is missing. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Enter the required parameter. Reissue the SCRIPT command. ═══ 5.3.222. 599 E ═══ REQUIRED SUBPARAMETER MISSING FOR: xxx. Explanation: The required subparameter for the xxx parameter is missing. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Enter the missing subparameter. Reissue the SCRIPT command. ═══ 5.3.223. 600 E ═══ NUMERIC PARAMETER OUTSIDE VALID RANGE: xxx. Explanation: A numeric control word parameter xxx was specified with a value less than or greater than the range that was defined or currently available for the control word. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was specified, the control word is ignored and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Correct the invalid parameter. Reissue the SCRIPT command. ═══ 5.3.224. 653 E ═══ POSTSCRIPT FILE file-id NOT FOUND. Explanation: The PostScript file-id specified on a .PO control word could not be found. System Action: If the CONTINUE option was specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: If the name of the file was misspelled, correct the name and reissue the SCRIPT command. If the file is not located in the default library, ensure that a correct .DD [Define Data File-id] control word was specified or that the SEARCH option was properly specified on the SCRIPT command if needed. Also ensure that the file resides in a place that is accessible to SCRIPT/VS. ═══ 5.3.225. 654 E ═══ INVALID POSTSCRIPT FILE. Explanation: The PostScript file named with the .PO [PostScript] control word does not meet the minimum Version 2.0 Adobe Document Structuring Conventions for a PostScript file. The first line in the file must be a comment that starts with the characters `%!' System Action: If the CONTINUE option has been specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: Ensure that the correct file was identified. If the correct file was identified, ensure that the PostScript file is in ASCII, not EBCDIC. If the correct file was identified and is in ASCII, see your document administrator for information about the Adobe Version 2.0 Document Structuring Conventions. ═══ 5.3.226. 655 E ═══ POSTSCRIPT FILE CONTAINS INVALID DATA. Explanation: A problem exists with the integer values specified on the %%BoundingBox comment in the PostScript file specified on the .PO control word. Either four integer values have not been specified on the %%BoundingBox comment, or the integer values do not describe a valid bounding box. System Action: If the CONTINUE option has been specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: Ensure that four integer values have been specified on the %%BoundingBox comment in the PostScript file. Verify that the first two integers define the lower-left corner of the bounding box and that the last two integers define the upper-right corner. Reformat the document. Note: Since the PostScript file is in ASCII, the file should be modified on a personal computer and then uploaded to the host computer. ═══ 5.3.227. 656 W ═══ SCALE PARAMETER IGNORED, MISSING [DEPTH OR WIDTH|%%BoundingBox] Explanation: The scale parameter was specified on the .PO [PostScript] control word, and either the %%BoundingBox information was missing or neither the DEPTH parameter nor WIDTH parameter was specified. System Action: The scale parameter is ignored and processing continues. User Response: Provide the PostScript file with a %%BoundingBox comment containing valid bounding box coordinates (four integer values in ASCII). Specify a DEPTH parameter, a WIDTH parameter, or both to scale the PostScript. ═══ 5.3.228. 657 E ═══ POSTSCRIPT FILE RECORD LENGTH EXCEEDS MAXIMUM OF xxx. Explanation: A PostScript file was specified on the .PO [PostScript] control word that had record lengths greater than the maximum allowed, even after any carriage return-line feeds characters were removed. xxx indicates maximum record length allowed. System Action: If the CONTINUE option has been specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: Reduce the PostScript file's record length. ═══ 5.3.229. 658 E ═══ WIDTH OR DEPTH TOO SMALL FOR SCALING. Explanation: The space reserved on the .PO control word for the PostScript image is not large enough for proper scaling. System Action: If the CONTINUE option has been specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: Specify a larger value on the DEPTH or WIDTH parameter on the .PO [PostScript] control word. ═══ 5.3.230. 659 E ═══ CALCULATED [DEPTH|WIDTH] OUTSIDE VALID RANGE. Explanation: Since DEPTH or WIDTH was not specified on the .PO [PostScript] control word, the value was calculated from the %%BoundingBox comment. The calculated value is larger than the space available on the page. System Action: If the CONTINUE option has been specified, the control word is ignored and processing continues. Otherwise, processing terminates. User Response: Scale the PostScript image to fit in a smaller space. ═══ 5.3.231. 700 T ═══ INVALID PHYSICAL DEVICE SPECIFIED AT INSTALLATION: devicename. Explanation: The physical device name devicename was specified inside a valid logical device, but its corresponding physical device table cannot be found. System Action: The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Processing terminates. User Response: Ensure that you have the correct physical device tables. Reissue the SCRIPT command. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.232. 701 W ═══ EXTRANEOUS PARAMETERS IGNORED FOR CONTROL WORD: `.xx'. Explanation: Extraneous parameters were found on control word .xx. System Action: The extraneous parameters are ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Remove the extraneous parameters. ═══ 5.3.233. 702 W ═══ RULE MISALIGNMENT MAY OCCUR DUE TO MIXED PITCH FONTS. Explanation: For the 3800 Printing Subsystem Model 1, and Model 3 in compatibility mode, text and vertical rules have been placed on the same output line under one of these conditions: o The text is in a truly proportional font. o The pitch of the text font and rule font are not equal. System Action: Processing continues normally. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. Misalignment of text or rules may occur. User Response: It is recommended that truly proportional fonts not be used with boxes or rules on the 3800. Also, text formatted with boxes and rules should be in a font of the same pitch as the boxes or rules. Failure to observe this guideline may result in severe misalignment of rules and text. ═══ 5.3.234. 704 S ═══ INSUFFICIENT COLUMN SPACE TO CONTINUE. Explanation: The current column definition is such that the column line length minus the current indention is less than one word space. Not enough space remains in the column to permit formatting. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. This message can also be issued if a cell in a table is too small to allow the text to be formatted. User Response: There are several ways to correct this error: o Decrease the left margin by using the .PM [Page Margins] or .AM [Adjust Margin] control words. o Increase the column line length by using the .CL [Column Line Length] control word. o Reduce the indention by using one of the following control words: .IN [Indent], .IR [Indent Right], .UN [Undent], .IL [Indent Line], or .OF [Offset]. o Increase the width of the cell in the table with the .TD [Table Definition] control word. Reissue the SCRIPT command. ═══ 5.3.235. 705 W ═══ BACKSPACING OVER NON-TEXT IGNORED. Explanation: The input line contained backspaces following something other than a word or word fragment. System Action: The backspaces are ignored and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Remove the extraneous backspaces from the input line. If explicit backspacing over tabs, word spaces, required blanks or other line controls is needed, use the .IS control word. Reissue the SCRIPT command if desired. ═══ 5.3.236. 706 W ═══ BACKSPACING BEYOND PRECEDING TEXT IGNORED. Explanation: The input line contained more consecutive backspaces than the preceding word or word fragment. System Action: The amount of backspacing is reduced to the width of the preceding word fragment and processing continues. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Remove the extraneous backspaces from the input line. If explicit backspacing over tabs, wordspaces, required blanks, or other line controls is needed, use the .IS control word. Reissue the SCRIPT command if desired. ═══ 5.3.237. 707 W ═══ HORIZONTAL SPACE ERROR(S) ON PAGE n DISPLACEMENT IS xx PELS Explanation: A space request on page n cannot be filled to within one pel for the 3800 Printing Subsystem Model 1. (This can happen only for requests of less than 11 pels or for requests from 20 to 22 pels.) xx is the amount of the error. System Action: Processing continues with the nearest amount of space that can be generated. User Response: Increase the size of the request to at least 23 pels. Reissue the SCRIPT command if desired. ═══ 5.3.238. 708 E ═══ TEXT EXCEEDS [LEFT|RIGHT|TOP|BOTTOM] PAGE BOUNDARY ON PAGE n. Explanation: Text extends beyond the page boundary on page n. Text may extend beyond the edge of the page, because part of a column definition extends outside the page or because text or an object extends outside a column. On line devices, text added to output lines with the NUMBER option of the SCRIPT command may extend beyond the page width. System Action: This page may be truncated or rejected by the output device if the next page exceeds the device form size. If the CONTINUE option was specified, the text is placed and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check .CD [Column Definition] and .CL [Column Line Length] control words and ensure that all columns are contained within the boundaries of the page. Check .FO [Format Mode] and .NF [No Formatting] control words to ensure that all text and rules are contained within the boundaries of the column. Check width and placement of areas to ensure that all text and rules are contained within the boundaries of the page. For line devices, if the text which exceeded the page width was added with the NUMBER option, then do not use the NUMBER option. Check to see if a line containing a nobreak page segment (.SI [Segment Include] control word), a PostScript image [.PO PostScript] or a space reserved with a .VT [Variable Text] control word is contained within the boundaries of the page. Check to see if the total of the .AM [Adjust Margin] value plus the line length plus the page margin is greater than the page width. If it is, decrease the value specified on .AM. Reissue the SCRIPT command. ═══ 5.3.239. 709 E ═══ PAGE SEGMENT segname EXCEEDS [LEFT|RIGHT|TOP|BOTTOM] PAGE BOUNDARY ON PAGE n. Explanation: A page segment segname extends beyond the bounds of page n. System Action: The page may be truncated or rejected by the output device if the page segment exceeds the device form size. If the CONTINUE option was specified, the page segment is placed and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Check the size of the page segment and adjust its placement to ensure that the entire page segment fits on the page. Reissue the SCRIPT command. ═══ 5.3.240. 710 E ═══ TOO MANY FONTS USED ON PAGE n. Explanation: More fonts are used on page n than are allowed for the specified physical device. System Action: If the CONTINUE option of the SCRIPT command has not been specified, processing stops. If the CONTINUE option has been specified, the page will not print. User Response: Modify the .DF [Define Font] and .BF [Begin Font] control words in the document to use fewer than the allowed number of different fonts per page. Check with your systems programmer to find out the maximum value allowed at your installation. Reissue the SCRIPT command. ═══ 5.3.241. 711 E ═══ TEXT EXCEEDS OUTPUT BUFFER SIZE ON PAGE n. Explanation: The amount of data for a single output record is more than 256 bytes on page n, excluding any carriage control character or TRC control character. System Action: If the CONTINUE option of the SCRIPT command was specified, the output record is truncated at 256 bytes and processing continues. If the CONTINUE option was not specified, processing stops. In the TSO environment, the output record is truncated to the output file LRECL or 255 whichever is less. User Response: Check control words like .CD [Column Definition], .TP [Tab Position], .TB [Tab Setting], .BX [Box], and .VR [Vertical Rule] to ensure that all horizontal displacement values result in less than 256 bytes of data per output record. Reissue the SCRIPT command. Note that if data you added with the NUMBER option of the SCRIPT command exceeds the output buffer size, this data will be truncated and no error message will be given. Note that when formatting for an IBM 2741 with the FILE option and using highlighted text, head-level control words, various GML tags, or other highlighted fonts, the backspacing and overstriking or underscoring used to achieve highlighting may cause the output record length to be several times larger than the actual text to be printed. If this is the case, the user may correct the problem by reducing the text length and/or reducing the number of overstrikes for the failing font, head level control word, or GML tag. ═══ 5.3.242. 712 W ═══ FONT STORAGE REQUIREMENT FOR PAGE n IS xxxK. Explanation: The amount of raster data for the fonts used on page n exceeds the value xxxK specified for the logical device. System Action: SCRIPT/VS processing continues, but the page may not be printable. User Response: Check control words like .DF [Define Font] and .BF [Begin Font] to ensure that all fonts used on the page are required. Reissue the SCRIPT command if desired. ═══ 5.3.243. 713 W ═══ NEGATIVE [A|C] -SPACE IN FONT `fontname' ON PAGE n MAY CAUSE ERRORS. Explanation: The current font, fontname, has a maximum a- or c-space that may cause text to extend beyond the left or right margin on page n. This font was started by a .BF [Begin Font] control word, .H0-6 control word, named area, defined variable, or restored environment. System Action: SCRIPT/VS processing continues normally, but the page may not be printable. Message 714 or 715 will follow. User Response: See message 714 or 715. ═══ 5.3.244. 714 I ═══ INCREASE PAGE MARGIN BY n DEVICE UNIT(S). Explanation: The current font has a maximum negative a- space that may extend beyond the left margin, if the character in that font with the large negative a- space occurs at the left margin. System Action: SCRIPT/VS processing continues normally, but the page may not be printable. User Response: Increase your page margin by the number or device units n. Reissue the SCRIPT command if desired. ═══ 5.3.245. 715 I ═══ DECREASE LINE LENGTH BY n DEVICE UNIT(S). Explanation: The current font has a maximum negative c- space that may extend beyond the right margin, if the character in that font with the large negative c- space occurs at the right margin. System Action: SCRIPT/VS processing continues normally, but the page may not be printable. User Response: Decrease your line length by the number or device units n. Reissue the SCRIPT command if desired. ═══ 5.3.246. 716 W ═══ x [ROW|ROWS] TOO LARGE ON PAGE n - DISCARDED. Explanation: An x number of rows in a table on page n are so large that they will not fit on an empty page. System Action: An imbed trace is printed if MESSAGE(TRACE) was specified. The rows are not printed and processing continues. User Response: Change either the dimensions of the row or the size of the page so that the row will fit on the page. ═══ 5.3.247. 717 E ═══ WIDTH OF ROTATED TABLE TOO LARGE ON PAGE n - TABLE DISCARDED. Explanation: The width of a table, rotated 90, -270, 270, or -90 degrees, is too large to fit on page n. System Action: An imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option of the SCRIPT command was specified, the table is discarded and processing continues. If the CONTINUE option was not specified, processing stops. User Response: Either change the dimensions of the table, do not rotate the table, or change the size of the page so that the table will fit on the page. ═══ 5.3.248. 718 W ═══ TOO MANY PAGE SEGMENTS MAPPED ON PAGE n. Explanation: More than 127 different page segments were mapped on the page n. This restriction applies only to the 3800 Model 3 and the 3820 printers or page printers equivalent at the data stream level. System Action: Only the first 127 page segments are included in the MPS structured field. User Response: Modify the .SI control words to map only 127 page segments per page, or modify the physical device so that `NOMAP' is the default. ═══ 5.3.249. 721 S ═══ NAMED AREA DOES NOT EXIST. Explanation: The named area specified on the .AR control word has not yet been defined. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Define the area with the .DA [Define Area] control word or use an area that has already been properly defined. Reissue the SCRIPT command. ═══ 5.3.250. 723 S ═══ FONTNAME FOR NAMED AREA DOES NOT EXIST. Explanation: The specified font for the named area has not been defined. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Either define the font or use an already defined font for the named area. Reissue the SCRIPT command. ═══ 5.3.251. 724 W ═══ UNABLE TO START FONT `fontname' FOR .DV. Explanation: The font fontname specified on a defined variable is either: o Not defined, and the variable was written to a side file in a previous run when the font was defined, o Defined but specifies TYPE parameters that cannot be satisfied in the current context. In either case, the error is detected when the variable is formatted. System Action: The content of the variable is formatted with the font unchanged. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Check the definition of the font used for the .DV to ensure that it can be started in the content where the variable is used and that it is properly defined. Reissue the SCRIPT command if desired. ═══ 5.3.252. 725 E ═══ DV VARIABLE VALUE TOO LONG. Explanation: The string given for this defined variable is longer than 256 characters and will overflow the input buffer. System Action: If the CONTINUE option was specified, the control word line is ignored. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. If the CONTINUE option was not specified, processing stops. User Response: Make the string portion of this .DV control word line smaller. Reissue the SCRIPT command. With a text variable, each character in the string is internally represented by 3 characters. Therefore, less than 256 characters in the string itself would overflow the input buffer. This is particularly true if the text variable has other text variables nested within it. With non-text variables, some of the 256 characters may be used to represent the font or baseline position of the variable; this will also decrease the number of characters allowed in the string. ═══ 5.3.253. 995 S ═══ PROCESSING ENDED AT HOST SYSTEM REQUEST - RC = n. Explanation: ATMS-III requested that SCRIPT/VS stop processing. The reason is indicated by reason code n. System Action: Processing stops. User Response: Report the problem to the system programmer at your installation. ═══ 5.3.254. 996 S ═══ INSUFFICIENT STORAGE AVAILABLE FOR INITIALIZATION. Explanation: Not enough space was available to permit preparation for formatting. System Action: Processing stops. User Response: Attempt to format the document with a larger region or virtual machine size. If the problem persists, report it to the systems programmer at your installation. ═══ 5.3.255. 997 S ═══ INSUFFICIENT STORAGE TO CONTINUE PROCESSING. Explanation: Not enough space was available to permit formatting to continue. The document may have caused a macro recursion loop or .GO loop invoking functions that require large storage amounts. System Action: Processing stops. The input line is printed, and an imbed trace is printed if MESSAGE(TRACE) was specified. User Response: Correct any errors in the document that might cause a loop. Reissue the SCRIPT command, or format the document with a larger region or virtual machine size. ═══ 5.4. Common problems: symptoms and solutions ═══ Common problems: symptoms and solutions Purpose This symptom index does not include those things we think you'll be able to figure out for yourself. For example, if a huge chunk of the document comes out highlighted, it may be traumatic, but you can still figure out for yourself that you left out (or misspelled) an end tag for a highlighted phrase. ═══ 5.4.1. Symptom: text doesn't format ═══ o Throughout the document If nothing worked, and your text and tags all come out unformatted in huge blocks, then your SCRIPT command did not specify the profile properly and the tags weren't recognized at all. If your tags don't show up in the text, but the text is unformatted as one big lump, then your SCRIPT command did not specify the library properly. In this case, the tags were recognized, but SCRIPT/VS couldn't find the processing instructions to do the work. This won't happen to you when you use BookMaster, because it checks to make sure the right library is there; if it isn't, it gives you a message and stops processing. This way, you don't waste a processing run that is sure to give you bad results. (We mention it here because it could happen if you are using a profile other than the one provided with BookMaster.) o Starting in the middle of the document When all of a sudden your formatting stops, and the text comes out in big blocks, this means that somehow you have managed, through a tag or a control word, to have one more SCRIPT/VS "restore" operation than you had "save" operations. (In this case, the restore operation restores a formatting environment in which tags are not recognized.) Something is out of balance. You will have to find it and get rid of it. The place to look is where the formatting stopped. ═══ 5.4.2. Symptom: "no APF found" message ═══ When you get the message "no APF found" for a tag, it means that SCRIPT/VS couldn't find any processing instructions (called "application processing functions") for your tag. There are several ways that this can happen: 1. Most commonly, it is a misspelled tag name, and what you have to do is correct the spelling. 2. Sometimes it results from the use of a colon in normal text that is not immediately followed by a blank, so it looks to BookMaster as if a tag was intended. You can fix this by replacing the colon with the &colon. symbol. 3. It can be caused by using a colon in front of a SCRIPT/VS control word. 4. It can be caused by using named style pseudo tags in the document. 5. It can be caused by using a tag name that is not valid for the document type. 6. If you use a named-style definition tag after the named-style end tag, like this: :zstyle. . . . :ezstyle. :zlodef. you will get the "no APF found" message. You should put the ZLODEF tag between the ZSTYLE tag and its end tag. ═══ 5.4.3. Symptom: text disappears ═══ If pieces of text disappear from your output document, the most likely reason is that you have left out a markup-content separator (the period at the end of the markup). Many of the tags will let you get away with forgetting the period, but some of them won't, and they think your text was intended as attributes and swallow it up. What's even worse, if you leave out the period, some things that come out okay today may not work in the future, due to changes in the profile you use. This is why it is a good idea to get into the habit of always putting in the period at the end of the markup. If a lot of text disappears, you may be missing a PSC end tag. Another thing that can cause text to disappear is an attribute value that contains blanks or special characters but is not enclosed in single quotes. The rest of the attribute value after the blank or special character doesn't get picked up as part of that attribute value. Table markup can also lead to disappearing text, if rows are too deep, or if the ETHD or ETFT tags begin anywhere other than column 1. Also, the use of too many symbols on a single input line can cause SCRIPT/VS to discard the text without any error message being issued. However, you can solve the problem of too many symbols on a single input line by breaking the line into multiple lines and using the &cont. symbol to concatenate the lines during formatting. ═══ 5.4.4. Symptom: lines are concatenated ═══ Lines in the scope of a LINES, XMP, CGRAPHIC, SCREEN, or DIALOG tag will be concatenated if the first line ends with an end tag, such as for a highlighted phrase. To bypass this, you can either end the line with an &rbl symbol (outside of the highlighted phrase) or use a .BR control word between the two lines. ═══ 5.4.5. Symptom: blanks disappear ═══ If you have a highlighted phrase that starts on one line and ends on another at the end of the input line, your next line of text will be butted up against the end of the highlighted phrase. This happens even when formatting is suspended in an example, screen, character graphic, or figure. The circumventions in this case depend on what you're trying to do: 1. If you are in an example, screen, character graphic, or figure, putting an &rbl. after the end of the highlighted phrase will solve the problem. 2. If you are in flowing text and the highlighted phrase does not end the sentence, just move the first word of the next line up to the same line as the end of the highlighted phrase. 3. If you are in flowing text and the highlighted phrase ends the sentence, put the punctuation mark, if possible, outside the highlighted phrase. 4. If the highlighted phrase ends the sentence and the punctuation must also be highlighted, then break the rule about always starting a sentence on a new input line, and bring the first word of the next line up to the same line as the end of the highlighted phrase, separating it from the end highlight tag with two blanks. ═══ 5.4.6. Symptom: symbol is redefined ═══ Suddenly the symbol you've defined starts showing up with a different value. You have most likely used a symbol name that BookMaster defines itself (and redefines on occasion); check the cross reference to symbols listing. ═══ 5.4.7. Symptom: semicolon won't print ═══ If a semicolon in your source document doesn't print and you get a line break instead, it's because SCRIPT/VS has misinterpreted this semicolon as a "control word separator". Use the &semi. symbol in place of the semicolon that won't print, and you're back in business. Sometimes the error caused by the semicolon looks even stranger than a simple line break - pieces of the text get duplicated and spread across several lines, for example. Even this alarming result can be solved with the &semi. symbol. ═══ 5.4.8. Symptom: colon won't print ═══ If a colon followed by characters other than a blank or a number disappears along with the characters, SCRIPT/VS thinks it is a GML tag which may result in some unintended processing. Use the &colon. symbol in place of the colon, and you'll be okay. Even if it doesn't disappear, you will get a message saying that SCRIPT/VS couldn't find an APF (application processing function) for that tag; for example, "the value is in the range AB:BB" will cause the message. If this message annoys you, again using the &colon. symbol will get rid of it. ═══ 5.4.9. Symptom: control word ignored ═══ If you have a tag that is not ended with a period followed immediately by a control word or macro, the period for the control word will be interpreted as the markup-content separator for the tag and not as the delimiter for the control word or macro. The control word or macro will be treated as text. For example, markup like this: :xmp .im xmpfile :exmp will eat the period on the IM macro and treat "im xmpfile" as the text of your example. ═══ 5.4.10. Symptom: column is narrow ═══ When you get this problem, it is almost certain that somewhere you have forgotten an end tag, or you indented and forgot to set it back to the correct margin. BookMaster does a bit of "housekeeping" when it comes to a heading tag - it identifies tags that have not ended, tries to force them to end, and gives you a message. However, if there are no more headings in your document, the checking is done for you at the end of the document. We don't guarantee that the housekeeping done when BookMaster comes to a heading will find all the things that can make the column shrink. It is a good practice to check the last couple of pages of your document and make sure that the column hasn't shrunk; if it has, then you have this problem. You'll have to search back through the document to find where the shrinkage begins and then see what has caused it. ═══ 5.4.11. Symptom: screen corners are missing ═══ If the corners on the right side of your screen are missing (or are overlaid on the left corners), your screen width definition is wider than your column width definition. You can correct this situation by making your screen narrower. ═══ 5.4.12. Symptom: table of contents, table list, assembly list, figure list, and/or cross-reference page numbers are wrong ═══ Sometimes the page numbers in cross references, the table of contents, table list, assembly list, and the figure list don't correspond to the actual pages on which the headings, tables, assemblies, and figures appear. Running the document with an additional formatting pass (FPASSES option) will generally clear this up. BookMaster also provides an "extended cross-reference facility" for repairing page numbers that can usually avoid the necessity to take additional passes. ═══ 5.4.13. Symptom: table caption page counts are out of whack ═══ If your table captions show up with impossible page counts, like "page 3 of 2", it is because there were too many discrepancies between the first and second formatting passes. Formatting with an additional pass - for example, FPASSES (3) - will usually solve the problem. Note: This problem can occur even when the extended cross-reference facility is used. ═══ 5.4.14. Symptom: figures are out of order ═══ When a number of figures with different PLACE and WIDTH attributes get bunched together, it can sometimes happen that they are printed out of order. (This can also happen when tables are placed inside figures.) This is because the figure numbers are assigned in the sequence in which the figures are found in the source file, but other things might cause the figures to be printed in a different sequence. For example, if you specify a figure with a PLACE attribute of TOP, and then follow it with a figure with a PLACE attribute of INLINE, the first figure can be floated past the second figure and thus be out of order. The fix for this problem depends on your document; you may want to move some figures around, or specify different PLACE attribute values on them. ═══ 5.4.15. Symptom: widowed head ═══ A "widowed head" is one that appears at the bottom of a column or page, with the text that is associated with the head in the next column or page. SCRIPT/VS tries to avoid widowed heads; however, sometimes this objective is in conflict with other things that SCRIPT/VS is also trying to do. Heads can be widowed when: o The head is followed by another head. o The head is followed by some largish object, like a figure or an example. o The head is followed by a three-line paragraph. In this case, if the last line of the paragraph would be a widow, SCRIPT/VS gets the preceding lines of the paragraph to prevent the widow, and in the process widows the head. The bypass (assuming you are not willing to rewrite the paragraph to make it either two or four lines long) is to force a page eject before the head, using a SCRIPT/VS control word (typically .CC - conditional column eject with a value great enough to ensure that the head and the material following it will fit). .cc 6p :h3.There and back again :p.... ═══ 5.4.16. Symptom: 3800 output is ragged ═══ You may get ragged output from a 3800 Model 1 device when: o The fonts used to format the document are not the ones used to print it. o Multiple pitched fonts are used. Note: DOCPROF JUSTIFY=YES has no effect on 3800 Model 1 output when using grids. ═══ 5.4.17. Symptom: SCRIPT/VS can't find an imbedded file (in an MVS ═══ environment) When SCRIPT/VS can't find an imbedded file, it sends you an error message. The kind of message you receive depends on the way the file is imbedded in the document. For example, if you specify an imbedded data set like this: .im horses and an error occurs, the error message refers to the file by the name of HORSES. However, if you specify the imbedded data set like this: .im 'D564321.STABLE.TEXT') the error message refers to a sequential fileid that bears no relationship to the name you used. The fileid has the format DSMTxxxx, where xxxx is the sequential number of the imbedded data set. So, if you are imbedding ten data sets and an error occurs while imbedding the sixth, the error message refers to it as DSMT0006. The NAMEFILE macro alleviates this problem. You can use it to give your file or data set a simple fileid, and then use the fileid to do the imbedding: .namefile name=horses tsofull='D654321.STABLE.TEXT' .im horses This way, the error message refers to the fileid defined with NAMEFILE: "horses". ═══ 5.4.18. Symptom: table of contents and figure list are empty ═══ If the table of contents, table list, assembly list, and figure list are empty, you've forgotten to specify FPASSES with a value of 2 or more in your SCRIPT command options. ═══ 5.4.19. Symptom: index is empty ═══ If you get a heading for your index but no entries, you've forgotten the INDEX option on the SCRIPT command (this also applies to the part number index). Of course, you also won't get an index if you forget your INDEX tag, because BookMaster has no place to put it. For a master index, there must be at least one line of text in the document or the index will not print. ═══ 5.4.20. Symptom: input buffer exceeded ═══ When you have a very large block of index entries (when it happened to us, it failed on the forty-second index entry in the block), SCRIPT/VS can come to a screeching halt with a message that the input record exceeded the input buffer length. You'll recognize this problem from the line following the message, which shows the .PI (put index) control word along with what appears to be your index entry. There are two possible bypasses for this problem: 1. If the block of index entries does not occur in the middle of flowing text (for instance, if it is just after a heading), insert a .BR (break) control word in between every couple of dozen entries. This flushes the buffer and gets it ready to take the next block. 2. If the block is in the middle of flowing text, move the line of text following the block of entries into the middle of the block, preceding the index entry that failed. This also flushes the buffer. Note: Be aware that use of the CIXn attributes can cause the creation of many index entries from very few tags, with the result that the "buffer exceeded" message is more likely to catch you unaware. If you are using cross-indexing, it is safer to flush the buffer every five to ten entries. ═══ 5.4.21. Symptom: question indention not correct ═══ If you use revision tags in questions, you may get an unusual indention for the first line of the question. It may look like this: # 6. A very large boat with a tall mast and # large sails is called a ________. To correct this indention problem, in your markup you must break the first line of the question into at least two lines and place the revision tags after the first line, like this: :question form=fillin. A very large :rev refid=ss23. boat with a tall mast and large sails is called a :erev refid=ss23. :blank ans='ship'.. :equestion. ═══ 5.4.22. Symptom: list indention not correct ═══ If you use revision tags in a list item, you may get an unusual indention for the first line of the list item. Your list may look similar to the one that follows - notice that the third list item is incorrectly indented. 1. first list item with no revision tags 2. second list item with no revision tags # 3. third list item, this time with revision tags 4. fourth list item, again with no revision tags To correct this indention problem, just rearrange your LI and REV tags, and this time don't begin a REV tag in the leftmost column of the line immediately following a LI tag that also begins in the leftmost column. :li. :rev refid=ss23. text of list item :erev refid=ss23. to this, :rev refid=ss23. :li. text of list item :erev refid=ss23. or this, :li.:rev refid=ss23. text of list item :erev refid=ss23. or almost any other way that meets your needs. Just don't put a REV tag in the leftmost column directly under a LI tag, and your indention will be correct. ═══ 5.4.23. Symptom: table rules through descenders ═══ Sometimes a horizontal rule in a table will run through the descenders of the text just above it. (The descenders are the lower legs of letters like "p" and "q".) This occurs when a row without horizontal rules of its own is ended by a table frame or by a row with horizontal rules. It looks something like this: +──────────────────────────+──────────────────────────+──────────────────────────+ │ Mind your p's and q's │ and your y's and g's │ and your j's! │ +──────────────────────────+──────────────────────────+──────────────────────────+ Several things can cause this problem. ═══ 5.4.24. Symptom: screen corners placed wrong ═══ When the screen corners don't match the lines drawn for the screen; the problem is the PROOFPRT program that converts 4250 output to 3820 or 38PP output. The corners will (and do) match on the 4250. There are font differences between the 4250 and 3820 or 38PP that make the screen corners look a little strange. ═══ 5.4.25. Symptom: IBN on covers ═══ This is a problem with the PROOFPRT program that converts 4250 output to 3820 or 38PP output. The logos will print fine on the 4250 printer. ═══ 5.4.26. Symptom: input file not found ═══ This can occur when your BMPROF exec file does not access the disk that contains your document file. ═══ 5.4.27. Symptom: unable to continue reading input file ═══ This can occur when you edit a file while the batch machine is formatting it. This can even occur when you use Xedit to peek at a file, make no changes, but press PF3 (File). While the batch machine is processing, you cannot edit any files in your document. ═══ 5.4.28. Symptom: why do I get all rules in my tables? ═══ I asked for only some rules on a table, but get a boxed frame and all horizontal and vertical rules. Why? DCF restricts the rules that you receive for tables to either all or none when you format for a line printer or terminal (3800, 3270, 1403, et al). If you don't want any rules, all of the following must be specified: frame=none hdframe=none rules=none ═══ 5.4.29. Symptom: how to get a stacked definition list ═══ I want to have a definiton list that looks like the following: TERM IS Here is the definition for ON A FEW the first term LINES NEXT TERM More definitions It doesn't work with DL, so what do I do? This is not possible to implement as a definition list in DCF. You'll need to use a table to do it, as follows: .getw symbol=termw text='term area' :table rules=none frame=none hdframe=none cols='&termw. *' width=textline split=yes. :row.:c.Term is on a few lines :c.Here is the definition for the first term :row.:c.Next term :c.More definitions. :etable. ═══ 5.4.30. Symptom: what causes "page check" errors? How to fix them? ═══ Why do I get the following message and how can I correct it? +++EDF238W Page Check: stuff on page x on pass 1 is on page y on pass 2. Whatever was on page x on the first (next-to-last) pass somehow was moved to page y on the second (last) pass. The likely cause is discrepancies between Pass 1 and Pass 2 in the length of the text that is substituted for :figref., :hdref., etc. tags. On Pass 1, forward references cannot be resolved, so BookMaster substitutes the phrase "--- Figure 'foo' unknown ---" or some such. On Pass 2, it substitutes the correct text, which is likely to be a different length. Usually, the new, improved text is longer, so that the "stuff on Pass 1" slips towards the back of the document. In your case, it appears that the string on Pass 2 got somewhat shorter, causing the "stuff on Pass 1" to creep towards the front of the document. The page check is done by the PGCHECK macro, which is called from all H0 and H1 tags (and implied H1's). There are a couple of fixes: (1) Use FPASSES(3) rather than TWOPASS, which should cause most of these references to settle down. (2) Start using DSMREFS files by specifying 'SYSVAR(R foo W foo)' every time that you SCRIPT the document -- where 'foo' is a convenient filename (e.g., the name of the main input file). The file 'foo DSMREFS' will remember the "correct" text from one SCRIPT run to the next. The use of SYSVARs R and W is otherwise known as the extended cross- reference facility. Extended cross-reference processing uses the data from the previous run ONLY ON THE FIRST PASS, and then only if the data has not already been found in the first pass. On the second pass, it USES DATA FROM THE FIRST PASS, not the data from the previous run. If this doesn't work, you may have to print two copies of the job, one with one pass and one with two and find what's happening. Sometimes sprinkling .pgcheck macros through the chapter preceding the error message will help narrow down the problem. ═══ 5.4.31. Symptom: why don't my symbols work right in an example? ═══ I'm using symbols in an example, and the one on the first line looks different from the others. My coding looks like: :xmp. First line of example with the symbol &larrow. Second line of example with the symbol &larrow. :exmp. The symbol prints differently on the first line and the second line. What's wrong? What you are seeing is a result of how DCF parses lines. It resolves the symbol on the first line of the example (as part of the residual text of the XMP tag) before it actually passes control to the XMP tag. So the font for the symbol is decided before the XMP tag can set it correctly. What you need to do is add a .BR following the XMP tag, like this: :xmp. .br First line of example with the symbol &larrow. Second line of example with the symbol &larrow. :exmp. This stops DCF from scanning for the residual text. Note that a comment (.*) will also work today, but some people are of the opinion that a .* comment should not stop the parsing, so don't rely on it always working. For similar reasons, we do not support many of the symbols in XPH. Because it is just an inline tag, we do not change the symbol definitions for every XPH. Thus, many symbols (such as ) may come out in a proportional font within an XPH. ═══ 5.4.32. Symptom: how do I selectively put horizontal rules into a table? ═══ I want to generate a table that has horizontal rules every 3 rows. How can I do this? Here's a graphic explanation of what I want: +--------------------+--------------------+ | Row 1, Cell 1 | Row 1, Cell 2 | | Row 2, Cell 1 | Row 2, Cell 2 | | Row 3, Cell 1 | Row 3, Cell 2 | +--------------------+--------------------+ | Row 4, Cell 1 | Row 4, Cell 2 | | Row 5, Cell 1 | Row 5, Cell 2 | | Row 6, Cell 1 | Row 6, Cell 2 | +--------------------+--------------------+ | Row 7, Cell 1 | Row 7, Cell 2 | | Row 8, Cell 1 | Row 8, Cell 2 | | Row 9, Cell 1 | Row 9, Cell 2 | +--------------------+--------------------+ The trick is to define a table without horizontal rules and place the rules across rows by placing an ":artwork rule width=column." in every cell of a "separator" row. The width=column is necessary so the rule spans the entire cell. The :tft. is needed to prevent depeditation in a table with no horizontal rules. :tdef id=maindef cols='* *' rules=vert. :tdef id=footdef refid=maindef mindepth=p5. :table refid=maindef. :tft refid=footdef temp. :c. :etft. :row.:c.Row 1, Cell 1:c.Row 1, Cell 2 :row.:c.Row 2, Cell 1:c.Row 2, Cell 2 :row.:c.Row 3, Cell 1:c.Row 3, Cell 2 :row.:c.:artwork rule width=column. -------------------------------------------------------------------------------- :row.:c.Row 4, Cell 1:c.Row 4, Cell 2 :row.:c.Row 5, Cell 1:c.Row 5, Cell 2 :row.:c.Row 6, Cell 1:c.Row 6, Cell 2 :row.:c.:artwork rule width=column. -------------------------------------------------------------------------------- :row.:c.Row 7, Cell 1:c.Row 7, Cell 2 :row.:c.Row 8, Cell 1:c.Row 8, Cell 2 :row.:c.Row 9, Cell 1:c.Row 9, Cell 2 :etable. ═══ 5.4.33. Symptom: how do I find all unresolved cross-references? ═══ BookMaster does not issue any error messages for cross-reference tags like HDREF and FIGREF that refer to IDs that were not found. How can I quickly locate the unresolved references without having to read every page of my text for phrases like -- Heading 'ABC' unknown --? The easiest way to catch all your unresolved cross-references is to print with SYSVAR(X YES) or on the ProcessMaster alter options menu set XREF Listing=YES. This will generate a list at the end of your document showing all IDs that were defined and all IDs that were referenced. Search the lists for question marks (?) and you've found all the IDs that were referenced but not defined. The Cross-Reference listing is broken into sections by document element type (For example: Headings, Figures, Tables). Under each section, is a 4-column table with column headings: id, File, Page, References. When an ID= is processed, BookMaster will add an entry to the 'id' column, and place the filename ('File'), current page number ('Page'), and text of the reference ('Reference') in the cross-reference listing. When a REFID= is processed and the ID= has already been defined, BookMaster will add the current page number to the 'Reference' column. When a REFID= is processed but the ID= has NOT been defined, BookMaster will add an entry to the 'id' column and use question marks (?) for the File, Page, and Reference Text. BookMaster will list the page that the REFID= was located on in the 'References' column so you can easily find it in your text. ═══ 5.4.34. Symptom: why doesn't NAMEIT GMLTYPE=HP4 make my symbol smaller? ═══ I have the following NAMEIT in my document: .nameit symbol=REQS gmltype=hp4 text='REQS' But when I use the symbol &REQS. in my document, it doen't print in the "small caps" font. I verified that my printer supports :hp4. as small caps and it does. Is there something I'm doing incorrectly or not understanding? There aren't any true "small caps" fonts generally available for our printers. So, the HP4 tag wings it by taking the normal body font, uppercasing everything, and shrinking the point size. On the NAMEIT macro, only the typeface and attributes of the highlighting level are picked up -- point size shifts are ignored. However, the SIZE attribute permits you to force a shift in point size: .nameit symbol=REQS gmltype=hp4 size='-2' text='REQS' ═══ 5.5. Script Command Options ═══ Script Command Options Purpose CHARS(font1 font2) Specifies the fonts to be used when formatting for the IBM 3800 Model 1 Printing Subsystem. EDFPRF30 expects two font specifications, the first of which is the normal text font and the second, the font used for headings, highlighting, and so forth. For example, this book, when formatted for the 3800, uses CHARS(GT12 GB12) for "gothic text, 12-pitch" and "gothic bold, 12-pitch", respectively. The fonts available are shown in the DCF User's Guide. Your organization may have added its own fonts to the ones available. FPASSES(n) Causes SCRIPT/VS to process your input document n times, producing output only on the last pass. This is necessary to resolve forward references (as when an automatically generated table of contents figure list, table list, or assemblies list). Note: Not unexpectedly, this option increases the computer processing time for the document. INDEX Causes SCRIPT/VS to create an index from index entries specified in the text of the document. If you omit the INDEX option, no index is produced. LIB(name ...) Specifies the names of the libraries containing SCRIPT/VS macros. The library normally used with EDFPRF30 is EDFLIB30 (which may have a different name in your organization). EDFLIB30 contains the APFs (application processing functions) and other macros called by EDFPRF30. OPTIONS(name) Specifies the name of a file containing more SCRIPT/VS command options. The options are processed as if they had been entered where the OPTIONS option appears. In the CMS environment, the file containing the options must have a filetype of OPTIONS. PROFILE(name) Specifies the name of a file or data set you want used as the document profile. The profile described in this book is named EDFPRF30. SYSVAR(c value ...) Specifies system variables that can be used to control the processing of a document. See the SYSVAR help topic for information on the SYSVAR options supported by EDFPRF30 and how to specify them. ═══ 5.5.1. Logical device and output destination ═══ DEVICE(type) Specifies the "logical" device and underlying physical device for which formatting is to be performed. In this context, "logical" means a combination of physical device type, page size, and, for some devices, number of lines per vertical inch. The logical device types supported by EDFPRF30 are listed below. Consult your document administrator for the logical device types that are valid in your installation and what they do. +────────────────────────────────────────────────────────────────────────────────+ │ Logical devices recognized by SCRIPT/VS and BookMaster │ +────────────+─────────────────+──────────────────────────+─────────+────────────+ │ TERMINALS │ LINE PRINTERS │ PAGE PRINTERS │ 240 PEL │ POSTSCRIPT │ │ │ │ │ DEVICES │ DEVICES │ +────────────+────────+────────+────────+────────+────────+─────────+────────────+ │ 3270 │ 1403N6 │ 3800N6 │ 3820A │ 38PPN │ 4250A │ PG1A │ PSA │ │ │ 1403N8 │ 3800N8 │ 3820A90│ 38PPW │ 4250L │ PG1A90 │ PSA90 │ │ │ 1403W6 │ 3800N12│ 3820A18│ 38PPNS │ 4250A4 │ PG1A180 │ PSA180 │ │ │ 1403W8 │ 3800W6 │ 3820A27│ 38PPWS │ │ PG1A270 │ PSA270 │ │ │ 1403W6S│ 3800W8 │ 3820L │ 38PPW90│ │ PG1L │ PSL │ │ │ 1403W8S│ 3800W12│ 3820A4 │ 38PPNS9│ │ PG1A4 │ PSA4 │ │ │ 1403SW │ 3800N6S│ │ 38PPW27│ │ PG2A │ │ │ │ │ 3800N8S│ │ │ │ PG2A90 │ │ │ │ │ 3800N12│ │ │ │ PG2A180 │ │ │ │ │ 3800W6S│ │ │ │ PG2A270 │ │ │ │ │ 3800W8S│ │ │ │ PG2L │ │ │ │ │ 3800W12│ │ │ │ PG2A4 │ │ │ │ │ │ │ │ │ │ │ +────────────+────────+────────+────────+────────+────────+─────────+────────────+ If you do not specify a device, "TERM" is the default in the CMS environment. The output destination of the document will be the physical device, unless the FILE, PRINT, or TERM options are specified. FILE(name) Causes output to be formatted for the specified logical device, but stored in the named file or data set instead of being displayed or printed. If you are using a line printer and omit the name and its surrounding parentheses, SCRIPT/VS will create a name for the output document by putting a dollar sign ($) in front of the first seven characters of the name of the input file. The default filetype is SCRIPT. If you are using a page printer and omit the name and its surrounding parentheses, SCRIPT/VS will use the name of the input file without putting in the dollar sign. The default filetype is LIST4250, LIST3820, or LIST38PP. PRINT Causes output to be formatted for the specified logical device, but printed on the system printer. If no logical device is specified, "DEVICE(1403W6)" is assumed. TERM Causes output to be formatted for the specified logical device, but displayed at your terminal instead of on the physical device. If no logical device is specified, "DEVICE(TERM)" is assumed. ═══ 5.5.2. Error handling ═══ CONTINUE Normally, SCRIPT/VS stops processing when it finds an error. This option directs it to continue processing unless the error is a severe one. MESSAGE(ID DELAY TRACE) This option, with the ID specified, causes the message identifier to be printed. This option, with the DELAY specified, causes error messages to be printed at the end of the output document, instead of being displayed at a terminal during processing. The TRACE option provides additional information pointing to where the error occurred by tracing through all the imbedded files from the one where the error occurred back to the primary input file. ═══ 5.6. BookMaster Symbols ═══ BookMaster Symbols Purpose A symbol is a name in a source document that can be replaced with something else during formatting. All symbols begin with an ampersand (&), followed by the symbol name, followed by a period. So our symbol for the bullet, which is named "bul", would look like this: &bul. The period here is just like the period you use at the end of a GML tag; it won't print in your output document. Symbols must be entered exactly as shown; that is, the symbol &ABC. is different from the symbol &abc. This means that when you use symbols, you must know the case of the name as well as the spelling. BookMaster provides these symbols for special purposes: &rbl. required blank &semi. semicolon &period. period &colon. colon &cont. continuation &colon. GML delimiter &egml. end GML delimiter &. ampersand &tab. tab character &date. date &time. time &vellip. vertical ellipsis &invellip. indented vertical ellipsis &finespace. fine space &ssbl. syntax significant blank Some symbols may not be available to you. 1. Available only on APA devices. 2. Not available on 1403 or 327x devices. 3. Available only on APA devices, and only if Math & Science fonts are installed. 4. Cannot be properly described in the directory. SYM- SYMBOL DESCRIPTION BOL NAME(S) a acute a aa A acute A Aa a circumflex a ac A circumflex A Ac a grave a ag A grave A Ag a overcircle a ao (1 A overcircle A Ao (1 a tilde a at A tilde A At a umlaut ae ae (1 A umlaut Ae Ae (1 accent acute ´. acute (1 accent grave ` grave (1 ae ligature ae aelig AE ligature AE AElig aleph &aleph. aleph (3 all &all. all (3 alpha р alpha Alpha A Alpha ampersand & amp and symbol ^ and (3 angle &angle. angle (3 angstrom П angstrom (1 apostrophe ' apos approx. identical &approxid. approxid (3 approximately &app. app, approx (1 arc &arc. arc (3 ASCII code 181 ╡ bx1012 (1 ASCII code 182 ╢ bx2021 (1 ASCII code 183 ╖ bx0021 (1 ASCII code 184 ╕ bx0012 (1 ASCII code 185 ╣ bx2022 (1 ASCII code 186 ║ bx2020 (1 ASCII code 187 ╗ bx0022 (1 ASCII code 188 ╝ bx2002 (1 ASCII code 189 ╜ bx2001 (1 ASCII code 190 ╛ bx1002 (1 ASCII code 198 ╞ bx1210 (1 ASCII code 199 ╟ bx2120 (1 ASCII code 200 ╚ bx2200 (1 ASCII code 201 ╔ bx0220 (1 ASCII code 202 ╩ bx2202 (1 ASCII code 203 ╦ bx0222 (1 ASCII code 204 ╠ bx2220 (1 ASCII code 205 ═ bx0202 (1 ASCII code 206 ╬ bx2222 (1 ASCII code 207 ╧ bx1202 (1 ASCII code 208 &bx2101. bx2101 (1 ASCII code 209 ╤ bx0212 (1 ASCII code 210 ╥ bx0121 (1 ASCII code 211 ╙ bx2100 (1 ASCII code 212 ╘ bx1200 (1 ASCII code 213 ╒ bx0210 (1 ASCII code 214 ╓ bx0120 (1 ASCII code 215 ╫ bx2121 (1 ASCII code 216 ╪ bx1212 (1 asterisk * asterisk at sign @ atsign back slash \ bslash, bsl backspace bs backward logical not й lnotrev (1 ballot box [_] ballot, box because &because. because (3 beta &beta. beta (1 Beta с Beta blank (b with slash) &blank. blank (1 box ascender ╩ bxas, bxbj box cross ┼ bxcr, bxcj box descender ╛ bxde, bxtj box horizontal ─ bxh box left junction Е bxle, bxlj box lower-left └ bxll SYM- SYMBOL DESCRIPTION BOL NAME(S) box lower-right ┘ bxlr box right junction О bxri, bxrj box upper-left ┌ bxul box upper-right ┐ bxur box vertical │ bxv bullet o bullet, bul c cedilla c cc (1 C cedilla C Cc (1 caret ^ caret cent Ы cent checkmark &check. check (1 chi &chi. chi (1 Chi &Chi. Chi circle &circ. circ (3 circle &circle. circle (1 circled dot &cdot. cdot (3 circled equals &cequal. cequal (3 circled minus &cminus. cminus (3 circled plus &cplus. cplus (3 circled times &ctimes. ctimes (3 close single quote ' csq club solid &CLUB. CLUB (1 colon : colon concatenate ││ concat congruent &congruent. congruent (1 contains as a subset &contains. contains (1 continuation char. cont (4 copyright (C) copr, copyr dagger &dagger. dagger (1 date date (4 up/down arrow/underscore &udarrowus. udarrowus (1 dbl. excl. point &dblxclm. dblxclm, dblxclam (1 decrease &decrease. decrease (3 definition/defined as ::= def degree ° degree, deg (2 del &del. del (1 delta ы delta (1 Delta &Delta. Delta (1 delta (variation) &vardelta. vardelta (1 determines &determines. determines (3 diamond solid &DIAMOND. DIAMOND diamond wide &diam. diam (3 diamond &diamond. diamond (1 divide / divide, div division slash / divslash dollar $ dollar dot . dot double C &doubleC. doubleC (3 double dagger &dbldag. dbldag (1 double dot .. dotdot double N &doubleN. doubleN (3 double P &doubleP. doubleP (3 double Q &doubleQ. doubleQ (3 double R &doubleR. doubleR (3 double S &dbls. dbls, sect, section (2 double Z &doubleZ. doubleZ (3 down arrow V darrow down arrowhead V dahead e acute e ea E acute E Ea e circumflex e ec E circumflex E Ec e grave e eg E grave E Eg e umlaut ee ee E umlaut Ee Ee eighth note ¬e18. note18 (1 ellipsis ... ellip, ellipsis em dash -- emdash, mdash en dash, dash - endash, ndash end quoted hex string ' ehex epsilon ю epsilon (1 Epsilon &Epsilon. Epsilon equals = eq, equals, eqsym equivalent &eqv. eqv (1 SYM- SYMBOL DESCRIPTION BOL NAME(S) eta &eta. eta (1 Eta &Eta. Eta Eulers &euler. euler (3 exclamation point ! xclm, xclam exists &exists. exists (3 face solid &FACE. FACE (1 face &face. face (1 factorial &factorial. factorial (3 fat cursor &cursor. cursor (1 female symbol &female. female (1 ff ligature ff ff ffi ligature ffi ffi ffl ligature ffl ffl fi ligature fi fi five eighths 5/8 frac58 fl ligature fl fl florin &florin. florin (1 fnof Я fnof (1 French close dbl. quote >> cdqf French open dbl. quote << odqf function of Я fnof gamma &gamma. gamma (1 Gamma т Gamma German close dbl. quote " cdqg German close sng. quote ' csqg German es-zet Document Composition Facility: Generalized Markup Lan- guage Starter Set ss German open dbl. quote " odqg German open sng. quote ' osqg gml delimiter : gml gml end tag delimiter :e egml greater than rank >rank. gtrank (3 greater than > gt, gtsym grtr. than or eq. rank &gerank. gerank (3 grtr. than or less than >lt. gtlt (3 grtr. than or equiv. >equiv. gtequiv (3 gtr. than or equal to Є ge, gesym h bar &hbar. hbar, planck (3 hamiltonian H hamilton (3 hat ^ hat heart solid &HEART. HEART (1 house  house (1 hyphen - hyphen i acute i ia I acute I Ia i circumflex i ic I circumflex I Ic i grave i ig I grave I Ig i umlaut ie ie I umlaut Ie Ie identical == identical if and only if &iff. iff (3 ij ligature ij ij increase &increase. increase (3 infinity ь infinity (1 integral bot. half ї intbot (1 integral top half Ї inttop (1 integral &integral. integral (1 intersection of sets я intersect (1 inverted ! н inve (1 inverted ? и invq (1 iota &iota. iota (1 Iota &Iota. Iota improper subset &isubset. isubset (3 improper superset &isuperset. isuperset (3 join &join. join (1 kappa &kappa. kappa (1 Kappa &Kappa. Kappa lambda &lambda. lambda (1 Lambda &Lambda. Lambda large bullet o lbullet left arrow < larrow left arrowhead < lahead left barb &lbarb. lbarb (3 SYM- SYMBOL DESCRIPTION BOL NAME(S) left brace д lbrace, lbrc left bracket [ lbracket, lbrk left double arrow &ldarrow. ldarrow (3 left parenthesis ( lparen, lpar left-right arrow &lrarrow. lrarrow (1 less than or eq. rank &lerank. lerank (3 less than or equal to є le, lesym less than rank <rank. ltrank (3 less than < lt, ltsym liter &liter. liter, scriptl (1 logical not ^ lnot, notsym logical or │ lor lozenge &loz. loz, lozenge (1 ls. than or equiv. <equiv. ltequiv (3 male symbol &male. male (1 meet &meet. meet (1 member of &memberof. memberof (1 micro second microsecond usec minus operation - minus, minusop minus-plus &mp. mp (3 mu ц mu (1 Mu &Mu. Mu much greater than >gt. gtgt (3 much less than <lt. ltlt (3 mult. dot large &lmultdot. lmultdot (1 mult. dot small &smultdot. smultdot (1 multiply * mult, times n tilde n nt N tilde N Nt nearly equal ў nearly (3 not improper subset &nisubset. nisubset (3 not improper superset &nisuperset. nisuperset (3 not a member &nmemberof. nmemberof (3 not a subset &nsubset. nsubset (3 not a superset &nsuperset. nsuperset (3 not equal to ╪ ne, nesym not existant &nexists. nexists (3 not identical &nidentical. nidentical (3 not less than rank &nltrank. nltrank (3 not less or equal rank &nlerank. nlerank (3 not nearly equal &nnearly. nnearly (3 not symbol ^ notsym, lnot nu &nu. nu (1 Nu &Nu. Nu number sign # numsign o acute o oa O acute O Oa o circumflex o oc O circumflex O Oc o grave o og O grave O Og o slash OS/VS os O slash O Os o tilde o ot O tilde O Ot o umlaut oe oe O umlaut Oe Oe oe ligature oe oelig OE ligature OE OElig omega &omega. omega (1 Omega ъ Omega omicron &omicron. omicron (1 Omicron &Omicron. Omicron one eighth 1/8 frac18 one half 1/2 frac12 one quarter 1/4 frac14 open single quote ' osq or symbol │ or pair of 16th notes ¬e1616. note1616 (1 paragraph &par. par (1 parallel ││ parallel partial &partial. partial (1 period . period perpendicular &perpend. perpend (3 peseta &peseta. peseta (1 SYM- SYMBOL DESCRIPTION BOL NAME(S) phi э phi (1 Phi ш Phi phi (variation) &varphi. varphi (1 physician Rx Rx Rx pi у pi (1 Pi &Pi. Pi plus at end of line + plusend plus operation + plusop plus-minus ё plusmin, pm plus + plus pound sterling Ь Lsterling (1 prime ' prime product &product. product (1 proportion &proportion. proportion (1 psi &psi. psi (1 Psi &Psi. Psi (1 ratio &ratio. ratio (3 registered trademark (R) regtm required blank rbl reverse bullet &revbul. revbul (1 reverse circle &revcir. revcir (1 rho &rho. rho (1 Rho &Rho. Rho riemann integral &riemann. riemann (3 right arrow > rarrow right arrowhead > rahead right barb &rbarb. rbarb (3 right brace З rbrace, rbrc right bracket ] rbracket, rbrk right double arrow &rdarrow. rdarrow (3 right parenthesis ) rparen, rpar right prime &rprime. rprime (3 script I &scriptI. scriptI (3 script l &scriptl. scriptl, liter (1 section §. sect, section, dbls (2 semicolon ; semi seven eighths 7/8 frac78 shaded box 1/2 dots ▒ box12 (1 shaded box 1/4 dots ░ box14 (1 shaded box 3/4 dots ▓ box34 (1 sigma х sigma (1 Sigma ф Sigma (1 sigma (variation) &varsigma. varsigma (3 similar ~ similar (1 slash left \ bslash, bsl slash right Document Composition Facility: SCRIPT/VS Language Refer- ence slr, slash solid box bottom half ▄ BOXBOT (1 solid box left half ▌ BOXLEFT (1 solid box right half ▐ BOXRIGHT (1 solid box top half ▀ BOXTOP (1 solid box █ BOX (1 spade solid &SPADE. SPADE (1 split vertical bar | splitvbar (1 square bullet ■ sqbul, sqbullet (2 square root √ sqrt (1 star solid &STAR. STAR (1 start quoted hex string X' hex straight double quote " sdq straight single quote ' ssq subscript left paren &sublpar. sublpar (1 subscript minus &subminus. subminus (1 subscript plus &subplus. subplus (1 subscript right paren &subrpar. subrpar (1 subscript 0 0 sub0 (1 subscript 1 1 sub1 (1 subscript 2 2 sub2 (1 subscript 3 3 sub3 (1 subscript 4 4 sub4 (1 subscript 5 5 sub5 (1 subscript 6 6 sub6 (1 subscript 7 7 sub7 (1 subscript 8 8 sub8 (1 subscript 9 9 sub9 (1 subset of, included in &subset. subset (1 SYM- SYMBOL DESCRIPTION BOL NAME(S) such that &suchthat. suchthat (3 sum &sum. sum (1 sun &sun. sun (1 superscript left paren &suplpar. suplpar (1 superscript minus &supminus. supminus (1 superscript n № supn (1 superscript plus &supplus. supplus (1 superscript right paren &suprpar. suprpar (1 superscript 0 ╡ sup0 superscript 1 (1 sup1 superscript 2 (2 sup2 superscript 3 (3 sup3 superscript 4 (4 sup4 superscript 5 (5 sup5 superscript 6 ц sup6 superscript 7 ╗ sup7 superscript 8 ╝ sup8 superscript 9 ╜ sup9 superset &superset. superset (3 tab tab (4 tau ч tau (1 Tau &Tau. Tau telephone solid &TELEPHONE. TELEPHONE (1 telephone &telephone. telephone (1 therefore &therefore. therefore (3 theta &theta. theta (1 Theta щ Theta (1 theta (variation) &vartheta. vartheta (1 three eighths 3/8 frac38 three quarters 3/4 frac34 tilde ~ tilde (1 time time (4 times * times, mult trademark (TM) tm triangle solid &TRIANGLE. TRIANGLE (1 triangle &triangle. triangle (1 u acute u ua U acute U Ua u circumflex u uc U circumflex U Uc u grave u ug U grave U Ug u umlaut ue ue U umlaut Ue Ue underscore _ us underscored a ж aus (1 underscored o з ous (1 union of 2 sets &union. union (1 up arrow A uarrow up arrowhead A uahead up-down arrow &udarrow. udarrow (1 up left barb &ulbarb. ulbarb (3 up right barb &urbarb. urbarb (3 upside down not &lnotusd. lnotusd (1 upsilon &upsilon. upsilon (1 Upsilon &Upsilon. Upsilon (1 vector &vector. vector (1 vertical ellipsis vellip (4 weierstrass elliptic &weierstr. weierstr (3 xi &xi. xi (1 Xi &Xi. Xi y umlaut ye ye Y umlaut Ye Ye yen Э yen (1 zero slashed &zero. zero (3 zeta &zeta. zeta (1 Zeta &Zeta. Zeta ═══ 5.7. SYSVARs BookMaster Script System Variables ═══ SYSVARs BookMaster Script System Variables Purpose System variables (SYSVARs) are values that can be passed in your SCRIPT/VS command (or, with CMS, in an options file called by that command) that allow you to control certain aspects of EDFPRF30 processing. SYSVARs are specified in your command options as follows: SYSVAR(c value c value ...) where c is the single character designation of the system variable you are specifying and value is the value you are assigning to it. A Annotation printing; can be set to: NO do not print annotations marked up with the ANNOT tag (default). YES print annotations B Book spine (EDFIUO maclib). SPINE print a book spine. For perfect bound books which are a half inch or larger in thickness, a book spine can be produced for styles IBMXAGD and IBMXARF by specifying the Script option SYSVAR(B SPINE) and using the COVER tag in the document. The information for the spine is obtained from the LIBRARY, TOPIC, VERSION, RELEASE, and DOCNUM tags. D Duplexing; can be set to: YES duplexing on; all level 1 segments force a right-hand page This is the initial setting. SB duplexing on; suppress blank pages (do not force a right-hand page) for level 1 segments. NO duplexing off; no blank pages. Duplexing on is intended for documents that will ultimately be printed on two sides of the paper; in some styles, it causes the running feet to be formatted differently on odd and even pages. Duplexing is requested by the SB or the YES option. Duplexing off (NO) is used when a document is not going to be reproduced on two sides of the paper. The running feet are handled the same on all pages, and there are no blank pages. This SYSVAR overrides the setting of the DUPLEX attribute on the DOCPROF tag. E Explode report (DVCF); can be set to YES. Setting it to any value at all causes the explode report to be produced; it is the existence of SYSVAR E, not its value, that is checked. F Folio-by-chapter (also known as "modular page numbering"); can be set to: CHAPnum number pages and figures by chapter/appendix, starting with chapter number num (that is, CHAP6 will cause the page numbering to start with 6-1) When this option is used, the first printing item in the file being processed should be an H1 tag for the chapter (a prolog is not a "printing" item. APPltr number pages, tables, assemblies, and figures by appendix, starting with appendix letter ltr When this option is used, the first printing item in the file being processed should be an H1 tag for the appendix (a prolog is not a "printing" item). FBC number pages, tables, assemblies, and figures by chapter/appendix (that is, page 3 of chapter 2 is numbered "2-3") When this option is used, the document should be complete, and must have a BODY tag at a minimum. This SYSVAR overrides the setting of the FBC attribute on the DOCPROF tag. G Include artwork. SYSVAR G performs the same function as the @ARTINCL user option. It accepts the same values: YES include the artwork INLINE include the artwork AND imbed it inline NO don't include the artwork, but leave space for pasting it in NOSPACE don't include the artwork and don't leave space H Head numbering; can be set to: NO do not number heads YES number heads value number heads starting with this value This allows you to process pieces of the document and get the heads numbered as if the whole document were being processed. For example, if the first heading in the piece is an H3, and you wanted it numbered 3.6.2, you would enter SYSVAR (H 3.6.2) When set to YES or NO, this SYSVAR overrides the setting of the HEADNUM attribute on the DOCPROF tag. When set to YES or to a value, the HEADNUM attribute, if specified, governs the levels of headings that will be numbered. If HEADNUM is not specified in the document, the initial setting for numbered headings is 1 through 4. I Show index entries; can be set to SHOW. (In fact, setting this SYSVAR to any value has the same effect.) This causes the index entries to be printed in place, in the document. M Master index; can be set to the name of the master-index-input file. This SYSVAR is acted upon only if the MINDEX tag is present in the source file. N reader's comment form and mailer (EDFIUO maclib). A Reader's Comment Form (RCF) and reply mailer may be generated for C&SI document styles IBMXAGD, IBMXARF, IBMXBGD, IBMXBRF, IBMXGGD, and IBMXASV. These two pages will be printed at the same time as the book, just preceding the back cover. The Reader's Comment Form and mailer will only print when SYSVAR N is specified, the &edfiuo. macro library is used, and the COVER tag is used in the document. The information for the RCF and mailer is obtained from the LIBRARY, TOPIC, VERSION, RELEASE, and DOCNUM tags of the source files and the ADDRESS and ZIP tags of the address file specified by SYSVAR N. The address file you create must have a filetype of ADDRESS. For example, if your address file was called LOCBLD ADDRESS, then the address file would contain: :address. International Business Machines Corporation Information Development Department Z99 PO BOX 31678 BOULDER CO :zip.82301-7690 &egml.address. P Process value; can be set to: value sets value on (that is, the condition is true) This SYSVAR allows you to set the condition that is to be "true" when processing PSC tags with the PROC attribute specified. Q Reserved for BookMaster development debugging purposes. R Extended cross-reference "read"; can be set to the name of the extended cross-reference file that is to be read for this formatting run. S Layout; can be set to: 1 single column 2 double column 3 three columns 8 eight columns OFFSET offset Single column (1) sets a one-column page. Double column (2) sets a double-column page. Offset (OFFSET) is the layout used for most manuals; the text (except for back matter, which is double column) is set in a single column offset from the left margin. This SYSVAR overrides the setting of the LAYOUT attribute on the DOCPROF tag. T Title page; can be set to: YES title page with elements aligned on the right RIGHT title page with elements aligned on the right (same as YES) CENTER title page with elements centered LEFT title page with elements aligned on the left NO no title page This SYSVAR overrides the setting of the TIPAGE attribute on the DOCPROF tag. U User options file name. This is an alternative to the @USER-OPTION form of user options. The file named will contain all of the user options. The filetype must be USEROPT. The file can contain only valid BookMaster user options, each one on a line by itself. Any other options are discarded, and an error message is issued. Here's what your user options file will look like: @DIALOG (LABEL) @BASEFONT (HELVETICA) . . . W Extended cross-reference "write"; can be set to the name of the extended cross-reference file that is to be written during this formatting run. X Cross-reference listing; can be set to: YES | ALL Produce cross-reference listing (initial setting). Display imbed trace on the terminal when processing in foreground. NO | DONLY Do not produce cross-reference listing. Display imbed trace on the terminal when processing in foreground. XONLY Produce cross-reference listing. Do not display imbed trace on the terminal. NONE Do not produce cross-reference listing. Do not display imbed trace on the terminal. EDFPRF30 generates an extremely useful listing at the end of your document that contains information about all the ID and REFID attributes used (HDREF, FIGREF, FNREF, etc.) and an imbed trace. You will definitely want this listing while you are developing your document. However, if you are printing multiple copies (say, for distribution as review drafts), you will want to suppress this listing. This SYSVAR lets you do that. 0 DVCF conditions file. It can be set to the name of a file that contains symbol definitions for DVCF conditions. 1-9 DVCF conditions. Each of the 9 can be set to an individual DVCF condition. ═══ 5.8. BookMaster User Options ═══ BookMaster User Options Purpose User options are specified by themselves in the SCRIPT/VS command or in an options file called by the SCRIPT/VS command. They also can be included in a USEROPT file as described on page They are identified by the first character in the option name, which is always an "@". For example, a user option might look like this: @USEROPT Some user options may have "suboptions", which are specified by enclosing them in parentheses following the user option. They might look like this: @USEROPT(SUBOPT1 SUBOPT2 SUBOPT3) The user options supported by EDFPRF30 are: @ARTINCL(options) Specifies whether to include artwork. @ARTINCL allows the same values as SYSVAR G. @DIALOG(options) Specifies the formatting technique to be used for dialogs. It overrides the setting of the DIALOG attribute on the DOCPROF tag. The options can be any or all of LABEL, FONT, and COLOR. @BASEFNT(font name) Specifies the name of the base font to be used in formatting the document. The font named will be used for all body copy. @HEADFNT(font name) Specifies the name of the head font to be used in formatting the document. The font named will be used for all headings. If any part of the font typeface name for either the base font or the head font is longer than eight characters, that font name must be included in the USEROPT file specified by the SYSVAR U option. Otherwise, the part of the font name that is longer than eight characters will be truncated and will no longer be a valid font typeface name. @UPROF(filename) Specifies a file that is to be processed at the end of EDFPRF30 processing, before it starts processing your document. @XMPID When this option is used, any ID attributes on XMP tags will be printed at the beginning of the example.