home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / wp_dtp / tguide15.lha / TextGuide / TextGuide.doc < prev    next >
Text File  |  1993-07-31  |  5KB  |  143 lines
  1.  
  2. $VER: TextGuide v1.5 Doc (31.07.93)
  3.  
  4.                                __  ___
  5.                                |_)( |_)
  6.                                |  _)| \
  7.                            S O F T W A R E
  8. ______________________________________________________________________
  9.  
  10.    Presents: TextGuide
  11. Description: Converts AmigaGuide files into standard Ascii files
  12. Requirement: All Amigas
  13.     Version: 1.5
  14.        Date: 31/07/93
  15.  
  16.       Status: Freeware.   
  17. Contribution: n/a
  18.  
  19.  Acknowledge: Amiga E, Wouter van Oorterssen; AmigaGuide, 
  20.               Commodore-Amiga Inc.; Spot, Nico François;
  21. ______________________________________________________________________
  22.  
  23. Please note, TextGuide requires titles and nodes to be quoted:
  24.  
  25.   Node "Name" "Title"
  26.   Title "Title"
  27.  
  28. Faliure to do this will result in the nodes NOT being converted when
  29. TextGuide is run.
  30.  
  31. Brief ________________________________________________________________
  32.  
  33. TextGuide is a small utility which converts AmigaGuide files into
  34. Ascii files suitable for reading with any file reader such as More
  35. etc.  It is also useful for people who already have AmigaGuide, but
  36. wish to view the doc files in Ascii format where the .doc file has not
  37. been supplied.
  38.  
  39. o Version 1.4 includes ability to find the title from the '@node'
  40.   commands.
  41.  
  42. Usage ________________________________________________________________
  43.  
  44. To use the program, you must supply it with two parameters.  The file
  45. you want to convert, and the destination or to file.  Once you have
  46. done this, the file will be converted.
  47.  
  48.  1> TextGuide Spot.Guide Spot.text
  49.  
  50. This would convert the mail tosser Spot's AmigaGuide documentation
  51. into an Ascii file called `Spot.text', although this is pointless as
  52. a Spot documentation file in Ascii is already supplied!
  53.  
  54.    After calling the program you will see many lines appearing,
  55. telling you what is happening:
  56.  
  57.  TextGuide © 1993 PSR Software
  58.   found command: line removed
  59.   found command: ignored due to context
  60.   found command: ignored due to end of line
  61.   found command: saving title: done
  62.   found command: saving title: removed due to end of line
  63.   found embedded: saving button
  64.   found embedded: removing
  65.   found command: embedded: saving button
  66.   found command: embedded: removing
  67.  
  68. The 'found command' line simply means that the first character on a
  69. line is a '@' as used by AmigaGuide.  If the character directly after
  70. that is an alphanumeric character, the whole line will be removed, as
  71. this will mean the line contains a '@node main' or other command.
  72. Before the lines is removed, it is tested to see if it is a 'title'
  73. line.  If it is, the contents of the quotes are saved in the folling
  74. format:
  75.  
  76. * CONTENTS OF THE QUOTES IN UPPERCASE
  77.  
  78. This will occur is either '@title "Title"' or '@node "Name" "Title" is
  79. found.
  80. If a line feed character is found whilst the program is looking for
  81. the quotes title information, 'removed due to end of line' will be
  82. shown.
  83.    'ignored due to context' means that the character after the '@' is
  84. a space, and so the line is not removed.
  85.    'ignored due to end of line' occurs when an end of line follows the
  86. '@' character, this doesn't occur very often!
  87.    'found embedded' means that an embedded command has been found,
  88. these begin with the characters '@{'.  If no quotation marks are found
  89. within the { and }, the whole embedded command is removed and
  90. 'removing' is displayed.  If, for a button for example, quotation
  91. marks ARE found, their contents are translated to upper case and
  92. written to the 'to' file and 'saving button' is shown.  The button
  93. will be converted to uppercase before being saved to the destination
  94. file.
  95.    Sometimes, when embedded commands are at the first character of a
  96. line, they will be confused with standard commands, and it is only
  97. when the second character is read that they can be distinguished.  In
  98. the case that it is an embedded command, 'found command: embedded'
  99. will be shown, followed by the 'saving button' or 'removing' depending
  100. whether any quotation marks are found.
  101.  
  102. Once the program has finished, the new file is ready for reading, and
  103. may be viewed with any text reader.
  104.  
  105. Note, due to the way AmigaGuide files are layed out, the order may be
  106. incorrect in the translated file, this cannot be helped!
  107.  
  108. Future Enhancements __________________________________________________
  109.  
  110. o Conversion of style changers (italic, bold, underline) into Ansi
  111. codes (by way of command line option).
  112. o Optional removal of 'index' node (suggested 23/07/93 Daniel Smith)
  113.  
  114. Disclaimer ___________________________________________________________
  115.  
  116. o I am not responsible to any damage caused through the use or misuse
  117. of this product and so it must only be used at your own risk.  All
  118. efforts have been made to ensure the stability of the program but
  119. this does not mean it is 100% safe.  Please backup any important data
  120. that could be damaged through the use of this software until you are
  121. sure that it is stable...
  122.  
  123. Donations/Comments ___________________________________________________
  124.  
  125. Any comments or donations can be sent to:
  126.  
  127.  PSR Software
  128.  Paul Ruane
  129.  26 Birdwood Close,
  130.  Selsdon, Surrey.
  131.  CR2 8QG.
  132.  
  133. I may also be contacted at the following addresses as Paul Ruane:
  134.  
  135.  Fidonet_____
  136.  2:253/516.12
  137.  2:252/149.3
  138.  
  139.  Amiganet____
  140.  39:135/13.12
  141.  
  142. _________________________________________________________________NULL_
  143.