Enter your search terms Submit search form
	Web pdp-10.trailing-edge.com

                      Notes for TOC, version 1(17)





1.0  INTRODUCTION

TOC is a    DSR-related utility program that is used to help generate  a
table of contents.

To generate input for TOC specify the /CONTENTS  switch  on  the     DSR
command  line.   See  the  description  of  the /CONTENTS switch that is
supplied with the new    DSR.

In order to use this version of TOC, you need the  new     DSR,  version
1(54) or newer.  Other    DSRs cannot generate the input needed by TOC.


                                  NOTE

               If you want to get a  running  page  count
               you  need to use version 1(101) of the new
                  DSR (or a newer version).





2.0  OPERATION

Use the /CONTENTS switch  of     DSR  to  generate  a  binary  table  of
contents  for  your document.  Then run TOC.  When TOC requests the name
of your input file, respond with  the  name  of  your  .BTC  file.   TOC
assumes  a  file  type of .BTC, unless you specify otherwise.  Output is
always written to a file of type .RNT.

For example, suppose you said
                             DSR ABC/CONTENTS
Then the binary table of contents file is called ABC.BTC.  When TOC asks
for  the  name  of your input specify either just ABC (in which case TOC
assumes .BTC) or you can specify .BTC in addition.  TOC  will  create  a
file called ABC.RNT.

TOC also asks about varying header-level indents.  If you  respond  with
"y"  or  "Y"  (without  the  quotes)  you get additional indentation for
header-levels 3 through 6.  Any other response  causes  header-levels  2
through  6  to  start  in  the same column, with the result that headers
having lots of numbers may run into the header-level text.

TOC now asks you if you want a running page counter.  If you answer  "y"
or  "Y"  that's  what you get.  Otherwise, answering anything else gives
you normal page numbers.



3.0  CREATING A MASTER TABLE OF CONTENTS

TOC allows you to segment your document,    DSR each section separately,
and  then  generate  a  master  table  of  contents  later.  To do this,
generate the .BTC files as usual.   Then  append  the  binary  table  of
contents files together in the same order in which you would arrange the
segments of your document.  Then proceed as if you  had  just  a  single
.BTC file to process.

You can also process all the .BTC files separately, and then append  the
resulting .RNT files together.



3.1  Output Processing

TOC generates a file with file type .RNT which is  to  be  processed  by
   DSR.  You can

     1.  Process the .RNT file just like an ordinary .RNO file, in which
         case    DSR generates a .MEC file, or

     2.  Use the .REQUIRE command (e.g., .REQUIRE "ABC.RNT") to  include
         the table of contents in your document.




4.0  RESTRICTIONS

This version of TOC does not have a "standard" command  line.   Further,
there are no command line switches.  And you cannot override the name or
type of the output file generated.



5.0  MESSAGES AND HINTS

TOC contains few error messages.  All I/O error messages  cause  TOC  to
terminate.  In addition, the message 'CONFUSED' is output if TOC doesn't
like the looks of your .BTC file.

TOC also knows whether or not it can understand the .BTC file  generated
by your particular version of    DSR.  If you get the message
                INCOMPATIBLE VERSIONS OF RUNOFF AND TOC
you are trying to get TOC to process a .BTC file  that  is  not  in  the
desired format;  the results are undefined.



[End of TOC.RND]