home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / guide / gguide2txt.lha / Gguide2txt.doc < prev    next >
Encoding:
Text File  |  1995-01-31  |  2.6 KB  |  70 lines
  1. Guide2txt  by John Marchant (aka 'Gnome')   Version 1
  2. =========
  3. Purpose
  4. --------
  5.   To convert amigaguide files into "normal" ascii text, and insert pagefeeds
  6. every n lines - where n is 63 by default, but can be changed by a command
  7. argument.
  8.  
  9. Usage
  10. -----
  11.   Gguide2txt <input guide filename> <output filename> [lines per page]
  12.  
  13. The two filenames must include the path. Lines per page is 63 by default.
  14. If pagefeeds are not wanted, enter [lines per page] as zero.
  15.  
  16. If the input file is not a guide, it will be unchanged on the output
  17. file (except for the pagefeeds).
  18.  
  19. Background
  20. -----------
  21.  Guide files usually irritate me.  The concept is fine, but it is often
  22. very difficult to find the information I want, particularly if there is a
  23. poor index or no index.  One of the problems of looking up something is
  24. that you don't always know what you need to look up.  I liken using a guide
  25. to searching a dark room with a torch.  You have to keep spotlighting small
  26. areas and inspecting them. But with a "proper document", you can bring it
  27. into your favourite editor (I use CygnusEd), and scroll up and down, so
  28. easily gaining a broader picture. You are now floodlighting your room!
  29. You CAN do this with a guide file, but it's so messy.
  30.  
  31.  So I tried several converter programs, and none of them satisfied me.  One
  32. of them put in pagefeedsafter every node.  And since this guide then had
  33. many pages with only a few lines on them, the converted file produced yards
  34. of blank paper when I printed it.
  35.  
  36. Features
  37. ---------
  38. There may be a few "unwanted features". The only one I know of at present
  39. is the treatment of lines like the following in MRB_Backups.guide.
  40.  
  41. @{" The Backup File Selector " 
  42.         ALink "MRBackup:Help/MRB_FileSelector.guide/main" }
  43.  
  44. This becomes, in the converted text:-
  45.  
  46.  The Backup File Selector         ALink "MRBackup:Help/MRB_FileSelector.guide/main" }
  47.  
  48. i.e. When a link is split onto a new line, the program flow malfunctions.
  49.  
  50. Since lines like this only occur in 2 guides out of about 50 that I tested,
  51. I decided to take no action at present.  I might attend to this is a later
  52. version.
  53.  
  54. Also, linewrap is not implemented at present. If I can summon the interest
  55. and energy, I'll do something about this one day. Not many guides seem to
  56. use long lines, anyway.
  57.  
  58. Any Problems
  59. --------------
  60.   I don't really want to make a big thing of this little utility I knocked
  61. up for my own use; but if you really want to contact me, you can send a
  62. message to:
  63.  
  64.  Fidonet: 2:2500/167.15     usenet: gnome@martinac.demon.co.uk
  65.  
  66. Or you can send Fax or Fidonet crash mail to my BBS on +44 01234 212752.
  67. "Moonlight BBS" is open to receive ONLY between the hours of 18:00 and
  68. 08:00 UK time.
  69.  
  70.