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