DSRtoSDML Reference Manual December 28, 1987 This manual describes the DSRtoSDML program, which converts a DSR input file to a VAX DOCUMENT input file. It explains how the converter interprets the commands and flags of DSR, discusses the translation of command combinations that identify higher level constructs, and describes how to run the converter. _______________________________________________________ Preface DSRtoSDML converts DSR files to VAX DOCUMENT V1.0 files. It reads a .RNO file and produces a converted .SDML file. If DSRtoSDML finds problems in the conversion, it produces a list file (.RNO_LIS). o Chapter 1 explains how to use DSRtoSDML. o Chapter 2 describes the conversion of text lines. o Chapter 3 describes the conversion of commands. o Chapter 4 explains the recognition and conversion of command combinations. o Appendix A provides an alphabetic list of DSR commands and a reference to further discussion for each command. o Appendix B lists the error messages. v _______________________________________________________ Contents _________________________________________________ PREFACE v _______________________________________________________ CHAPTER 1 INTRODUCTION 1-1 _________________________________________________ 1.1 CONVERTING FILES 1-2 1.1.1 Copying the Converter 1-2 1.1.2 Running the Converter 1-2 1.1.3 Preparing to Run VAX DOCUMENT 1-3 1.1.4 Running VAX DOCUMENT 1-4 1.1.5 Inspecting the Result 1-4 _________________________________________________ 1.2 CONVERSION METHODS 1-4 1.2.1 Example of Conversion 1-5 1.2.2 Direct Method 1-5 1.2.3 Profile Method 1-6 1.2.4 Marking Preface and Abstract 1-7 _______________________________________________________ CHAPTER 2 TEXT PROCESSING 2-1 _________________________________________________ 2.1 FLAGS 2-1 _________________________________________________ 2.2 SYMBOLIC REFERENCES 2-3 _________________________________________________ 2.3 SPECIAL CHARACTERS 2-4 iii Contents _______________________________________________________ CHAPTER 3 COMMAND PROCESSING 3-1 _________________________________________________ 3.1 PAGE FORMATTING COMMANDS 3-2 3.1.1 Page Size and Running Heads 3-2 3.1.2 Paging and Page Number Control 3-2 3.1.3 Subpaging 3-3 _________________________________________________ 3.2 TEXT FORMATTING COMMANDS 3-3 3.2.1 Margin Settings 3-3 3.2.2 Filling and Justification 3-3 3.2.3 Vertical Spacing 3-5 3.2.4 Horizontal Spacing 3-7 3.2.5 Paragraph Formatting 3-8 3.2.6 Text Emphasis 3-8 3.2.7 Figures 3-9 3.2.8 Lists 3-11 3.2.9 Notes and Footnotes 3-14 _________________________________________________ 3.3 SECTION FORMATTING COMMANDS 3-15 3.3.1 Appendixes and Chapters 3-16 3.3.2 Sections 3-17 3.3.3 Indexes 3-18 3.3.4 Table of Contents 3-19 _________________________________________________ 3.4 FLAG RECOGNITION COMMANDS 3-19 _________________________________________________ 3.5 MISCELLANEOUS COMMANDS 3-20 iv Contents _______________________________________________________ CHAPTER 4 SPECIAL COMMAND COMBINATIONS 4-1 _________________________________________________ 4.1 DEFINITION LISTS 4-1 _________________________________________________ 4.2 CROSS REFERENCES 4-2 4.2.1 Adding New Reference Keywords 4-3 4.2.2 Deleting Reference Keywords 4-4 _________________________________________________ 4.3 INPLICIT CAPTIONS 4-5 _________________________________________________ 4.4 TABLES 4-5 4.4.1 Tables with Tabs 4-11 4.4.2 Tables with Dashes and Bars 4-12 4.4.3 Tables coded using Nofill mode 4-13 _________________________________________________ 4.5 ANGLE BRACKETS 4-15 _________________________________________________ 4.6 CONTENTS ENTRIES 4-16 _______________________________________________________ APPENDIX A SUMMARY OF DSR COMMANDS A-1 v Contents _______________________________________________________ APPENDIX B ERROR MESSAGES B-1 _______________________________________________________ INDEX _______________________________________________________ TABLES 1-1 Qualifiers 1-3 1-2 Methods of Conversion 1-4 2-1 Conversion of Flags 2-2 3-1 DSR Command Classification 3-1 3-2 Page Size and Running Head Commands 3-2 3-3 Paging Commands 3-2 3-4 Subpaging Commands 3-3 3-5 Margin Commands 3-3 3-6 Fill and Justification Commands 3-3 3-7 Vertical Spacing Commands 3-5 3-8 .BLANK or .SKIP Conversion 3-5 3-9 Horizontal Spacing Commands 3-7 3-10 Paragraph Commands 3-8 3-11 Text Emphasis Commands 3-8 3-12 Figure Commands 3-9 3-13 List Commands 3-12 3-14 Note and Footnote Commands 3-14 3-15 Appendix and Chapter Commands 3-16 3-16 Section Commands 3-17 3-17 Index Commands 3-18 3-18 Table of Contents 3-19 3-19 Flag Recognition Commands 3-19 3-20 Miscellaneous Commands 3-20 A-1 Summary of DSR Commands A-1 vi _______________________________________________________ 1 Introduction The DSR-to-SDML Converter program, DSRtoSDML, converts a DSR input file to a VAX DOCUMENT input file. The converter performs the following actions: o Translates DSR commands to their SDML equivalents o Interpets and processes DSR flags appropriately o Treats some DSR command combinations as higher level constructs o Recognizes and processes cross references o Recognizes and processes captions o Removes control characters and protects characters reserved by VAX DOCUMENT The converter has two major goals: o Produce a file that can be successfully processed by VAX DOCUMENT. o Generate VAX DOCUMENT constructs that are stylistically correct. The second goal is harder to achieve than the first, because the converter often does not have sufficient information to make the best translation. The converter will sometimes need help in interpreting the DSR file. When it is dealing with combinations of DSR commands or trying to draw conclusions from the position of text on the page, it is making its best guess at the translation and can guess wrong. If the converter does make the wrong guess, you can sometimes help it out by reformatting the DSR file. The rules 1-1 Introduction that the converter uses to make its guesses are given in Chapter 4. The converter has two modes of operation: o Direct Mode--In this mode, the converter creates a corresponding .SDML file for each .RNO file it converts o Profile--In this mode, looks at the structure of the .RNO file and creates a VAX DOCUMENT profile and a set of VAX DOCUMENT element files. The normal mode of operation is direct. If the /PROFILE qualifier is given on the command line, the profile mode is used. For more information on these two methods, see Section 1.2. __________________________________________________________________ 1.1 Converting Files The best way to approach the converter is to try it out. DSRtoSDML creates valid SDML files from most DSR source files. The steps involved in converting a file are the following: o Run DSRtoSDML to convert the DSR file to a VAX DOCUMENT file. o Resolve any cross references indicated by the converter's list file. o Run VAX DOCUMENT to get formatted output. If the converted file doesn't produce the results you want when you run it through VAX DOCUMENT, you can edit the DSR file so that the converter has more information or you can edit the SDML file to correct deficiencies in the conversion. 1-2 Introduction ___________________________ 1.1.1 Copying the Converter To use the DSRtoSDML converter, copy the DSRtoSDML.EXE file to a directory on your machine and enter the following line in your LOGIN.COM file: $ DSRtoSDML :== $ yourdisk:[yourdirectory]DSRtoSDML.exe ___________________________ 1.1.2 Running the Converter You can then run DSRtoSDML as follows: $ DSRtoSDML filename[/qualifier ...] Filename is the name of the file you wish to convert. Note: DSRtoSDML converts only files that have an .RNO extension. DSRPLUS users--DSRtoSDML also converts .RTB files. The file you submit to DSRtoSDML should be a file that runs correctly through DSR. DSRtoSDML interprets the flag settings and other control information that DSR requires. It must have a complete DSR file to do its job properly. You can use either the direct method or the profile method, as described in Section 1.2. DSRtoSDML converts the file you specify on the command line and any files required within that file that have an .RNO extension. DSR handles undocumented commands. DSRtoSDML handles as many of these commands as it knows about, but you may find that a file with incorrect DSR code processes without errors through DSR and yet causes 1-3 Introduction error messages on conversion. You should look very carefully at any such file. The best solution would be to correct the DSR code so that it conforms to the description in the DSR manual. Table 1-1 lists the qualifiers that can be used when invoking the converter. The following qualifiers are supplied: Table 1-1 Qualifiers _______________________________________________________ /PROFILE=profilename Selects the profile method of conversion. If you don't specify this qualifier, the direct method of conversion is used. Conversion methods are described in Section 1.2. /TITLE=quoted string Provides a document title. If you use the profile method, you can supply a title for the title page with this qualifier. /NODEFLIST Suppresses definition list interpretation. If you use margin settings and indents that confuse the converter, use this qualifier. The interpretation of definition lists is described in Section 4.1. /NOLIST Prints errors and warnings on your terminal and does not make a a list file. If you don't specify this qualifier, your list file will be filespec.RNO_ LIS and only important errors will be printed on your terminal. 1-4 Introduction Table 1-1 (Cont.) Qualifiers _______________________________________________________ /INCLUDE_DSR Encloses DSR commands in comments in your SDML listing. If you do not use this qualifier, DSR commands are not shown in your SDML listing. /KEY Converts to the appropriate , , or tag. If you do not use this qualifier, a left angle bracket is enclosed in the tag. The conversion of angle brackets is described in Section 4.5. _______________________________________________________ DSRPLUS USERS: If you use .HT, .HF, and .HE commands to captions your tables, figures, and examples, you can use the /NOIMPLICIT_CAPTION qualifier to disable the implicit caption checking. Then you will not have any false caption identifications. ___________________________ 1.1.3 Preparing to Run VAX DOCUMENT If DSRtoSDML detects any errors or unresolved cross references during conversion, it prints a message on the terminal screen. If it doesn't print such a message, you can assume that no errors were detected. If there are unresolved cross references, the list file indicates the name of the cross reference symbol and the numbr of references. Section references are never defined by DSRtoSDML, so you must identify any sections that are referenced. These references begin with the letter 'S'. 1-5 Introduction You can run the file with unresolved references through VAX DOCUMENT. If there are fewer than 30, you will probably get output and the undefined references will be listed in that output. If there are more than 30 references, the tag translator will abort the run. The tag translator error messages provide help in locating the undefined references. ___________________________ 1.1.4 Running VAX DOCUMENT If you used the direct method of conversion, you submit the file you converted to VAX DOCUMENT by specifying the file you named as input to the converter as the file for VAX DOCUMENT. For example, you might convert the DSR file ALPHA and run it as follows: $ DSRtoSDML ALPHA $ DOCUMENT ALPHA REPORT LN03 If you used the profile method, you use the profilename as input to VAX DOCUMENT and you probably also want to specify the /CONTENTS and /INDEX qualifiers to get a table of contents and index. For example, you might convert the DSR file MYBOOK.RNO as follows: $ DSRtoSDML MYBOOK/PROFILE=MB/TITLE="REFLECTIONS ON WRITING" $ DOCUMENT MB MANUAL LN03/CONTENTS/INDEX 1-6 Introduction ___________________________ 1.1.5 Inspecting the Result Look carefully at the result produced by VAX DOCUMENT. You may find that some of your highly structured coding has been "flattened out" by DSRtoSDML. Usually, in such cases, you want to use doctype- specific tags. You can add these tags and try running VAX DOCUMENT again. See the VAX DOCUMENT User Manual Volumne 2 for more information on doctype-specific tags. __________________________________________________________________ 1.2 Conversion Methods DSRtoSDML has two methods of conversion, namely: o Direct conversion o Profile creation The direct method is the default; you select profile method by using the /PROFILE qualifier on the command line when you run DSRtoSDML. 1-7 Introduction Table 1-2 Methods of Conversion _______________________________________________________ Method______Qualifier_____________Description__________ Direct default DSRtoSDML produces an output file with the same name as the input file and the .SDML extension. It converts any required files and produces .SDML file for each required .RNO file. Profile /PROFILE=profilename DSRtoSDML produces Creation a profile file (profilename.SDML) and a set of element files. It treats each chapter or appendix of the input file as a separate element. It encloses in comments all text that appears before the first chapter and provides its own front matter element. _______________________________________________________ The following sections show a DSR source file, the result of converting that file with the direct method and then the result of converting that file with the profile method. 1-8 Introduction ___________________________ 1.2.1 Example of Conversion Consider the DSR file XYZ.RNO, which contains a title page , contents, and four chapters: .page .c;This is the title .b.b .c;Another title .page .c;Preface .b XYZ is a system for the generation of text. .page 1. First chapter 2. Second Chapter .ch Introduction This is the introduction .b It explains the way to use the xyz system .ch Language Considerations The XYZ has its own language. .b More on this later. .req "insert1.rno" .ch Conclusions And now to draw some conclusions. The required file INSERT1.RNO contains the chapter on Details: This is an insert. .ch Insert Chapter Details are given here. 1-9 Introduction ___________________________ 1.2.2 Direct Method The direct method is the default. You can process the XYZ file as follows: $ DSRtoSDML XYZ The converter produces two files, XYZ.SDML and INSERT1.SDML. The XYZ.SDML file is as follows: (Created by DSRtoSDML from file XYZ.rno) ( on 24-DEC-1987 at 10:49:04.81) (This is the title)

(Another title) (Preface)

XYZ is a system for the generation of text. 1. First chapter 2. Second Chapter (Introduction\C1)

This is the introduction

It explains the way to use the xyz system (Language Considerations\C2)

The XYZ has its own language.

More on this later. (insert1.SDML) (Conclusions\C4)

And now to draw some conclusions. The INSERT1.SDML file is as follows: (Created by DSRtoSDML from file insert1.rno) This is an insert. (Insert Chapter\C3)

Details are given here. 1-10 Introduction ___________________________ 1.2.3 Profile Method You can process the XYZ file with the profile method as follows: $ DSRtoSDML/PRO=MYBOOK/TITLE="SAMPLE BOOK" XYZ The converter will produce the profile file and five element files. The profile file MYBOOK.SDML is as follows: (Created by DSRtoSDML from file XYZ.rno) (MYBOOK_FRONT.SDML) (MYBOOK_Introduc.SDML) (MYBOOK_Language.SDML) (MYBOOK_Insert_C.SDML) (MYBOOK_Conclusi.SDML) The first element, MYBOOK_FRONT.SDML, is produced by the converter for you to fill in later. 1-11 Introduction (front) (SAMPLE BOOK) <ABSTRACT>(<DATE>) <COMMENT>(<CENTER_LINE>(This is the title)) <COMMENT>(<P>) <COMMENT>(<P>) <COMMENT>(<CENTER_LINE>(Another title)) <COMMENT>(<CENTER_LINE>(Preface)) <COMMENT>(<P>) <COMMENT>(XYZ is a system for the generation of text.) <COMMENT>(1. First chapter) <COMMENT>(2. Second Chapter) <ENDABSTRACT> <REVISION_INFO>(Revision\New or Updated Manual) <ENDTITLE_PAGE> <COPYRIGHT_PAGE> <PRINT_DATE>(Insert date here) <COPYRIGHT_DATE>(Insert copyright date here) <ENDCOPYRIGHT_PAGE> <PREFACE> <ENDPREFACE> <ENDFRONT_MATTER> The second element, MYBOOK_INTRODUC, is: <comment>(Created by DSRtoSDML from file XYZ.rno) <CHAPTER>(Introduction\C1)<P> This is the introduction <P> It explains the way to use the xyz system. The third element, MYBOOK_LANGUAGE.SDML, is: 1-12 Introduction <comment>(Created by DSRtoSDML from file XYZ.rno) <CHAPTER>(Language Considerations\C2)<P> The XYZ has its own language. <P> More on this later. <comment>(Created by DSRtoSDML from file insert1.rno) This is an insert. The fourth element, MYBOOK_INSERT_C.SDML, is: <comment>(Created by DSRtoSDML from file insert1.rno) <CHAPTER>(Insert Chapter\C3)<P> Details are given here. <comment>(Created by DSRtoSDML from file XYZ.rno) The fifth element, MYBOOK_CONCLUSI, is: <comment>(Created by DSRtoSDML from file XYZ.rno) <CHAPTER>(Conclusions\C4)<P> And now to draw some conclusions. The names of the elements are formed by truncating the chapter titles. You will probably want to choose better names for the elements. To do so, change the name of the element in the profile file and rename the element file. ___________________________ 1.2.4 Marking Preface and Abstract If you use the profile method of conversion, DSRtoSDML comments out and does not convert text that appears before the first chapter. However, you can identify the abstract and preface by inserting commands in your DSR file, as follows: 1-13 Introduction _______________________________________________________ Command_____Action_____________________________________ .ZBP Identifies the beginning of the preface .ZEP Identifies the end of the preface .ZBA Identifies the beginning of the abstract .ZEA________Identifies_the_end_of_the_abstract_________ If you mark the beginning of the preface in the sample file as follows: .page .c;This is the title .b.b .c;Another title .page .c;Preface .zbp .b XYZ is a system for the generation of text. .page 1. First chapter 2. Second Chapter .zep .ch Introduction This is the introduction .b It explains the way to use the xyz system .ch Language Considerations The XYZ has its own language. .b More on this later. .req "insert1.rno" .ch Conclusions And now to draw some conclusions. 1-14 Introduction Then when you run this file using the profile method, DSRtoSDML recognizes the preface delimiting commands. The file MYBOOK_FRONT.SDML contains the indicated text between the <PREFACE> and <ENDPREFACE> tags. <FRONT_MATTER>(front) <TITLE_PAGE><TITLE>(SAMPLE BOOK) <ABSTRACT>(<DATE>) <COMMENT>(<CENTER_LINE>(This is the title)) <COMMENT>(<P>) <COMMENT>(<P>) <COMMENT>(<CENTER_LINE>(Another title)) <COMMENT>(<CENTER_LINE>(Preface)) <ENDABSTRACT> <REVISION_INFO>(Revision\New or Updated Manual) <ENDTITLE_PAGE> <COPYRIGHT_PAGE> <PRINT_DATE>(Insert date here) <COPYRIGHT_DATE>(Insert copyright date here) <ENDCOPYRIGHT_PAGE> <PREFACE> <P> XYZ is a system for the generation of text. <COMMENT>(1. First chapter) <COMMENT>(2. Second Chapter) <ENDPREFACE> <ENDFRONT_MATTER> 1-15 _______________________________________________________ 2 Text Processing The converter examines a DSR text line for the following: o Flags o Symbolic references o Special characters If the .AUTOPARAGRAPH or .AUTOTABLE DSR command is in effect, the first character of a text line determines the paragraphing. The following sections describe the conversion of text lines in more detail. __________________________________________________________________ 2.1 Flags The converter uses the .FLAGS, .NOFLAGS, .ENABLE, and .DISABLE commands to identify and interpret flag characters within a text line. It handles flags like DSR, namely: 2-1 Text Processing +-------------+ | FLAG ON? | +-------------+ / \ NO YES / \ Leave it as Remove from text literal | | +---------------+ | FLAG ENABLED? | +---------------+ / \ NO YES / \ Do nothing Take action If a flag is on, the converter removes the flag from text, whether it is enabled or disabled. If the flag is enabled, the converter treats it as shown in Table 2-1: 2-2 Text Processing Table 2-1 Conversion of Flags _______________________________________________________ Flag_____________defaultConverter_Action_______________ ACCEPT _ Treats the next character literally. BOLD * Used alone, applies <EMPHASIS>(text\BOLD) to the following character. Used with the uppercase flag, applies the construct to a sequence of characters. BREAK | No action CAPITALIZE < Generates the <UPPERCASE> construct. COMMENT ! Generates the <COMMENT> construct. CONTROL . Recognizes the following text as a command. HYPHENATE = No action INDEX > Generates <INDEX> construct. LOWERCASE \ Used before the bold or underline flag, terminates bolding or underlining. Otherwise, converts the next character to lowercase. OVERSTRIKE % Issues a warning. PERIOD + No action 2-3 Text Processing Table 2-1 (Cont.) Conversion of Flags _______________________________________________________ Flag_____________defaultConverter_Action_______________ SPACE # Inserts <ALIGN_CHAR> where necessary. SUBINDEX > Converts to <XS>. SUBSTITUTE $ Generates <DATE> for $$date(). Issues a warning for all other uses. UNDERLINE & Used alone, applies <EMPHASIS>(text) to the following character. Used with the uppercase flag, applies the construct to a sequence of characters. UPPERCASE ^ Used before the bold or underline flag, initiates bolding or underlining of a sequence of characters. Otherwise, capitalizes the next character. _______________________________________________________ EXAMPLE In the following example, the default bold flag "*" causes the bolding of the text "bold text". The bold flag is then changes to "%" and the text bolded again. DSR File: 2-4 Text Processing .b .fl bold Here is some ^*bold text\*. .fl bold % Here is some more ^%bold text\%. SDML File: <P>Here is some <EMPHASIS>(bold text\BOLD). Here is some more <EMPHASIS>(bold text\BOLD). Formatted Output: Here is some bold text. Here is some more bold text. __________________________________________________________________ 2.2 Symbolic references The converter tries to make all references symbolic. It also tries to find implicit captions. After conversion you should examine your symbolic references carefully and change them to more meaningful symbolic names. For example, "F1P1" could be something like "sys_flow". If you have undefined references, DSRtoSDML prints a message on your terminal requesting that you look at the list file. The list file contains a list of undefined references. References to sections are always undefined, because the converter does not attach a symbol to a section. If you have more than thirty undefined references, VAX DOCUMENT will terminate processing after tag translation. You can determine the total number of undefined references by looking at the list file. For example, consider the following list file: Created by DSRtoSDML (BL4) from file DEFLIST.rno on 4-DEC-1987 at 09:39:17.03 DSRtoSDML (BL4) DEFLIST 2-5 Text Processing Opening File: "Intro.rno" Opening File: "Text.rno" Opening File: "Commands.rno" Opening File: "Conclusions.rno" UNDEFINED REFERENCES Symbol No. of References T2P1 1 S4P5 1 T8P1 9 T9P1 1 The list file indicates that four symbols are undefined. For symbols T2P1 (Table 2.1), S4P5 (Section 4.5) and T9P1 (Table 9.1), one cross reference was found. For symbol T8P1 (Table 8.1), nine cross references were found. A more detailed discussion of the conversion or references is given in Section 4.2. EXAMPLE In the following example it converts the reference to the figure and the implicit caption. It uses the figure number given in the DSR source (1.1) as the symbolic name (F1P1). The actual number of the figure, however, can be different as shown in this example. DSR File: See Figure 1.1 for a diagram of system flow. .lt here+------+ | | | |------------->there .el.b ^*Figure 1.1: System Flow\* .b;Other examples of system flow are given in the next section. 2-6 Text Processing SDML File: <P>See <REFERENCE>(F1P1) for a diagram of system flow. <FIGURE>(System Flow\F1P1) <FIGURE_ATTRIBUTES>(KEEP) <LINE_ART> here+------+ | | | |------------->there <ENDLINE_ART> <ENDFIGURE><P> Other examples of system flow are given in the next section. Formatted Output: See Figure 2-1 for a diagram of system flow. Figure 2-1 System Flow _______________________________________________________ here+------+ | | | |------------->there _______________________________________________________ Other examples of system flow are given in the next section. 2-7 Text Processing __________________________________________________________________ 2.3 Special Characters DSRtoSDML eliminates control characters from DSR files. These characters are sometimes used to convey information to an output device. A control character in an SDML file cause VAX DOCUMENT to issue an error message. DSRtoSDML also converts the following characters to the indicated tags: \ <backslash> ( <oparen> ) <cparen> & <ampersand> | <vbar> 2-8 _______________________________________________________ 3 Command Processing DSRtoSDML converts many DSR commands directly to VAX DOCUMENT tags. To understand how the converter works, it's helpful to classify the different kinds of DSR commands. o A Design directive command provides design layout information. For VAX DOCUMENT, this information is not logically part of the .SDML file but is provided by the choice of doctype. A single VAX DOCUMENT file can be presented in many different ways depending on the doctype selected when processing the file. o A Process directive command provides information to the converter when it is processing the file. The converter makes decisions about the translation based on the information supplied by these commands, in the same way that DSR makes these decisions. o A Construct command identifies a construct. These commands are mapped directly to VAX DOCUMENT tags. o A Component command can be part of a higher level construct. The converter tries to combine such commands to produce that construct. Table 3-1 gives the converter action for a command in each of the classes. 3-1 Command Processing Table 3-1 DSR Command Classification _______________________________________________________ DSR_Command_Class___Examples_________Conversion_Action_ Design directive .DHL No action Process directive .FL BOLD @ Sets the bold flag character to @ and turns on bolding Construct .HL1 Converts to <HEAD1> Component .LM Interprets as a .I-n definition list and codes as a two column table _______________________________________________________ Table A-1 lists the DSR commands in alphabetical order and gives the classification for each command. The following sections group the DSR commands by function as Appendix A of the DSR manual groups them. The groups are: o Page Formatting o Text Formatting o Section Formatting o Flag Recognition o Miscellaneous 3-2 Command Processing __________________________________________________________________ 3.1 Page Formatting Commands Page formatting in VAX DOCUMENT is controlled by the doctype keyword specified on the command line when running VAX DOCUMENT. Since the paging of VAX DOCUMENT is different from the paging for DSR, and since the running heads and footers are controlled by the document design, none of these commands is translated into a corresponding DOCUMENT command. ___________________________ 3.1.1 Page Size and Running Heads Table 3-2 list the DSR commands that control the page size and running head formats. Table 3-2 Page Size and Running Head Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .AUTOSUBTITLELE } No action { .DATETE } No action .HEADERS UPPER No action { .HEADERS LOWER } .HEADERS MIXED { .NOAHEADERS } No action { .NOBSUBTITLE } No action .FIRST TITLE No action .LAYOUT No action 3-3 Command Processing Table 3-2 (Cont.) Page Size and Running Head Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .PAGE SIZE No action .TITLE No action _______________________________________________________ ___________________________ 3.1.2 Paging and Page Number Control Table 3-3 list the DSR commands that control page numbering. Table 3-3 Paging Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .DISPLAY NUMBER No action { .NOMNUMBERGE } No action .NUMBER RUNNING No action { .PAGINGNG } No action _______________________________________________________ ___________________________ 3.1.3 Subpaging Table 3-4 list the DSR commands that control the subpaging format: 3-4 Command Processing Table 3-4 Subpaging Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .DISPLAY SUBPAGE No action .NUMBER SUBPAGE No action { .ENDPSUBPAGE } No action _______________________________________________________ __________________________________________________________________ 3.2 Text Formatting Commands DSR text formatting commands can usually be mapped to VAX DOCUMENT tags. However, some DSR text formatting commands are used in combinations to indicate a higher level construct, such as a definition list. ___________________________ 3.2.1 Margin Settings Table 3-5 lists the DSR commands that control margin settings. Table 3-5 Margin Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .LEFT MARGIN Interprets as part of a definition list if followed by a negative indent. See Section 4.1 for more information. .RIGHT MARGIN No Action _______________________________________________________ 3-5 Command Processing ___________________________ 3.2.2 Filling and Justification Section 3.2.2 lists the commands that control filling and justification. Table 3-6 Fill and Justification Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .AUTOJUSTIFYFY } No Action { .FILLLL } Converts to the <CODE_ EXAMPLE> and <ENDCODE_ EXAMPLE> tags. { .NOSJUSTIFY } No Action _______________________________________________________ The converter provides a <P> tag if text follows the previous unfilled construct. The converter terminates a code example if it finds a DSR command that is translated to a VAX DOCUMENT tag within the unfilled construct. This sometimes produces unexpected results as can be seen in the following example, in which the converter finds the .C DSR command and terminates the VAX DOCUMENT code example. Note: Text in Nofill mode should be carefully examined after conversion. EXAMPLE In the following example, DSRtoSDML encloses the text in nofill mode in a VAX DOCUMENT code example. In the second case, it terminates nofill mode when it finds the .c command because the <CENTER_LINE> tag cannot be used in a code example. DSR File: 3-6 Command Processing .b;In some cases, a box is needed to carry household equipment and other supplies. Often boxes are found in grocery stores. .nf +-------------+ | | | | <------- a box | | +-------------+ .f Boxes come in many different sizes. .nf Some boxes are empty. Some are partly full. .c;******* Some are full. .f SDML File: <P> In some cases, a box is needed to carry household equipment and other supplies. Often boxes are found in grocery stores. <CODE_EXAMPLE> +-------------+ <VBAR> <VBAR> <VBAR> <VBAR> <LITERAL>(<)------- a box <VBAR> <VBAR> +-------------+ <ENDCODE_EXAMPLE><P> Boxes come in many different sizes. <CODE_EXAMPLE> Some boxes are empty. 3-7 Command Processing Some are partly full. <ENDCODE_EXAMPLE> <CENTER_LINE>(*******) Some are full. 3-8 Command Processing Formatted Output: In some cases, a box is needed to carry household equipment and other supplies. Often boxes are found in grocery stores. +-------------+ | | | | <------- a box | | +-------------+ Boxes come in many different sizes. Some boxes are empty. Some are partly full. ******* Some are full. Notice that the text "Some are full" does not appear as you might expect. ___________________________ 3.2.3 Vertical Spacing Table 3-7 lists the DSR commands that control vertical spacing. 3-9 Command Processing Table 3-7 Vertical Spacing Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .BLANK Generates tags depending on its argument as shown in Table 3-8. .BREAK Generates blank line if in NoFill Mode or <LINE> tag if in Fill mode { .NOEKEEP } Treats in same way as DSR Retains multiple blank lines when .NO FILL is in effect .SKIP Generates tags depending on its argument as shown in Table 3-8. .SPACING No action .PAGE No action .TEST PAGE No action for DSR; used in translating .RTB tables for DSRPLUS _______________________________________________________ Table 3-8 .BLANK or .SKIP Conversion _______________________________________________________ .BLn n=1 <CP> .SKn .BLn 1<n<4 <P> .SKn .BLn n>4 <FIGURE_SPACE>(n) .SKn _______________________________________________________ 3-10 Command Processing EXAMPLE In the following example, DSRtoSDML replaces the single blank line (.BL1) by <CP>, the sequence of five blank lines by a figure construct, and the paragraph and two blank lines by <P> tags. DSR File: .P In refusing to paint historical subjects and choosing subjects that could be directly experienced and painted, they rejected studied composition. .BL1 The Impressionists, working outdoors, realized that light was made up of color. Traditional artists, working in studios, thought of light as tone. .bl 2 The following picture shows an example of their work: .b5 SDML File: <P> In refusing to paint historical subjects and choosing subjects that could be directly experienced and painted, they rejected studied composition. <CP> The Impressionists, working outdoors, realized that light was made up of color. Traditional artists, working in studios, thought of light as tone. <P> The following picture shows an example of their work: <FIGURE> <FIGURE_ATTRIBUTES>(KEEP) <FIGURE_SPACE>(5) <ENDFIGURE><P> Formatted Output: 3-11 Command Processing In refusing to paint historical subjects and choosing subjects that could be directly experienced and painted, they rejected studied composition. The Impressionists, working outdoors, realized that light was made up of color. Traditional artists, working in studios, thought of light as tone. The following picture shows an example of their work: ___________________________ 3.2.4 Horizontal Spacing Table 3-9 list the DSR commands that control horizontal spacing. 3-12 Command Processing Table 3-9 Horizontal Spacing Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .CENTER Examines to see if it is an implicit caption. If it is not, it is converted to <CENTER_LINE>. For more information on the implicit captions, see Section 4.3. .INDENT Examines to see if it is part of a definition list. It not, it is converted to a <LINE> tag. For more information on the definition lists, see Section 4.1. { .NORPERIOD } No Action .RIGHT Examines to see if it is an implicit caption, If not, it is converted to <RIGHT_ LINE>. For more information on the implicit captions, see Section 4.3. .TAB STOPS Sets the tab stop positions, which determine the number of blanks that are substituted for tabs in text _______________________________________________________ EXAMPLE In the following example, left, right, and center justification are replaced by their VAX DOCUMENT equivalents. DSR File: 3-13 Command Processing .b;You can choose any of the following: .bl Left Side .r Right Side .c Center SDML File: <P> You can choose any of the following: <P> Left Side <RIGHT_LINE>(Right Side) <CENTER_LINE>(Center) Formatted Output: You can choose any of the following: Left Side Right Side Center ___________________________ 3.2.5 Paragraph Formatting Table 3-10 lists the DSR commands that control the format of paragraphs. 3-14 Command Processing Table 3-10 Paragraph Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .AUTOPARAGRAPH Enters autoparagraph mode, which causes the generation of a <P> tag when a line begins with a space or tab. .NOAUTOPARAGRAPH Cancels autoparagraph mode. .AUTOTABLE Enters autotable mode, which causes the generation of a <P> tag if a line does not begin with a space or tab. .NOAUTOTABLE Cancels autotable mode. .PARAGRAPH Generates a <P> tag. .SET PARAGRAPH Converts to a definition list if in that context _______________________________________________________ ___________________________ 3.2.6 Text Emphasis Table 3-11 lists the DSR commands that control the appearance of text emphasis such as bolding or underlining. 3-15 Command Processing Table 3-11 Text Emphasis Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .ENABLE BAR Generates the <REVISION> tag. .DISABLE BAR No action { .ENABLEE } BOLDING Turns bolding on or off. { .DISABLE } HYPHENATION No action { .DISABLE } No action OVERSTRIKING { .ENABLEE } UNDERLINING turns underlining on or off. .BEGIN BAR Generates the <MARK> tag. .END BAR Generates the <ENDMARK> tag. _______________________________________________________ 3-16 Command Processing EXAMPLE In the following example, DSRtoSDML replaces the DSR commands for side bars by their VAX DOCUMENT equivalents. DSR File: .EBB Instructions on the assembly of the bicycle are given in the appendix. .BB .b A detailed fold-out chart is also provided. All the parts of the bicycle are numbered in this chart. .EB .b Final assembly requires about three hours. SDML File: <REVISION> <P>Instructions on the assembly of the bicycle are given in the appendix. <MARK> <P> A detailed fold-out chart is also provided. All the parts of the bicycle are numbered in this chart. <ENDMARK> <P> Final assembly requires about three hours. Formatted Output: Instructions on the assembly of the bicycle are given in the appendix. A detailed fold-out chart is also provided. All the parts of the bicycle are numbered in this chart. Final assembly requires about three hours. 3-17 Command Processing ___________________________ 3.2.7 Figures Table 3-12 lists the DSR commands that control the format of figures. Table 3-12 Figure Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .FIGURE DEFERRED } Generates figure tags. The converter looks for an implicit caption to include in the figure. For more information on the implicit captions, see Section 4.3. { .ENDELITERAL } If the converter finds an implicit caption, it generates figure tags; otherwise it converts the literal to a literal code example. _______________________________________________________ The converter provides a <P> tag if text follows the figure. 3-18 Command Processing EXAMPLE In the following example, DSRtoSDML detects cross references and implicit captions and produces figure constructs. It uses the FLOAT attribute for the deferred figure (.fgd) and produces line art tags instead of code example tags for the literal within the figure construct. DSR File: .fl bold .b See Figure 2-1 for the most frequently used configuration. .fg 2 Figure 2-1: Configuration A .b See Figure 2-2 for another possibility. .fgd 3 Figure 2-2: Configuration B .b See Figure 2-3 for a flow diagram of the system. .lt +-----+ | |------>| | | .el ^*Figure 2-3: Diagram\* .b SDML File: 3-19 Command Processing <P> See <REFERENCE>(F2H1) for the most frequently used configuration. <FIGURE>(Configuration A\F2H1) <FIGURE_ATTRIBUTES>(KEEP) <FIGURE_SPACE>(2) <ENDFIGURE><P> See <REFERENCE>(F2H2) for another possibility. <FIGURE>(Configuration B\F2H2) <FIGURE_ATTRIBUTES>(FLOAT) <FIGURE_SPACE>(3) <ENDFIGURE><P> See <REFERENCE>(F2H3) for a flow diagram of the system. <FIGURE>(Diagram\F2H3) <FIGURE_ATTRIBUTES>(KEEP) <LINE_ART> +-----+ | |------>| | | <ENDLINE_ART> <ENDFIGURE><P> 3-20 Command Processing Formatted Output: See Figure 3-1 for the most frequently used configuration. Figure 3-1 Configuration A _______________________________________________________ _______________________________________________________ See Figure 3-2 for another possibility. Figure 3-2 Configuration B _______________________________________________________ _______________________________________________________ See Figure 3-3 for a flow diagram of the system. 3-21 Command Processing Figure 3-3 Diagram _______________________________________________________ +-----+ | |------>| | | _______________________________________________________ ___________________________ 3.2.8 Lists Table 3-13 lists the DSR commands that control the appearance and format of lists. Table 3-13 List Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ 3-22 Command Processing Table 3-13 (Cont.) List Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .DISPLAY ELEMENTS Sets the argument for the <LIST> tag for the following cases: D NUMBERED O NUMBERED (octal numbers not supported) H NUMBERED (hex numbers not supported) LU ALPHABETIC\UPPERCASE LL ALPHABETIC LM ALPHABETIC (mixed case not supported) RU ROMAN\UPPERCASE RL ROMAN RM ROMAN (mixed case not supported) .LIST Generates <LIST> with the argument specified by the .DLE command or the default NUMBERED .END LIST Generates the <ENDLIST> tag. .LIST ELEMENT Generates the <LE> tag. 3-23 Command Processing Table 3-13 (Cont.) List Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .NUMBER LIST Closes the open list and opens a new list that starts with the specified number _______________________________________________________ The converter reports an error if it finds an unmatched .LS or .ELS or if it finds an .LE outside of the context of a list. EXAMPLE In the following example, DSRtoSDML replaces a numbered list, a list with a special list enumerator (*), a roman list, and an alphabetic list by the VAX DOCUMENT equivalents. 3-24 Command Processing DSR File: .b;The following beverages are available: .ls.le;Milk .le;Coffee .ls '*' .le;Decaf .le;Regular .els .le;Tea .els Another list is: .dle RU .ls .le;Roman list item one .ls 'o' .le; bullet item .els .le;Roman list item two .els .dle LL .ls .le; Alpha List item one .le; Alpha List item two .els SDML File: 3-25 Command Processing <P> The following beverages are available: <LIST>(NUMBERED) <LE>Milk <LE>Coffee <LIST>(UNNUMBERED\*) <LE>Decaf <LE>Regular <ENDLIST> <LE>Tea <ENDLIST><P> Another list is: <LIST>(ROMAN\UPPERCASE) <LE>Roman list item one <LIST>(UNNUMBERED) <LE> bullet item <ENDLIST> <LE>Roman list item two <ENDLIST> <LIST>(ALPHABETIC) <LE> Alpha List item one <LE> Alpha List item two <ENDLIST><P> 3-26 Command Processing Formatted Output: The following beverages are available: 1 Milk 2 Coffee * Decaf * Regular 3 Tea Another list is: I Roman list item one o bullet item II Roman list item two a. Alpha List item one b. Alpha List item two ___________________________ 3.2.9 Notes and Footnotes Table 3-14 lists the DSR commands that insert notes and footnotes. Table 3-14 Note and Footnote Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .FOOTNOTE Generates <FOOTNOTE> tag. .END FOOTNOTE Generates <ENDFOOTNOTE> tag .NOTE Generates <NOTE> tag. .ENDNOTE Generates <ENDNOTE> tag. _______________________________________________________ 3-27 Command Processing The converter reports an error if it finds nested footnotes. Note: The converter always uses the number 1 for the footnote. You can change that to use any of the footnote designators offered by VAX DOCUMENT. Also, if more than one footnote appears on a page, you should change the footnote number to the appropriate number. The converter reports an error if it finds a .EN without a matching .N. 3-28 Command Processing EXAMPLE In the following example, DSRtoSDML replaces a footnote and two notes by the VAX DOCUMENT equivalents. DSR File: .b;The processor generates the XYZ error if the terminator is not present. .fn Not all cases report this error. .efn .n The population statistics in this figure are rounded to the nearest thousand. .en .n Warning This toy is not recommended for children under the age of three. .en -1 SDML File: <P> The processor generates the XYZ error if the terminator is not present. <FOOTNOTE>(1\ Not all cases report this error. ) <NOTE> The population statistics in this figure are rounded to the nearest thousand. <ENDNOTE><P> <NOTE>(Warning) This toy is not recommended for children under the age of three. <ENDNOTE><P> Formatted Output: 3-29 Command Processing The processor generates the XYZ error if the terminator is not present. [1] Note: The population statistics in this figure are rounded to the nearest thousand. Warning: This toy is not recommended for children under the age of three. __________________________________________________________________ 3.3 Section Formatting Commands Section formatting commands divide a document into chapters and sections and are used to control tables of contents, appendixes and indexes. ___________________________ 3.3.1 Appendixes and Chapters Table 3-15 lists the DSR commands that control the appearance and format of appendixes and chapters. ________________ [1] Not all cases report this error. 3-30 Command Processing Table 3-15 Appendix and Chapter Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .APPENDIX Generates the <APPENDIX> tag and a generated symbol. The converter provides a tag if one is needed. .CHAPTER Generates the <CHAPTER> tag and a generated symbol. The converter provides a tag if one is needed. .DISPLAY { APPENDIX } No action .NUMBER { CHAPTERX } Generates the <SET_CHAPTER_ NUMBER> or the <SET_ APPENDIX_LETTER> tag. The converter updates its internal counter so that references are correctly interpreted. _______________________________________________________ The generated symbol consists of a letter (C for chapter or A for appendix, followed by the chapter number or appendix letter. The generated symbol is necessary for bookbuilding and cross references. You should replace the symbol generated by the converter by a more mnemonic symbol. When you do this, you must also change the symbol used in references. EXAMPLE In the following example, DSRtoSDML replaces chapter and appendix commands by the VAX DOCUMENT equivalents. DSR File: 3-31 Command Processing .ch Introduction This chapter introduces the book. ... .chapter Commands The commands used are given on the following pages. ... .ax Command Summary Commands are summarized in the following table. ... .appendix Error Messages A listing of error messages appears ... SDML File: <CHAPTER>(Introduction\C1)<P> This chapter introduces the book. ... <CHAPTER>(Commands\C2)<P> The commands used are given on the following pages. ... <APPENDIX>(Command Summary\AA)<P> Commands are summarized in the following table. ... <ENDAPPENDIX> <APPENDIX>(Error Messages\AB)<P> A listing of error messages appears ... <ENDAPPENDIX> Notice that <ENDAPPENDIX> tags were inserted in the previous example. The converter automatically inserts tags that indicate the end of a context when it encounters a tag beginning a new context. The following table shows the tags that cause a new context: _______________________________________________________ Tag_________Context_______________Inserted_Tag_________ <CHAPTER> Preface_context <ENDPREFACE> <CHAPTER> Front_Matter context <ENDFRONT_MATTER> <APPENDIX> Appendix context <ENDAPPENDIX> <APPENDIX>__Glossary_context______<ENDGLOSSARY>________ 3-32 Command Processing ___________________________ 3.3.2 Sections Table 3-16 lists the DSR commands that control the appearance and format of sections. Table 3-16 Section Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .DISPLAY LEVELS No action .HEADER LEVEL Generates <HEADN> tag, where n is determined from the argument of .HL .NUMBER LEVEL No action .SET LEVEL Sets the internal header level count. .STYLE HEADERS No action _______________________________________________________ A paragraph tag is generated following this construct. The converter maintains the current level count. If the DSR command has a signed argument, then the value of the argument is added to the current header level count to create the correct VAX DOCUMENT header construct. EXAMPLE In the following example, DSRtoSDML replaces header level commands by the VAX DOCUMENT equivalents. It generates a <HEAD3> tag for the command .hl+1 because adding one to the header that is in force at that point (two) produces a third level heading. DSR File: 3-33 Command Processing The United States and Europe are important apple producing areas. .hl1 Origin The apple originated from the wild crab apple tree of Afghanistan. The modern apple is the result of thousands of years of chance selection and mutation and 200 years of controlled breeding. .hl2 Production The two most important apple producing areas are Europe and the United States. .hl+1 United States Varieties The Northeast and Northwest are important apple growing areas. 3-34 Command Processing SDML File: The United States and Europe are important apple producing areas. <HEAD1>(Origin)<P> The apple originated from the wild crab apple tree of Afghanistan. The modern apple is the result of thousands of years of chance selection and mutation and 200 years of controlled breeding. <HEAD2>(Production)<P> The two most important apple producing areas are Europe and the United States. <HEAD3>(United States Varieties)<P> The Northeast and Northwest are important apple growing areas. ___________________________ 3.3.3 Indexes Table 3-17 list the DSR commands that control the appearance of index and index entries. Table 3-17 Index Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .DISABLE } INDEXING No action .ENTRY Generates the <Y> tag and replaces any instances of > within the argument with the <XS> tag. { .NOAFLAGSDINDEX } Sets the index flag character and turns indexing on and off. { .NOAFLAGSBSUBINDEX } Sets the subindex flag and sets subindexing on and off. 3-35 Command Processing Table 3-17 (Cont.) Index Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .INDEX Generates the <X> tag and replaces any instances of > within the argument by the <XS> tag. .XLOWER .XUPPER _______________________________________________________ EXAMPLE In this example, DSRtoSDML replaces index and subindex commands by the VAX DOCUMENT equivalents. DSR File: .X Cats .X Cats>Angora .X Cats>Siamese>Sealpoint .Y Sealpoint>See Cats SDML File: <X>(Cats) <X>(Cats<XS>Angora) <X>(Cats<XS>Siamese<XS>Sealpoint) <Y>(Sealpoint<XS>See Cats) 3-36 Command Processing ___________________________ 3.3.4 Table of Contents Table 3-18 lists the DSR commands that control the appearance of tables of contents and tables of contents entries. Table 3-18 Table of Contents _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .DISABLE } TOC No action .SEND TOC Examines to see if it identifies a part of the document (for example: the glossary). See Section 4.6 for more details. _______________________________________________________ __________________________________________________________________ 3.4 Flag Recognition Commands DSR flag recognition commands enable or disable the recognition of characters as flags rather than as text. Table 3-19 list the DSR flag recognition commands. 3-37 Command Processing Table 3-19 Flag Recognition Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .NOFLAGS } ACCEPT Sets the flag and turns on or off { .NOFLAGS } ALL Sets the flag and turns on or off { .NOFLAGS } BOLD Sets the flag and turns on or off { .NOFLAGS } BREAK Sets the flag and turns on or off { .NOFLAGS } CAPITALIZE Sets the flag and turns on or off { .NOFLAGS } COMMENT Sets the flag and turns on or off { .NOFLAGS } HYPHENATE Sets the flag and turns on or off { .NOFLAGS } LOWERCASE Sets the flag and turns on or off { .NOFLAGS } OVERSTRIKE Sets the flag and turns on or off { .NOFLAGS } PERIOD Sets the flag and turns on or off { .NOFLAGS } SPACE Sets the flag and turns on or off { .NOFLAGS } SUBSTITUTE Sets the flag and turns on or off 3-38 Command Processing Table 3-19 (Cont.) Flag Recognition Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .NOFLAGS } UNDERLINE Sets the flag and turns on or off { .NOFLAGS } UPPERCASE Sets the flag and turns on or off _______________________________________________________ __________________________________________________________________ 3.5 Miscellaneous Commands Table 3-20 lists some miscellaneous commands, including the condition facility commands and the file inclusion facility commands. Table 3-20 Miscellaneous Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ { .NONCONTROLACHARACTERS }Sets the flag and turns on or off .IF Generates the <CONDITION> tag .IFNOT Generates the <CONDITION> tag with an argument whose name is prefaced by the string "NOT". 3-39 Command Processing Table 3-20 (Cont.) Miscellaneous Commands _______________________________________________________ DSR_Command_______________Converter_Action_____________ .ELSE Generates an <ENDCONDITION> tag to conclude the existing condition and generates a <CONDITION> tag with an argument whose name is prefaced by the string "NOT". .ENDIF Generates an <ENDCONDITION> tag .NO SPACE No action .REPEAT Produces the string specified by the command .REQUIRE Generates the <INCLUDE> tag and begins processing the specified file. .SET { DATE } No action .VARIABLE No action _______________________________________________________ VAX DOCUMENT does not allow nested conditions and it does not supply an alternative condition (ELSE). The converter creates a new condition name, where necessary, by prefacing the condition name with NOT. The conversions are shown in the following list: The converter reports an error if it finds unmatched .IF and .ENDIF commands. It reports any nested .IF constructs. 3-40 Command Processing EXAMPLE In this example, DSRtoSDML replaces condition commands. DSR File: .if draft This is a draft copy -- do not circulate .else draft Final Review Copy -- please return .endif draft SDML File: <CONDITION>(draft) This is a draft copy -- do not circulate <ENDCONDITION> <CONDITION>(NOTdraft) Final Review Copy -- please return <ENDCONDITION> EXAMPLE In the following example, DSRtoSDML replaces the require command by the <document< equivalent. It then open the file Daily.rno and converts that file and any files required by it. DSR File: For more information, read this: .req "Daily.rno" SDML File: For more information, read this: <INCLUDE>(Daily.SDML) EXAMPLE 3-41 Command Processing In the following example, DSRtoSDML expands the repeat command. DSR File: Here is a string of a's. .b .rpt 25 "a" .b SDML File: Here is a string of a's. <P> aaaaaaaaaaaaaaaaaaaaaaaaa<P> 3-42 _______________________________________________________ 4 Special Command Combinations DSRtoSDML recognizes certain command combinations and processes them in a special way. It looks for the following constructs: o Definition Lists o Cross References o Implicit Captions o Figures o Tables In addition, it gives the following special attention: o Angle Brackets o Other Special Characters The following sections describe the special combinations in detail. __________________________________________________________________ 4.1 Definition Lists A definition list is identified by the combination of the Left Margin (.LM) and negative indent (.I-) commands or, in AUTOPARAGRAPH mode, by Left Margin (.LM) and Set Paragraph (.SPR) commands. The converter creates a two column table for a definition list. It examines the first line following the negative indent (.I-) to find the separation between the first column and the second column. It identifies any of the following as the separation between columns: 4-1 Special Command Combinations o Two or more blanks o Two or more space flags (#) o One or more tabs If the converter does not find a separation, it uses the first line following the negative indent as the first column. 4-2 Special Command Combinations EXAMPLE In the following example, DSRtoSDML recognizes a definition list construct and replaces it by a two column table. DSR File: .lm+12 .b.i-12;CLEARED Applies only to X.25 circuits. The X.25 circuit will not exist in the volatile database when PSI is loaded. .b.i-12;OFF Allows no traffic over a circuit. The circuit is unavailable for network activity. .b.i-12;ON Allows traffic over a circuit. This is the normal operational state allowing for complete route-through and downline loading operations. .lm-12 SDML File: <TABLE> <TABLE_SETUP>(2\12) <TABLE_ROW>(CLEARED\Applies only to X.25 circuits. The X.25 circuit will not exist in the volatile database when PSI is loaded. ) <TABLE_ROW>(OFF\Allows no traffic over a circuit. The circuit is unavailable for network activity. ) <TABLE_ROW>(ON\Allows traffic over a circuit. This is the normal operational state allowing for complete route-through and downline loading operations. )<ENDTABLE><P> Formatted Output: 4-3 Special Command Combinations CLEARED Applies only to X.25 circuits. The X.25 circuit will not exist in the volatile database when PSI is loaded. OFF Allows no traffic over a circuit. The circuit is unavailable for network activity. ON Allows traffic over a circuit. This is the normal operational state allowing for complete route-through and downline loading operations. __________________________________________________________________ 4.2 Cross References The converter looks for references to figures, examples, tables, chapters, sections, or appendixes. It determines these references by searching for a reference keyword. The default reference keywords are: Figure Example Table Chapter Section Appendix DSRtoSDML looks for an exact match (including case) to a reference keyword. Note that "FIGURE" is not match because of casel; the following sections tell you how to add more reference keywords to the list. If DSRtoSDML finds a match, it checks the following text for a reference number. If it finds a reference keyword followed by a reference number (for example: Figure 1.1), it identifies it as a reference. 4-4 Special Command Combinations A reference may be upgraded to a caption if it passes the tests given in the next section. If the reference is not a caption, the converter generates a <REFERENCE> tag with a symbol created from the kind of reference and its reference number as its argument. Some examples follow: _______________________________________________________ Reference Text________Replacement________________________________ Figure 1.1 <REFERENCE>(F1P1) Figure 1-2 <REFERENCE>(F1H2) Section <REFERENCE>(S1P1P3) 1.1.3 Chapter_3___<REFERENCE>(C3)____________________________ For example, the symbol F1P1 is generated from the kind of reference (F from Figure) and the reference number (1P1 from 1.1). ___________________________ 4.2.1 Adding New Reference Keywords If you use reference keywords that are different from the default reference keywords to identify these parts of your document, you can add your reference keywords to the reference keyword table with the following command in your DSR file: .ZCW default-reference-keyword new-reference-keyword For example, if you use the word "Illustration" to refer to figures, you can add the following command: .ZCW Figure Illustration 4-5 Special Command Combinations After this command, both "Figure" and "Illustration" are recognized as the beginning of a reference to a figure. EXAMPLE In the following example, two references to "Illustrations" are given. The converter does not recognize the first reference because the keyword 'Illustration' is not part of the default reference keyword table. It recognizes the second reference because that word is added to the reference keyword table by the .ZCW command. DSR File: See Illustration 1.1 for more information. .ZCW Figure Illustration See Illustration 1.1 for more information. SDML File: See Illustration 1.1 for more information. See <REFERENCE>(F1P1) for more information. A reference keyword must match exactly in the text, including the case of the letters. If you use different case or abbreviations for your references, you must include these variations as reference keywords. For example, some variations on figure are: .zwc Figure figure .zwc Figure Fig. .zwc Figure FIG After these commands are processed by the converter, the following four words are recognized as the beginning of a reference to a figure: o Figure o figure 4-6 Special Command Combinations o Fig. o FIG Other variation , however, are not recognized. For example, FIGURE is not recognized, because that reference keyword was not added to the table. ___________________________ 4.2.2 Deleting Reference Keywords You can delete keywords from the reference keyword table with the following command: .ZWD default-reference-keyword deleted-reference-keyword You can delete the default keyword or any of the new keywords you added. You can, for example, delete the reference keyword "Chapter" as follows: .ZWD Chapter Chapter Consider the interpretation of the reference in the following sample file: EXAMPLE In the following example, two chapter references are given. The first reference is recognized. However, the converter does not recognize the second reference because it occurs after the reference keyword is deleted from its reference keyword table. DSR File: See Chapter 3 for a discussion of the syntax. .ZWD Chapter Chapter See Chapter 3 for a discussion of the syntax. SDML File: See <REFERENCE>(C3) for a discussion of the syntax. See Chapter 3 for a discussion of the syntax. 4-7 Special Command Combinations __________________________________________________________________ 4.3 Inplicit Captions DSRtoSDML identifies DSR captions. A reference that passes the following tests is promoted to a caption. 1 The reference is the first text on the line (it can be preceded by flags). 2 The text line that includes the reference is on a line by itself. That is, it is preceded and followed by a line breaking command. The application of rule 1 prevents caption identification in sentences like the following: See Figure 1.1 for more information. The application of rule 2 prevents the false identification of a caption in this case: More information is given in the following sections. See Figure 1.1 for a flow diagram. However, a false identification can still be made if a sentence that is not a caption satisfies the given rules. For example: .b Figure 1.1 shows the configuration. .fg25 Figure 1.1: Configuration A .b The converter incorrectly identifies the line that references the figure as an implicit caption in this case because it begins with a reference and is on a line by itself. You can prevent the misidentification by breaking the reference line into two lines as follows: 4-8 Special Command Combinations .b Figure 1.1 shows the configuration. .fg25 Figure 1.1: Configuration A .b Or you can correct the SDML code that the converter produces. __________________________________________________________________ 4.4 Tables DSRPLUS: The converter can process .RTB files ( that is table files that have already been processed by DSR). You can specify the .RTB file as the input file on the command line or you can include the .RTB file with a .REQ command. The converter does not process the .DO TABLE command. You must create the .RTB file as a boxed, outlined table with headers and vertical lines. DSRtoSDML uses the vertical lines to determine columns. The converter identifies a table when it finds the combination of a caption and a literal. The caption can precede or follow the literal. It determines the number of columns in the table by the table headings. It also uses the table headings to determine the starting position of each column. The converter analyzes the first row of the table to check its guess at the column positions. The following examples show the variety of tables that the converter can handle. It cannot handle a table which does not have a clearly defined heading and first row or, alternatively, a clearly defined first and second row. Tables with complicated headings, which span columns, fall in this category. 4-9 Special Command Combinations EXAMPLE In the following example, DSRtoSDML converts a literal table to a VAX DOCUMENT table construct. DSR File: .b Table 2.5 Flowers .lt Name Color Bloom Pansy Violet Spring Rose Red Spring .el SDML File: <TABLE>(Flowers\T2P5) <TABLE_ATTRIBUTES>(WIDE) <TABLE_SETUP>(3\10\11) <table_heads>( Name \ Color \ Bloom ) <table_row>( Pansy \ Violet \ Spring ) <table_row>( Rose \ Red \ Spring ) <ENDTABLE><P> Formatted Output: 4-10 Special Command Combinations Table 4-1 Flowers _______________________________________________________ Name________Color________Bloom_________________________ Pansy Violet Spring Rose Red Spring _______________________________________________________ If the first row of the table has the same number of columns as the heading, the converter uses the leftmost estimate for the starting position of a column and, in this way, attempts to handle centered headings. If the converter detects a problem during table conversion, it backs up and produces the text as a code example in the SDML file. It writes a message in the list file indicating what problem it detected and then gives the table conversion in the list file. Sometimes, you can extract the table from the list file and easily edit it to get the results you want. 4-11 Special Command Combinations Some problems the converter may encounter Are: o Column determination finds more than 9 columns or less than 2 columns o Column division results in splitting a word o An excessively long column is found EXAMPLE In the following example, the columns of the table in the .RNO file don't line up. The converter makes its estimate of columns from the heading and the first row. When it divides the table into columns, the column division of the second row results in splitting a word. The list file shows the line with the problem and indicates the column divisions with carats (^). The list file also contains the converter's attempt at table conversion for that case. The converter generates an empty table followed by a code example in the .SDML file. DSR File: .b Table 2.5 Flowers .lt Name Color Bloom Pansy Violet Spring Rose Red Spring .el List File: Created by DSRtoSDML BL4 from file TAB0A.rno on 1-DEC-1987 at 15:47:55.75 DSRtoSDML BL4 TAB0A Opening File: "TAB0A.rno" 4-12 Special Command Combinations *** Column division requires splitting in mid-word Input File TAB0A.rno, Line 10 Rose Red Spring ^ ^ ^ *** Cannot create table -- using code example Input File TAB0A.rno, Line 10 <TABLE>(Flowers\T2P5) <TABLE_ATTRIBUTES>(WIDE) <TABLE_SETUP>(3\ 8\ 8) <table_heads>( Name \ Color \ Bloom ) <table_row>( Pansy \ Violet \ Spring ) <table_row>( Rose R \ ed S \ pring ) EXAMPLE In the following example, DSRtoSDML converts a table with multi-line rows. Rows in this kind of table are separated by blank lines. 4-13 Special Command Combinations DSR File: .b;Here is a table. .b Table 1.1: Produce Table .lt Produce Variety Description Apple McIntosh Good Eating Apple. Keeps well. Can be used for pies and jellies. Orange Florida Best for juice. Smaller than California. Pear Bosc Good for eating. Keeps well. .el See Table 1.1 for an introduction to apples and oranges. .b SDML File: <P> Here is a table. <P> <TABLE>(Produce Table\T1P1) <table_setup>(3\10\11) <table_heads>(Produce \Variety \Description ) <table_row>(Apple \McIntosh \Good Eating Apple. Keeps well. Can be used for pies and jellies. ) <table_row>(Orange \Florida \Best for juice. Smaller than California. ) <table_row>(Pear \Bosc \Good for eating. Keeps well. ) 4-14 Special Command Combinations <ENDTABLE><P> See <REFERENCE>(T1P1) for an introduction to apples and oranges. <P> Formatted Output: Here is a table. Table 4-6 Produce Table _______________________________________________________ Produce_____Variety______Description___________________ Apple McIntosh Good Eating Apple. Keeps well. Can be used for pies and jellies. Orange Florida Best for juice. Smaller than California. Pear Bosc Good for eating. Keeps well. _______________________________________________________ See Table 4-6 for an introduction to apples and oranges. 4-15 Special Command Combinations EXAMPLE In the following example, DSRtoSDML converts a table in which each row occupies a single line and blank lines are not used to separate rows. DSR File: .b;Here is a table. .b Table 1.2: Produce Table .lt Produce Variety Description Apple McIntosh Good Eating Apple. Orange Florida Best for juice. Pear Bosc Good for eating. Keeps well. .el See Table 1.2 for an introduction to apples and oranges. .b SDML File: <P> Here is a table. <TABLE>(Produce Table\T1P2) <TABLE_ATTRIBUTES>(WIDE) <TABLE_SETUP>(3\13\15) <table_heads>( Produce \ Variety \ Description ) <table_row>( Apple \ McIntosh \ Good Eating Apple. ) <table_row>( Orange \ Florida \ Best for juice. ) <table_row>( Pear 4-16 Special Command Combinations \ Bosc \ Good for eating. Keeps well. ) <ENDTABLE><P> See <REFERENCE>(T1P2) for an introduction to apples and oranges. <P> Formatted Output: Here is a table. Table 4-3 Produce Table _______________________________________________________ Produce________Variety__________Description____________ Apple McIntosh Good Eating Apple. Orange Florida Best for juice. Pear Bosc Good for eating. Keeps well. _______________________________________________________ See Table 4-3 for an introduction to apples and oranges. ___________________________ 4.4.1 Tables with Tabs Tabs are converted to the appropriate number of spaces. The .TS command is processed to get the correct values for tabs when necessary. Caveat: One or more lines of text must separate the .TS command from the table. If not, the old tab values are used in the table. EXAMPLE 4-17 Special Command Combinations In the following example, DSRtoSDML converts a table that uses tabs to line up the columns. DSR File: .ts 10,40,60 See Table A.1 for shipment schedules. .b Table A.1: Shipment Schedules .lt Company State Shipment Schedule Alpha NY Shipment of 12 crates weekly Beta Mississippi Yearly shipment Gamma Alabama Monthly shipment Delta California Different billing system See separate sheet. .el SDML File: See <REFERENCE>(TAP1) for shipment schedules. <P> <TABLE>(Shipment Schedules\TAP1) <table_setup>(3\ 9\30) <table_heads>(Company \State \Shipment Schedule ) <table_row>(Alpha \NY \Shipment of 12 crates weekly ) <table_row>(Beta \Mississippi \Yearly shipment ) <table_row>(Gamma \Alabama 4-18 Special Command Combinations \Monthly shipment ) <table_row>(Delta \California \Different billing system See separate sheet. ) <ENDTABLE> 4-19 Special Command Combinations Formatted Output: See Table 4-4 for shipment schedules. Table 4-4 Shipment Schedules _______________________________________________________ Shipment Company____State___________________________Schedule____ Alpha NY Shipment of 12 crates weekly Beta Mississippi Yearly shipment Gamma Alabama Monthly shipment Delta California Different billing system See separate sheet. _______________________________________________________ ___________________________ 4.4.2 Tables with Dashes and Bars Some tables are coded with dashes and bars to produce column separations, row separations, or boxes. EXAMPLE In the following example, DSRtoSDML ignores the outlining characters. DSR File: 4-20 Special Command Combinations .b Table 4.5 Flowers .lt +-------+--------+-----------+ | Name Color Bloom | +-------+--------+-----------+ | | | | | Tulip | Yellow | Spring | | | | | | | | | | Pansy | Violet | Spring | | | | and fall | | | | | +-------+--------+-----------+ | | | | | Rose | Red | Spring | | | | | +-------+--------+-----------+ .el 4-21 Special Command Combinations SDML File: <TABLE>(Flowers\T4P5) <TABLE_ATTRIBUTES>(WIDE) <TABLE_SETUP>(3\10\ 9) <table_heads>( Name \ Color \ Bloom ) <table_row>( Tulip \ Yellow \ Spring ) <table_row>(Pansy \Violet \Spring and fall ) <table_row>( Rose \ Red \ Spring ) <ENDTABLE><P> Formatted Output: Table 4-5 Flowers _______________________________________________________ Name________Color______Bloom___________________________ Tulip Yellow Spring Pansy Violet Spring and fall Rose Red Spring _______________________________________________________ 4-22 Special Command Combinations ___________________________ 4.4.3 Tables coded using Nofill mode Tables are sometimes coded using nofill mode. Because Nofill mode has many uses, you must indicate to the converter that this is a table by changing the .NO FILL preceding the table to either .LITERAL or .ZLT and the the .FILL following the table to .EL. Use .LITERAL if the table does not make use of flags and use .ZLT if the table does use flags. EXAMPLE In the following example, the converter does not make the conversion to a table because the table is coded using .NO FILL. 4-23 Special Command Combinations DSR File: .fl bold .fl substitute Here is a table. .b Table 1.1: Varieties of Fruit .b .nf ^*Fruit\* ^*Variety\* Apple McIntosh Orange Florida .f SDML File: Here is a table. <P><REFERENCE>(T1P1) Varieties of Fruit<P> <CODE_EXAMPLE><EMPHASIS>(Fruit\BOLD) <EMPHASIS>(Variety\BOLD) Apple McIntosh Orange Florida <ENDCODE_EXAMPLE><P> Formatted Output: Here is a table. Table 4-6 Varieties of Fruit Fruit Variety Apple McIntosh Orange Florida EXAMPLE 4-24 Special Command Combinations In the following example, the .ZLT command is used since this table contains flags. DSR File: .fl bold .fl substitute Here is a table. .b Table 1.1: Varieties of Fruit .b .ZLT ^*Fruit\* ^*Variety\* Apple McIntosh Orange Florida .EL 4-25 Special Command Combinations SDML File: Here is a table. <TABLE>(Varieties of Fruit\T1P1) <TABLE_ATTRIBUTES>(WIDE) <TABLE_SETUP>(2\11) <table_heads>( Fruit \ Variety ) <table_row>( Apple \ McIntosh ) <table_row>( Orange \ Florida ) <ENDTABLE><P> Formatted Output: Here is a table. Table 4-6 Varieties of Fruit _______________________________________________________ Fruit________Variety___________________________________ Apple McIntosh Orange Florida _______________________________________________________ 4-26 Special Command Combinations __________________________________________________________________ 4.5 Angle Brackets Angle brackets are often used in text to indicate keyboard keys. If the /KEY qualifier is specified on the command line, the converter checks angle brackets and recognizes the following cases: o If the text within the angle brackets is one word and less than 15 characters, it converts the angle brackets and text to a <KEY> tag. o If the text satisfies the above rule and includes the word "arrow", it converts the angle brackets and text to <MATH_CHAR>. o If the text includes a colon, it converts the angle brackets and text to <BITMAP>. If none of these rules apply, the converter encloses the left angle bracket in a <LITERAL> tag. Some examples of this conversion are: _______________________________________________________ Text_____________Conversion____________________________ <RETURN> <KEY>(RETURN) <return> <UPARROW> <MATH_CHAR>(uparrow) ^ <1:245> <BITMAP>(1:245) <1:245> if a<b and c>d If a<LITERAL>(<)b if a<b and c>d _________________and_c>d_______________________________ Note: If you use the /KEY capability, you must process the resulting file through VAX DOCUMENT with one of the Software doctypes because <KEY> is not a global tag. 4-27 Special Command Combinations __________________________________________________________________ 4.6 Contents Entries Since the .STC command often signifies a division of a manual, the converter looks for the following commands: .STC Preface <FRONT_MATTER> if not in that context <PREFACE> .STC Glossary <GLOSSARY> The converter generates an appropriate end tag, when it detects the next context. It generates <ENDPREFACE> and <ENDFRONT_MATTER> when it finds a <CHAPTER>. It generates <ENDGLOSSARY> if it finds an <APPENDIX> tag. The converter closes all contexts at the end of the file. It reports an error if it finds that it did not close a context before the end of the file, except for the Glossary context, which normally ends the file. EXAMPLE In the following example, DSRtoSDML recognized a preface and glossary. It generates glossary tags for the definition list in the glossary context. DSR File: .STC PREFACE This book discusses the origin of species. .ch Mammals of the World More information to be supplied. .stc GLOSSARY .lm+5 .i-5;Albatross Large ocean bird .i-5;Armadillo Armor-plated mammal .lm0 SDML File: 4-28 Special Command Combinations <FRONT_MATTER> <PREFACE> This book discusses the origin of the Latin language. <GLOSSARY> <GTERM>(Albatross) <GDEF>(Large ocean bird ) <GTERM>(Armadillo) <GDEF>(Armor-plated mammal ) <ENDGLOSSARY> 4-29 _______________________________________________________ A Summary of DSR Commands To learn more about the way the command is handled, consult the indicated reference. Table A-1 Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .APPENDIX .AX Construct Section 3.3.1 .AUTOJUSTIFY .AJ Design Section 3.2.2 .NAJ directive .AUTOPARAGRAPH .AP Process Section 3.2.5 .NAP directive .AUTOSUBTITLE .AST Design Section 3.1 .NAST directive .AUTOTABLE .AT Process Section 3.2.5 .NAT directive .BEGIN BAR .BB Construct Section 3.2.6 .END BAR .EB .BLANK .B Construct Section 3.2.3 .BREAK .BR Construct Section 3.2.3 .CENTRE .C Construct Section 3.2.4 .CENTER .CHAPTER .CH Construct Section 3.3.1 A-1 Summary of DSR Commands Table A-1 (Cont.) Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .CONTROL CHARACTERS .CC Process .NCC directive .DATE .D Design Section 3.1 .NODATE .ND directive .DISABLE Process Section 2.1 directive .DISABLE BARS Process Section 3.2.6 directive APPENDIX { .DCH } Design .DISPLAY { CHAPTER } directive COUNTER FIGURE .DISPLAY ELEMENTS .DLE Component .DO INDEX .DX Construct .ELSE .ELSE Construct Section 3.5 .ENABLE flag Process Section 2.1 directive .ENABLE BARS .EBB Construct Section 3.2.6 .END BAR .EB Construct Section 3.2.6 .ENTRY .Y Construct Section 3.3.3 .FIGURE .FG Construct Section 3.2.7 .FIGURE DEFERRED .FGD Construct Section 3.2.7 A-2 Summary of DSR Commands Table A-1 (Cont.) Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .FILL .F Construct Section 3.2.2 .NOFILL .NF .FIRST TITLE .FT Design directive .FLAGS .FL Process Section 2.1 .NFL directive .FOOTNOTE .FN Construct Section 3.2.9 .END FOOTNOTE .EFN .HEADER LEVEL .HL Construct Section 3.3.2 .HEADERS Design directive .IF Construct Section 3.5 .IFNOT .ELSE .ENDIF .INDENT .I Component Section 4.1 .INDEX .X Construct Section 3.3.3 .JUSTIFY .J Design Section 3.2.2 .NOJUSTIFY .NJ directive .KEEP .K Process Section 3.2.3 .NOKEEP .NK directive .LAYOUT Design directive A-3 Summary of DSR Commands Table A-1 (Cont.) Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .LEFT MARGIN .LM Component Section 3.2.1 .LIST .LS Construct Section 3.2.8 .LIST ELEMENT .LE .END LIST .ELS .LITERAL .LT Construct Section 3.2.7 .END LITERAL .EL .LOWER CASE Construct not in manual .NO Can't Decide .NOTE .N Construct Section 3.2.9 .ENDNOTE .EN .NUMBER Can't Decide can do for lists .PAGE .PG Design Section 3.2.3 directive .PAGE SIZE .PS Design Section 3.1 directive .PAGING .PA Design Section 3.1 directive .PARAGRAPH .P Construct Section 3.2.5 .PERIOD .PR Can't Decide .NOPERIOD .NPR .PRINT INDEX Construct Section 3.3.3 A-4 Summary of DSR Commands Table A-1 (Cont.) Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .REPEAT .RPT Process Section 3.5 directive .REQUIRE .REQ Construct Section 3.5 .RIGHT .R Construct Section 3.2.4 .RIGHT MARGIN .RM Design Section 3.2.1 directive .SEND TOC .STC Component Section 3.3.4 .SET DATE No action .SET LEVEL Process Section 3.3.2 directive .SET PARAGRAPH Process Section 3.3.2 directive .SET TIME No action .SKIP .SK Construct Section 3.2.3 .SPACING Process directive .STYLE HEADERS Design Section 3.1 directive .SUBPAGE No action .SUBTITLE Design Section 3.1 .NOSUBTITLE directive A-5 Summary of DSR Commands Table A-1 (Cont.) Summary of DSR Commands _______________________________________________________ Command____________________AbbreviationClassification__ Reference .TAB STOPS .TS Component Section 3.2.4 .TEST PAGE .TP Design Section 3.2.3 directive .TITLE .T Design Section 3.1 directive _______________________________________________________ A-6 _______________________________________________________ B Error Messages 'Bad Command at position position--inputline, Explanation: The converter thinks the DSR command is syntactically incorrect. 'Cannot find column separation in Def List', Explanation: The converter has started a definition list and is unable to break the text into two parts. 'Cannot do .ZWC because reference word table is full', Explanation: The table that holds reference keywords is full and no more words can be added. 'Cannot interpret this part of line: < inputline, Explanation: The command has something at the end that looks illegal. 'Command ".FLAGS flagname char" is illegal: char is already a flag', Explanation: An attempt is made to assign a character already in use as a flag to another flag. 'Element Table Exceeded', Explanation: The table that holds the elements is full. '.ELSE encountered outside .If context', Explanation: Incorrectly formatted .if .else construct. B-1 Error Messages 'Error: Removed control char, ASCII char decimal from line', Explanation: Control character has been removed from text. 'Error: Removed Invalid char, ASCII char decimal from inputline', Explanation: Invalid character has been removed from text. 'Error writing line outputline', Explanation: Input/Ouput error while writing line. 'Flag Flag used at end of a line', Explanation: Although DSR allows a flag at the end of a line, the converter does not. The interpretation of such a construct is open to discussion. 'Had to break up line', Explanation: The output line was too long and had to be broken up. 'Ignored .ZWC because refword is already in table', Explanation: An attempt was made to define a keyword reference name more than once. 'Invalid .ZWC (or .ZWD): first argument not a reference word', Explanation: The first argument must be one of the original reference words: Figure, Chapter, Table, Section, Appendix, Example. 'Invalid .ZWC (or .ZWD): second parameter missing', Explanation: Null definitions are not allowed. 'Invalid .ZWD: given parameter pair is not in table', Explanation: An attempt was made to delete a reference word that was not defined. B-2 Error Messages 'Invalid Command InputLine, Explanation: DSR command is not recognized. 'Multiple Definition of symbol, Explanation: More than one definition of a symbol was made. This probably means that a reference was interpreted as an implicit caption. Or a table or figure may have been continued. 'Nested bars ignored', Explanation: Converter ignores nested .BB command. 'Nested endbars ignored', Explanation: Converter ignores nested .EB command. 'Nested Ifs not translated', Explanation: Converter cannot translate nested .IF constructs. 'Reference Table Size exceeded', Explanation: Too many unique references detected. 'Require file too deeply nested; Skipped it', Explanation: A limit of ten nested require files is allowed. Beyond that you get this message. 'Unmatched .ELS', Explanation: Converter found .ELS without .LS 'Unmatched .ENDIF', Explanation: Converter found .ENDIF without .IF 'Unrecognized substitution: InputLine, Explanation: Problem with cross referencing B-3 Error Messages 'Unterminated Table Generated', Explanation: Converter got confused in trying to make a definition list conversion and left a table open. B-4 _________________________________________________________________ Index _______________________________ Conversion _______________________________ methods 1-4 & 2-4 <CPAREN> 2-4 ( 2-4 Cross reference 4-2 ) 2-4 \ 2-4 _______________________________ | 2-4 D _______________________________ _______________________________ Design directive 3-1 A Direct method 1-4 _______________________________ Abstract conversion 1-7 _______________________________ <AMPERSAND> 2-4 E Angle bracket 4-13 _______________________________ Appendix 3-15 Emphasis 3-8 Autoparagraphing 2-1 _______________________________ Autotable 2-1 F _______________________________ _______________________________ B Figure 3-9 _______________________________ Filling 3-3 <BACKSLASH> 2-4 Flag 3-19 Bracket 4-13 Flags 2-1 Footnote 3-14 _______________________________ C _______________________________ _______________________________ H Caption 4-3, 4-5 _______________________________ table 4-5 Horizontal space 3-6 Chapter 3-15 _______________________________ Characters 2-4 Commands 3-1 I Component 3-1 _______________________________ Conditional 3-19 Implicit caption 4-5 Construct 3-1 Include 3-19 Control characters 2-4 Index 3-18 Index-1 Index _______________________________ _______________________________ J Q _______________________________ _______________________________ Justification 3-3 Qualifiers 1-2 _______________________________ _______________________________ K R _______________________________ _______________________________ Keyword Reference keyword 4-2 reference 4-2 adding 4-3 deleting 4-4 _______________________________ Repeated text 3-19 L Require 3-19 _______________________________ Revision bar 3-8 List 3-11 Running heads 3-2 _______________________________ _______________________________ M S _______________________________ _______________________________ Margins 3-3 Section 3-17 _______________________________ Side bar 3-8 Space N horizontal 3-6 _______________________________ vertical 3-5 Note 3-14 Special Characters 2-4 _______________________________ Subpaging 3-3 O Symbolic references 2-3 _______________________________ _______________________________ <OPAREN> 2-4 T _______________________________ _______________________________ P Table caption 4-5 _______________________________ table of contents 3-18 Paging 3-2 _______________________________ Paragraph 3-8 V Preface conversion 1-7 _______________________________ Process directive 3-1 VAX DOCUMENT Profile creation method 1-4 running 1-3 <VBAR> 2-4 Index-2 Index Vertical space 3-5 _______________________________ Z _______________________________ .ZBA 1-7 .ZBP 1-7 .ZCW 4-3 .ZEA 1-7 .ZEP 1-7 Index-3