home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 2129.dms / in.adf / TextEngine / TextEngine.doc < prev    next >
Encoding:
Text File  |  1993-03-12  |  14.7 KB  |  357 lines

  1.  
  2.           TextEngine V3.4, Copyright Nicholas Harvey, 1992.
  3.  
  4. INTRODUCTION
  5. Welcome to TextEngine, a shareware wordprocessing system for the CBM 
  6. Amiga. I have virtually re-written the entire program since 
  7. version 3.3 so if, in the past, you have used a previous version of 
  8. TextEngine, it is very important that you read this file, as there are
  9. a number of significant changes to the program which you might find 
  10. useful.
  11.  
  12. TextEngine is shareware, and I give my permission for it to be freely 
  13. distributed. If you use it regularly, or are just feeling generous, 
  14. then please help out this poor student and register with me by sending
  15. £5 to the address below:
  16.  
  17.         Nicholas Harvey
  18.         149 Manor Road North
  19.         Thames Ditton
  20.         Surrey
  21.         KT7 OBQ
  22.         England
  23.  
  24. This version of TextEngine has been written to take advantage of some 
  25. of the new features of Workbench 2.04 including the new '3D Look', and
  26. file requesters. If you use TextEngine with WB 1.3 or 1.2, then you 
  27. will not be able to use these features, but the program will still 
  28. function correctly on your system.
  29.  
  30.  
  31. SYSTEM REQUIREMENTS
  32. TextEngine should run on any memory configuration from 1/2 MB chip RAM
  33. upwards. The following files are required to be present on your disk 
  34. for the program to work:
  35.  
  36.    TextEngine3.4.gfx - This contains the various graphical images used
  37.                        by TextEngine and should be in the current 
  38.                        directory.
  39.  
  40. TextEngine3.4.config - This contains the user's prefered setup for 
  41.                        TextEngine which is loaded on startup and used 
  42.                        to configure the program to the user's needs. 
  43.                        This also should be in the current directory.
  44.  
  45.     libs/asl.library - Only WB 2.04 users will need this if they want 
  46.                        to use file requesters with TextEngine.
  47.  
  48.  devs/printer.device - This file is needed for printing, along with 
  49.                        your printer driver, which should be in the 
  50.                        devs/printers directory.
  51.  
  52.       l/port-handler - Also needed for printing.
  53.  
  54. Also included is a program called TE_Converter, which is used to 
  55. convert ASCII files created from previous versions of TextEngine (or 
  56. from other programs) into TextEngine V3.4 format. Instructions on 
  57. using this program can be found in the section 'USING TE_CONVERTER'.
  58.  
  59.  
  60. LOADING TEXTENGINE
  61. From workbench: Simply double-click on the TextEngine icon and the 
  62.                 program will load.
  63.  
  64. From the CLI:   Type: run TextEngine <filename>
  65.                 If you enter the name of a valid TextEngine document 
  66.                 in the filename option, it will be loaded 
  67.                 automatically on startup.
  68.  
  69. If TextEngine fails to load, check the following things:
  70. 1) Make sure that you have enough free RAM to load TextEngine.
  71. 2) Make sure that the TextEngine3.4.gfx file is in the current 
  72.    directory.
  73.  
  74. TextEngine should load if the above conditions are satisfied.
  75.  
  76.  
  77. SETTING UP TEXTENGINE
  78. TextEngine can be configured to suit most people's needs by using the 
  79. following menu selections:
  80.  
  81. TEXT/WORDWAP  - Selecting this toggles the wordwrap on and off.
  82.  
  83. PREFS/PRINTER - Here, the paper margins can be alterd by changing the 
  84.                 values contained in the following boxes:
  85.  
  86. Lines per page: Here you enter the maximimum number of lines that can 
  87. be printed on your piece of paper from top to bottom with no gaps at 
  88. the top or bottom. This is usually set at 70 for A4 paper.
  89.  
  90. Top margin: Enter the number of blank lines you want placed at the top
  91. of the page in here.
  92.  
  93. Bottom margin: Enter the number of blank lines you want placed at the 
  94. bottom of the page in here.
  95.  
  96. If, for example, you specified 70 lines per page with a 5 line margin 
  97. at the top and bottom, then the maximum number of lines on that page 
  98. would be 70-5-5 = 60 lines.
  99.  
  100. Chars per line: Here you enter the maximum number of characters that 
  101. can be printed across the page from left to right with no gaps either 
  102. side. This is usually set at 80 for A4 paper.
  103.  
  104. Left margin: This defines the width of the left margin in characters.
  105.  
  106. Right margin: This defines the width of the right margin in 
  107. characters.
  108.  
  109. PREFS/PALETTE - Here you can change the colours of the editor screen.
  110.  
  111.    PREFS/NTSC - Using this option will toggle between PAL and NTSC 
  112.                 screen heights.
  113.  
  114.  PREFS/MACROS - Here you can assign each of the ten function keys a 
  115.                 string of 100 characters which is entered into your 
  116.                 document each time they are pressed. This can be very 
  117.                 useful when you repeat a word or phrase many times.
  118.  
  119. To save this setup to disk, select PREFS/SAVE PREFERENCES. This writes
  120. all of the above information, except for the macros, to the 
  121. TextEngine3.4.config file. Macros are saved each time you save your 
  122. document so that each document you write has its own set of macros.
  123.  
  124.  
  125. DISK FUNCTIONS
  126. In the FILE menu, there are the following options:
  127.  
  128.       LOAD - Lets you load a file
  129.       SAVE - Lets you save a file
  130. SAVE ASCII - This saves your file in ASCII format. Beware, this option
  131.              sometimes takes quite a long time when saving large 
  132.              files!
  133.     APPEND - Lets you merge a file with the current document. The 
  134.              file is loaded into your document at the cursor position.
  135.      ERASE - Lets you erase a file
  136.        DIR - This feature is only available if you are using WB 
  137.              1.3/1.2, or if TextEngine fails to open the asl.library. 
  138.              It displays the contents of a given directory, and is 
  139.              useful for locating files on the disk.
  140.  
  141. When using TextEngine with WB 2.04, proper file requesters are used to
  142. select a file name for the above functions. Unfortunately, these are 
  143. not available when using WB 1.3/1.2, but instead the user must simply 
  144. type the file name in at the LOAD/SAVE/APPEND/ERASE prompts.
  145.  
  146. TextEngine V3.4 uses its own file format which is incompatible with 
  147. normal ASCII text files. If you want to load an ASCII file into 
  148. TextEngine, then you must convert it first with the TE_Converter 
  149. program (see section called 'USING TE_CONVERTER').
  150.  
  151. If TextEngine fails to carry out a file function for any reason, then 
  152. an error message is displayed. These errors are explained fully in the
  153. section 'AMIGADOS ERROR MESSAGES'.
  154.  
  155.  
  156. EDITING A DOCUMENT
  157. There is a text buffer of 65520 bytes available, which should be large
  158. enough for most purposes. If you want to write larger documents, then 
  159. it might be a good idea to seperate it into smaller sections and edit
  160. these individually. When the text buffer is full, an error message is
  161. displayed. To see how much room there is left in the buffer, select
  162. ABOUT from the PROJECT menu.
  163.  
  164.  
  165. Keyboard input:
  166. Text is entered in the normal way with the keyboard, with the 
  167. following extra keyboard functions being available:
  168.  
  169. SHIFT+RIGHT CURSOR - End of line.
  170.  SHIFT+LEFT CURSOR - Start of line.
  171.    SHIFT+UP CURSOR - Page up.
  172.  SHIFT+DOWN CURSOR - Page down.
  173.             CTRL+T - Top of file (also available in the TEXT menu).
  174.             CTRL+B - Bottom of file. (also available in the TEXT 
  175.                      menu).
  176.             CTRL+C - Centre line. (also available in the TEXT menu).
  177.             F1-F10 - The ten function keys will each insert a user 
  178.                      defined string of text (as defined in the MACRO 
  179.                      editor) into the file.
  180.  
  181.  
  182. On-screen displays:
  183. Along the top of the screen is a ruler with each division representing
  184. one character. The numbers 0 to 9 represent TAB positions, and the 
  185. small white vertical bar represents the maximum width of the page. The
  186. position of the white bar is calculated from the values entered in 
  187. the PRINTER PREFERENCES window. Along the bottom of the screen is a 
  188. status bar which displays the following information:
  189.  
  190.      LINE - The current line at which the cursor is situated.
  191. PAGE/LINE - The current page, and line on that page, where the cursor 
  192.             is located.
  193.        WW - Word wrap status (ON or OFF).
  194.    STATUS - The general status of TextEngine.
  195.  
  196. The PAGE/LINE numbers are calculated using the values entered in the 
  197. PRINTER PREFERENCES window, so that they represent the limits of the 
  198. paper you are using.
  199.  
  200. Eg, Lets imagine you are using A4 paper (70 lines per page), with top
  201. and bottom margins of 5 lines. If the cursor was on LINE 00189, then 
  202. the PAGE/LINE values would be 00004/00009 (4 pages at 60 lines = 180,
  203. plus 9 lines = 189 lines).
  204.  
  205.  
  206. Word wrap:
  207. When the current line becomes longer than the width of the page (as 
  208. defined in PRINTER PREFERENCES), the word wrap comes into action. 
  209. There are two different ways in which the word wrap takes effect:
  210.  
  211. 1) If you are editing the last word on the line, then when the word 
  212. wrap takes effect a new line is created below the current one, and the
  213. last word is pushed onto it.
  214.  
  215. 2) If you are editing the middle of the current line, then when the 
  216. word wrap takes effect the last word of that line is pushed onto the 
  217. beginning of the line below if there is room for it. If there is not 
  218. room for the word on the line below, a new line is created and the 
  219. word is pushed onto that.
  220.  
  221. When the word wrap is turned off (by selecting the TEXT/WORD WRAP menu
  222. option) the full width of the screen is available for editing, and 
  223. text input stops when the cursor reaches the right hand edge.
  224.  
  225.  
  226. Merging 2 lines with the backspace:
  227. Lets imagine you had the following two lines in your file:
  228.  
  229. Jack and Jill went up the hill to fetch a pail of water,
  230. Jack fell down and broke his crown, and Jill came tumbling after.
  231.  
  232. You can now merge the two lines by placing the cursor at the start of 
  233. the second line and pressing the backspace key. The result in this 
  234. instant would be the following:
  235.  
  236. Jack and Jill went up the hill to fetch a pail of water, Jack fell
  237. down and broke his crown, and Jill came tumbling after.
  238.  
  239.  
  240. Cut/copy and paste:
  241. Up to 70 lines can be cut or copied into a buffer and pasted elsewhere
  242. in the document. The procedure for this is quite simple:
  243.  
  244. 1) Place the cursor at the top of the block of text and select MARK 
  245.    TOP from the CUT menu.
  246. 2) Move the cursor down to the bottom of the block, and either select 
  247.    CUT TEXT or COPY TEXT from the CUT menu. This will either cut the 
  248.    block of text from the file into the cut buffer, or just copy the 
  249.    block into the buffer whilst leaving it intact in the file.
  250. 3) Move the cursor to the position you want to paste the block you 
  251.    have just copied, and select PASTE from the CUT menu.
  252.  
  253. Please note that only whole lines can be cut, copied, and pasted.
  254.  
  255.  
  256. Printer styles:
  257. In the STYLES menu are a number of text styles that can be used in 
  258. your document. Selecting an option from this menu inserts the 
  259. corresponding control charater into your file, which, when the file is
  260. printed, tells your printer to turn on that style. The next time the 
  261. same character appears, the printer is told to turn off that style. 
  262. This is true for all styles except for PICA and ELITE, which cancel 
  263. each other out. Take the following line of text, for example:
  264.  
  265. There's simply no match for °TextEngine's° user friendliness!
  266.  
  267. When printed, the first five words are printed normally, then the word
  268. 'TextEngine' is printed in italics, and the rest of the sentance is 
  269. printed normally again. Please note that not all printers support all 
  270. of these styles, but try them out and see for yourself.
  271.  
  272. If you use many styles at once, and want to cancel them together, then
  273. why not use the CANCEL STYLES control character. This cancels any 
  274. styles which are currently selected and returns the printer to normal 
  275. draft mode.
  276.  
  277.  
  278. OTHER FEATURES OF TEXTENGINE V3.4
  279. To print a file, select PRINT from the PROJECT menu. If you need to 
  280. stop printing for some reason, simply click on the CANCEL gadget.
  281.  
  282. Selecting SLEEP from the PROJECT menu returns you to the Workbench 
  283. and reduces TextEngine to a small window at the top of the screen. In
  284. doing this, about 50kB of chip RAM is released and TextEngine will let
  285. other tasks get on with what they are doing without taking up valuable
  286. processor time. To return to the editor screen, make sure the small
  287. TextEngine window is selected, and then press the right mouse button.
  288.  
  289. In the TEXT menu is the WORD COUNT option. Not only does this count 
  290. the words in the document, but also the lines and pages too.
  291.  
  292.  
  293. USING TE_CONVERTER
  294. Supplied with the main TextEngine program is a much smaller program 
  295. called TE_Converter. This is used to convert any ASCII text file to a 
  296. format that is compatible with TextEngine V3.4. To use it, simply 
  297. follow these steps:
  298.  
  299. 1) Type in the file name of the ASCII file in the box labeled INPUT 
  300.    FILENAME.
  301. 2) Type in the filename that you want the new file to be saved as in 
  302.    the box labelled OUTPUT FILENAME.
  303. 3) Click on the PROCESS gadget, and the old file will be loaded, 
  304.    converted, and a new file created, completely automatically.
  305.  
  306. Any errors displayed in the title bar of the window are explained 
  307. briefly in the 'AMIGADOS ERROR MESSAGES' section of this file.
  308.  
  309.  
  310. AMIGADOS ERROR MESSAGES
  311. If an error occurs when accessing a file with TextEngine or 
  312. TE_Converter, and AmigaDOS error number is displayed. Here is a list 
  313. of the meanings of most errors that might occur.
  314.  
  315.         Error | Meaning
  316.         ------+--------------------------------
  317.         202   | Object in use
  318.         203   | Object already exists
  319.         204   | Directory not found
  320.         205   | Object not found
  321.         212   | Object not of required type
  322.         213   | Disk not validated
  323.         214   | Disk write-protected
  324.         218   | Device not mounted
  325.         221   | Disk full
  326.         222   | File is protected from deletion
  327.         223   | File is protected from writing
  328.         224   | File is protected from reading
  329.         225   | Not a DOS disk
  330.         226   | No disk in drive
  331.  
  332.  
  333. FINAL NOTE, THANKS, AND HELLOS
  334. Well, I hope you enjoy using TextEngine. Not bad for a fivers worth of
  335. software, I think!
  336.  
  337. Many thanks for the support I have had from the following people:
  338. John Reece, Micheal Amoah, Paul Burnham, M Rhodes, C Ralfe, Ian 
  339. Rawlings, G Lambert, S May, Stan Davey, R Evans, P Sullivan, David 
  340. McClay, E Berney, John Ellis, J Jarret, Gary Shaw, R Chambers, P Berg,
  341. Peter Stubbs, Graeme McGibbon, D Simons, Len Mullenger, Alan Lingard, 
  342. Christopher Jones, Sheila Walsh, Pauli Hietala (hello Finland!), 
  343. Andrew Chambers, A Gravener, C Wellman, R Minns, Ken Spry, 17 Bit, 
  344. Deltrax, David Aslett, Bill Sloan, Keith Pang, D Davies, Victor Hunt, 
  345. J Bryer, B Wyatt, Ernest Wilson, Larry Cashill, Dennis Brunskill, Roy 
  346. Pearson, N Peters, Colin Curtis, W Davies, Tony Campbell, T Dullage, 
  347. Frank Mitchell, Jim Finney, Graham Adair, Tony Davies, R Robertson, 
  348. Marcus Ong, Ian Ridehalgh, and C M Stacey.
  349.  
  350. Usual hellos go to: Mark Higgins, Martin Guy, Gary Taylor, Warren 
  351. Saunders, Glen Batchelor and the Friday night gang! Yo dudes to 
  352. everyone at JS Surbiton (especially Denise Frewin), and farewell to 
  353. Esher College (particularly Dave and Jean of the Physics department!)
  354.  
  355. Signed: Nick (2/8/92)
  356.  
  357.