home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / wf200b.arj / WF200DOC.EXE / lha / WF.014 < prev    next >
Text File  |  1989-12-22  |  8KB  |  245 lines
  1. .f3                              - # -              Chapter 14 - TOC
  2. .rm70
  3. .mt5
  4. .mb5
  5. .pl66
  6. .tc
  7. .tc 14. TABLE OF CONTENTS .................................#
  8. 14. TABLE OF CONTENTS
  9.  
  10. Many documents you produce will require a table of contents. This can
  11. be achieved by identifying the table of contents entries, and
  12. executing a Generate Table Of Contents command (Ctrl F5). The table of
  13. contents files have the same name as the file you are generating for,
  14. but have the extension .TOC for the main one and the extensions .TO1
  15. up to .TO9 for the ancilliary ones. Only those files you request will
  16. be produced.
  17.  
  18. Table of contents files can be included in your document by use if the
  19. file include (.FI) dot command, and if so included, will be printed
  20. when you print the document. However, if you change the document, you
  21. will need to re-create the table of contents files, since this is not
  22. done automatically.
  23.  
  24. Level Numbers can be generated automatically if you wish, or you can
  25. put them in yourself. Automatic level numbers can be numbers, letters
  26. or Roman numerals.
  27.  
  28. .tc    Identifying Table of Contents Entries ..............#
  29. Identifying Table of Contents Entries
  30.  
  31. Before you can generate a table of contents, you need to identify each
  32. entry that you want in the table of contents. This is done with the
  33. .TC dot command. Separate each entry from the dot command by at least
  34. one space. If you wish to include the page number, merely put the
  35. character # in the line where you wish it to print. You can include
  36. special print control functions and characters for special effects
  37. during printing. To indent an entry in the table of contents, just put
  38. extra spaces after the TC
  39.  
  40.   for example:
  41.  
  42.     .TC INTRODUCTION.............................#
  43.  
  44.     .TC      Part 1..............................#
  45.  
  46.     Your table of contents entries will look like this:
  47.  
  48.     INTRODUCTION.............................1
  49.          Part 1..............................2
  50.  
  51.  
  52. If you follow the dot command immediately by a number 1 to 9, the
  53. table of contents line will not be written to the .TOC file, but
  54. instead to a separate file with the extension .TO1 to .TO9 depending
  55. on the digit. This allows you more flexability in generating tables of
  56. contents, for example a separate list of tables, a separate list of
  57. illustrations and so on.
  58.  
  59. .CP7
  60.   for example:
  61.  
  62.     .TC1 figure 1.1 Sales vs Expendature ... #
  63.     .tc2 table 1.1 Sales vs Expenditure  ... #
  64.  
  65.   will produce in file.TO1 the line
  66.  
  67.        figure 1.1 Sales vs Expenditure ... 4
  68.  
  69.   and in file.TO2 the line
  70.  
  71.        table 1.1 Sales vs Expenditure  ... 4
  72.  
  73.   assuming that the page number is 4.
  74.  
  75. Word Fugue will gather all the entries for a numbered .TC command and
  76. place them into separate files. All these files have the same name as
  77. the original document, but the extension is set to a numbered
  78. extension: .TO1 , .TO2 and so on.
  79.  
  80. .tc    Automatic Level Numbering ..........................#
  81. Automatic Level Numbering
  82.  
  83. Level numbers can be generated automatically by use of the @L print
  84. function. You can have up to 9 diffent level numbers, in differing
  85. types and styles. This is discussed more fully below. You place the
  86. level number in brackets : {.@L1} for level 1 to {.@L9} for level 9.
  87. They will be expanded at printing or TOC generation, depending whether
  88. they are in the text body or the .TC lines.
  89.  
  90. .tc       Style of Numbering ..............................#
  91.   Style of Numbering
  92.  
  93.   Style can be any of Office, Decimal (default), or Nodot.
  94.  
  95.   Office prints only one number for each level, followed by a dot.
  96.   Thus:
  97.  
  98.          {.@L1}
  99.            {.@L2}
  100.              {.@L3}
  101.  
  102.            gives
  103.            1.
  104.              1.
  105.                1.
  106.  
  107.   NoDot is similar to Office, except that the dot (.) is not printed.
  108.   Thus:
  109.  
  110.          {.@L1}
  111.            {.@L2}
  112.              {.@L3}
  113.  
  114.            gives
  115.            1
  116.              1
  117.                1
  118.  
  119.   You set this with the .TS command
  120.  
  121.          .TS O   for  Office
  122.       or .TS D   for  Decimal
  123.       or .TS N   for  Nodot
  124.  
  125.   The style you last set remains in effect for all level numbers until
  126.   you change it. Thus if you wish to have decimal numbering for the
  127.   first three levels, and Office numbering for the remainder, you will
  128.   need to use .TS D when you start, .TS O when you reach level 4, and
  129.   .TS D when you return to a level lower than 4. You will need to
  130.   continue toggling the style throughout the document.
  131.  
  132. .tc       Types of Numbering ..............................#
  133.   Types of Numbering
  134.  
  135.   Each level can have its own type of numbering, independent of all
  136.   the other levels. The available types of numbering are:-
  137.  
  138.     R      Roman uppercase       eg   III.
  139.     r      roman lowercase       eg   iii.
  140.     N or n Numeric (default)     eg   3.
  141.     A      Alphabetic uppercase  eg   C.
  142.     a      alphabetic lowercase  eg   c.
  143.  
  144.   You set this with the .TL command:
  145.  
  146.               .TLn x
  147.                         where n is 1 to 9 (the level)
  148.                               x is R,r,N,n,A,a (as above)
  149.  
  150.   NOTE These letters are case sensitive, so that r (lowercase) will
  151.        give lowercase Roman, while R (uppercase) will give uppercase
  152.        Roman.
  153.  
  154. .tc       Set Start Numbers ...............................#
  155.   Set Start Numbers
  156.  
  157.   Each level defaults to starting at number 1. However, you can start
  158.   each level at a different number, eg if you have divided your
  159.   document up into different parts, and only want to print a part of
  160.   it.
  161.  
  162.   Note that referencing a lower numbered level will automatically
  163.   reset all higher numbered levels to 1.
  164.  
  165.   For alphas, use the equivalent number eg a = 1, b=2, z=26 etc. The
  166.   level number is always stored internally as a number, and is
  167.   converted on printing to the appropriate text.
  168.  
  169. .CP5
  170.   You set this with .TN command:
  171.  
  172.             .TNn  i
  173.                        where n is 1 to 9 (the level)
  174.                              i is the start number
  175.  
  176. .tc       Examples ........................................#
  177.   Examples
  178.  
  179.      OFFICE
  180.  
  181.           .TS Office
  182.           .TL2 r
  183.           .tl3 a
  184.              {.@L1} this is level 1
  185.                {.@L2} this is level 2
  186.                   ({.@L3}) this is level 3
  187.  
  188.                     produces
  189.  
  190.              1. this is level 1
  191.                i. this is level 2
  192.                   (a.)  this is level 3
  193.  
  194.  
  195.      NODOT
  196.  
  197.           .TS Nodot
  198.           .TL2 r
  199.           .tl3 a
  200.              {.@L1} this is level 1
  201.                {.@L2} this is level 2
  202.                   ({.@L3}) this is level 3
  203.  
  204.                     produces
  205.  
  206.              1 this is level 1
  207.                i this is level 2
  208.                   (a) this is level 3
  209.  
  210.  
  211.      DECIMAL
  212.  
  213.           .TS Decimal
  214.           .TL2 r
  215.           .tl3 a
  216.              {.@L1} this is level 1
  217.                {.@L2} this is level 2
  218.                   ({.@L3}) this is level 3
  219.  
  220.                     produces
  221.  
  222.              1. this is level 1
  223.                1.i. this is level 2
  224.                   (1.i.a.) this is level 3
  225.  
  226.  
  227.   Embed the commands in the .TC lines for the correct numbers to
  228.   appear in table of contents.
  229.  
  230. .CP5
  231. .tc    Producing a Table of Contents ......................#
  232. Producing a Table of Contents
  233.  
  234. To produce the table of contents, enter the command Ctrl F5. You will
  235. be prompted for the name of the file for which to generate the TOC.
  236. Enter the name of the file. Note if you are working on the file,
  237. please save it first so that the up to date version is used.
  238.  
  239. Word Fugue will gather all the entries for a numbered .TC command and
  240. place them into separate files. All these files have the same name as
  241. the original document, but the extension is set to a numbered
  242. extension: .TO1 , .TO2 and so on.
  243.  
  244. These files should be included in your document via the .FI command.
  245.