home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / PROGRAMS / WSTAR / TBL20.LBR / TBLCTENT.DZC / TBLCTENT.DOC
Text File  |  2000-06-30  |  5KB  |  102 lines
  1. .op
  2.  WordStar file utility  --  December, 1987 Version 2.0
  3.  Version 1.0 Copyright  1985  by Dean A. Fields
  4.  Version 2.0 Copyright  1987  by Ellis B. Levin
  5.  
  6. TBL.COM Version 2.0 handles text of multiple lines, 
  7. adjusting for each different text length.  It is 
  8. designed for legal briefs and other documents where
  9. it is necessary to index multiple lines of text.
  10.  
  11. It will handle text of up to 498 characters.  
  12.  
  13. In addition it contains two other modifications from version
  14. 1.0:  First, it does not put the table of contents text 
  15. in upper case.  Second, it puts a blank line between
  16. each text in the table of contents.
  17.  
  18.      This  program  is released to the Public Domain and  may  be 
  19. freely  distributed  and copied,  but may not be sold without the 
  20. authors written permission.
  21.  
  22.     All Rights Reserved
  23.  
  24.                                               
  25.  Written in TURBO PASCAL Ver. 3.0             
  26.                                               
  27.  Version 1.0 Tested on a:                                 
  28.      COMPAQ        MsDos 3.1                  
  29.      KAYPRO 4-84   CP/M 2.2
  30.                                               
  31.      To use this program, type the program name, TBLCTENT, at the 
  32. DOS  prompt,  and press the return key.   The program will  first 
  33. announce  itself,  and then prompt for the name of the file  that 
  34. the table of content is to be created from.
  35.  
  36.      This  program  creates a Table of Contents  for  a  WordStar 
  37. document  file.   TBLCTENT  looks for control  codes,  and  takes 
  38. whatever  is between them and places it in the table of  contents 
  39. file.  The control codes are, ^R to start and stop inclusion into 
  40. the  table  of  contents file.   They are placed in the  file  by 
  41. entering  a  ^P^R at the beginning and end of the  text  you want 
  42. included into the table of contents file.   The ^R's should never 
  43. have  WordStar dot commands between them.   The name of the table 
  44. of  contents file is the same as the input document,  except  the 
  45. file  type  which is ".TBC".   The maximum number  of  characters 
  46. allowed  in  a  Table of Content entry is 55,  if  more  then  55 
  47. characters  appear between the ^R's,  then the Table  of  Content 
  48. entry is truncated to 55 characters.
  49.                                               
  50.      After  you enter the file name that the table of content  is 
  51. to  be  created  from,  TBLCTENT will try to open that  file  for 
  52. input.   If the file can not be opened (ie. because it can not be 
  53. found  or  something)  the  condition is  reported  and  you  are 
  54. reprompted for an input file name.   This program can be  aborted 
  55. at  anytime by a ^C.   If the input file name is found,  then the 
  56. output  file  (Table of Content file) is  checked  for.   If  the 
  57. output  file  already exist,  you are given the option of  either 
  58. deleting it (overwritting it ), or canceling the program.  If you 
  59. delete  it,  then processing continues as if the file  had  never 
  60. existed.
  61.  
  62.      During  processing,  TBLCTENT  reports  pages  that  it  has 
  63. scanned   for  table  of  content  entries;   so  you  can   tell 
  64. approximately  how  far  you are in the  input  document.   Pages 
  65. covered by a .OP command are not counted. 
  66. .pa
  67.     The following describes how the WordStar .OP, .PA, and .PN n 
  68. commands are treated by TBLCTENT:
  69.  
  70.          .OP   causes  the  program to stop searching  for  Table
  71.                of Content information, because .OP turns off page
  72.                number  and  therefore there is no page number  to
  73.                associate to the Table of Content entry,  and thus
  74.                no  reason  to  report a Table of  Content  entry.  
  75.                Table  of Content searching resumes with the  next 
  76.                .PN n command encountered.
  77.  
  78.          .PA   causes the page number variable to be incremented
  79.  
  80.          .PN n  causes  the  page  number variable to  be  set to 
  81.                number  n  of the .PN n command.   n  can  not  be 
  82.                larger than 9999, unless provisions are made to do 
  83.                the following:
  84.                     1)  - MaxNum  in  the CONST  section  at  the 
  85.                     beginning  of the program must be changed  to 
  86.                     accommodate the new size
  87.  
  88.                     2)   - the   "CASE  pndx  of"  structure   in 
  89.                     Procedure test_line must be changed to handle 
  90.                     the larger page numbers
  91.  
  92.                     3)   - Procedure   translate_line   must   be 
  93.                     modified  to accommodate  the  new  TBC  line 
  94.                     format,    which   includes   balancing   and 
  95.                     centering of the TBC entry.
  96.  
  97.      Once  the Table of Content file has been created,  it can be 
  98. edited  with  WordStar to add in printer control codes  for  your 
  99. specific type of printer.   On some machines the Table of Content 
  100. file will contain a few ^@'s at the end of the file;  The ^@'s do 
  101. not  print.   You  can  ignore them or delete them  it  makes  no 
  102. difference.few ^@'s at the end of the file;