home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / jrc102.lzh / JR-Edit.doc < prev    next >
Text File  |  1991-04-03  |  9KB  |  215 lines
  1. JR-Edit.doc
  2. -----------
  3.  
  4.    JR-Edit is an external phonebook editor for use with JR-Comm 1.02.  It
  5. gives you the ability to import JR-Comm 0.94a .def, .macros and .phones
  6. files for conversion to JR-Comm 1.02 format.  JR-Edit also provides you
  7. with an import facility to convert files that are in "The Final List"(tm)
  8. format.  Lastly, you can print, globaly edit and/or append JR-Comm 1.02
  9. phonebook files.
  10.  
  11.    The program itself is basically the same user interface that exists in
  12. JR-Comm with a few changes and additions.  For this reason, the majority of
  13. operation of the various parameter requesters used in JR-Edit will not be
  14. discussed here.  Only those features that deviate from JR-Comm operation will
  15. be described in this document.  Consult the JR-Comm 1.02 Users Manual for
  16. desciptions of the various parameter requesters and other related functions.
  17.  
  18.  
  19.  
  20. START-UP
  21. --------
  22.  
  23.    JR-Edit begins by searching and loading the the defaults files in the
  24. same exact sequence as JR-Comm, it will NOT load files that are other than
  25. 1.02 format.  JR-Edit is considered to be primarily an external editor for
  26. JR-Comm 1.02, not a converter for other format files even though it does
  27. contain these functions.
  28.  
  29.    Once loaded, JR-Edit will exist on a 16 color custom screen with the
  30. phonebook requester permanently open.  The 16 color screen is required so
  31. that you may edit the color palette for *any* type screen without JR-Edit
  32. requiring the necessary logic to convert to the proper screen type prior
  33. to accessing the color palette requester.
  34.  
  35.  
  36.  
  37. DEFAULT PARAMETERS
  38. ------------------
  39.  
  40.    As with JR-Comm, JR-Edit will resort to the same exact set of default
  41. parameter settings if a jrcomm.def file was not found.  So, you may want
  42. to create your jrcomm.def file with JR-Edit prior to running JR-Comm for
  43. the first time.
  44.  
  45.    Although the phonebook requester is always open, you can still change
  46. the default parameters by opening the respective requester via the items
  47. in the OPTIONS menu.  It is recommended that you set them prior to doing
  48. a 0.94a or TFL import operation so that all the new entries created as a
  49. result inherit the settings that are not explicitly set during the import
  50. itself.
  51.  
  52.    A menu item in the PROJECT menu is provided to import an convert a 0.94a
  53. .def file.  You will still have to do quite a bit of setting on your own due
  54. to the new options that did not exist in JR-Comm 0.94a after completing the
  55. import operation.  It was included primarily for completness.
  56.  
  57.    You will HAVE to import 0.94a format .macros files as well due to a few
  58. differences in macros format and file structure.  A simple read/write 
  59. procedure will provide you with conversion "in place" to JR-Comm 1.02.  Refer
  60. to chapter 11 of the JR-Comm Users Manual for information of the new macro
  61. escapes that are available in JR-Comm 1.02.
  62.  
  63.  
  64.  
  65. IMPORTING 0.94a phonebook files
  66. -------------------------------
  67.  
  68.    The selection gadget labeled "IMPORT" is used for both 0.94a and TFL
  69. format files, only 0.94a files will be discussed in this section, refer
  70. to the next section for TFL files.
  71.  
  72.    Selecting this gadget will open the JR-Comm file requester so that you
  73. may select the desired 0.94a phonebook file and closing the file
  74. requester via the "OK" gadget you are now presented with the IMPORT
  75. selection requester, select 0.94a.
  76.  
  77.    All phonebook entries will be imported and converted to 1.02 format.
  78. The options new to 1.02 that were in effect when you imported the 0.94a
  79. phonebook will be passed on to each entry.  You can now edit each entry
  80. individually or with the global edit function described below.
  81.  
  82.  
  83.  
  84. IMPORTING TFL phonebook files
  85. -----------------------------
  86.  
  87.    The same sequence of operations are used to select and import a TFL
  88. format phonebook.  As with the 0.94a phonebook import function, current
  89. settings in effect will be copied to each phonebook entry created during
  90. the conversion.  Since little information in a TFL phone entry is related
  91. to JR-Comm, almost all the options for each entry will reflect the current
  92. settings of JR-Edit.  Please make sure that everything is set the way you
  93. want it to be before you import a TFL file.
  94.  
  95.    Also note that there are two TFL import options.  The "TFL var." option
  96. is for certain "quasi-compaitble" TFL format phonebooks that lose the first
  97. number of a phonebook when imported with the primary "TFL (tm)" import
  98. option.
  99.  
  100.    The following data are extracted from a TFL phone entry:
  101.  
  102.  
  103.    Item        Column position   # of chars     Details
  104. ---------------------------------------------------------------------------
  105.    Name        1                 15             (all info copied)
  106.    Phone #     20 (19 for var.)  16             (trailing alphas removed)
  107.    Baud        37                5              (max)
  108.    Duplex      43                1              (Full or Half)
  109.    Data len.   44                1              (7 or 8)
  110.    Parity      45                1              (Even, Odd or None)
  111.    Stop bits   46                1              (1 or 2)
  112.    
  113.  
  114.    Since JR-Edit does not contain any sort of search or matching features,
  115. you may want to edit a raw TFL file with a text editor into multiple files
  116. so that you can adjust the default settings (terminal emulation and protocol
  117. being the most common) for each group of entries that you want to import.
  118.  
  119.  
  120.  
  121. PRINT
  122. -----
  123.  
  124.    JR-Edit provides you with a hardcopy print feature.  It does not print
  125. out every setting of a phonebook entry however, only the most important
  126. ones in the following format:
  127.  
  128. Name  PhoneNumber  Password
  129. Baud Duplex BitsParityStop Emulation CRxlate LFxlate EOLout protocol
  130.  
  131. example:
  132.  
  133. Dynalogic BBS 1-609-625-2453 mypw
  134. 2400 F 8N1 IBM Color CRN LFN CR ZMODEM
  135.  
  136.  
  137.  
  138. APPEND
  139. ------
  140.  
  141.    This function will append another JR-Comm 1.02 format phonebook to the
  142. current one.  The LOAD function clears the current phonebook prior to
  143. loading a new one.
  144.  
  145.  
  146.  
  147. SELECT & UNSELECT
  148. -----------------
  149.  
  150.    Works as expected.  Select all or unselect all entries in the phonebook.
  151.  
  152.  
  153.  
  154. GLOBAL
  155. ------
  156.  
  157.    The global editor enables you to set selected entries to settings of
  158. your choosing.  This mode can quickly get you into trouble, so save a
  159. copy of the phonebook to an alternate file prior to making any changes.
  160.  
  161.    The first step is to select the entries that you wish to globally
  162. edit.  Now select the GLOBAL gadget.
  163.  
  164.    You are now greeted with the PHONE ENTRY EDITOR requester, notice that
  165. the string gadgets for name, phone number, capture file, macros file and
  166. password are missing.  You cannot globally edit these portions of each
  167. entry.
  168.  
  169.    The following actions are applied to every entry for this requester:
  170.  
  171.        Length:  If zero, no effect.  Used otherwise.
  172.     Cents/min:  Same as Length.
  173.   Dial Prefix:  If all are "off", no effect.  Selected otherwise.
  174. Password type:  Same as for Dial Prefix.
  175.   Reset Timer:  Each entry will be set to the state of this option, off or
  176.                 on.
  177.  
  178.    Notice that the "mutually excluded" gadget sets (for example, the Dial
  179. Prefix group), are all "off" to begin with.  If they are, then no change
  180. will occur to the selected entries when exiting the PHONE ENTRY EDITOR
  181. requester.  If one is selected, all entries will be updated to this
  182. selection.  If you decide to not use the selected option, toggle it again
  183. and it will turn "off".  This action will only occur during the global edit
  184. mode of operation, it will operate "normally" during a singular edit of a
  185. phonebook entry.
  186.  
  187.    The Reset Timer is an example of an "on/off" option, so, its setting will
  188. be copied over to each selected entry regardless if you have never touched
  189. it.
  190.  
  191.    The SERIAL and XFERS gadgets will open their respective requesters and
  192. operate the same as the PHONE ENTRY EDITOR requester.  The TERMINAL
  193. PARAMETERS requester is a different beast altogether however, so please
  194. pay attention to the following.
  195.  
  196.    The CR xlate, LF xlate, EOL out and Capture filters work the same as
  197. the mutually excluded groups described above.  The Miscellaneous group
  198. of options are all "on/off" gadgets, so you must set the ones you want
  199. on.  The Screen type, Emulation and Text size gadget groups should only be
  200. tinkered with *after* you have selected an emulation.  Remember this!
  201.  
  202.    The four color options at the bottom are all initially set to the
  203. value of 16, this is an invalid color number, so JR-Edit will not set
  204. phonebook entries unless these numbers are something other than 16.
  205.  
  206.    If you find that you've set something that you didn't intend to set or
  207. you wish to start over, just close the requester (SERIAL, TERMINAL or 
  208. TRANSFER only) and then re-open it.  Everything will be reset.
  209.  
  210.    If you decide that you do not want to globally set any of the phonebook
  211. entries, select the CANCEL gadget in the PHONE ENTRY EDITOR requester.
  212.  
  213.    Again, please save your phonebook prior to doing any global editing in
  214. case you muck things up too badly.
  215.