home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / util / conv / Easy_Guide.lha / Easyguide / Easyguide.doc < prev    next >
Encoding:
Text File  |  1997-02-02  |  4.6 KB  |  205 lines
  1.  
  2. <****>"Usage"
  3.  
  4.                                  Easy Guide
  5.  
  6.                      v 1.35 (c) 1997 Christopher Mulready
  7.  
  8. Copyright:-
  9.  
  10. May not be used for commercial purposes without my written permission
  11.                                         ^^^^^^^ 
  12.  
  13. IMPORTANT!
  14. Make sure you have amigaguide.datatype in your datatypes (drawer)
  15. or multiview wont work it.
  16.  
  17.  
  18.  
  19. Easy Guide is I hope the easiest way to creat Amigaguide docs
  20. When you run Easy Guide you will be presented with an .asl file selector.
  21. just choose the text file you want to convert then choose the destination
  22. for your newly created guide, and hey presto! its done!! :-))
  23.  
  24. For any of you who do not get the asl.filerequester you can type from CLI
  25.  
  26.  1> easyguide Path:text.doc path:text.guide
  27.  
  28. Where Path:text.doc is the name of your text to be converted and
  29. Path:Text.guide is the path and the name of the guide to save as.
  30.  
  31. Just to show you how east it is.. when you quit from this text, run easyguide
  32. and convert this text file.
  33.  
  34. When you have done it you MUST!! read through this text file again
  35. and make sure you read all of this!! text and not the .guide version
  36. or you will get confused as this is just a demonstration for your benifit.
  37. and take note of the 2 markers below using the <*>.
  38. one has 4(begining) the other has 6 (end), always leave an empty line between
  39. the end and begining of a new section as below.
  40.  
  41. <******>
  42.  
  43. <****>"Preparing your doc"
  44.  
  45. Start your favorite text editor and load in your text.
  46.  
  47. All you do now is mark the begining and the end of each chapter in your text
  48. like so..
  49.  
  50. <******>
  51.  
  52. <****>"Demo Title"
  53.  
  54. The marker above with 4 starts * is the begining of your chapter and the title
  55. The title also is used as the name of your button in the Amigaguide.
  56.  
  57. The marker below with 6 stars * marks the end of the chapter
  58. notice that there are 4 * at the top and 6 * at the bottom, dont forget
  59. the < >
  60.  
  61. <******>
  62.  
  63. <****>"To sum up"
  64.  
  65. If you go back to the original text file you will notice markers made up
  66. from a combination of stars ** and < > with the title of the chapter 
  67. inside The "  " quotes.
  68.  
  69. Just seperate your sections or chapters with these markers and Easy Guide
  70. will do all the hard work.
  71.  
  72. <******>
  73.  
  74. <****>"Troubleshooting"
  75.  
  76. IMPORTANT!
  77. I have successfully tested Easyguide on an A1200 by formating a blank disk
  78. creating a libs(drawer) with the asl.library only! inside libs 
  79. and Easyguide in the root directory.
  80.  
  81. Now booting from this disk into CLI I now type  1>easyguide  
  82. The asl.filerequester appears and easyguide works! fine.
  83. Try this method before giving up! if this works then your asl.library on
  84. your sys: in not in your path or easy guide requires the asl.library V39+
  85. in which case you maybe only able to use it from CLI.
  86.  
  87.  
  88.  
  89.  
  90. If you have any trouble using Easy Guide E-mail me at the address below.
  91.  
  92. E-mail: chris_mulready@nemesis.ie
  93.  
  94. Ph +353-1-8429248
  95.  
  96. Address
  97.  
  98. 88 Patrick Pearse Tower
  99. Ballymun
  100. Dublin 9
  101. Repubic of Ireland.
  102.  
  103. <******>
  104.  
  105. <****>"To do list"
  106.  
  107.  
  108.  
  109.                            What To Do Next!!
  110.  
  111.  
  112.  
  113.                    more bug testing!
  114.  
  115.             Get rid of the empty guide button
  116.  
  117.            And maybe some of your suggestions
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133. E-mail: chris_mulready@nemesis.ie
  134.  
  135. Ph +353-1-8429248
  136.  
  137. Address
  138.  
  139. 88 Patrick Pearse Tower
  140. Ballymun
  141. Dublin 9
  142. Repubic of Ireland.
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152. <******>
  153.  
  154. <****> "Bug Fix's v1.1 - v2.35 (silly! me)"
  155.  
  156. I made a seriouse boo in 1.1 onwards
  157.  
  158. I Had Easyguide reserve a BUFFER of 3meg!! WOW!! realy very bad!
  159. unless you had about 4mgs easyguide would not work for you.
  160.  
  161. Now it only needs a 100k buffer Phew! and will work fine
  162.  
  163. Easyguide works 100% with a minimal resouces
  164.  
  165. Example:
  166.  
  167. I have successfully tested Easyguide by formating a blank disk
  168. creating a libs(drawer) with the asl.library only! inside libs 
  169. and Easyguide in the root directory.
  170.  
  171. Now booting from this disk into CLI I now type  1>easyguide  
  172. The asl.filerequester appears and easyguide works! fine.
  173. Try this method before giving up! if this works then your asl.library on
  174. your sys: in not in your path or easy guide requires the asl.library V39+
  175. in which case you maybe only able to use it from CLI.
  176.  
  177. I got rid of that nasty! space that appeared in the title string.
  178.  
  179. alot of you were finding it hard to load converted amigaguide text in to
  180. multiview.
  181.  
  182. The only solution I could find was to ensure that you have the
  183.  
  184. Amigaguide.datatype 
  185.  
  186. in your Datatypes (Drawer)
  187. Without it you get errors 
  188.  
  189. tested with
  190.  
  191. asl.library V39.4
  192.  
  193. amigaguide.datatype V39.15
  194.  
  195.  
  196. Please note the extra 4 * and <> and 6 * and<> and " " at the bottom
  197. include these for now
  198. Leave at least 1 empty line before each section.
  199.  
  200. <******>
  201.  
  202.  
  203. <****>" "
  204. include this section in all your guides you may however delete this line only.
  205. <******>