home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / pse_lang.zip / helpfile.zip / genhelp.ipf < prev    next >
Text File  |  1997-10-21  |  17KB  |  260 lines

  1. :h1 res=2.General Help
  2. :i1.General Help
  3. :p.:p.Click on &odq.Search&odq. to find help on any particular item.
  4. :p.:p.Most of the controls have a tip on the message bar at the bottom of the screen and are otherwise 
  5. pretty well understood by most experienced computer users. If you look down there you'll see the 
  6. tips as you move your mouse over the menu's and buttons. If you don't look down there you'll 
  7. actually be able to see what you're doing and hit the mark most of the time with your mouse clicks.
  8. .*********************************************************
  9. :h2 res=21.Bubble Help
  10. :i1.Bubble Help
  11. :p.BUBBLE HELP
  12. :p.As the mouse passes over the toolbar, textboxes popup to help identify each button.  
  13. This can be toggled on or off from the "Settings" dialog. The bubble help boxes close 
  14. when the mouse returns to the edit window or they time out. If the mouse movement 
  15. is too quick (generally sliding sideways and down) sometimes they will not toggle off 
  16. as they may be to quick for the trap that awaits them. In this situation they will still 
  17. only remain on for a few seconds and then toggle off automatically. The bubble help 
  18. seemed to lose it's bearings during testing when there were many resizing events 
  19. performed back to back. This shouldn't occur during normal useage but if it does just 
  20. maximize the window and it should correct itself. 
  21.  
  22. :h2 res=22.Changing Colors
  23. :i1.Changing Colors
  24. :p.CHANGING COLORS
  25. :p.The color selection utility allows you to choose from a sixteen color palette. 
  26. The utility will show the example text in the colors you choose by clicking on a selection 
  27. from the Foreground and Background listboxes. You may elect to "SET" new colors or 
  28. "Cancel" a color change. Be aware that if you hit the "SET" button without choosing new 
  29. colors the edit window will set to the default Black on White mode.
  30. :ul.
  31. :li.SET - If you decide to keep a new color selection, click on "Set" and the new selection will be saved.
  32. :li.APPLY - To preview your selection in the Enhanced EE Editor window click on "Apply". 
  33. This is sort of the "Free home trial" of color selection. The colors you apply will not "stick" 
  34. until you click the "Set" button. Choose as many combinations as you like and preview them.
  35. :li.CANCEL - If you decide you don't want to change, click on "Cancel" and your original colors 
  36. will be cheerfully refunded.
  37. :li.HELP - Brings a small popup help panel.
  38. :li."I WANT A DIFFERENT COLOR!" - The Enhanced EE Editor will support more (up to 16 million) 
  39. colors for the background through drag and drop actions from your desktop Color Palette if your 
  40. monitor/video card will allow it. First choose the text or "ForeGround" color from the built in "EEE 
  41. Color Palette" then open the "OS/2 System Color Palette", choose or edit a color and drop it on 
  42. the edit window. The new color will be saved in the ini file. If you change your text or "Foreground" 
  43. color AFTER dropping from the color palette you'll end up with one of the sixteen base colors and 
  44. have to re-drag and drop your new background.
  45. :eul.
  46.  
  47. :h2 res=23.Changing Fonts
  48. :i1.Changing Fonts
  49. :p.CHANGING FONTS
  50. :p.Press the "Font" button on the toolbar or on either menu select "Options", "Set", 
  51. "Set Font" to open the font dialog. Choose your new font from the font dialog and
  52. click "OK". The new font setting will be saved. Notice that the edit field and history
  53. combobox can have two different fonts and must be changed separately. The history 
  54. combobox font dialog is accessed from the "Settings" dialog.
  55.  
  56. :h2 res=24.Changing Settings
  57. :i1.Changing Settings
  58. :p.CHANGING SETTINGS
  59. :p.When the settings dialog opens you will notice that you can toggle the WordWrap on/off, 
  60. set the TabStop, turn AutoSave on/off, set the File History Limit, toggle the bubble help, 
  61. add a name for inserting and find a signature file for insert. Notice also that the file statistics
  62. (EE only, EEE file stats are in the  "Find, by Line#" menu item) are updated as you edit. 
  63. When finished selecting your settings press the exit button and the settings will be in effect.
  64. :ul.
  65. :li.WORD WRAP - Toggles WordWrap on or off. This may also be toggled from the menu.
  66. :li.TABSTOP - Sets size of the tab in the editor in characters.
  67. :li.AUTOSAVE - Toggles AutoSave on/off and sets the interval in minutes between saves. The 
  68. spin button selects the number of minutes between automatic saves or you can type the number 
  69. in. It is only enabled when the "AutoSave" checkbox is checked. The light just to the left of the 
  70. File History combobox will light up during any disk activity the EEE creates. AutoSave is available
  71. only in the EEE editor. Be careful using AutoSave, it saves mistakes too... (EEE)
  72. :li.HISTORY LIMIT - Sets the limit of file names and locations that are tracked in the File History 
  73. combobox. The limit was installed as a measure against having an ini file with so many names 
  74. that it degrades loading performance and creates a huge unusable combobox. Set it to suit your 
  75. taste and cpu. The shareware version of EEE has a built in limit of 10 History Files stored the full 
  76. version has no limit. (EEE)
  77. :li.HISTORY FONT - Opens the font dialog to set a new font for the History combobox. (EEE)
  78. :li.NAME - Enter the name to be used for "Insert - Name" (EEE)
  79. :li.SIG FILE - Enter the full path to the signature file to be used for "Options - Insert - Sig File..." 
  80. or click on "Browse" to locate one. (EEE)
  81. :li.BUBBLE HELP - As the mouse passes over the toolbar, textboxes popup to help identify each 
  82. button. This setting toggles bubble help "On" or "Off". (EEE)
  83. :li.CONFIRM SAVE - Uncheck to turn "File saved" dialog OFF after saving a file.
  84. :li.CONFIRM CLOSE - Uncheck to turn "Do you want to Exit?" dialog OFF at program exit.
  85. :li.CHANGED FILE - Uncheck to save changed files automatically at program end with no confirmation.
  86. (Dangerous... best left ON)
  87. :li.PRESENTATION - Uncheck to turn "Toggle Presentation mode with ctrl+p" OFF when switching
  88. to Presentation Mode.
  89. :eul.
  90. :h2 res=25.Search Functions
  91. :i1.Search Functions
  92. :p.SEARCH BY KEYWORD OR LINE # (EEE only)
  93. :p.Searches in documents can take on two forms.
  94.  
  95. :p.SEARCH BY KEYWORD - The search dialog for text lets you key in a word in the "Find" field and 
  96. if desired the "Change to" field allows you to change the search word by confirming the change or 
  97. by electing to change all instances of the word from the present cursor position to the end of the 
  98. document. Once the search stops on the object word of its' search you can "Cancel" to end the 
  99. search or click "Find" again to search for the next instance of the word in question.
  100.  
  101. :p.SEARCH BY LINE # - The search dialog for "Line #" searches shows you the number of characters 
  102. in the file and the number of lines. In the Enhanced EE a line is defined as a string of characters 
  103. located on the same row as opposed to a string that ends in a carraige return/line feed pair. If you 
  104. turn off the wordwrap you can see just how long a true line can actually get in some cases. The 
  105. spin button will only allow you to choose a legal line #. You may also key in any legal number in 
  106. the spin button field. When the selection is made click on "Goto Line #" to search or "Cancel" to 
  107. close the dialog without a search. (EEE)
  108.  
  109. :h2 res=26.Presentation Mode
  110. :i1.Presentation Mode
  111. :p.PRESENTATION MODE
  112. :p.One of the truely neat things about IBM's WebExplorer was its' Presentation Mode. I used it 
  113. all the time, It was so nice to sit and read without so much clutter all around. I only wish Netscape 
  114. had thought to do the same. The Enhanced EE Editor is equipted with a presentation mode that 
  115. takes the edit window to the full extents of your screen. It's not flashy, there is nothing else to 
  116. see, BUT... there is no clutter, just the text loaded in the editor. You can still do almost everything 
  117. you could do from the main window but all commands go through the popup menu or the Hot keys. 
  118. Just right click anywhere on the screen for the popup. You can toggle the presentation mode on &. 
  119. off with the "Control+p" key combination or from the menues.
  120.  
  121. :h2 res=27.Multiple Language Support
  122. :i1.Multiple Language Support
  123. :p.MULTIPLE LANGUAGE SUPPORT
  124. :p.Beginning with Beta v.11 the Enhanced E's offer multiple language support. At this point 
  125. only the menu items and bubble help text can be changed. The editors look each time they start 
  126. for a file called "LANGUAGE". If the file exists then it is read into a stem variable and the menu 
  127. items are updated with their new names. There is a template for translation available at the 
  128. PillarSoft website called PseeLang.zip. It has about 65 commands to interpet. If you decide to 
  129. try it, let me know of the outcome.
  130.  
  131. :h2 res=28.Html Stripping Support
  132. :i1.Html Stripping
  133. :p.HTML CODE STRIPPING SUPPORT
  134.  
  135. :p.Stripping html code is easy right from the desktop once you plug in HTM2TXT. 
  136. The htm2txt1.zip file can be downloaded from the PillarSoft site, Hobbes or any of the 
  137. usual OS/2 FTP sites. Just copy the "Htm2TxT.cmd" file into the Enhanced E directory 
  138. and the Enhanced E's will do the rest. Load any html (or htm) file and click "Strip Html" 
  139. or hit the hot key "Ctrl+h". The red light beside the history list will glow while Htm2Txt 
  140. is quietly working. Be aware that a large file will take a few seconds to be processed. 
  141. The TXT version of the file will be saved with the original html files' name and a ".txt" 
  142. extention in the original files' directory.
  143.  
  144. :p.Htm2Txt has command line options if you want to investigate it further. The editor sends 
  145. commands that limit it to processing only the object file but it will allow chaining of any 
  146. files mentioned in the object htm file plus a few other little goodies.
  147.  
  148. :p.Otto Raeder, the writer of Htm2Txt, has done a real nice job with this utility. 
  149. It would have taken alot of work to do what he has done so rather than reinvent 
  150. the wheel I asked Otto if I could include his code in this editor. He graciously said 
  151. "Go for it" but rather than do it that way (I'd feel like a kid cheating on an exam!) 
  152. I decided just to make the Enhanced EE work with it like a plugin so I won't be 
  153. inadvertantly taking credit for his work. He distributes it freely and I would like to 
  154. say thank you anyway to Otto, and thanks from the OS/2 community for all your work.
  155.  
  156. :p.In keeping with the free nature of Otto's work the HTM2TXT command file has been 
  157. incorporated into the freeware version of the Enhanced E also. Hopefully this combo 
  158. will get alot of good, hard use out of the users of OS/2.
  159.  
  160. :h2 res=29.Drag and Drop
  161. :i1.Drag and Drop
  162. :p.DRAG AND DROP
  163. :p.The Enhanced E's now support;
  164. :ul.
  165. :li.Dropping text files onto the desktop icon to start the editor with the selected text file 
  166. loaded.
  167. :li.Dropping text files on the edit window while the editor is running. When a file is dropped 
  168. on the edit window you will be asked if you wish to save the previously loaded file before 
  169. the newly dropped file is loaded. The editors will only accept complete "plain text" files that 
  170. physically exist somewhere on your drive.
  171. :li.Dropping text from other locations inside the edit window causing it to be rearranged.
  172. :eul.
  173. :p.You may now also drag selected (highlighted) text to;
  174. :ul.
  175. :li.Another editor or application that accepts dropped text.
  176. :li.The printer object. Makes sending a file to a different printer or fax easier than changing 
  177. to another driver. With the file loaded just click on "Select All" and drag the file to your 
  178. selected printer object.
  179. :li.The desktop to save snippets of information in temporary files. Each file dropped on the 
  180. desktop gets a unique temporary name (up to one thousand unique names) that you can rename 
  181. whatever you please. TIP: An easy way to rename icons (and the filename with it) is to hold 
  182. down the <alt> key while left clicking the mouse on the icon. After editing the title, click the 
  183. mouse elsewhere on the desktop to close the icons' entry field and save the new name.
  184. :li.Another location inside the edit window to "Move" text from place to place or to "Copy" text
  185. (by holding the <Control> key down while dragging) to another location in the editing field.
  186. :eul.
  187.  
  188. :h2 res=30.Code Templates
  189. :i1.Code Templates
  190. :p.CODE TEMPLATES
  191. :P.The registered version of the Enhanced E has a bonus code template tool built in. The template
  192. tool is outside the original scope of what the Enhanced E was to become but it seemed to be a
  193. nice enhancement to the editor and will remain.
  194. :p.To use the code template tool you must have code files installed in the Enhanced E directory.
  195. (available free at the PillarSoft website or you can build your own) Select the "Code Templates"
  196. menuitem fron the "Options" menu, a file dialog will open listing all the template files available in
  197. the Enhanced E directory, chose one and the code template will open with your selection. There
  198. are three ways to transfer code from the template tool to the editor&colon.
  199. :ul.
  200. :li.Double click on the entry you wish to use, it will be sent to the current cursor postion in the
  201. editor. This is by far the easiest method of transferring your choice to the edit window and one
  202. that is not implemented by any other editors that I know of. Double clicking will only send code 
  203. to its' parent editor so if you have two or more instances of the Enhanced E running you may 
  204. also run two or more different code types and they will only send information to their individual
  205. editors.
  206. :li.Highlight your choice, choose "Create link to clipboard" from the popup or "Options" menu and
  207. paste it into the editor. (always pastes to current cursor location)
  208. :li.You may also drag a snippet to the location of your choice in the editor. This is a very powerful
  209. method of inserting code exactly where you want it.
  210. :eul.
  211. :p.The template tool is extendable to allow it's use for many types of code or general information
  212. insertion. It follows a format widely used by other applications that will allow use of code from the
  213. other apps as well as making these code lists available elsewhere.
  214. :p.You can set up your own templates, add them together, modify them or even make templates
  215. that list taglines or jokes. It's up to you! If you have templates you would like to share with others,
  216. we can make them avaiable for you on the PillarSoft website.
  217.  
  218. :h2 res=40.Text to IPF
  219. :i1.Text to IPF
  220. :p.TEXT TO IPF
  221. :p.Registered users will find the Text to IPF conversion selection in the menu under "Options".
  222. :p.Open the text file you wish to convert and select "Text to IPF". A progress indicator will pop up
  223. and after the work is done the file will be saved in the same directory with, the same root filename,
  224. the extention ".ipf" and it will automatically load the ipf file into the editor. This conversion, along
  225. with the IPF code templates will give you a good start on converting existing files to help files or
  226. online books etc.
  227. :p.It is a work still in progress and is very slow as of yet.  Because it has to test every character
  228. of the file, a 10k file can take up to a minute to do. Of course it still beats doing it by hand all to heck.
  229. Try a small file first so you know what to expect. On a p120 here we only get about 9k/minute.
  230. :p.We may add a compile button etc. to call the IBM Information Presentation Facility for compilation
  231. if there is enough interest.
  232. :ul.
  233. :li.Change the title lines to suit your needs.
  234. :li.The IPF compiler doesn't like long lines. Shorten any long ones with carraige returns.
  235. :li.The IPF conversion runs on it's own thread but we may drop the thread priority in the future. It really
  236. pegs the cpu meter while it's hashing away. Let us know what your thoughts are.
  237. :eul.
  238.  
  239. :h2 res=41.Errata
  240. :i1.Errata
  241. :p.ERRATA
  242. :p.FILE CHAR COUNT - Located in the "Settings"(EE) or the "Find - by Line#..."(EEE) 
  243. dialog the total number of characters in the currently loaded file is displayed.
  244. :p.FILE LINE COUNT - Also located in the "Settings"(EE) or the "Find - by Line#..."(EEE) 
  245. dialog the total number of lines in the currently loaded file are displayed. Notice that 
  246. if the file uses long lines you may have to set WordWrap "off" to find the correct line 
  247. referenced by a compiler error comment etc.
  248. :p.The <Ctrl>+<Home> key combination will take you to the top of the file.
  249. :p.The <Ctrl>+<End> key combination will take you to the end of the file.
  250. :p.When saving a file that has the "Read Only" bit set, the editor says the file is saved when
  251. in all actuality the editor cannot overwrite it. It is safest to leave it that way but is this 
  252. something I should add the option of overriding?
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.