home *** CD-ROM | disk | FTP | other *** search
/ Phoenix CD 2.0 / Phoenix_CD.cdr / 15a / mspantoc.zip / MSP10.DOC < prev    next >
Text File  |  1987-01-20  |  131KB  |  3,975 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                       MSPANTOC                                      MSPANTOC
  20.                                      Version 1.0
  21.  
  22.  
  23.  
  24.                             A Document Processing Utility
  25.  
  26.                                  Paragraph Numbering
  27.                               Symbolic Cross References
  28.                             Table of Contents Generating
  29.  
  30.  
  31.  
  32.                                 The Nunnery Works Ltd
  33.                                        Box 582
  34.                             Chesterville, Ontario K0C 1H0
  35.                                        Canada
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.           This document describes version 1.0 of the MSPANTOC document
  43.           processing utility.
  44.  
  45.           The MSPANTOC program and this document are both (C) copyright
  46.           1987 by The Nunnery Works Ltd.
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.           TABLE OF CONTENTS
  55.  
  56.           1. INTRODUCTION   . . . . . . . . . . . . . . . . . . . .     1-1
  57.              1.1. Purpose of This Manual  . . . . . . . . . . . . .     1-1
  58.              1.2. Some Fine Print   . . . . . . . . . . . . . . . .     1-1
  59.              1.3. Our Ownership, Your Rights  . . . . . . . . . . .     1-1
  60.              1.4. MSPANTOC Overview   . . . . . . . . . . . . . . .     1-3
  61.                   1.4.1. Paragraph/Section Numbering  . . . . . . .     1-3
  62.                   1.4.2. Symbolic Cross References  . . . . . . . .     1-3
  63.                   1.4.3. Figure Numbering   . . . . . . . . . . . .     1-3
  64.                   1.4.4. Table Numbering  . . . . . . . . . . . . .     1-3
  65.                   1.4.5. Table of Contents  . . . . . . . . . . . .     1-4
  66.                   1.4.6. List of Figures  . . . . . . . . . . . . .     1-4
  67.                   1.4.7. List of Tables   . . . . . . . . . . . . .     1-4
  68.                   1.4.8. Format Options   . . . . . . . . . . . . .     1-4
  69.              1.5. System Requirements   . . . . . . . . . . . . . .     1-6
  70.              1.6. The Nunnery Works Ltd   . . . . . . . . . . . . .     1-7
  71.              1.7. Why We Created MSPANTOC   . . . . . . . . . . . .     1-7
  72.              1.8. Bugs, Comments and Suggestions  . . . . . . . . .     1-8
  73.              1.9. Future Plans  . . . . . . . . . . . . . . . . . .     1-9
  74.                   1.9.1. Exported Symbols   . . . . . . . . . . . .     1-9
  75.                   1.9.2. Imported Symbols   . . . . . . . . . . . .     1-9
  76.                   1.9.3. Run Time Format Changes  . . . . . . . . .     1-10
  77.              1.10. How To Become a Registered User  . . . . . . . .     1-11
  78.                    1.10.1. As a Personal User   . . . . . . . . . .     1-11
  79.                    1.10.2. As a Corporate or Government User  . . .     1-12
  80.                    1.10.3. For a Site License   . . . . . . . . . .     1-12
  81.              1.11. Registration Form  . . . . . . . . . . . . . . .     1-13
  82.           2. INSTALLATION   . . . . . . . . . . . . . . . . . . . .     2-1
  83.              2.1. Introduction  . . . . . . . . . . . . . . . . . .     2-1
  84.              2.2. Make a Back Up Copy   . . . . . . . . . . . . . .     2-1
  85.              2.3. Distributed Files   . . . . . . . . . . . . . . .     2-1
  86.                   2.3.1. MSP10.DOC  . . . . . . . . . . . . . . . .     2-1
  87.                   2.3.2. MSP10.EXE  . . . . . . . . . . . . . . . .     2-1
  88.                   2.3.3. MSP.CFG  . . . . . . . . . . . . . . . . .     2-2
  89.                   2.3.4. MSPC10.EXE   . . . . . . . . . . . . . . .     2-2
  90.                   2.3.5. WS.ATR   . . . . . . . . . . . . . . . . .     2-2
  91.                   2.3.6. WP.ATR   . . . . . . . . . . . . . . . . .     2-2
  92.           3. PREPARING A DOCUMENT   . . . . . . . . . . . . . . . .     3-1
  93.              3.1. Introduction  . . . . . . . . . . . . . . . . . .     3-1
  94.              3.2. Document Preparation Summary  . . . . . . . . . .     3-1
  95.              3.3. Creating a Document   . . . . . . . . . . . . . .     3-1
  96.                   3.3.1. Justification  . . . . . . . . . . . . . .     3-2
  97.                   3.3.2. Page Numbering   . . . . . . . . . . . . .     3-2
  98.                   3.3.3. Page Breaks  . . . . . . . . . . . . . . .     3-3
  99.              3.4. Our Chapter File Organization   . . . . . . . . .     3-3
  100.              3.5. MSPANTOC Requests   . . . . . . . . . . . . . . .     3-4
  101.                   3.5.1. Lead-in String   . . . . . . . . . . . . .     3-4
  102.                   3.5.2. Request Code   . . . . . . . . . . . . . .     3-4
  103.                   3.5.3. Symbol Name  . . . . . . . . . . . . . . .     3-5
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.           TABLE OF CONTENTS
  111.  
  112.              3.6. Request Codes in Detail   . . . . . . . . . . . .     3-7
  113.                   3.6.1. *n - Assign a Paragraph Number   . . . . .     3-7
  114.                   3.6.2. #n - Assign a Section Number   . . . . . .     3-7
  115.                   3.6.3. F - Assign a Figure Number   . . . . . . .     3-8
  116.                   3.6.4. T - Assign a Table Number  . . . . . . . .     3-9
  117.                   3.6.5. @ - Request Current Chapter Number   . . .     3-9
  118.                   3.6.6. ? - Request a Paragraph Number   . . . . .     3-10
  119.                   3.6.7. P - Request a Page Number  . . . . . . . .     3-10
  120.           4. CONFIGURING MSPANTOC   . . . . . . . . . . . . . . . .     4-1
  121.              4.1. Introduction  . . . . . . . . . . . . . . . . . .     4-1
  122.              4.2. Operation Summary   . . . . . . . . . . . . . . .     4-1
  123.                   4.2.1. Command Line   . . . . . . . . . . . . . .     4-1
  124.                   4.2.2. Input Configuration File   . . . . . . . .     4-1
  125.                   4.2.3. Attribute File   . . . . . . . . . . . . .     4-1
  126.                   4.2.4. Output Configuration File  . . . . . . . .     4-2
  127.              4.3. Running MSPC  . . . . . . . . . . . . . . . . . .     4-3
  128.              4.4. Creating an Attribute File  . . . . . . . . . . .     4-3
  129.              4.5. Displayed Messages  . . . . . . . . . . . . . . .     4-4
  130.                   4.5.1. Status Messages  . . . . . . . . . . . . .     4-4
  131.                   4.5.2. Error Messages   . . . . . . . . . . . . .     4-5
  132.              4.6. Configuration Options   . . . . . . . . . . . . .     4-8
  133.                   4.6.1. Main Menu  . . . . . . . . . . . . . . . .     4-8
  134.                   4.6.2. Table of Contents Menu   . . . . . . . . .     4-10
  135.                   4.6.3. Figures menu   . . . . . . . . . . . . . .     4-14
  136.                   4.6.4. Tables menu    . . . . . . . . . . . . . .     4-17
  137.                   4.6.5. Document format menu, part 1   . . . . . .     4-20
  138.                   4.6.6. Document format menu, part 2   . . . . . .     4-22
  139.                   4.6.7. Document format menu, part 3   . . . . . .     4-24
  140.                   4.6.8. Miscellaneous menu   . . . . . . . . . . .     4-25
  141.           5. RUNNING MSPANTOC   . . . . . . . . . . . . . . . . . .     5-1
  142.              5.1. Introduction  . . . . . . . . . . . . . . . . . .     5-1
  143.              5.2. Command Line Format   . . . . . . . . . . . . . .     5-1
  144.                   5.2.1. Control File   . . . . . . . . . . . . . .     5-1
  145.                   5.2.2. Configuration File   . . . . . . . . . . .     5-2
  146.              5.3. Command Line Examples   . . . . . . . . . . . . .     5-2
  147.              5.4. Displayed Messages  . . . . . . . . . . . . . . .     5-3
  148.                   5.4.1. Status Messages  . . . . . . . . . . . . .     5-3
  149.                   5.4.2. Error Messages   . . . . . . . . . . . . .     5-3
  150.              5.5. Processing Summary  . . . . . . . . . . . . . . .     5-7
  151.                   5.5.1. Command Line   . . . . . . . . . . . . . .     5-7
  152.                   5.5.2. Control File   . . . . . . . . . . . . . .     5-7
  153.                   5.5.3. Configuration File   . . . . . . . . . . .     5-7
  154.                   5.5.4. Input Text Files   . . . . . . . . . . . .     5-7
  155.                   5.5.5. Table of Contents File   . . . . . . . . .     5-8
  156.                   5.5.6. List of Figures File   . . . . . . . . . .     5-8
  157.                   5.5.7. List of Tables File  . . . . . . . . . . .     5-8
  158.                   5.5.8. Output Text Files  . . . . . . . . . . . .     5-8
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.           TABLE OF CONTENTS
  166.  
  167.           6. PRINTING A DOCUMENT  . . . . . . . . . . . . . . . . .     6-1
  168.              6.1. Introduction  . . . . . . . . . . . . . . . . . .     6-1
  169.              6.2. After MSPANTOC Runs   . . . . . . . . . . . . . .     6-1
  170.              6.3. A General Solution  . . . . . . . . . . . . . . .     6-1
  171.              6.4. Using WordStar with MailMerge   . . . . . . . . .     6-2
  172.              6.5. Using WordStar without MailMerge  . . . . . . . .     6-2
  173.              6.6. Using WordPerfect   . . . . . . . . . . . . . . .     6-3
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.           LIST OF FIGURES
  182.  
  183.           Figure 3-1    Sample Multi-Level Numbers  . . . . . . . .     3-5
  184.           Figure 4-1    MSPC Operation Summary  . . . . . . . . . .     4-2
  185.           Figure 4-2    Main Menu   . . . . . . . . . . . . . . . .     4-9
  186.           Figure 4-3    Table of Contents Menu  . . . . . . . . . .     4-12
  187.           Figure 4-4    Table of Contents, With Indentation   . . .     4-13
  188.           Figure 4-5    Table of Contents, No Indentation   . . . .     4-13
  189.           Figure 4-6    Table of Contents, Lowest Level Only  . . .     4-13
  190.           Figure 4-7    Figures Menu  . . . . . . . . . . . . . . .     4-16
  191.           Figure 4-8    Tables Menu   . . . . . . . . . . . . . . .     4-19
  192.           Figure 4-9    Document Menu, Part 1   . . . . . . . . . .     4-21
  193.           Figure 4-10   Document Menu, Part 2   . . . . . . . . . .     4-21
  194.           Figure 4-11   Table of Contents, Differing Number Syste       4-23
  195.           Figure 4-12   Document Menu, Part 3   . . . . . . . . . .     4-26
  196.           Figure 4-13   Miscellaneous Values Menu   . . . . . . . .     4-26
  197.           Figure 5-1    MSPANTOC Processing Summary   . . . . . . .     5-9
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.           MSPANTOC Version 1.0                                 INTRODUCTION
  206.  
  207.           1. INTRODUCTION          1. INTRODUCTION          _______________
  208.  
  209.           1.1. Purpose of This Manual          1.1. Purpose of This Manual
  210.  
  211.           This manual describes MSPANTOC, version 1.0.  MSPANTOC is a
  212.           document processing utility for MS-DOS and PC-DOS that 
  213.  
  214.                1) numbers sections, paragraphs, figures and tables
  215.                2) resolves symbolic cross references to section, paragraph,
  216.                   figure and table numbers
  217.                3) creates a table of contents, a list of figures and a list
  218.                   of tables.
  219.  
  220.           This chapter presents an overview of MSPANTOC and describes the
  221.           ownership and licensing conditions.
  222.  
  223.  
  224.           1.2. Some Fine Print          1.2. Some Fine Print
  225.  
  226.           MailMerge is a registered trademark of MicroPro International
  227.           Corporation.
  228.  
  229.           MS-DOS is a registered trademark of Microsoft Corporation.
  230.  
  231.           PC-DOS is a registered trademark of IBM Corporation.
  232.  
  233.           StarIndex is a trademark of MicroPro International Corporation.
  234.  
  235.           WordPerfect is a registered trademark of WordPerfect Corporation.
  236.  
  237.           WordStar is a registered trademark of MicroPro International
  238.           Corporation
  239.  
  240.  
  241.           1.3. Our Ownership, Your Rights          1.3. Our Ownership, Your Rights
  242.  
  243.           The MSPANTOC program and this manual are both the copyrighted
  244.           property of The Nunnery Works Ltd.  
  245.  
  246.           We are distributing this program as user-supported software. 
  247.           This does not mean that we are releasing MSPANTOC into the public
  248.           domain.  Instead, we are retaining all rights to the program and
  249.           its documentation.
  250.  
  251.           We grant you a limited license to use MSPANTOC for your personal
  252.           evaluation purposes.
  253.  
  254.  
  255.  
  256.  
  257.  
  258.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-1
  259.  
  260.  
  261.  
  262.  
  263.  
  264.           MSPANTOC Version 1.0                                 INTRODUCTION
  265.  
  266.           We encourage you to copy and to distribute the MSPANTOC program
  267.           and documentation, subject to the following conditions:
  268.  
  269.                1) Any fee you charge for copying or distributing
  270.                   MSPANTOC is to cover your handling and media costs.
  271.                   This fee does not give the person who receives the
  272.                   copy any rights with respect to MSPANTOC other than
  273.                   those stated above.
  274.                2) All distributed copies of the MSPANTOC program and
  275.                   documentation, excluding the distribution media, remain
  276.                   the property of The Nunnery Works Ltd.
  277.                3) You may distribute MSPANTOC only in its original and
  278.                   unmodified state.
  279.  
  280.           After you have evaluated MSPANTOC and if you find it useful, we
  281.           ask you and any to whom you distribute the MSPANTOC program to
  282.           become registered users.  To register, fill in the registration
  283.           request form and return it to us along with the appropriate
  284.           registration fee for your location.  See section 1.10 on page
  285.           1-11 for details.  
  286.  
  287.           Please note that we accept corporate and government purchase
  288.           orders.  See section 1.10.2 for details.
  289.  
  290.           We will be happy to provide a site license to corporate or
  291.           government users.  Please write for details.
  292.  
  293.           Your registration helps us by providing the funds to further
  294.           extend MSPANTOC.  
  295.  
  296.           If you become a registered user, we will:
  297.  
  298.                1) Send you a receipt for your registration fee
  299.                2) Send you a copy of the most recent version of the
  300.                   program.
  301.                3) Send you the next major update, free of additional
  302.                   charge.
  303.                4) Notify you of significant updates which will be available
  304.                   at minimal charge.
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-2
  318.  
  319.  
  320.  
  321.  
  322.  
  323.           MSPANTOC Version 1.0                                 INTRODUCTION
  324.  
  325.           1.4. MSPANTOC Overview          1.4. MSPANTOC Overview
  326.  
  327.           MSPANTOC is not a word processing program and it is not an
  328.           outline processor.  It reads a document you create with your
  329.           favorite word processing package and writes a new document,
  330.           updated with
  331.  
  332.                1) assigned section, paragraph, figure and table numbers,
  333.                2) resolved cross references
  334.                3) a table of contents
  335.                4) a list of figures
  336.                5) a list of tables.
  337.  
  338.  
  339.           1.4.1. Paragraph/Section Numbering          1.4.1. Paragraph/Section Numbering
  340.  
  341.           MSPANTOC sequentially numbers the paragraphs or sections that you
  342.           identify and creates multi-level paragraph or section numbers,
  343.           like 3.2.1.5.
  344.  
  345.  
  346.           1.4.2. Symbolic Cross References          1.4.2. Symbolic Cross References
  347.  
  348.           MSPANTOC resolves symbolic section, paragraph, figure and table
  349.           number cross references.  It allows you to enter in your document
  350.           a phrase such as "refer to paragraph =>?alloy_desc for a full
  351.           description of the alloy contents."  The output file that
  352.           MSPANTOC creates will contain the full section, paragraph, figure
  353.           or table number associated with the symbol "alloy_desc".
  354.  
  355.  
  356.           1.4.3. Figure Numbering          1.4.3. Figure Numbering
  357.  
  358.           MSPANTOC sequentially numbers figures that you identify and
  359.           creates figure numbers, like 3-5, according to a format you
  360.           specify.
  361.  
  362.  
  363.           1.4.4. Table Numbering          1.4.4. Table Numbering
  364.  
  365.           MSPANTOC sequentially numbers tables that you identify and
  366.           creates table numbers, like 7-2, according to a format you
  367.           specify.
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-3
  377.  
  378.  
  379.  
  380.  
  381.  
  382.           MSPANTOC Version 1.0                                 INTRODUCTION
  383.  
  384.           1.4.5. Table of Contents          1.4.5. Table of Contents
  385.  
  386.           MSPANTOC automatically creates a file containing a formatted
  387.           table of contents.  The table of contents includes the section
  388.           numbers, section headings and page numbers. 
  389.  
  390.  
  391.           1.4.6. List of Figures          1.4.6. List of Figures
  392.  
  393.           MSPANTOC automatically creates a file containing a formatted list
  394.           of the figures you identify in your document.  The list of
  395.           figures includes the figure numbers, figure descriptions and page
  396.           numbers.
  397.  
  398.  
  399.           1.4.7. List of Tables          1.4.7. List of Tables
  400.  
  401.           MSPANTOC automatically creates a file containing a formatted list
  402.           of the tables you identify in your document.  The list of tables
  403.           includes the table numbers, table descriptions and page numbers.
  404.  
  405.  
  406.           1.4.8. Format Options          1.4.8. Format Options
  407.  
  408.           MSPANTOC provides extensive control over the appearance of the
  409.           document it creates and allows the following display format
  410.           options:
  411.  
  412.  
  413.           1.4.8.1. Number Level Format
  414.  
  415.           MSPANTOC will display each level of a paragraph or section number
  416.           in one of 5 formats:
  417.  
  418.                1) Arabic numbers (1, 2, 3, ...), 
  419.                2) upper case Roman numerals (I, II, III, IV, ...), 
  420.                3) lower case Roman numerals (i, ii, iii, iv, ...), 
  421.                4) upper case alphabetics (A, B, C, ...) or 
  422.                5) lower case alphabetics (a, b, c, ...).
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-4
  436.  
  437.  
  438.  
  439.  
  440.  
  441.           MSPANTOC Version 1.0                                 INTRODUCTION
  442.  
  443.           1.4.8.2. Print Attributes
  444.  
  445.           MSPANTOC can include the specific codes that your word processing
  446.           package uses to select print attributes such as bold, underlined,
  447.           italics etc. to control the printed appearance of the following
  448.           items:
  449.  
  450.                1) section headings, by level, in the table of contents
  451.                2) section headings, by level, in the main document
  452.                3) figure descriptions in the main document
  453.                4) table descriptions in the main document
  454.  
  455.  
  456.           1.4.8.3. Level Number Punctuation
  457.  
  458.           MSPANTOC allows you to specify the punctuation inserted after
  459.           each level of a multi-level section or paragraph number.  For
  460.           example, MSPANTOC will display a number with (strange ?)
  461.           punctuation like 3-4.2#a) if you request it.
  462.  
  463.  
  464.           1.4.8.4. Page Number Format
  465.  
  466.           MSPANTOC will number pages either sequentially (1, 2, 3, ...) or
  467.           sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
  468.  
  469.  
  470.           1.4.8.5. Figure Number Format
  471.  
  472.           MSPANTOC will number figures either sequentially (1, 2, 3, ...)
  473.           or sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
  474.  
  475.  
  476.           1.4.8.6. Table Number Format
  477.  
  478.           MSPANTOC will number tables either sequentially (1, 2, 3, ...) or
  479.           sequentially within chapter number (1-1, 1-2, ..., 2-1, ...).
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-5
  495.  
  496.  
  497.  
  498.  
  499.  
  500.           MSPANTOC Version 1.0                                 INTRODUCTION
  501.  
  502.           1.5. System Requirements          1.5. System Requirements
  503.  
  504.           The Nunnery Works Ltd specifically designed MSPANTOC to operate
  505.           on any MS-DOS or PC-DOS system.  MSPANTOC does not use any
  506.           specific IBM PC hardware feature (graphics, ports, disks etc) and
  507.           should work on any system that runs MS-DOS or PC-DOS with version
  508.           numbers of 2.xx or higher.
  509.  
  510.           The minimum system requirements are:
  511.  
  512.                1) a system that runs MS-DOS or PC-DOS 2.xx or higher
  513.                2) 128k of memory
  514.                3) at least one floppy disk drive
  515.  
  516.           However, we recommend that you use a system that includes a hard
  517.           disk.
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-6
  554.  
  555.  
  556.  
  557.  
  558.  
  559.           MSPANTOC Version 1.0                                 INTRODUCTION
  560.  
  561.           1.6. The Nunnery Works Ltd          1.6. The Nunnery Works Ltd
  562.  
  563.           The Nunnery Works Ltd is a consulting company located in
  564.           Chesterville, Ontario, a small farming community about 40 miles
  565.           southeast of Ottawa.  Our founder lives in a house that was used
  566.           as a convent for 50 years, thus, our name.
  567.  
  568.  
  569.           1.7. Why We Created MSPANTOC          1.7. Why We Created MSPANTOC
  570.  
  571.           Much of our work involves technical writing - proposals, bids or
  572.           general documentation that requires multi-level paragraph and
  573.           section numbering. 
  574.  
  575.           In our environment, these types of documents are written by
  576.           multiple authors, require frequent re-organization and
  577.           renumbering and require extensive cross references.
  578.            
  579.           We created our first version of what evolved into MSPANTOC in
  580.           1975 for use in a mini computer environment.  We later
  581.           implemented versions for different environments but not for MS-
  582.           DOS or PC-DOS.
  583.  
  584.           We tried StarIndex when we were using WordStar but StarIndex
  585.           supports only 4 levels of numbering and does not provide a
  586.           symbolic referencing feature to solve our requirements for
  587.           automatic cross references.
  588.  
  589.           We also tried WordPerfect but did not like the requirement to
  590.           indent to create new sub-levels and WordPerfect also does not
  591.           provide symbolic referencing.
  592.  
  593.           So, because we could not locate a commercial product that met our
  594.           requirements, we decided to implement our existing program under
  595.           MS-DOS.
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-7
  613.  
  614.  
  615.  
  616.  
  617.  
  618.           MSPANTOC Version 1.0                                 INTRODUCTION
  619.  
  620.           1.8. Bugs, Comments and Suggestions          1.8. Bugs, Comments and Suggestions
  621.  
  622.           We have been in the design and programming business a long time
  623.           and we have not yet built a program of any size that did not
  624.           contain some surprise bugs.  We do not expect that MSPANTOC will
  625.           be any different.
  626.  
  627.           If and when you discover any obvious problems or anything at all
  628.           that does not seem to operate the way the documentation states it
  629.           should, please inform us by mail and we will correct the problems
  630.           as soon as possible and return an updated version of the program
  631.           to you.
  632.  
  633.           We are particularly interested in making MSPANTOC compatible with
  634.           as many word processing packages as possible.  If any MSPANTOC
  635.           features do not work with your word processing package, please
  636.           let us know.
  637.  
  638.           It is our intent that MSPANTOC operates as documented, is bug
  639.           free and performs a useful function.
  640.  
  641.           If you have any comments or suggestions for enhancements, please
  642.           write us and pass them on.  Wherever possible, we will continue
  643.           to extend the program to make it even more useful.   If we can
  644.           implement any of your suggestions, we will send you a new version
  645.           of the program that includes the changes you suggested.
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-8
  672.  
  673.  
  674.  
  675.  
  676.  
  677.           MSPANTOC Version 1.0                                 INTRODUCTION
  678.  
  679.           1.9. Future Plans          1.9. Future Plans
  680.  
  681.           Future versions of MSPANTOC will include at least the following
  682.           new features:
  683.  
  684.  
  685.           1.9.1. Exported Symbols          1.9.1. Exported Symbols
  686.  
  687.           A future version of MSPANTOC will allow you to specify a file
  688.           name where it will output the symbols defined in the current
  689.           document.
  690.  
  691.           For each symbol, MSPANTOC will output the following:
  692.  
  693.                1) the symbol name
  694.                2) the page number where the symbol is defined
  695.                3) the page number format
  696.                4) the section, paragraph, figure or table number
  697.                   associated with the symbol
  698.                5) the number display format in effect at the time the
  699.                   symbol was defined
  700.  
  701.  
  702.           1.9.2. Imported Symbols          1.9.2. Imported Symbols
  703.  
  704.           A future version of MSPANTOC will allow you to specify one or
  705.           more file names from which it will obtain full information about
  706.           symbols defined in some other documents.
  707.  
  708.           For each symbol, MSPANTOC will read the following:
  709.  
  710.                1) the symbol name
  711.                2) the page number where the symbol is defined
  712.                3) the page number format
  713.                4) the section, paragraph, figure or table number
  714.                   associated with the symbol
  715.                5) the number display format in effect at the time the
  716.                   symbol was defined
  717.  
  718.           This feature will allow the user to make symbolic cross
  719.           references into other documents.  In addition, MSPANTOC will
  720.           resolve these cross references using the number display formats
  721.           used in the other documents.  These formats could be different
  722.           from the formats being used in the current document.
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.           Copyright (C) The Nunnery Works Ltd 1987                 Page 1-9
  731.  
  732.  
  733.  
  734.  
  735.  
  736.           MSPANTOC Version 1.0                                 INTRODUCTION
  737.  
  738.           1.9.3. Run Time Format Changes          1.9.3. Run Time Format Changes
  739.  
  740.           A future version of MSPANTOC will allow you to select and change
  741.           from within your document the display format, by level, for
  742.           section and paragraph numbers.
  743.  
  744.           This feature will allow MSPANTOC to generate, for example, a 3
  745.           level section number like 3.7.12 in one part of the document and
  746.           other numbers like 5.2.a) or 5.3.iv) in another part.
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.           Copyright (C) The Nunnery Works Ltd 1987                Page 1-10
  790.  
  791.  
  792.  
  793.  
  794.  
  795.           MSPANTOC Version 1.0                                 INTRODUCTION
  796.  
  797.           1.10. How To Become a Registered User          1.10. How To Become a Registered User
  798.  
  799.           We encourage you to register as a user of MSPANTOC.  You can
  800.           register as a user (personal, corporate or government) of one or
  801.           more copies and we also offer site licenses.
  802.  
  803.           If you become a registered user, we will:
  804.  
  805.                1) Send you a receipt for your registration fee
  806.                2) Send you a copy of the most recent version of the
  807.                   program, licensed for use on a single computer.
  808.                3) Send you the next major update, free of additional
  809.                   charge.
  810.                4) Notify you of significant updates which will be available
  811.                   at minimal charge.
  812.  
  813.  
  814.           In all cases, our address is
  815.  
  816.                The Nunnery Works Ltd
  817.                Box 582
  818.                Chesterville, Ontario K0C 1H0
  819.                Canada
  820.  
  821.  
  822.           1.10.1. As a Personal User          1.10.1. As a Personal User
  823.  
  824.           To register as a personal user of MSPANTOC, fill in the
  825.           registration form on the following page and return it along with
  826.           the appropriate registration fee to The Nunnery Works Ltd.
  827.  
  828.           The registration fee is as follows:
  829.  
  830.                1) For residents of Ontario, $37.14, Canadian funds
  831.                   ($35.00 + $2.14 sales tax)
  832.                2) For the rest of Canada, $35.00, Canadian funds
  833.                3) For the rest of the world, $35.00, US funds.
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.           Copyright (C) The Nunnery Works Ltd 1987                Page 1-11
  849.  
  850.  
  851.  
  852.  
  853.  
  854.           MSPANTOC Version 1.0                                 INTRODUCTION
  855.  
  856.           1.10.2. As a Corporate or Government User          1.10.2. As a Corporate or Government User
  857.  
  858.           To register as a corporate or government user of a single copy of
  859.           MSPANTOC, send a purchase order to The Nunnery Works Ltd.
  860.  
  861.           Each copy of MSPANTOC will be licensed for use on a single
  862.           computer.
  863.  
  864.           The registration fee for each copy is as follows:
  865.  
  866.                1) For Ontario addresses, $37.14, Canadian funds
  867.                   ($35.00 + $2.14 provincial sales tax)
  868.                2) For the rest of Canada, $35.00, Canadian funds
  869.                3) For the rest of the world, $35.00, US funds.
  870.  
  871.           Our terms for purchase orders are net 15.
  872.  
  873.  
  874.           1.10.3. For a Site License          1.10.3. For a Site License
  875.  
  876.           We will be pleased to license your site for the use of multiple
  877.           copies of MSPANTOC.  For details, write to
  878.  
  879.                The Nunnery Works Ltd
  880.                Box 582
  881.                Chesterville, Ontario K0C 1H0
  882.                Canada
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.           Copyright (C) The Nunnery Works Ltd 1987                Page 1-12
  908.  
  909.  
  910.  
  911.  
  912.  
  913.           MSPANTOC Version 1.0                                 INTRODUCTION
  914.  
  915.           1.11. Registration Form          1.11. Registration Form
  916.  
  917.  
  918.           Mail to:  The Nunnery Works Ltd
  919.                     Box 582
  920.                     Chesterville, Ontario K0C 1H0
  921.                     Canada
  922.  
  923.  
  924.  
  925.           Please send me ________ registered copies of MSPANTOC.
  926.  
  927.           Registration fee ($35.00 each copy)          _________ . ______
  928.  
  929.           Sales tax, Ontario residents only
  930.           ($2.14 for each copy)                        _________ . ______
  931.  
  932.           Total enclosed, cheque or money order 
  933.           payable to The Nunnery Works Ltd             _________ . ______
  934.  
  935.  
  936.  
  937.  
  938.           Name:     ___________________________________
  939.  
  940.           Address:  ___________________________________
  941.  
  942.           City:     __________________
  943.  
  944.           Prov/State:  _____________  Postal/Zip Code: _______________
  945.  
  946.           Country:  ________________
  947.  
  948.           Telephone:     (______) ______ - ____________
  949.  
  950.           MSPANTOC Serial Number from your current copy:    __________
  951.  
  952.           Your word processing package:  _____________________________
  953.  
  954.           Your operating system (please circle one)  MS-DOS  or  PC-DOS
  955.  
  956.  
  957.           Comments:
  958.  
  959.  
  960.  
  961.  
  962.  
  963.  
  964.  
  965.  
  966.           Copyright (C) The Nunnery Works Ltd 1987                Page 1-13
  967.  
  968.  
  969.  
  970.  
  971.  
  972.           MSPANTOC Version 1.0                                 INSTALLATION
  973.  
  974.           2. INSTALLATION          2. INSTALLATION          _______________
  975.  
  976.           2.1. Introduction          2.1. Introduction
  977.  
  978.           This chapter describes the various files distributed as part of
  979.           the MSPANTOC package.
  980.  
  981.  
  982.           2.2. Make a Back Up Copy          2.2. Make a Back Up Copy
  983.  
  984.           Before using MSPANTOC, we recommend that you make a copy of the
  985.           distributed files, save your original copy and then work from
  986.           your copy.
  987.  
  988.           Use the following procedure to make a copy of the MSPANTOC
  989.           distribution files.
  990.  
  991.                1. Insert your system diskette in drive A and enter the
  992.                   following command:
  993.  
  994.                   >A:DISKCOPY A: B:
  995.  
  996.                2. Insert the diskette containing the MSPANTOC
  997.                   distribution files in drive A and a formatted diskette
  998.                   in drive B and then press the RETURN or ENTER key.
  999.  
  1000.           This procedure copies the distributed MSPANTOC files to a new
  1001.           diskette in drive B.  When the copy operation completes, save the
  1002.           original diskette from drive A and retain the copy from drive B
  1003.           as your working copy.
  1004.  
  1005.  
  1006.           2.3. Distributed Files          2.3. Distributed Files
  1007.  
  1008.           The Nunnery Works Ltd distributes MSPANTOC, version 1.0, on a
  1009.           single diskette containing the following files.
  1010.  
  1011.  
  1012.           2.3.1. MSP10.DOC          2.3.1. MSP10.DOC
  1013.  
  1014.           This file is the MSPANTOC, version 1.0 documentation file.
  1015.  
  1016.  
  1017.           2.3.2. MSP10.EXE          2.3.2. MSP10.EXE
  1018.  
  1019.           This file is the MSPANTOC, version 1.0 executable program.
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.           Copyright (C) The Nunnery Works Ltd 1987                 Page 2-1
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.           MSPANTOC Version 1.0                                 INSTALLATION
  1032.  
  1033.           2.3.3. MSP.CFG          2.3.3. MSP.CFG
  1034.  
  1035.           This file is the MSPANTOC, version 1.0, default configuration
  1036.           file.
  1037.  
  1038.  
  1039.           2.3.4. MSPC10.EXE          2.3.4. MSPC10.EXE
  1040.  
  1041.           This file is the MSPANTOC, version 1.0, executable configuration
  1042.           program.
  1043.  
  1044.  
  1045.           2.3.5. WS.ATR          2.3.5. WS.ATR
  1046.  
  1047.           This file is the default print attribute file for use with
  1048.           WordStar.
  1049.  
  1050.           The MSPANTOC configuration program reads this file and includes
  1051.           its contents in the configuration file.
  1052.  
  1053.  
  1054.           2.3.6. WP.ATR          2.3.6. WP.ATR
  1055.  
  1056.           This file is the default print attribute file for use with
  1057.           WordPerfect.
  1058.  
  1059.           The MSPANTOC configuration program reads this file and includes
  1060.           its contents in the configuration file.
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.           Copyright (C) The Nunnery Works Ltd 1987                 Page 2-2
  1085.  
  1086.  
  1087.  
  1088.  
  1089.  
  1090.           MSPANTOC Version 1.0                                 INSTALLATION
  1091.  
  1092.  
  1093.  
  1094.  
  1095.  
  1096.  
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125.  
  1126.  
  1127.  
  1128.  
  1129.  
  1130.  
  1131.  
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.           Copyright (C) The Nunnery Works Ltd 1987                 Page 2-3
  1144.  
  1145.  
  1146.  
  1147.  
  1148.  
  1149.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1150.  
  1151.           3. PREPARING A DOCUMENT          3. PREPARING A DOCUMENT          _______________________
  1152.  
  1153.           3.1. Introduction          3.1. Introduction
  1154.  
  1155.           This chapter describes how to use MSPANTOC to number sections,
  1156.           paragraphs, figures or tables and to cross reference to other
  1157.           parts of your document.
  1158.  
  1159.  
  1160.           3.2. Document Preparation Summary          3.2. Document Preparation Summary
  1161.  
  1162.           The following steps summarize the work you must do to prepare a
  1163.           document for processing by MSPANTOC.  These steps are usually
  1164.           done in parallel but it is obviously easier to present them as a
  1165.           list of separate items.
  1166.  
  1167.                1) Create a document using your word processing package.
  1168.                2) Identify any sections to be numbered and included in
  1169.                   the table of contents and include an MSPANTOC section 
  1170.                   number request for each one.
  1171.                3) Identify any paragraphs to be numbered and include an
  1172.                   MSPANTOC paragraph number request for each one.
  1173.                4) Identify any figures or tables to be numbered and include
  1174.                   an MSPANTOC figure or table number request for each one.
  1175.                5) Identify any sections, paragraphs, figures or tables that
  1176.                   must be referenced elsewhere within the document and
  1177.                   assign a unique symbol to each.
  1178.                6) Identify any locations in your document which must
  1179.                   reference by number or page number a section, paragraph,
  1180.                   figure or table located elsewhere within the document and
  1181.                   include an MSPANTOC cross reference request for each one.
  1182.  
  1183.  
  1184.           3.3. Creating a Document          3.3. Creating a Document
  1185.  
  1186.           Prepare your document using your favorite word processing
  1187.           package.  We suggest that you organize your document so that each
  1188.           chapter occupies a separate file.  This method simplifies the
  1189.           problems of adding, deleting or changing the order of the
  1190.           chapters but it works only with a word processing package that
  1191.           can merge separate files together for printing as a single
  1192.           document.  Both WordStar and WordPerfect will do this.
  1193.  
  1194.           Within each file, the only areas that might be different from
  1195.           your normal procedures are document justification, page numbering
  1196.           and page breaks.
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-1
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1209.  
  1210.           3.3.1. Justification          3.3.1. Justification
  1211.  
  1212.           If you intend to cross reference paragraph numbers using 
  1213.           MSPANTOC symbolic references, a document formatted with ragged
  1214.           right margins (no right justification) will work best.  
  1215.  
  1216.           MSPANTOC does not reformat your paragraphs when it makes text
  1217.           replacements.  Anywhere it replaces a cross reference request of
  1218.           the form "=>?symbol" with a paragraph number of different length
  1219.           such as 1.3, the right margin will not be justified.
  1220.  
  1221.  
  1222.           3.3.2. Page Numbering          3.3.2. Page Numbering
  1223.  
  1224.           If you want pages numbered in a strictly sequential format from
  1225.           beginning to end of your document, there should be no problem. 
  1226.           You can use your word processing package to place the page
  1227.           numbers anywhere on the page.
  1228.  
  1229.           If you want pages numbered sequentially within chapters with the
  1230.           page number resetting to 1 at the start of each chapter, proceed
  1231.           as follows:
  1232.  
  1233.                1) Select the MSPANTOC configuration option to number pages
  1234.                   within chapters.  This option directs MSPANTOC to create
  1235.                   the table of contents and page number cross references
  1236.                   with the correct format page numbers.
  1237.                2) At the beginning of each chapter, insert the command for
  1238.                   your word processing package to reset the page number to
  1239.                   1.
  1240.                3) Request that your word processor number the pages 
  1241.                   somewhere other than in a page header.  A page footing
  1242.                   is an ideal place.  Insert a footer definition in each
  1243.                   chapter and position the footer definition after the 
  1244.                   =>#1 that defines the new chapter number and heading.
  1245.                4) Wherever you want the page number to appear, insert the
  1246.                   MSPANTOC chapter number request (=>@) before the page
  1247.                   number.
  1248.  
  1249.                   In WordStar, insert something like
  1250.  
  1251.                     ... Page =>@-#
  1252.  
  1253.                   and WordStar will replace the # with the current page
  1254.                   number within the chapter to create a line that looks
  1255.                   like
  1256.  
  1257.                     ... Page 12-3
  1258.  
  1259.  
  1260.  
  1261.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-2
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1268.  
  1269.                   In WordPerfect, insert something like
  1270.  
  1271.                     ... Page =>@-^N
  1272.  
  1273.                   and WordPerfect will replace the ^N (control-N) with
  1274.                   the current page number within the chapter to create
  1275.                   a line that looks like
  1276.  
  1277.                     ... Page 7-15
  1278.  
  1279.  
  1280.           3.3.3. Page Breaks          3.3.3. Page Breaks
  1281.  
  1282.           If MSPANTOC is to produce a usable table of contents, list of
  1283.           figures and list of tables, you must control page breaks
  1284.           manually.  Wherever you require page breaks in a document, insert
  1285.           an unconditional form feed.  We designed MSPANTOC to work with
  1286.           documents created by any word processing package.  The only
  1287.           universal method of detecting where page breaks occur is to
  1288.           accept form feeds only.
  1289.  
  1290.           WordStar inserts a form feed at the cursor location in a document
  1291.           when you type ^PL (control-P L).
  1292.  
  1293.           WordPerfect inserts a form feed at the cursor location in a
  1294.           document when you type ^ENTER (control-ENTER).
  1295.  
  1296.  
  1297.           3.4. Our Chapter File Organization          3.4. Our Chapter File Organization
  1298.  
  1299.           As a guide for you, the following list shows the order in which
  1300.           we position items in our individual chapter files.
  1301.  
  1302.                1) Margin settings for the chapter.
  1303.                2) Pitch setting for the chapter.
  1304.                3) Header definition for the chapter.
  1305.                4) A form feed.
  1306.                5) The chapter section heading (=>#1 heading).
  1307.                6) A command to set the page number to 1.
  1308.                7) Footing definition for the chapter, including the page
  1309.                   number in the footing.
  1310.                8) The chapter text.
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.  
  1319.  
  1320.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-3
  1321.  
  1322.  
  1323.  
  1324.  
  1325.  
  1326.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1327.  
  1328.           3.5. MSPANTOC Requests          3.5. MSPANTOC Requests
  1329.  
  1330.           All MSPANTOC requests consist of 2 mandatory items:
  1331.  
  1332.                1) a lead-in string
  1333.                2) a 1 or 2 character request code
  1334.  
  1335.           and some requests require or allow the addition of another item:
  1336.  
  1337.                3) a symbol name
  1338.  
  1339.  
  1340.           3.5.1. Lead-in String          3.5.1. Lead-in String
  1341.  
  1342.           A lead-in string is a predefined sequence of from 1 to 3
  1343.           characters which identify for MSPANTOC (and visually highlight)
  1344.           the next 1 or 2 characters as an action request code.
  1345.  
  1346.           The configuration file on the MSPANTOC distribution diskette
  1347.           defines the 2 character string => as the default lead-in string. 
  1348.           Refer to section 4.6.8.2 on page 4-25 for a description of how to
  1349.           use the MSPANTOC configuration program to change the lead-in
  1350.           string.
  1351.  
  1352.  
  1353.           3.5.2. Request Code          3.5.2. Request Code
  1354.  
  1355.           The request code is 1 or 2 characters and identifies a request to
  1356.           MSPANTOC for either
  1357.  
  1358.                1) the assignment of a new paragraph, section, figure
  1359.                   or table number
  1360.                2) the retrieval of a page, chapter, section, paragraph,
  1361.                   figure or table number defined elsewhere in the
  1362.                   document.
  1363.  
  1364.           The request code can be one of the following:
  1365.  
  1366.                *n - Assign a level n paragraph number
  1367.                #n - Assign a level n section number
  1368.                F  - Assign a figure number
  1369.                T  - Assign a table number
  1370.  
  1371.                @  - Request the current chapter number
  1372.                ?  - Request a paragraph number
  1373.                P  - Request a page number
  1374.  
  1375.  
  1376.  
  1377.  
  1378.  
  1379.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-4
  1380.  
  1381.  
  1382.  
  1383.  
  1384.  
  1385.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1386.  
  1387.           A paragraph or section number request includes a single digit in
  1388.           the range 1-9.  This digit defines the paragraph or section level
  1389.           number to assign.  For example, the figure 3-1 lists sample
  1390.           paragraph or section numbers that MSPANTOC assigns for each
  1391.           level.
  1392.  
  1393.           __________________________________________________________
  1394.  
  1395.              Level   Sample Section or Paragraph Number
  1396.  
  1397.                1     1.
  1398.                2     1.2.
  1399.                3     1.2.3.
  1400.                4     1.2.3.4.
  1401.                5     1.2.3.4.5.
  1402.                6     1.2.3.4.5.6.
  1403.                7     1.2.3.4.5.6.7.
  1404.                8     1.2.3.4.5.6.7.8.
  1405.                9     1.2.3.4.5.6.7.8.9.
  1406.  
  1407.              Figure  3-1: Sample Multi-Level Numbers
  1408.  
  1409.           __________________________________________________________
  1410.  
  1411.  
  1412.  
  1413.           3.5.3. Symbol Name          3.5.3. Symbol Name
  1414.  
  1415.           A symbol name can follow the number assignment request codes (*n,
  1416.           #n, F and T).  MSPANTOC saves the symbol name along with
  1417.  
  1418.                1) the full multi-level assigned number (section, paragraph,
  1419.                   figure or table)
  1420.                2) the page number where the symbol is defined
  1421.  
  1422.           A symbol name must follow the request codes ? and P.  MSPANTOC
  1423.           replaces the lead-in string, request code and the symbol name
  1424.           with either the full multi-level assigned number (?) or page
  1425.           number (P) that was saved with the symbol name.
  1426.  
  1427.           A symbol name consists of from 1 to 10 characters.  If a symbol
  1428.           name has more than 10 characters, MSPANTOC uses only the first
  1429.           10.
  1430.  
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-5
  1439.  
  1440.  
  1441.  
  1442.  
  1443.  
  1444.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1445.  
  1446.           Each character in a symbol name can be chosen from the following
  1447.           groups:
  1448.  
  1449.                1) alphabetic characters, A-Z, a-z
  1450.                2) numeric characters, 0-9
  1451.                3) the 2 special characters, - (dash or minus sign) and
  1452.                   _ (underline)
  1453.  
  1454.           MSPANTOC considers a symbol name to end with the first occurrence
  1455.           of a character that does not belong to one of the above groups.
  1456.  
  1457.           MSPANTOC converts all symbol names to upper case.  Thus, upper
  1458.           and lower case letters are equivalent and cannot be used to
  1459.           differentiate symbols.
  1460.  
  1461.  
  1462.  
  1463.  
  1464.  
  1465.  
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472.  
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.  
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-6
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1504.  
  1505.           3.6. Request Codes in Detail          3.6. Request Codes in Detail
  1506.  
  1507.           The following sections describe the individual request codes in
  1508.           more detail.
  1509.  
  1510.  
  1511.           3.6.1. *n - Assign a Paragraph Number          3.6.1. *n - Assign a Paragraph Number
  1512.  
  1513.           Use the *n request to number a paragraph without creating a table
  1514.           of contents entry.
  1515.  
  1516.           MSPANTOC increments the current level n number, clears all level
  1517.           numbers lower than n and leaves level numbers higher than n
  1518.           unchanged.  Level 1 is the highest level (chapter) number and
  1519.           level 9 is the lowest level number.
  1520.  
  1521.           MSPANTOC replaces the lead-in string and 2 character request code
  1522.           with the full n-level paragraph number.
  1523.  
  1524.           For example, if a document contains
  1525.  
  1526.                =>*3 This is an example of a paragraph number assignment
  1527.                with no need for a table of contents entry.
  1528.  
  1529.           after MSPANTOC processes the document, the output file will
  1530.           contain a line with the form
  1531.  
  1532.                2.3.4. This is an example of a paragraph number ...
  1533.  
  1534.  
  1535.           3.6.2. #n - Assign a Section Number          3.6.2. #n - Assign a Section Number
  1536.  
  1537.           Use the #n request to number a section and create an entry in the
  1538.           table of contents.
  1539.  
  1540.           MSPANTOC increments the current level n number, clears all level
  1541.           numbers lower than n and leaves level numbers higher than n
  1542.           unchanged.  Level 1 is the highest level (chapter) number and
  1543.           level 9 is the lowest level number.
  1544.  
  1545.           MSPANTOC replaces the lead-in string and 2 character request code
  1546.           with the full n-level section number.
  1547.  
  1548.           MSPANTOC adds the line containing the section number definition
  1549.           to the table of contents.
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-7
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1563.  
  1564.           For example, if a document contains
  1565.  
  1566.                =>#1 INTRODUCTION
  1567.  
  1568.           after MSPANTOC processes the document, the output file will
  1569.           contain a line with the form
  1570.  
  1571.                2. INTRODUCTION
  1572.  
  1573.           and the table of contents will include an entry with the assigned
  1574.           section number (2.), heading text (INTRODUCTION) and current page
  1575.           number.
  1576.  
  1577.  
  1578.           3.6.3. F - Assign a Figure Number          3.6.3. F - Assign a Figure Number
  1579.  
  1580.           Use the F request to number a figure and create an entry in the
  1581.           list of figures.  MSPANTOC accepts the request code in either
  1582.           upper (F) or lower (f) case.
  1583.  
  1584.           MSPANTOC increments the current figure number and replaces the
  1585.           lead-in string and request code (=>F) with the figure caption
  1586.           (see section 4.6.3.4 on page 4-15 for a description of how to
  1587.           change the figure caption) followed by the figure number.
  1588.  
  1589.           MSPANTOC adds the line containing the figure number definition to
  1590.           the list of figures.
  1591.  
  1592.           For example, if a document contains
  1593.  
  1594.                =>F Summary Report Example
  1595.  
  1596.           and the current figure caption value is Figure, after MSPANTOC
  1597.           processes the document, the output file will contain a line with
  1598.           the form
  1599.  
  1600.                Figure 5-2: Summary Report Example
  1601.  
  1602.           and the list of figures will include an entry with the figure
  1603.           caption (Figure), assigned figure number (5-2), figure title
  1604.           (Summary Report Example) and current page number.
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.  
  1614.  
  1615.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-8
  1616.  
  1617.  
  1618.  
  1619.  
  1620.  
  1621.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1622.  
  1623.           3.6.4. T - Assign a Table Number          3.6.4. T - Assign a Table Number
  1624.  
  1625.           Use the T request to number a table and create an entry in the
  1626.           list of tables.  MSPANTOC accepts the request code in either
  1627.           upper (T) or lower (t) case.
  1628.  
  1629.           MSPANTOC increments the current table number and replaces the
  1630.           lead-in string and request code (=>T) with the table caption (see
  1631.           section 4.6.4.4 on page 4-18 for a description of how to change
  1632.           the table caption) followed by the table number.
  1633.  
  1634.           MSPANTOC adds the line containing the table number definition to
  1635.           the list of tables.
  1636.  
  1637.           For example, if a document contains
  1638.  
  1639.                =>T Revenues by Region
  1640.  
  1641.           and the current table caption value is Table, after MSPANTOC
  1642.           processes the document, the output file will contain a line with
  1643.           the form
  1644.  
  1645.                Table 3-9: Revenues by Region
  1646.  
  1647.           and the list of tables will include an entry with the table
  1648.           caption (Table), assigned table number (3-9), table title
  1649.           (Revenues by Region) and current page number.
  1650.  
  1651.  
  1652.           3.6.5. @ - Request Current Chapter Number          3.6.5. @ - Request Current Chapter Number
  1653.  
  1654.           Use the @ request in page footing definitions or anywhere else
  1655.           you want the current chapter number to appear.
  1656.  
  1657.           MSPANTOC replaces the lead-in string and request code (=>@) with
  1658.           the current value of the level 1 number, the chapter number.
  1659.  
  1660.           For example, if a document contains
  1661.  
  1662.                Page =>@-3 ...
  1663.  
  1664.           and the current chapter number is 6, after MSPANTOC processes the
  1665.           document, the output file will contain the following line
  1666.  
  1667.                Page 6-3 ...
  1668.  
  1669.  
  1670.  
  1671.  
  1672.  
  1673.  
  1674.           Copyright (C) The Nunnery Works Ltd 1987                 Page 3-9
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.           MSPANTOC Version 1.0                         PREPARING A DOCUMENT
  1681.  
  1682.           3.6.6. ? - Request a Paragraph Number          3.6.6. ? - Request a Paragraph Number
  1683.  
  1684.           Use the ? request to cross reference to a symbolic section,
  1685.           paragraph, figure or table number.
  1686.  
  1687.           MSPANTOC searches its symbol table for the symbol name that
  1688.           follows the request code.  If it finds the symbol name, MSPANTOC
  1689.           replaces the lead-in string, the request code and the symbol name
  1690.           with the full multi-level paragraph, section, figure or table
  1691.           number stored in the symbol table entry. 
  1692.  
  1693.           For example, if a document contains
  1694.  
  1695.                ... refer to paragraph =>?details
  1696.  
  1697.           after MSPANTOC processes the document, the output file will
  1698.           contain a line with the form
  1699.  
  1700.                ... refer to paragraph 4.2.7.
  1701.  
  1702.  
  1703.           3.6.7. P - Request a Page Number          3.6.7. P - Request a Page Number
  1704.  
  1705.           Use the P request to cross reference to a symbolic page number
  1706.           for the beginning of a section, paragraph, figure or table. 
  1707.           MSPANTOC accepts the request code in either upper (P) or lower
  1708.           (p) case.
  1709.  
  1710.           MSPANTOC searches its symbol table for the symbol name that
  1711.           follows the request code.  If it finds the symbol name, MSPANTOC
  1712.           replaces the lead-in string, the request code and the symbol name
  1713.           with the page number stored in the symbol table entry.
  1714.  
  1715.           For example, if a document contains
  1716.  
  1717.                ... refer to paragraph =>?summary on page =>Psummary.
  1718.  
  1719.           after MSPANTOC processes the document, the output file will
  1720.           contain a line with the form
  1721.  
  1722.                ... refer to paragraph 2.9.12 on page 2-46.
  1723.  
  1724.  
  1725.  
  1726.  
  1727.  
  1728.  
  1729.  
  1730.  
  1731.  
  1732.  
  1733.           Copyright (C) The Nunnery Works Ltd 1987                Page 3-10
  1734.  
  1735.  
  1736.  
  1737.  
  1738.  
  1739.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  1740.  
  1741.           4. CONFIGURING MSPANTOC          4. CONFIGURING MSPANTOC          _______________________
  1742.  
  1743.           4.1. Introduction          4.1. Introduction
  1744.  
  1745.           This chapter describes the operation of the MSPANTOC
  1746.           configuration program, MSPC.  It describes the command line
  1747.           format, the configuration options and the error messages and
  1748.           summarizes the operation of the program.
  1749.  
  1750.  
  1751.           4.2. Operation Summary          4.2. Operation Summary
  1752.  
  1753.           Figure 4-1 on page 4-2 summarizes the operation of MSPC.
  1754.  
  1755.           MSPC reads all files on the left side of the figure and creates
  1756.           the files on the right side.
  1757.  
  1758.  
  1759.           4.2.1. Command Line          4.2.1. Command Line
  1760.  
  1761.           MSPC obtains the pathnames of the optional input configuration
  1762.           file and the optional attribute file from the command line you
  1763.           enter.
  1764.  
  1765.  
  1766.           4.2.2. Input Configuration File          4.2.2. Input Configuration File
  1767.  
  1768.           If you specify an input configuration file, MSPC reads this file
  1769.           to obtain the current settings of all user settable values.  MSPC
  1770.           then allows you to update these values and save the new values
  1771.           back to another disk file.  
  1772.  
  1773.           If the command line does not contain a configuration file name,
  1774.           MSPC uses an internally defined set of default values as a
  1775.           starting point which you can update to meet your needs.
  1776.  
  1777.  
  1778.           4.2.3. Attribute File          4.2.3. Attribute File
  1779.  
  1780.           MSPC reads the print attribute file to obtain the control
  1781.           character strings that your word processing package uses to
  1782.           identify portions of text to print using special formatting
  1783.           attributes.  These attributes include, for example, bold print,
  1784.           italic print, emphasized print, underlined print etc.
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-1
  1793.  
  1794.  
  1795.  
  1796.  
  1797.  
  1798.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  1799.  
  1800.           4.2.4. Output Configuration File          4.2.4. Output Configuration File
  1801.  
  1802.           MSPC gives you the option of saving your configuration changes. 
  1803.           If you so choose, MSPC creates a new configuration file on disk
  1804.           and saves your updated values in this file.  MSPC gives you the
  1805.           choice of file name.
  1806.  
  1807.  
  1808.  
  1809.           __________________________________________________________
  1810.  
  1811.                               ----------------
  1812.                               |              |
  1813.           Command Line -----> |              |
  1814.                               |      M       |
  1815.                               |      S       |
  1816.                               |      P       |
  1817.           Configuration File  |      C       |    Configuration File 
  1818.                               |              |
  1819.              -------------    |              |       -------------
  1820.              |           |    |              |       |           |
  1821.              |           |--> |              |  -->  |           |
  1822.              |           |    |              |       |           |
  1823.              -------------    |              |       -------------
  1824.                               |              |
  1825.                               |              |
  1826.           Attribute File      |              |
  1827.                               |              |
  1828.              -------------    |              |
  1829.              |           |    |              |
  1830.              |           |--> |              |
  1831.              |           |    |              |
  1832.              -------------    |              |
  1833.                               |              |
  1834.                               |              |
  1835.                               ----------------
  1836.  
  1837.  
  1838.           Figure  4-1: MSPC Operation Summary
  1839.  
  1840.           __________________________________________________________
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-2
  1852.  
  1853.  
  1854.  
  1855.  
  1856.  
  1857.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  1858.  
  1859.           4.3. Running MSPC          4.3. Running MSPC
  1860.  
  1861.           To run the MSPANTOC configuration program, enter a command line
  1862.           with the form
  1863.  
  1864.                MSPC10 input-configuration-file/C attribute-file/A
  1865.  
  1866.           where:
  1867.  
  1868.                1) MSPC10 is the name of the MSPANTOC configuration
  1869.                   program, version 1.0
  1870.                2) input-configuration-file is the full pathname of the
  1871.                   optional input configuration file
  1872.                3) attribute-file is the full pathname of the optional
  1873.                   attribute file
  1874.  
  1875.  
  1876.           4.4. Creating an Attribute File          4.4. Creating an Attribute File
  1877.  
  1878.           Create the attribute file with your word processing package.  The
  1879.           attribute file consists of one or more lines that each end with a
  1880.           hard carriage return or line feed.  
  1881.  
  1882.           Each line defines one print attribute and consists of
  1883.  
  1884.                1) the control codes used to turn the attribute on
  1885.                2) an arbitrarily chosen and unique single upper 
  1886.                   case letter to identify the attribute
  1887.                3) the control codes used to turn the attribute off
  1888.                4) a hard carriage return or line feed.
  1889.  
  1890.           For example, to enter the attribute file line to define the print
  1891.           attribute bold, in general you would proceed as follows:
  1892.  
  1893.                1) turn bold printing on
  1894.                2) type a capital B
  1895.                3) turn bold printing off
  1896.                4) press carriage return (or ENTER)
  1897.  
  1898.           Specifically, in WordStar, you would proceed as follows:
  1899.  
  1900.                1) type ^PB (control-P then B)
  1901.                2) type capital B
  1902.                3) type ^PB (control-P then B)
  1903.                4) press carriage return (or ENTER)
  1904.  
  1905.  
  1906.  
  1907.  
  1908.  
  1909.  
  1910.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-3
  1911.  
  1912.  
  1913.  
  1914.  
  1915.  
  1916.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  1917.  
  1918.           In WordPerfect, you would proceed as follows:
  1919.  
  1920.                1) press BOLD-ON
  1921.                2) type capital B
  1922.                3) press BOLD-OFF
  1923.                4) press carriage return (or ENTER)
  1924.  
  1925.           Testing an attribute file is simple.  Print the file using your
  1926.           word processing package.  If the single upper case letters print
  1927.           with the attributes you intended, then the file is correct.  If
  1928.           the printed results are not correct, consult your word processing
  1929.           documentation.
  1930.  
  1931.           The MSPANTOC distribution files include WS.ATR and WP.ATR.  These
  1932.           files contain basic (bold and underline) attribute definitions
  1933.           for WordStar and WordPerfect, respectively.
  1934.  
  1935.           This section mentions only the bold and underline attributes but
  1936.           MSPC and MSPANTOC will accept any print attributes that your word
  1937.           processing package and printer combination can support.
  1938.  
  1939.  
  1940.           4.5. Displayed Messages          4.5. Displayed Messages
  1941.  
  1942.           MSPC displays 2 types of messages on the console display screen
  1943.           while it is running, status messages and error messages.
  1944.  
  1945.           The following 2 sections describe each of the possible status and
  1946.           error messages that you might see.
  1947.  
  1948.  
  1949.           4.5.1. Status Messages          4.5.1. Status Messages
  1950.  
  1951.           4.5.1.1. Unable to open attribute file file-name
  1952.  
  1953.           MS-DOS or PC-DOS reported an error while MSPC was trying to open
  1954.           the named file for use as an attribute file.  The named file
  1955.           probably does not exist.  MSPC assumes that you do not want any
  1956.           attributes defined and continues execution after displaying the
  1957.           following message:
  1958.  
  1959.                Assuming no attributes wanted
  1960.  
  1961.  
  1962.  
  1963.  
  1964.  
  1965.  
  1966.  
  1967.  
  1968.  
  1969.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-4
  1970.  
  1971.  
  1972.  
  1973.  
  1974.  
  1975.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  1976.  
  1977.           4.5.2. Error Messages          4.5.2. Error Messages
  1978.  
  1979.           4.5.2.1. Caption is too long. Max length is 99 characters
  1980.  
  1981.           The figure or table caption you entered is too long.  MSPC will
  1982.           accept a caption with a length up to the specified maximum.
  1983.  
  1984.  
  1985.           4.5.2.2. File f-n does not contain a usable copy of configuration
  1986.           data
  1987.  
  1988.           MSPC attempted to obtain configuration information from the file
  1989.           named f-n in the message.  This file does not contain a usable
  1990.           copy of configuration data.  Either the file was not previously
  1991.           created by MSPC or it was created by an old version of MSPC.
  1992.  
  1993.  
  1994.           4.5.2.3. File write error, file file-name
  1995.  
  1996.           MS-DOS or PC-DOS reported an error while MSPC was trying to write
  1997.           to the file named file-name in the message.  This could be a
  1998.           transient disk error that will go away if you retry or it could
  1999.           be permanent.  It could be caused because there is not enough
  2000.           room on the disk drive or because you have a write protected
  2001.           diskette.
  2002.  
  2003.  
  2004.           4.5.2.4. Heading is too long. Max length is 99 characters
  2005.  
  2006.           The table of contents, figure or table heading you entered is too
  2007.           long.  MSPC will accept a heading with a length up to the
  2008.           specified maximum.
  2009.  
  2010.  
  2011.           4.5.2.5. Input file read error, file file-name
  2012.  
  2013.           MS-DOS or PC-DOS reported an error while MSPC was trying to read
  2014.           from the file named file-name in the message.  This could be a
  2015.           transient disk error that will go away if you retry or it could
  2016.           be permanent.
  2017.  
  2018.  
  2019.  
  2020.  
  2021.  
  2022.  
  2023.  
  2024.  
  2025.  
  2026.  
  2027.  
  2028.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-5
  2029.  
  2030.  
  2031.  
  2032.  
  2033.  
  2034.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2035.  
  2036.           4.5.2.6. Invalid attribute code atr-code
  2037.  
  2038.           MSPC has no definition for the named attribute code.  Add a
  2039.           definition of this code to your attribute file and rerun MSPC.
  2040.  
  2041.  
  2042.           4.5.2.7. Invalid command line format
  2043.  
  2044.           MSPC detected an error in the command line.
  2045.  
  2046.  
  2047.           4.5.2.8. Minimum string length is 1 character
  2048.  
  2049.           You attempted to specify a zero length lead-in string.  MSPC
  2050.           requires a lead-in string to be at least 1 character long.
  2051.  
  2052.  
  2053.           4.5.2.9. Missing attribute type code
  2054.  
  2055.           MSPC found a line in your attribute file that does not contain an
  2056.           upper case letter it can consider to be the attribute code.
  2057.  
  2058.  
  2059.           4.5.2.10. String is too long. Max length is 99 characters
  2060.  
  2061.           You attempted to specify a lead-in string that is too long.  MSPC
  2062.           will accept a lead-in string with the specified maximum length.
  2063.  
  2064.  
  2065.           4.5.2.11. Too many attributes
  2066.  
  2067.           You specified too many print attributes for the current item. 
  2068.           MSPC will accept a maximum of 5 print attributes for any one
  2069.           item.
  2070.  
  2071.  
  2072.           4.5.2.12. Too many attributes in file file-name
  2073.  
  2074.           The named attribute file contains too many attribute code
  2075.           definitions.  MSPC will accept a maximum of 15 individual
  2076.           attributes.
  2077.  
  2078.  
  2079.  
  2080.  
  2081.  
  2082.  
  2083.  
  2084.  
  2085.  
  2086.  
  2087.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-6
  2088.  
  2089.  
  2090.  
  2091.  
  2092.  
  2093.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2094.  
  2095.           4.5.2.13. Too many attribute lead-in characters
  2096.  
  2097.           Your attribute file contains too many characters before the upper
  2098.           case letter that defines the attribute code.  The characters
  2099.           before the attribute code should be the characters your word
  2100.           processing package uses to turn the print attribute on.  MSPC
  2101.           will accept a maximum of 9 characters before the attribute code. 
  2102.           If your word processing package turns on a print attributes with
  2103.           a string of more than 9 characters, please contact us.
  2104.  
  2105.  
  2106.           4.5.2.14. Too many attribute lead-out characters for code X
  2107.  
  2108.           Your attribute file contains too many characters after the
  2109.           specified attribute code.  The characters after the attribute
  2110.           code should be the characters your word processing package uses
  2111.           to turn the print attribute off.  MSPC will accept a maximum of 9
  2112.           characters after the attribute code.  If your word processing
  2113.           package turns off a print attributes with a string of more than 9
  2114.           characters, please contact us.
  2115.  
  2116.  
  2117.           4.5.2.15. Unable to read configuration data from file file-name
  2118.  
  2119.           MS-DOS or PC-DOS reported an error while MSPC was trying to read
  2120.           configuration data from the file named file-name in the message. 
  2121.           This could be a transient disk error that will go away if you
  2122.           retry or it could be permanent.
  2123.  
  2124.  
  2125.           4.5.2.16. Unable to open input configuration file file-name
  2126.  
  2127.           MS-DOS or PC-DOS reported an error while MSPC was trying to open
  2128.           the named configuration file.  The named file probably does not
  2129.           exist.
  2130.  
  2131.  
  2132.           4.5.2.17. Unable to open output configuration file file-name
  2133.  
  2134.           MS-DOS or PC-DOS reported an error while MSPC was trying to open
  2135.           the named configuration file.
  2136.  
  2137.  
  2138.  
  2139.  
  2140.  
  2141.  
  2142.  
  2143.  
  2144.  
  2145.  
  2146.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-7
  2147.  
  2148.  
  2149.  
  2150.  
  2151.  
  2152.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2153.  
  2154.  
  2155.           4.6. Configuration Options          4.6. Configuration Options
  2156.  
  2157.           MSPC interacts with the user through a series of menus.  (PC-DOS
  2158.           users will find these menus to be very unsophisticated visually
  2159.           but they work on all MS-DOS computers.)
  2160.  
  2161.           Select options from the menus by typing the single character
  2162.           option, in either upper or lower case, and then pressing carriage
  2163.           return (or ENTER).
  2164.  
  2165.  
  2166.           4.6.1. Main Menu          4.6.1. Main Menu
  2167.  
  2168.           Figure 4-2 on page 4-9 illustrates the contents of the MSPC main
  2169.           menu.
  2170.  
  2171.           The following paragraphs describe each of the main menu options.
  2172.  
  2173.  
  2174.           4.6.1.1. A  Table of contents menu 
  2175.  
  2176.           Select option A from the main menu to display the table of
  2177.           contents menu.
  2178.  
  2179.  
  2180.           4.6.1.2. B  Figures menu 
  2181.  
  2182.           Select option B from the main menu to display the figures menu.
  2183.  
  2184.  
  2185.           4.6.1.3. C  Tables menu 
  2186.  
  2187.           Select option C from the main menu to display the tables menu.
  2188.  
  2189.  
  2190.           4.6.1.4. D  Document format menu, part 1 
  2191.  
  2192.           Select option D from the main menu to display part 1 of the
  2193.           document format menu.
  2194.  
  2195.  
  2196.           4.6.1.5. E  Document format menu, part 2 
  2197.  
  2198.           Select option E from the main menu to display part 2 of the
  2199.           document format menu.
  2200.  
  2201.  
  2202.  
  2203.  
  2204.  
  2205.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-8
  2206.  
  2207.  
  2208.  
  2209.  
  2210.  
  2211.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2212.  
  2213.           4.6.1.6. F  Document format menu, part 3 
  2214.  
  2215.           Select option F from the main menu to display part 3 of the
  2216.           document format menu.
  2217.  
  2218.  
  2219.           4.6.1.7. G  Miscellaneous menu 
  2220.  
  2221.           Select option G from the main menu to display the miscellaneous
  2222.           menu.
  2223.  
  2224.  
  2225.           4.6.1.8. X  Exit this program 
  2226.  
  2227.           Select option X from the main menu to exit from MSPC and return
  2228.           to MS-DOS or PC-DOS.
  2229.  
  2230.           Before MSPC returns to DOS, it offers you the opportunity to save
  2231.           your configuration changes in a new disk file.  To save the new
  2232.           configuration, reply Y to the question and supply the desired
  2233.           filename.
  2234.  
  2235.  
  2236.           __________________________________________________________
  2237.  
  2238.           MAIN MENU 
  2239.            
  2240.           Option  Description 
  2241.            
  2242.             A . . Table of contents menu 
  2243.             B . . Figures menu 
  2244.             C . . Tables menu 
  2245.             D . . Document format menu, part 1 
  2246.             E . . Document format menu, part 2 
  2247.             F . . Document format menu, part 3 
  2248.             G . . Miscellaneous menu 
  2249.             X . . Exit this program 
  2250.            
  2251.           __________________________________________________________
  2252.  
  2253.           Figure  4-2: Main Menu
  2254.  
  2255.  
  2256.  
  2257.  
  2258.  
  2259.  
  2260.  
  2261.  
  2262.  
  2263.  
  2264.           Copyright (C) The Nunnery Works Ltd 1987                 Page 4-9
  2265.  
  2266.  
  2267.  
  2268.  
  2269.  
  2270.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2271.  
  2272.           4.6.2. Table of Contents Menu          4.6.2. Table of Contents Menu
  2273.  
  2274.           Figure 4-3 on page 4-12 illustrates the contents of the MSPC
  2275.           table of contents menu.
  2276.  
  2277.           The following paragraphs describe each of the table of contents
  2278.           menu options.
  2279.  
  2280.  
  2281.           4.6.2.1. A  Display all table of contents parameters 
  2282.  
  2283.           Select option A from the table of contents menu to display the
  2284.           current values for the following items:
  2285.  
  2286.                1)  the table of contents page heading
  2287.                2)  the table of contents page heading print attributes
  2288.                3)  the number of paragraph level numbers that will
  2289.                    appear in the table of contents
  2290.                4)  whether table of contents entries are indented
  2291.                5)  the maximum number of lines on each page in the table
  2292.                    of contents
  2293.                6)  the level 1 heading print attributes
  2294.                7)  the level 2 heading print attributes
  2295.                8)  the level 3 heading print attributes
  2296.                9)  the level 4 heading print attributes
  2297.                10) the level 5 heading print attributes
  2298.                11) the level 6 heading print attributes
  2299.                12) the level 7 heading print attributes
  2300.                13) the level 8 heading print attributes
  2301.                14) the level 9 heading print attributes
  2302.  
  2303.  
  2304.           4.6.2.2. B  Change table of contents page heading 
  2305.  
  2306.           Select option B from the table of contents menu to change the
  2307.           heading MSPANTOC puts at the top of each page of the table of
  2308.           contents.
  2309.  
  2310.           The default value for this heading is
  2311.  
  2312.                TABLE OF CONTENTS
  2313.  
  2314.           and the maximum length of the heading is 80 characters.
  2315.  
  2316.  
  2317.  
  2318.  
  2319.  
  2320.  
  2321.  
  2322.  
  2323.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-10
  2324.  
  2325.  
  2326.  
  2327.  
  2328.  
  2329.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2330.  
  2331.           4.6.2.3. C  Change table of contents page heading print
  2332.           attributes 
  2333.  
  2334.           Select option C from the table of contents menu to change the
  2335.           print attributes MSPANTOC outputs along with the table of
  2336.           contents page heading.
  2337.  
  2338.           MSPANTOC will accept a maximum of 5 print attributes.
  2339.  
  2340.           By default, MSPANTOC does not output any print attributes along
  2341.           with the table of contents page heading.
  2342.            
  2343.  
  2344.           4.6.2.4. D  Change number of levels in table of contents 
  2345.  
  2346.           Select option D from the table of contents menu to change the
  2347.           maximum number of levels that will appear in the table of
  2348.           contents.
  2349.  
  2350.           The maximum number of levels in the table of contents is 9 and
  2351.           the minimum is 1.
  2352.  
  2353.           By default, MSPANTOC will only include entries in the table of
  2354.           contents for section numbers of 3 levels or less.
  2355.  
  2356.            
  2357.           4.6.2.5. E  Change indentation in table of contents 
  2358.  
  2359.           Select option E from the table of contents menu to select whether
  2360.           MSPANTOC should indent table of contents entries or not.
  2361.  
  2362.           Figure 4-4 on page 4-13 shows an example of a table of contents
  2363.           created with indentation and figure 4-5 on page 4-13 shows an
  2364.           example of a table of contents without indentation.
  2365.  
  2366.            
  2367.           4.6.2.6. F  Change max lines on table of contents page 
  2368.  
  2369.           Select option F from the table of contents menu to change the
  2370.           maximum number of lines MSPANTOC will write on each page of the
  2371.           table of contents.
  2372.  
  2373.           The default value is 50 lines.
  2374.            
  2375.  
  2376.  
  2377.  
  2378.  
  2379.  
  2380.  
  2381.  
  2382.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-11
  2383.  
  2384.  
  2385.  
  2386.  
  2387.  
  2388.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2389.  
  2390.           4.6.2.7. G-O  Change print attributes for level 1-9 headings
  2391.  
  2392.           Select options G-O from the table of contents menu to change the
  2393.           print attributes MSPANTOC outputs along with the section heading
  2394.           for a level 1-9, respectively, table of contents entry.
  2395.  
  2396.           MSPANTOC will accept a maximum of 5 print attributes.
  2397.  
  2398.           By default, MSPANTOC does not output any print attributes along
  2399.           with a level 1-9 table of contents entry.
  2400.            
  2401.  
  2402.           4.6.2.8. X  Exit to main menu 
  2403.  
  2404.           Select option X from the table of contents menu to return to the
  2405.           main menu.
  2406.  
  2407.  
  2408.           __________________________________________________________
  2409.  
  2410.           TABLE OF CONTENTS MENU 
  2411.            
  2412.           Option  Description 
  2413.            
  2414.             A . . Display all table of contents parameters 
  2415.             B . . Change table of contents page heading 
  2416.             C . . Change table of contents page heading print attributes 
  2417.             D . . Change number of paragraph levels in table of contents
  2418.             E . . Change indentation in table of contents 
  2419.             F . . Change max lines on table of contents page 
  2420.             G . . Change print attributes for level 1 heading 
  2421.             H . . Change print attributes for level 2 heading 
  2422.             I . . Change print attributes for level 3 heading 
  2423.             J . . Change print attributes for level 4 heading 
  2424.             K . . Change print attributes for level 5 heading 
  2425.             L . . Change print attributes for level 6 heading 
  2426.             M . . Change print attributes for level 7 heading 
  2427.             N . . Change print attributes for level 8 heading 
  2428.             O . . Change print attributes for level 9 heading 
  2429.             X . . Exit to main menu 
  2430.            
  2431.           __________________________________________________________
  2432.            
  2433.           Figure  4-3: Table of Contents Menu
  2434.  
  2435.  
  2436.  
  2437.  
  2438.  
  2439.  
  2440.  
  2441.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-12
  2442.  
  2443.  
  2444.  
  2445.  
  2446.  
  2447.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2448.  
  2449.           ___________________________________________________________
  2450.  
  2451.           1. INTRODUCTION  . . . . . . . . . . . . . . . . . .    1-1 
  2452.              1.1. Purpose of This Manual   . . . . . . . . . .    1-1 
  2453.              1.2. MSPANTOC   . . . . . . . . . . . . . . . . .    1-1 
  2454.                   1.2.1. Paragraph/Section Numbering . . . . .    1-1 
  2455.                   1.2.2. Figure Numbering  . . . . . . . . . .    1-1 
  2456.                   1.2.3. Table Numbering   . . . . . . . . . .    1-1 
  2457.                   1.2.4. Symbolic Cross References . . . . . .    1-1 
  2458.              1.3. Some Fine Print  . . . . . . . . . . . . . .    1-3 
  2459.  
  2460.           ___________________________________________________________
  2461.  
  2462.           Figure  4-4: Table of Contents, With Indentation
  2463.  
  2464.  
  2465.           ___________________________________________________________
  2466.            
  2467.           1.         INTRODUCTION  . . . . . . . . . . . . . .    1-1 
  2468.           1.1.       Purpose of This Manual  . . . . . . . . .    1-1 
  2469.           1.2.       MSPANTOC  . . . . . . . . . . . . . . . .    1-1 
  2470.           1.2.1.     Paragraph/Section Numbering   . . . . . .    1-1 
  2471.           1.2.2.     Figure Numbering  . . . . . . . . . . . .    1-1 
  2472.           1.2.3.     Table Numbering   . . . . . . . . . . . .    1-1 
  2473.           1.3.       Some Fine Print   . . . . . . . . . . . .    1-5 
  2474.  
  2475.           ___________________________________________________________
  2476.  
  2477.           Figure  4-5: Table of Contents, No Indentation
  2478.  
  2479.  
  2480.           ___________________________________________________________
  2481.            
  2482.           1. INTRODUCTION  . . . . . . . . . . . . . . . . . .    1-1 
  2483.              1. Purpose of This Manual   . . . . . . . . . . .    1-1 
  2484.              2. MSPANTOC   . . . . . . . . . . . . . . . . . .    1-1 
  2485.                 1. Paragraph/Section Numbering   . . . . . . .    1-1 
  2486.                 2. Figure Numbering  . . . . . . . . . . . . .    1-1 
  2487.                 3. Table Numbering   . . . . . . . . . . . . .    1-1 
  2488.                 4. Symbolic Cross References   . . . . . . . .    1-1 
  2489.                 5. Table of Contents   . . . . . . . . . . . .    1-2 
  2490.              3. Some Fine Print  . . . . . . . . . . . . . . .    1-5 
  2491.  
  2492.           ___________________________________________________________
  2493.  
  2494.           Figure  4-6: Table of Contents, Lowest Level Only
  2495.  
  2496.  
  2497.  
  2498.  
  2499.  
  2500.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-13
  2501.  
  2502.  
  2503.  
  2504.  
  2505.  
  2506.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2507.  
  2508.           4.6.3. Figures menu           4.6.3. Figures menu 
  2509.  
  2510.           Figure 4-7 on page 4-16 illustrates the contents of the MSPC
  2511.           figures menu.
  2512.  
  2513.           The following paragraphs describe each of the figures menu
  2514.           options.
  2515.  
  2516.  
  2517.           4.6.3.1. A  Display all figures parameters 
  2518.  
  2519.           Select option A from the figures menu to display the current
  2520.           values for the following items:
  2521.  
  2522.                1) the list of figures page heading
  2523.                2) the list of figures page heading print attributes
  2524.                3) the figures caption
  2525.                4) the figure numbering format
  2526.                5) the figure number punctuation
  2527.                6) the figure description line print attributes
  2528.                7) the maximum number of lines on a list of figures
  2529.                   page
  2530.  
  2531.  
  2532.           4.6.3.2. B  Change list of figures page heading 
  2533.  
  2534.           Select option B from the figures menu to change the heading
  2535.           MSPANTOC puts at the top of each page of the list of figures.
  2536.  
  2537.           The default value for this heading is
  2538.  
  2539.                LIST OF FIGURES
  2540.  
  2541.           and the maximum length of the heading is 80 characters.
  2542.  
  2543.  
  2544.           4.6.3.3. C  Change list of figures page heading print attributes 
  2545.  
  2546.           Select option C from the figures menu to change the print
  2547.           attributes MSPANTOC outputs along with the list of figures page
  2548.           heading.
  2549.  
  2550.           MSPANTOC will accept a maximum of 5 print attributes.
  2551.  
  2552.           By default, MSPANTOC does not output any print attributes along
  2553.           with the list of figures page heading.
  2554.            
  2555.  
  2556.  
  2557.  
  2558.  
  2559.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-14
  2560.  
  2561.  
  2562.  
  2563.  
  2564.  
  2565.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2566.  
  2567.           4.6.3.4. D  Change figures caption 
  2568.  
  2569.           Select option D from the figures menu to change the caption
  2570.           MSPANTOC outputs before a figure number in both the output
  2571.           document file and the list of figures.
  2572.  
  2573.           The default value for this caption is
  2574.  
  2575.                Figure
  2576.  
  2577.           and the maximum length of the caption is 25 characters.
  2578.  
  2579.  
  2580.           4.6.3.5. E  Change figure numbering format 
  2581.  
  2582.           Select option E from the figures menu to change the way MSPANTOC
  2583.           assigns figure numbers.  MSPANTOC assigns figure numbers
  2584.           sequentially within chapters or within the document as a whole.
  2585.  
  2586.           When MSPANTOC numbers figures within chapters, figure numbers are
  2587.           composed of 2 parts, separated by a dash (-).  The first part of
  2588.           the figure number is the current chapter number and it appears in
  2589.           the same display format chosen for level 1 numbers.  The second
  2590.           part of the figure number is the sequential figure number within
  2591.           the current chapter.  MSPANTOC assigns the number 1 to the first
  2592.           figure in a chapter.  This number always appears in Arabic number
  2593.           format.
  2594.  
  2595.           When MSPANTOC numbers figures within the document as a whole, it
  2596.           simply numbers figures sequentially, beginning at 1.  This figure
  2597.           number always appears in Arabic number format.
  2598.  
  2599.  
  2600.           4.6.3.6. F  Change figure number punctuation 
  2601.  
  2602.           Select option F from the figures menu to change the single
  2603.           character of punctuation MSPANTOC outputs after a figure number.
  2604.  
  2605.           The default value for this punctuation character is a colon (:).
  2606.  
  2607.  
  2608.  
  2609.  
  2610.  
  2611.  
  2612.  
  2613.  
  2614.  
  2615.  
  2616.  
  2617.  
  2618.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-15
  2619.  
  2620.  
  2621.  
  2622.  
  2623.  
  2624.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2625.  
  2626.           4.6.3.7. G  Change figure description line print attributes 
  2627.  
  2628.           Select option G from the figures menu to change the print
  2629.           attributes MSPANTOC outputs along with the figure description.
  2630.  
  2631.           MSPANTOC will accept a maximum of 5 print attributes.
  2632.  
  2633.           By default, MSPANTOC does not output any print attributes along
  2634.           with the figure description.
  2635.  
  2636.  
  2637.           4.6.3.8. H  Change max lines on list of figures page 
  2638.  
  2639.           Select option H from the figures menu to change the maximum
  2640.           number of lines MSPANTOC will write on each page of the list of
  2641.           figures.
  2642.  
  2643.           The default value is 50 lines.
  2644.            
  2645.  
  2646.           4.6.3.9. X  Exit to main menu 
  2647.  
  2648.           Select option X from the figures menu to return to the main menu.
  2649.  
  2650.  
  2651.  
  2652.           __________________________________________________________
  2653.  
  2654.           FIGURES MENU 
  2655.            
  2656.           Option  Description 
  2657.            
  2658.             A . . Display all figures parameters 
  2659.             B . . Change list of figures page heading 
  2660.             C . . Change list of figures page heading print attributes 
  2661.             D . . Change figures caption 
  2662.             E . . Change figure numbering format 
  2663.             F . . Change figure number punctuation 
  2664.             G . . Change figure description line print attributes 
  2665.             H . . Change max lines on list of figures page 
  2666.             X . . Exit to main menu 
  2667.            
  2668.           __________________________________________________________
  2669.            
  2670.           Figure  4-7: Figures Menu
  2671.  
  2672.  
  2673.  
  2674.  
  2675.  
  2676.  
  2677.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-16
  2678.  
  2679.  
  2680.  
  2681.  
  2682.  
  2683.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2684.  
  2685.           4.6.4. Tables menu           4.6.4. Tables menu 
  2686.  
  2687.           Figure 4-8 on page 4-19 illustrates the contents of the MSPC
  2688.           tables menu.
  2689.  
  2690.           The following paragraphs describe each of the tables menu
  2691.           options.
  2692.  
  2693.  
  2694.           4.6.4.1. A  Display all table parameters 
  2695.  
  2696.           Select option A from the tables menu to display the current
  2697.           values for the following items:
  2698.  
  2699.                1) the list of tables page heading 
  2700.                2) the list of tables page heading print attributes 
  2701.                3) the tables caption 
  2702.                4) the table numbering format 
  2703.                5) the table number punctuation 
  2704.                6) the table description line print attributes 
  2705.                7) the maximum number of lines on each list of tables
  2706.                   page 
  2707.  
  2708.  
  2709.           4.6.4.2. B  Change list of tables page heading 
  2710.  
  2711.           Select option B from the tables menu to change the heading
  2712.           MSPANTOC puts at the top of each page of the list of tables.
  2713.  
  2714.           The default value for this heading is
  2715.  
  2716.                LIST OF TABLES
  2717.  
  2718.  
  2719.           and the maximum length of the heading is 80 characters.
  2720.  
  2721.  
  2722.           4.6.4.3. C  Change list of tables page heading print attributes 
  2723.  
  2724.           Select option C from the tables menu to change the print
  2725.           attributes MSPANTOC outputs along with the list of tables page
  2726.           heading.
  2727.  
  2728.           MSPANTOC will accept a maximum of 5 print attributes.
  2729.  
  2730.           By default, MSPANTOC does not output any print attributes along
  2731.           with the list of tables page heading.
  2732.  
  2733.  
  2734.  
  2735.  
  2736.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-17
  2737.  
  2738.  
  2739.  
  2740.  
  2741.  
  2742.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2743.  
  2744.           4.6.4.4. D  Change tables caption 
  2745.  
  2746.           Select option D from the tables menu to change the caption
  2747.           MSPANTOC outputs before a table number in both the output
  2748.           document file and the list of tables.
  2749.  
  2750.           The default value for this caption is
  2751.  
  2752.                Table
  2753.  
  2754.           and the maximum length of the caption is 25 characters.
  2755.  
  2756.  
  2757.           4.6.4.5. E  Change table numbering format 
  2758.  
  2759.           Select option E from the tables menu to change the way MSPANTOC
  2760.           assigns table numbers.  MSPANTOC assigns table numbers
  2761.           sequentially within chapters or within the document as a whole.
  2762.  
  2763.           When MSPANTOC numbers tables within chapters, table numbers are
  2764.           composed of 2 parts, separated by a dash (-).  The first part of
  2765.           the table number is the current chapter number and it appears in
  2766.           the same display format chosen for level 1 numbers.  The second
  2767.           part of the table number is the sequential table number within
  2768.           the current chapter.  MSPANTOC assigns the number 1 to the first
  2769.           table in a chapter.  This number always appears in Arabic number
  2770.           format.
  2771.  
  2772.           When MSPANTOC numbers tables within the document as a whole, it
  2773.           simply numbers tables sequentially, beginning at 1.  This table
  2774.           number always appears in Arabic number format.
  2775.  
  2776.  
  2777.           4.6.4.6. F  Change table number punctuation 
  2778.  
  2779.           Select option F from the tables menu to change the single
  2780.           character of punctuation MSPANTOC outputs after a table number.
  2781.  
  2782.           The default value for this punctuation character is a colon (:).
  2783.  
  2784.  
  2785.  
  2786.  
  2787.  
  2788.  
  2789.  
  2790.  
  2791.  
  2792.  
  2793.  
  2794.  
  2795.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-18
  2796.  
  2797.  
  2798.  
  2799.  
  2800.  
  2801.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2802.  
  2803.           4.6.4.7. G  Change table description line print attributes 
  2804.  
  2805.           Select option G from the tables menu to change the print
  2806.           attributes MSPANTOC outputs along with the table description.
  2807.  
  2808.           MSPANTOC will accept a maximum of 5 print attributes.
  2809.  
  2810.           By default, MSPANTOC does not output any print attributes along
  2811.           with the table description.
  2812.            
  2813.  
  2814.           4.6.4.8. H  Change max lines on list of tables page 
  2815.  
  2816.           Select option H from the tables menu to change the maximum number
  2817.           of lines MSPANTOC will write on each page of the list of tables.
  2818.  
  2819.           The default value is 50 lines.
  2820.            
  2821.  
  2822.           4.6.4.9. X  Exit to main menu 
  2823.  
  2824.           Select option X from the tables menu to return to the main menu.
  2825.  
  2826.  
  2827.  
  2828.  
  2829.           __________________________________________________________
  2830.  
  2831.           TABLES MENU 
  2832.            
  2833.           Option  Description 
  2834.            
  2835.             A . . Display all table parameters 
  2836.             B . . Change list of tables page heading 
  2837.             C . . Change list of tables page heading print attributes 
  2838.             D . . Change tables caption 
  2839.             E . . Change table numbering format 
  2840.             F . . Change table number punctuation 
  2841.             G . . Change table description line print attributes 
  2842.             H . . Change max lines on list of tables page 
  2843.             X . . Exit to main menu 
  2844.            
  2845.           __________________________________________________________
  2846.            
  2847.           Figure  4-8: Tables Menu
  2848.  
  2849.  
  2850.  
  2851.  
  2852.  
  2853.  
  2854.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-19
  2855.  
  2856.  
  2857.  
  2858.  
  2859.  
  2860.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2861.  
  2862.           4.6.5. Document format menu, part 1           4.6.5. Document format menu, part 1 
  2863.  
  2864.           Figure 4-9 on page 4-21 illustrates the contents of part 1 of the
  2865.           MSPC document format menu.
  2866.  
  2867.           The following paragraphs describe each of the document format,
  2868.           part 1, menu options.
  2869.  
  2870.  
  2871.           4.6.5.1. A  Display part 1 document parameters 
  2872.  
  2873.           Select option A from part 1 of the document format menu to
  2874.           display the current values for the following items:
  2875.  
  2876.                1) level 1 heading print attributes
  2877.                2) level 2 heading print attributes
  2878.                3) level 3 heading print attributes
  2879.                4) level 4 heading print attributes
  2880.                5) level 5 heading print attributes
  2881.                6) level 6 heading print attributes
  2882.                7) level 7 heading print attributes
  2883.                8) level 8 heading print attributes
  2884.                9) level 9 heading print attributes
  2885.  
  2886.  
  2887.           4.6.5.2. B-J  Change print attributes for level 1-9 headings 
  2888.  
  2889.           Select options B-J from the part 1 document format menu to change
  2890.           the print attributes MSPANTOC outputs along with a level 1-9
  2891.           section heading in the main document.
  2892.  
  2893.           MSPANTOC will accept a maximum of 5 print attributes.
  2894.  
  2895.           By default, MSPANTOC does not output any print attributes along
  2896.           with a section heading.
  2897.            
  2898.  
  2899.           4.6.5.3. X  Exit to main menu 
  2900.  
  2901.           Select option X from part 1 of the document format menu to return
  2902.           to the main menu.
  2903.  
  2904.  
  2905.  
  2906.  
  2907.  
  2908.  
  2909.  
  2910.  
  2911.  
  2912.  
  2913.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-20
  2914.  
  2915.  
  2916.  
  2917.  
  2918.  
  2919.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2920.  
  2921.  
  2922.           __________________________________________________________
  2923.            
  2924.           MAIN DOCUMENT MENU, PART 1 
  2925.            
  2926.           Option  Description 
  2927.            
  2928.             A . . Display part 1 document parameters 
  2929.             B . . Change print attributes for level 1 heading 
  2930.             C . . Change print attributes for level 2 heading 
  2931.             D . . Change print attributes for level 3 heading 
  2932.             E . . Change print attributes for level 4 heading 
  2933.             F . . Change print attributes for level 5 heading 
  2934.             G . . Change print attributes for level 6 heading 
  2935.             H . . Change print attributes for level 7 heading 
  2936.             I . . Change print attributes for level 8 heading 
  2937.             J . . Change print attributes for level 9 heading 
  2938.             K . . Change page numbering format 
  2939.             X . . Exit to main menu 
  2940.            
  2941.           __________________________________________________________
  2942.            
  2943.           Figure  4-9: Document Menu, Part 1
  2944.  
  2945.  
  2946.  
  2947.           __________________________________________________________
  2948.  
  2949.           MAIN DOCUMENT MENU, PART 2 
  2950.            
  2951.           Option  Description 
  2952.            
  2953.             A . . Display part 2 document parameters 
  2954.             B . . Change display format for paragraph number level 1 
  2955.             C . . Change display format for paragraph number level 2 
  2956.             D . . Change display format for paragraph number level 3 
  2957.             E . . Change display format for paragraph number level 4 
  2958.             F . . Change display format for paragraph number level 5 
  2959.             G . . Change display format for paragraph number level 6 
  2960.             H . . Change display format for paragraph number level 7 
  2961.             I . . Change display format for paragraph number level 8 
  2962.             J . . Change display format for paragraph number level 9 
  2963.             X . . Exit to main menu 
  2964.            
  2965.           __________________________________________________________
  2966.            
  2967.           Figure  4-10: Document Menu, Part 2
  2968.  
  2969.  
  2970.  
  2971.  
  2972.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-21
  2973.  
  2974.  
  2975.  
  2976.  
  2977.  
  2978.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  2979.  
  2980.           4.6.6. Document format menu, part 2           4.6.6. Document format menu, part 2 
  2981.  
  2982.           Figure 4-10 on page 4-21 illustrates the contents of part 2 of
  2983.           the MSPC document format menu.
  2984.  
  2985.           The following paragraphs describe each of the document format,
  2986.           part 2, menu options.
  2987.  
  2988.  
  2989.           4.6.6.1. A  Display part 2 document parameters 
  2990.  
  2991.           Select option A from part 2 of the document format menu to
  2992.           display the current values for the following items:
  2993.  
  2994.                1) paragraph number level 1 display format
  2995.                2) paragraph number level 2 display format
  2996.                3) paragraph number level 3 display format
  2997.                4) paragraph number level 4 display format
  2998.                5) paragraph number level 5 display format
  2999.                6) paragraph number level 6 display format
  3000.                7) paragraph number level 7 display format
  3001.                8) paragraph number level 8 display format
  3002.                9) paragraph number level 9 display format
  3003.  
  3004.  
  3005.           4.6.6.2. B-J  Change display format for paragraph number level 1-
  3006.           9 
  3007.  
  3008.           Select options B-J from part 2 of the document format menu to
  3009.           change the format MSPANTOC uses to display each level, 1-9
  3010.           respectively, of a section or paragraph number.
  3011.  
  3012.           MSPANTOC supports 5 display formats:
  3013.  
  3014.                1) Arabic numbers
  3015.                2) upper case Roman numerals
  3016.                3) lower case Roman numerals
  3017.                4) upper case alphabetics
  3018.                5) lower case alphabetics
  3019.  
  3020.           Arabic numerals are ordinary numbers, 1, 2, 3, 4, ...
  3021.  
  3022.           Upper case Roman numerals, I, II, III, IV, ... range up to a
  3023.           maximum of XCIX (99).
  3024.  
  3025.  
  3026.  
  3027.  
  3028.  
  3029.  
  3030.  
  3031.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-22
  3032.  
  3033.  
  3034.  
  3035.  
  3036.  
  3037.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  3038.  
  3039.           Lower case Roman numerals, i, ii, iii, iv, ... range up to a
  3040.           maximum of xcix (99).
  3041.  
  3042.           Upper case alphabetics, A, B, C, ..., Z, AA, AB, ..., AZ, BA, BB,
  3043.           ..., BZ, CA, CB, ... range up to a maximum of CU (99).
  3044.  
  3045.           Lower case alphabetics, a, b, c, ..., z, aa, ab, ..., az, ba, bb,
  3046.           ..., bz, ca, cb, ... range up to a maximum of cu (99).
  3047.  
  3048.           The default display format is Arabic numbers.
  3049.  
  3050.           Figure 4-11 on page 4-23 show a table of contents fragment for a
  3051.           document with the following numbering format
  3052.  
  3053.                Level     Format
  3054.  
  3055.                  1       Arabic
  3056.                  2       Upper case Roman numerals
  3057.                  3       Lower case alphabetics
  3058.  
  3059.  
  3060.           4.6.6.3. X  Exit to main menu 
  3061.  
  3062.           Select option X from part 2 of the document format menu to return
  3063.           to the main menu.
  3064.  
  3065.  
  3066.  
  3067.           __________________________________________________________
  3068.  
  3069.           1. INTRODUCTION  . . . . . . . . . . . . . . . . .    1-1 
  3070.              1.I. Purpose of This Manual   . . . . . . . . .    1-1 
  3071.              1.II. MSPANTOC  . . . . . . . . . . . . . . . .    1-1 
  3072.                    1.II.a. Paragraph/Section Numbering . . .    1-1 
  3073.                    1.II.b. Figure Numbering  . . . . . . . .    1-1 
  3074.                    1.II.c. Table Numbering   . . . . . . . .    1-1 
  3075.                    1.II.d. Symbolic Cross References   . . .    1-1 
  3076.                    1.II.e. Table of Contents   . . . . . . .    1-2 
  3077.                    1.II.f. List of Figures   . . . . . . . .    1-2 
  3078.              1.III. Some Fine Print  . . . . . . . . . . . .    1-5 
  3079.              1.IV. System Requirements   . . . . . . . . . .    1-6 
  3080.  
  3081.           __________________________________________________________
  3082.  
  3083.           Figure  4-11: Table of Contents, Differing Number Systems
  3084.  
  3085.  
  3086.  
  3087.  
  3088.  
  3089.  
  3090.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-23
  3091.  
  3092.  
  3093.  
  3094.  
  3095.  
  3096.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  3097.  
  3098.           4.6.7. Document format menu, part 3           4.6.7. Document format menu, part 3 
  3099.  
  3100.           Figure 4-12 on page >>doc3men illustrates the contents of part 3
  3101.           of the MSPC document format menu.
  3102.  
  3103.           The following paragraphs describe each of the document format,
  3104.           part 3, menu options.
  3105.  
  3106.  
  3107.           4.6.7.1. A  Display part 3 document parameters 
  3108.  
  3109.           Select option A from part 3 of the document format menu to
  3110.           display the current values for the following items:
  3111.  
  3112.                1) the paragraph number level 1 punctuation
  3113.                2) the paragraph number level 2 punctuation
  3114.                3) the paragraph number level 3 punctuation
  3115.                4) the paragraph number level 4 punctuation
  3116.                5) the paragraph number level 5 punctuation
  3117.                6) the paragraph number level 6 punctuation
  3118.                7) the paragraph number level 7 punctuation
  3119.                8) the paragraph number level 8 punctuation
  3120.                9) the paragraph number level 9 punctuation
  3121.  
  3122.  
  3123.           4.6.7.2. B-J  Change paragraph number level 1-9 punctuation 
  3124.  
  3125.           Select options B-J from part 3 of the document format menu to
  3126.           change the single character of punctuation MSPANTOC outputs after
  3127.           each level, 1-9 respectively, of a section or paragraph number.
  3128.  
  3129.           The default value for this punctuation character is a period (.).
  3130.  
  3131.  
  3132.           4.6.7.3. X  Exit to main menu 
  3133.  
  3134.           Select option X from part 3 of the document format menu to return
  3135.           to the main menu.
  3136.  
  3137.  
  3138.  
  3139.  
  3140.  
  3141.  
  3142.  
  3143.  
  3144.  
  3145.  
  3146.  
  3147.  
  3148.  
  3149.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-24
  3150.  
  3151.  
  3152.  
  3153.  
  3154.  
  3155.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  3156.  
  3157.           4.6.8. Miscellaneous menu           4.6.8. Miscellaneous menu 
  3158.  
  3159.           Figure 4-13 on page 4-26 illustrates the contents of the MSPC
  3160.           miscellaneous menu.
  3161.  
  3162.           The following paragraphs describe each of the miscellaneous menu
  3163.           options.
  3164.  
  3165.  
  3166.           4.6.8.1. A  Display all miscellaneous values 
  3167.  
  3168.           Select option A from the miscellaneous menu to display the
  3169.           current values for the following items:
  3170.  
  3171.                1) all valid print attribute codes
  3172.                2) the paragraph number lead-in string
  3173.  
  3174.  
  3175.           4.6.8.2. B  Change lead-in string 
  3176.  
  3177.           Select option B from the miscellaneous menu to change the lead-in
  3178.           string.  A lead-in string is a pre-defined sequence of from 1 to
  3179.           3 characters which identify for MSPANTOC and visually highlight
  3180.           the next 1 or 2 characters in a text file as an action request
  3181.           code.
  3182.  
  3183.           The default lead-in string is the 2 character sequence
  3184.  
  3185.                =>
  3186.  
  3187.  
  3188.           4.6.8.3. C  Change line termination sequence
  3189.  
  3190.           Select option C from the miscellaneous menu to change the line
  3191.           termination sequence MSPANTOC uses to end each line in the table
  3192.           of contents, list of figures and list of tables that it creates.
  3193.  
  3194.           The default line termination sequence is a carriage return and a
  3195.           line feed.  If you use WordPerfect, select a line termination
  3196.           sequence of a line feed only.
  3197.  
  3198.           The line termination sequence needs changing if your word
  3199.           processing package prints the table of contents, list of figures
  3200.           or list of tables double spaced, all on one line or in some other
  3201.           incorrect fashion.
  3202.  
  3203.  
  3204.  
  3205.  
  3206.  
  3207.  
  3208.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-25
  3209.  
  3210.  
  3211.  
  3212.  
  3213.  
  3214.           MSPANTOC Version 1.0                         CONFIGURING MSPANTOC
  3215.  
  3216.           4.6.8.4. X  Exit to main menu 
  3217.  
  3218.           Select option X from the miscellaneous menu to return to the main
  3219.           menu.
  3220.  
  3221.  
  3222.           __________________________________________________________
  3223.  
  3224.           MAIN DOCUMENT MENU, PART 3 
  3225.            
  3226.           Option  Description 
  3227.            
  3228.             A . . Display part 3 document parameters 
  3229.             B . . Change paragraph number level 1 punctuation 
  3230.             C . . Change paragraph number level 2 punctuation 
  3231.             D . . Change paragraph number level 3 punctuation 
  3232.             E . . Change paragraph number level 4 punctuation 
  3233.             F . . Change paragraph number level 5 punctuation 
  3234.             G . . Change paragraph number level 6 punctuation 
  3235.             H . . Change paragraph number level 7 punctuation 
  3236.             I . . Change paragraph number level 8 punctuation 
  3237.             J . . Change paragraph number level 9 punctuation 
  3238.             X . . Exit to main menu 
  3239.            
  3240.           __________________________________________________________
  3241.            
  3242.           Figure  4-12: Document Menu, Part 3
  3243.  
  3244.  
  3245.  
  3246.           __________________________________________________________
  3247.  
  3248.           MISCELLANEOUS VALUES MENU 
  3249.            
  3250.           Option  Description 
  3251.            
  3252.             A . . Display all miscellaneous values 
  3253.             B . . Change lead-in string 
  3254.             C . . Change line termination sequence
  3255.             X . . Exit to main menu 
  3256.  
  3257.           __________________________________________________________
  3258.  
  3259.           Figure  4-13: Miscellaneous Values Menu
  3260.  
  3261.  
  3262.  
  3263.  
  3264.  
  3265.  
  3266.  
  3267.           Copyright (C) The Nunnery Works Ltd 1987                Page 4-26
  3268.  
  3269.  
  3270.  
  3271.  
  3272.  
  3273.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3274.  
  3275.           5. RUNNING MSPANTOC          5. RUNNING MSPANTOC          ___________________
  3276.  
  3277.           5.1. Introduction          5.1. Introduction
  3278.  
  3279.           This chapter describes how to run MSPANTOC.  It describes the
  3280.           command line format, the status and error messages and summarizes
  3281.           the operation of the program.
  3282.  
  3283.  
  3284.           5.2. Command Line Format          5.2. Command Line Format
  3285.  
  3286.           To run the MSPANTOC program, enter a command line with the form
  3287.  
  3288.                MSP10 control-file configuration-file/C
  3289.  
  3290.           where:
  3291.  
  3292.                1) MSP10 is the name of the MSPANTOC executable program,
  3293.                   version 1.0
  3294.                2) control-file is the full pathname of the control file
  3295.                3) configuration-file is the full pathname of the
  3296.                   optional configuration file
  3297.  
  3298.  
  3299.           5.2.1. Control File          5.2.1. Control File
  3300.  
  3301.           The control file is a standard MS-DOS or PC-DOS text file which
  3302.           you must create.  It contains an ordered list of the names of the
  3303.           text files that make up your document.  
  3304.  
  3305.           If you follow our suggestions, the control file contains a list,
  3306.           one per line, of the full pathnames of the individual chapter
  3307.           files for your document in the order they are to appear in the
  3308.           final document.
  3309.  
  3310.           MSPANTOC reads each input text file, assigns section, paragraph,
  3311.           figure and table numbers, resolves cross references and writes
  3312.           the updated text files to disk using file names with extensions
  3313.           of APN (assigned paragraph numbers).
  3314.  
  3315.           In addition, MSPANTOC uses the root of the full control file
  3316.           pathname as the root for the table of contents pathname, list of
  3317.           figures pathname and list of tables pathname.  The root of a
  3318.           pathname is the drive designation, all directory names and the
  3319.           filename without any extension, ie all characters up to the dot
  3320.           which separates the filename from its extension.
  3321.  
  3322.  
  3323.  
  3324.  
  3325.  
  3326.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-1
  3327.  
  3328.  
  3329.  
  3330.  
  3331.  
  3332.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3333.  
  3334.           For example, if your document consists of 5 chapters organized
  3335.           into the following files: INTRO.DOC, COMPLIANCE.DOC, TECH.DOC,
  3336.           PRICE.DOC and SPECS.DOC, then the control file would contain 5
  3337.           lines as follows:
  3338.  
  3339.                INTRO.DOC
  3340.                COMPLIANCE.DOC
  3341.                TECH.DOC
  3342.                PRICE.DOC
  3343.                SPECS.DOC
  3344.  
  3345.  
  3346.           5.2.2. Configuration File          5.2.2. Configuration File
  3347.  
  3348.           The MSPANTOC configuration program creates the configuration
  3349.           file.  MSPANTOC reads the configuration file to obtain the
  3350.           current settings for all user settable values.
  3351.  
  3352.           If the command line does not reference a configuration file,
  3353.           MSPANTOC attempts to read the configuration information from the
  3354.           default configuration file name MSP.CFG.
  3355.  
  3356.  
  3357.           5.3. Command Line Examples          5.3. Command Line Examples
  3358.  
  3359.           1) MSP10 CONTROL.FIL
  3360.  
  3361.           MSPANTOC reads the list of documents to process from the control
  3362.           file named CONTROL.FIL.
  3363.  
  3364.           MSPANTOC uses the configuration information in file MSP.CFG.
  3365.  
  3366.           MSPANTOC builds
  3367.  
  3368.                1) the table of contents in file CONTROL.TOC
  3369.                2) the list of figures in file CONTROL.FIG
  3370.                3) the list of tables in file CONTROL.TBL
  3371.  
  3372.  
  3373.           2) MSP10 C:\DOCS\PROPOSAL.CTL PROPOSAL.CFG/C
  3374.  
  3375.           MSPANTOC reads the list of documents to process from the control
  3376.           file named C:\DOCS\PROPOSAL.CTL.
  3377.  
  3378.           MSPANTOC uses the configuration information in the file named 
  3379.           PROPOSAL.CFG.
  3380.  
  3381.  
  3382.  
  3383.  
  3384.  
  3385.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-2
  3386.  
  3387.  
  3388.  
  3389.  
  3390.  
  3391.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3392.  
  3393.           MSPANTOC builds
  3394.  
  3395.                1) the table of contents in file C:\DOCS\PROPOSAL.TOC
  3396.                2) the list of figures in file C:\DOCS\PROPOSAL.FIG
  3397.                3) the list of tables in file C:\DOCS\PROPOSAL.TBL
  3398.  
  3399.  
  3400.           5.4. Displayed Messages          5.4. Displayed Messages
  3401.  
  3402.           MSPANTOC displays 2 types of messages on the console display
  3403.           screen while it is running, status messages and error messages.
  3404.  
  3405.           The following 2 sections describe each of the possible status and
  3406.           error messages that you might see.
  3407.  
  3408.  
  3409.           5.4.1. Status Messages          5.4.1. Status Messages
  3410.  
  3411.           5.4.1.1. Pass 1, file file-name 
  3412.  
  3413.           MSPANTOC displays a status message showing its progress through
  3414.           your document.  The status message identifies the current pass
  3415.           number, 1 or 2, and the current input file being processed. 
  3416.           Section 5.5.4 on page 5-7 describes the 2 pass processing that
  3417.           MSPANTOC performs.
  3418.  
  3419.  
  3420.           5.4.2. Error Messages          5.4.2. Error Messages
  3421.  
  3422.           5.4.2.1. Control file error, unexpected end of line or end of
  3423.           file
  3424.  
  3425.           MSPANTOC encountered one of 2 unexpected conditions while reading
  3426.           the control file:
  3427.  
  3428.                1) an empty line (no file name)
  3429.                2) an unexpected end of file
  3430.  
  3431.  
  3432.           5.4.2.2. File f-n does not contain a usable copy of configuration
  3433.           data
  3434.  
  3435.           MSPANTOC attempted to obtain configuration information from the
  3436.           file named f-n in the message.  This file does not contain a
  3437.           usable copy of configuration data.  Either the file was not
  3438.           created by the MSPANTOC configuration program or it was created
  3439.           by an old version of the configuration program.
  3440.  
  3441.  
  3442.  
  3443.  
  3444.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-3
  3445.  
  3446.  
  3447.  
  3448.  
  3449.  
  3450.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3451.  
  3452.           5.4.2.3. File write error, file file-name
  3453.  
  3454.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3455.           write to the file named file-name in the message.  This could be
  3456.           a transient disk error that will go away if you retry or it could
  3457.           be permanent.  It could be caused because there is not enough
  3458.           room on the disk drive or because you have a write protected
  3459.           diskette.
  3460.  
  3461.  
  3462.           5.4.2.4. Input file read error, file file-name
  3463.  
  3464.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3465.           read from the file named file-name in the message.  This could be
  3466.           a transient disk error that will go away if you retry or it could
  3467.           be permanent.
  3468.  
  3469.  
  3470.           5.4.2.5. Insufficient memory for program execution
  3471.  
  3472.           MSPANTOC attempts to build its table of symbols in memory it
  3473.           obtains from the operating system.  MS-DOS or PC-DOS reported
  3474.           that there is not enough space to satisfy the request made by
  3475.           MSPANTOC.  Please report this problem to The Nunnery Works Ltd.
  3476.  
  3477.  
  3478.           5.4.2.6. Invalid attribute code atr-code
  3479.  
  3480.           MSPANTOC found a request to use the named attribute code but
  3481.           there was no definition for this code in the attribute file when
  3482.           the configuration program was run.
  3483.  
  3484.  
  3485.           5.4.2.7. Invalid command line format
  3486.  
  3487.           MSPANTOC detected an error in the command line.
  3488.  
  3489.  
  3490.           5.4.2.8. Level number N too large for conversion to roman
  3491.           numerals
  3492.  
  3493.           MSPANTOC will convert level numbers from 1-99 to Roman numerals. 
  3494.           The number reported in the message (N) is outside this range.
  3495.  
  3496.  
  3497.  
  3498.  
  3499.  
  3500.  
  3501.  
  3502.  
  3503.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-4
  3504.  
  3505.  
  3506.  
  3507.  
  3508.  
  3509.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3510.  
  3511.           5.4.2.9. Level number N too large for conversion to alpha
  3512.  
  3513.           MSPANTOC will convert level numbers from 1-99 to an alphabetic
  3514.           level number.  The number reported in the message (N) is outside
  3515.           this range.
  3516.  
  3517.  
  3518.           5.4.2.10. No room for symbol symbol-name in file file-name
  3519.  
  3520.           The symbol table is full and cannot hold the named symbol from
  3521.           the named input file.
  3522.  
  3523.  
  3524.           5.4.2.11. Room for N symbol table entries
  3525.  
  3526.           Before MSPANTOC begins processing the input document, it checks
  3527.           the amount of available memory reported by MS-DOS or PC-DOS.  The
  3528.           available memory is sufficient to hold a maximum of N symbol
  3529.           table entries.
  3530.  
  3531.  
  3532.           5.4.2.12. Symbol symbol-name in file file-name was previously
  3533.           defined
  3534.  
  3535.           Symbol names must be unique in their first 10 characters.  The
  3536.           named symbol from the named input file was previously defined
  3537.           elsewhere in the document.
  3538.  
  3539.  
  3540.           5.4.2.13. Unable to read configuration data from file file-name
  3541.  
  3542.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3543.           read configuration data from the file named file-name in the
  3544.           message.  This could be a transient disk error that will go away
  3545.           if you retry or it could be permanent.
  3546.  
  3547.  
  3548.           5.4.2.14. Unable to open configuration file file-name
  3549.  
  3550.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3551.           open the named configuration file.  The named file probably does
  3552.           not exist.
  3553.  
  3554.  
  3555.  
  3556.  
  3557.  
  3558.  
  3559.  
  3560.  
  3561.  
  3562.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-5
  3563.  
  3564.  
  3565.  
  3566.  
  3567.  
  3568.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3569.  
  3570.           5.4.2.15. Unable to open control file file-name
  3571.  
  3572.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3573.           open the named control file.  The named file probably does not
  3574.           exist.
  3575.  
  3576.  
  3577.           5.4.2.16. Unable to open input file file-name
  3578.  
  3579.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3580.           open the named input document file.  The named file probably does
  3581.           not exist.
  3582.  
  3583.  
  3584.           5.4.2.17. Unable to open list of figures file file-name
  3585.  
  3586.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3587.           open the named list of figures file.
  3588.  
  3589.  
  3590.           5.4.2.18. Unable to open list of tables file file-name
  3591.  
  3592.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3593.           open the named list of tables file.
  3594.  
  3595.  
  3596.           5.4.2.19. Unable to open output file file-name
  3597.  
  3598.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3599.           open the named output document file.
  3600.  
  3601.  
  3602.           5.4.2.20. Unable to open table of contents file file-name
  3603.  
  3604.           MS-DOS or PC-DOS reported an error while MSPANTOC was trying to
  3605.           open the named table of contents file.
  3606.  
  3607.  
  3608.           5.4.2.21. Undefined symbol symbol-name in file file-name
  3609.  
  3610.           MSPANTOC has made one complete pass through the entire document
  3611.           and is now making a second pass through the named document file. 
  3612.           The named symbol has not been defined anywhere in the document.
  3613.           Section 5.5.4 on page 5-7 describes the 2 pass processing that
  3614.           MSPANTOC performs.
  3615.  
  3616.  
  3617.  
  3618.  
  3619.  
  3620.  
  3621.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-6
  3622.  
  3623.  
  3624.  
  3625.  
  3626.  
  3627.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3628.  
  3629.           5.5. Processing Summary          5.5. Processing Summary
  3630.  
  3631.           Figure 5-1 on page 5-9 summarizes the processing performed by
  3632.           MSPANTOC.
  3633.  
  3634.           MSPANTOC reads all files on the left side of the figure and
  3635.           creates all files on the right side.
  3636.  
  3637.  
  3638.           5.5.1. Command Line          5.5.1. Command Line
  3639.  
  3640.           MSPANTOC obtains the pathnames of the control file and the
  3641.           configuration file from the command line you enter.
  3642.  
  3643.  
  3644.           5.5.2. Control File          5.5.2. Control File
  3645.  
  3646.           The control file contains an ordered list of the text files that
  3647.           compose your document.  MSPANTOC obtains the pathnames of the
  3648.           text files from this file and reads the text files in the order
  3649.           they appear in the control file.
  3650.  
  3651.           MSPANTOC also uses the root of the control file name as the root
  3652.           of the table of contents, list of figures and list of tables
  3653.           files that it creates.
  3654.  
  3655.  
  3656.           5.5.3. Configuration File          5.5.3. Configuration File
  3657.  
  3658.           MSPANTOC reads the configuration file to obtain the current
  3659.           settings of all user settable values.  If the command line does
  3660.           not contain a configuration file name, MSPANTOC uses the file
  3661.           name MSP.CFG as a default.
  3662.  
  3663.  
  3664.           5.5.4. Input Text Files          5.5.4. Input Text Files
  3665.  
  3666.           MSPANTOC makes two passes through the list of input text files. 
  3667.           On the first pass, MSPANTOC reads each text file in the list.  On
  3668.           the second pass, MSPANTOC reads only those text files it found to
  3669.           contain references to symbols not yet defined at the time of the
  3670.           first pass.
  3671.  
  3672.  
  3673.  
  3674.  
  3675.  
  3676.  
  3677.  
  3678.  
  3679.  
  3680.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-7
  3681.  
  3682.  
  3683.  
  3684.  
  3685.  
  3686.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3687.  
  3688.           5.5.5. Table of Contents File          5.5.5. Table of Contents File
  3689.  
  3690.           MSPANTOC creates a table of contents file using the root of the
  3691.           control file pathname and the extension TOC.  The table of
  3692.           contents contains the section number, section description and
  3693.           page number for each section you identify in your document.  
  3694.  
  3695.           MSPANTOC builds the table of contents using the format you
  3696.           requested in the configuration file.
  3697.  
  3698.  
  3699.  
  3700.           5.5.6. List of Figures File          5.5.6. List of Figures File
  3701.  
  3702.           MSPANTOC creates a list of figures file using the root of the
  3703.           control file pathname and the extension FIG.  The list of figures
  3704.           contains the table number, figure description and page number for
  3705.           each figure you identify in your document.
  3706.  
  3707.  
  3708.           5.5.7. List of Tables File          5.5.7. List of Tables File
  3709.  
  3710.           MSPANTOC creates a list of tables file using the root of the
  3711.           control file pathname and the extension TBL.  The list of tables
  3712.           contains the table number, table description and page number for
  3713.           each table you identify in your document.
  3714.  
  3715.  
  3716.           5.5.8. Output Text Files          5.5.8. Output Text Files
  3717.  
  3718.           MSPANTOC creates one output text file for each input text file
  3719.           listed in the control file.  The output text file name uses the
  3720.           root of the input text file pathname and the extension APN
  3721.           (assigned paragraph numbers).
  3722.  
  3723.           The output text file is an almost exact copy of the input text
  3724.           file.  The only changes that MSPANTOC makes are as follows:
  3725.  
  3726.                1) it assigns paragraph, section, figure or table
  3727.                   numbers where requested
  3728.                2) it removes symbol names from paragraph, section,
  3729.                   figure or table number assignment requests
  3730.                3) it inserts chapter numbers where requested
  3731.                4) it resolves cross references where requested
  3732.                5) it inserts print attribute control strings where
  3733.                   requested
  3734.  
  3735.  
  3736.  
  3737.  
  3738.  
  3739.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-8
  3740.  
  3741.  
  3742.  
  3743.  
  3744.  
  3745.           MSPANTOC Version 1.0                             RUNNING MSPANTOC
  3746.  
  3747.                               ----------------
  3748.           Command Line -----> |              |    Table of Contents
  3749.                               |      M       |
  3750.                               |      S       |       -------------
  3751.           Configuration --->  |      P       |       |           |
  3752.           File                |      A       |  -->  |  XXX.TOC  |
  3753.                               |      N       |       |           |
  3754.           Control File -----> |      T       |       -------------
  3755.                               |      O       |
  3756.               (XXX.CTL)       |      C       |
  3757.              -------------    |              |    List of Figures
  3758.              |           |    |              |
  3759.              | CHAP1.DOC |    |              |       -------------
  3760.              | CHAP2.DOC |    |              |       |           |
  3761.              |     .     |    |              |  -->  |  XXX.FIG  |
  3762.              |     .     |    |              |       |           |
  3763.              | CHAPN.DOC |    |              |       -------------
  3764.              |           |    |              |
  3765.              -------------    |              |    List of Tables
  3766.                               |              |
  3767.                               |              |       -------------
  3768.                               |              |       |           |
  3769.                               |              |  -->  |  XXX.TBL  |
  3770.                               |              |       |           |
  3771.                               |              |       -------------
  3772.                               |              |
  3773.           Text Files          |              |    Text Files
  3774.                               |              |
  3775.              -------------    |              |       -------------
  3776.              |           |    |              |       |           |
  3777.              | CHAP1.DOC |--> |              |  -->  | CHAP1.APN |
  3778.              |           |    |              |       |           |
  3779.              -------------    |              |       -------------
  3780.                               |              |
  3781.              -------------    |              |       -------------
  3782.              |           |    |              |       |           |
  3783.              | CHAP2.DOC |--> |              |  -->  | CHAP2.APN |
  3784.              |           |    |              |       |           |
  3785.              -------------    |              |       -------------
  3786.                               |              |
  3787.              -------------    |              |       -------------
  3788.              |           |    |              |       |           |
  3789.              | CHAPN.DOC |--> |              |  -->  | CHAPN.APN |
  3790.              |           |    |              |       |           |
  3791.              -------------    |              |       -------------
  3792.                               ----------------
  3793.  
  3794.           Figure  5-1: MSPANTOC Processing Summary
  3795.  
  3796.  
  3797.  
  3798.           Copyright (C) The Nunnery Works Ltd 1987                 Page 5-9
  3799.  
  3800.  
  3801.  
  3802.  
  3803.  
  3804.           MSPANTOC Version 1.0                          PRINTING A DOCUMENT
  3805.  
  3806.           6. PRINTING A DOCUMENT          6. PRINTING A DOCUMENT          ______________________
  3807.  
  3808.           6.1. Introduction          6.1. Introduction
  3809.  
  3810.           This chapter describes how to print a document and assumes that
  3811.           you accepted our suggestion and created a series of individual
  3812.           files, each containing a single chapter.
  3813.  
  3814.  
  3815.           6.2. After MSPANTOC Runs          6.2. After MSPANTOC Runs
  3816.  
  3817.           MSPANTOC writes its output to files with suffixes of APN with one
  3818.           such file created for each entry in the control file.  MSPANTOC
  3819.           also creates a table of contents file, a list of figures file and
  3820.           a list of tables file.  The problem is to combine these files
  3821.           into a complete document.
  3822.  
  3823.  
  3824.           6.3. A General Solution          6.3. A General Solution
  3825.  
  3826.           Assume that your control file named CTL.FIL contains the
  3827.           following:
  3828.  
  3829.                INTRO.DOC
  3830.                COMPLIANCE.DOC
  3831.                PRICE.DOC
  3832.                SPECS.DOC
  3833.  
  3834.           and that you have also created a document header page in file
  3835.           HEADER.DOC.
  3836.  
  3837.           Then, in general, you want the files printed in the following
  3838.           order:
  3839.  
  3840.                HEADER.DOC
  3841.                CTL.TOC             the table of contents file
  3842.                CTL.FIG             the list of figures file
  3843.                CTL.TBL             the list of tables file
  3844.                INTRO.APN
  3845.                COMPLIANCE.APN
  3846.                PRICE.APN
  3847.                SPECS.APN
  3848.  
  3849.           The following sections describe how to do this in WordStar and
  3850.           WordPerfect.
  3851.  
  3852.  
  3853.  
  3854.  
  3855.  
  3856.  
  3857.           Copyright (C) The Nunnery Works Ltd 1987                 Page 6-1
  3858.  
  3859.  
  3860.  
  3861.  
  3862.  
  3863.           MSPANTOC Version 1.0                          PRINTING A DOCUMENT
  3864.  
  3865.           6.4. Using WordStar with MailMerge          6.4. Using WordStar with MailMerge
  3866.  
  3867.           To print this document with WordStar if you also have MailMerge,
  3868.           proceed as follows:
  3869.  
  3870.                1) Create a file called MASTER.LST with the following
  3871.                   contents:
  3872.  
  3873.                     .FI HEADER.DOC
  3874.                     .FI CTL.TOC
  3875.                     .FI CTL.FIG
  3876.                     .FI CTL.TBL
  3877.                     .FI INTRO.APN
  3878.                     .FI COMPLIANCE.APN
  3879.                     .FI PRICE.APN
  3880.                     .FI SPECS.APN
  3881.  
  3882.                2) Select the merge print option from your WordStar main 
  3883.                   menu and specify file name MASTER.LST.  MailMerge will 
  3884.                   merge all the files listed in MASTER.LST into a single
  3885.                   printed document.
  3886.  
  3887.  
  3888.           6.5. Using WordStar without MailMerge          6.5. Using WordStar without MailMerge
  3889.  
  3890.           To print this document with WordStar if you do not have
  3891.           MailMerge, proceed as follows:
  3892.  
  3893.                1) Select the print option (P) from your WordStar main
  3894.                   menu and specify file HEADER.DOC.  WordStar will
  3895.                   print the document header page, HEADER.DOC.
  3896.                2) Repeat this procedure for each of the following files,
  3897.                   in order:   
  3898.  
  3899.                     CTL.TOC
  3900.                     CTL.FIG
  3901.                     CTL.TBL
  3902.                     INTRO.APN
  3903.                     COMPLIANCE.APN
  3904.                     PRICE.APN
  3905.                     SPECS.APN
  3906.  
  3907.  
  3908.  
  3909.  
  3910.  
  3911.  
  3912.  
  3913.  
  3914.  
  3915.  
  3916.           Copyright (C) The Nunnery Works Ltd 1987                 Page 6-2
  3917.  
  3918.  
  3919.  
  3920.  
  3921.  
  3922.           MSPANTOC Version 1.0                          PRINTING A DOCUMENT
  3923.  
  3924.           6.6. Using WordPerfect          6.6. Using WordPerfect
  3925.  
  3926.           To print this document with WordPerfect, proceed as follows:
  3927.  
  3928.                1) Create a file called MASTER.LST with the following
  3929.                   contents:
  3930.  
  3931.                     ^PHEADER.DOC^P
  3932.                     ^PCTL.TOC^P
  3933.                     ^PCTL.FIG^P
  3934.                     ^PCTL.TBL^P
  3935.                     ^PINTRO.APN^P
  3936.                     ^PCOMPLIANCE.APN^P
  3937.                     ^PPRICE.APN^P
  3938.                     ^PSPECS.APN^P
  3939.  
  3940.                   Note that ^P respresents control-P.
  3941.                2) Press the EXECUTE-MERGE function key.
  3942.                3) Specify MASTER.LST as the primary file name and just 
  3943.                   ENTER for the secondary file name.
  3944.                4) WordPerfect merges the files listed in MASTER.LST into
  3945.                   a complete document.  When the merge completes, you have
  3946.                   the option of saving the merged document to disk for 
  3947.                   later printing or printing immediately.
  3948.  
  3949.  
  3950.  
  3951.  
  3952.  
  3953.  
  3954.  
  3955.  
  3956.  
  3957.  
  3958.  
  3959.  
  3960.  
  3961.  
  3962.  
  3963.  
  3964.  
  3965.  
  3966.  
  3967.  
  3968.  
  3969.  
  3970.  
  3971.  
  3972.  
  3973.  
  3974.  
  3975.           Copyright (C) The Nunnery Works Ltd 1987                 Page 6-3