home *** CD-ROM | disk | FTP | other *** search
/ Borland Programmer's Resource / Borland_Programmers_Resource_CD_1995.iso / utils / rtfprsr / text2rtf / read.me < prev    next >
Encoding:
Text File  |  1995-05-19  |  3.7 KB  |  119 lines
  1.  
  2.  
  3.  
  4.         TXT2RTF - Text to Rich Text Converter Version 1.0
  5.               (c) 1991 Winefred Washington
  6.  
  7. Disclaimer
  8.  
  9. TXT2RTF is distributed as a uer-supported software product.  You may
  10. copy and distribute TXT2RTF and its accomplanying files freely, as long
  11. as the files are distributed together unaltered.
  12.  
  13. TXT2RTF is distributed "as is" and without any expressed and implied
  14. warranties.  Because of the diversity of conditions and hardware under
  15. which this program may be used, no warranty of fitness for a particular
  16. purpose is offered.  The user is advised to test the program thoroughly
  17. before relying on it.  The user assumes the entire risk of using the
  18. program.  Any liability of the programmer or distributor is limited
  19. exclusively to product replacement or refund of the registration fee.
  20.  
  21.  
  22.  
  23.  
  24.  
  25. Introduction
  26.  
  27. TXT2RTF, Text to Rich Text Format, is a user-supported utility designed
  28. to take a plain ASCII text file and convert it into a RTF file suitable
  29. for use with Borland's Help Compiler.  To run TXT2RTF, you need an IBM
  30. compatible equipped with DOS 2.XX or later.  Helpdemo.txt is also
  31. included to illustrate all of TXT2RTF features.
  32.  
  33. If you choose to register, you will receive TXT2RTF's C source code. To
  34. register send $15 to:
  35.  
  36.         Winefred Washington
  37.         PO Box 3206
  38.         Huntsville, AL  35810
  39.  
  40.  
  41.  
  42. TXT2RTF Syntax
  43.  
  44. TXT2RTF uses many of the same control codes described in Borland's Help
  45. Compiler user's manual.  The following control codes are recognized:
  46.  
  47.     *  - Build Tag
  48.     #  - Context String
  49.     $  - Title
  50.     K  - Keyword
  51.     +  - Browse Sequence
  52.  
  53. The next three control codes differ from their Borland Help Compiler
  54. counterparts:
  55.  
  56.     =  - Cross-reference
  57.     -  - Definition
  58.     [] - Cross-reference context string
  59.  
  60. To generate a valid RTF file, the text file must be formatted as
  61. follows:
  62.  
  63.     o All control code footnodes must appear at the START of a page.
  64.  
  65.     o Footnotes must fit on a single line in the ASCII text file.
  66.  
  67.     o The body of the text appears after the control code footnotes.
  68.  
  69.     o Bitmaps are placed by reference See Borland's Help Compiler
  70.       user's manual on how to place bitmaps by reference.
  71.  
  72.     o Each page must end with an ASCII formfeed (0x0c).
  73.  
  74.  
  75. Cross-references are used to create hypertext connections from one topic
  76. to another.  To place a cross-reference, use two '=' characters to bound
  77. the cross-reference text:
  78.  
  79.     This is = an example = of how to use the cross-reference
  80.     characters.
  81.  
  82.  
  83.  
  84. Both characters must appear on the same line in the ASCII text file.
  85.  
  86. Definition text is used to display a pop window containing information. 
  87. To place a definition, use two '-' characters to bound the definition
  88. text.  Both characters must appear on the same line in the ASCII text
  89. file.
  90.  
  91. A cross-reference context string is hidden text embedded in a RTF which
  92. is used to reference hypertext.  Cross-reference context strings must
  93. follow cross-references or definitions strings.  A cross-reference
  94. context string must be enclosed between '[]' characters.  As with the
  95. cross-reference and definition characters, cross-reference context
  96. characters must start and end on the same line in the ASCII text file.
  97.  
  98. To embed '-', '=', '\', '[' and ']' characters, precede them with a '\'.
  99.  
  100. The file DEMOHELP.TXT is included to illustrate the correct text file
  101. format.  To create a RTF file from the demo file, use the following
  102. command-line:
  103.  
  104.     TXT2RTF demohelp.txt demohelp.rtf
  105.  
  106. TXT2RTF will generate a Borland HC compatible RTF file.
  107.  
  108. DEMORTF.EXE is a windows 3.0 program provided to demostrate TXT2RTF
  109. features.
  110.  
  111. If you have any suggestions or corrections, write:
  112.  
  113.     Winefred Washington
  114.     PO Box 3206
  115.     Huntsville, AL  35810
  116.  
  117. or by CompuServe at 72070,3713.
  118.  
  119.