home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / COMMS / READ45A / READCIX.TXT < prev    next >
Encoding:
Text File  |  1995-05-04  |  19.2 KB  |  435 lines

  1.                               ReadCIX      v4.5
  2.  
  3.  
  4. An Offline message reader for CIX for the Psion Series 3a Pocket computer.
  5.  
  6. Sales.
  7. ######
  8.  
  9.  This product is Shareware.
  10.  
  11. If you find this product useful  please register it. Registration will remove the Nag screen and  provide the latest version, plus automatic upgrades. There is a 20 day evaluation period, after which the program  will only display the Nag screen.
  12.  
  13. To register send a cheque for UKP12.00  to
  14.  
  15.      D.Keppler
  16.      1 Field Close
  17.      Beyton
  18.      Bury St Edmunds
  19.      Suffolk
  20.      IP30 9AB
  21.  
  22. Or register on Compuserve under SWREG Number 4515 for $25
  23.  
  24. Upgrading
  25. ##########
  26.  
  27. For versions before 4.2 please remove all ReadCIX files and install this version in the new directories. Users of 4.2 and above must delete the configuration file and install the new programs and scripts over the older versions.
  28.  
  29. Introduction. 
  30. #############
  31.  It is important to remember the concept behind ReadCIX, it was never meant to be a full OLR such as Matrix or Telepathy or Ameol,the size limits imposed by the small memory would make this impossible. Not from any limitations of OPL or the Series 3a itself, more the problems of fitting a large message base into 2Mb of RAM. ReadCIX was created to cater for the times when you have not had time to read all the messages downloaded onto a desktop PC or while you are away and would like to keep up to date with messages and Mail.
  32.  
  33. There is no clever or complicated thread handling in ReadCIX, all it tries to do is either take a previously downloaded scratchpad or,  a scratchpad downloaded to the  Series 3a automatically, and present the messages in an orderly  fashion and enable you to create new messages and replies.
  34.  
  35. Installation.
  36. #############
  37.  You can install ReadCIX.opa  into any \app directory. The remaining files must go in a \app\readcix directory  on  any drive. 
  38.  
  39.  There are 17 Files included in the Zip file:
  40.  
  41.   \app Directory
  42.           ReadCIX.opa               : The program itself, 
  43.   \app\readcix Directory
  44.           ReadMen.opa                 : A further program module
  45.           Rhscms.dyl                    : Comms DYL
  46.           Readall.man                :
  47.           Upload.man               : The main ReadCIX scripts 
  48.           Terminal.man                  :
  49.           CixMail.sco                    : Additional scripts
  50.           Resume.sco                   : 
  51.           Basket.sco                     :
  52.           Flist.sco                         :
  53.           Billing.sco
  54.           News.sco                      :
  55.           Finish,Mail,Welcome.wve : Optional Sound files.
  56.  
  57. Files not to be installed.
  58.  
  59.           ReadCIX.TXT                   : This file   
  60.           Scripts.zip                      : Source for the supplied scripts
  61.  
  62. ****Notes
  63.  
  64. The Zip file of Scriipt source is included  to enable advanced users to customize the scripts. Unless you are VERY sure if what you are doing, do not overwrite the supplied ones.
  65.  
  66.  
  67.        Psion-I will then install the program as described in the Psion manual.
  68.  
  69.  Operation.
  70.  ##########
  71.  General.
  72.  
  73. ReadCIX allows you to browse a set of messages downloaded from CIX, either by ReadCIX itself or transferred from another computer. It will arrange your messages into conferences, and you can pick which conferences to read. While viewing a message you may print the text or jot down notes or save a message. You can also reply to a message or create new mail and messages.
  74.  
  75. On first running the program you will be prompted for your CIX user name and password, this is used by ReadCIX to notify you of any replies to messages created by ReadCIX and for logging on to CIX.  Once the program has started,first set up the options in the Configure ReadCIX, Configure Comms and printer options under the special menu. The path names all need a trailing \ ie b:\cix\ . If you intend using the built in Comms functions then the correct connections to a modem must be made. Once a scratchpad has been downloaded use the post option to create the individual message files for reading.
  76.  
  77. If space is limited on the Series 3a the scratchpad can be posted from a remote drive using the serial link.
  78.  
  79. Here is a description of the menu options.
  80.  
  81. Files. 
  82. ==============
  83.  
  84. Read Messages
  85. -------------------------.
  86. Select a conference to read. 
  87.  
  88. Delete Messages
  89. --------------------------
  90. Deletes one or all the message files. It is best to use this option for deleting message files rather than the system screen as the message pointers are reset.
  91.  
  92. Display Text File
  93. -------------------------
  94. Select and display a text file from within ReadCIX, this could be a previously saved message or downloaded information such as billing details.
  95.  
  96. Delete Text File
  97. -----------------------
  98. Deletes one or all of the text files stored in the directory \cix\text
  99.  
  100.  Exit.
  101. ---------
  102. Return to the system screen.
  103.  
  104. Connect
  105. ======
  106.  
  107. Full connect
  108. -----------------
  109. This  will run the supplied script Readall. This will upload any replies and download any new messages.
  110.  
  111. Just upload replies 
  112. -----------------------------
  113. This will run the supplied script Upload which will just upload any replies.
  114.  
  115. Run Script 
  116. ----------------
  117. This will run a user supplied script. ReadCIX will look in the directory defined in the  setting in the Configure option for additional scripts. The following are supplied.
  118.  
  119. CixMail:            Just uploads any replies stored and downloads any waiting Mail
  120. Resume:        Will prompt for a user name and logon and retrive the resume
  121. Baskets:                       Downloads a listing of the contents of you In/Out Baskets 
  122. Flist:                             Downloads a listing of  a topics file list
  123. Billing:                          Prompts for Year and Month and retreivs billing details
  124. News:                           Downloads any new messages from Newsnet newsgroups you are
  125.                                     joined to
  126. Terminal
  127. -------------
  128. Allows you to start up the built in Comms app, with optionaly logging on to CIX and staying online.
  129.  
  130. **** Notes.
  131.  
  132. Read CIX uses the Standard Series 3a Comms application to connect to CIX, therefore there are a few things to setup outside ReadCIX before it can be used. The Comms application must be installed and the serial link connected to a modem with the correct cables. 
  133. When a script is selected from the menu, ReadCIX passes control to the Comms application while the script is running. This allows you to monitor the progress of the script and reply to
  134. any prompts. When the script has finished, control returns to ReadCIX.
  135.  
  136.  Posting.
  137. ========
  138.  
  139. Post Scratchpad.
  140. -------------------------
  141. After prompting for a file name this option will read through the downloaded scratchpad and post the messages to the relevant file. ReadCIX uses the first eight characters of the conference name as a file name. It will create a file for each new conference. If ReadCIX finds a conference exists already, the messages will be added to the end of file. ReadCIX maintains a pointer to the last read message for each conference and will position you at the last read message upon entering a conference file. After posting the scratchpad will be renamed to Scratchp.sc(x) where x is an number from 1-5 This will allow the scratchpad to be saved for later importing into a desktop system. For example the scratchpads could be saved whilst away and the imported into AMEOL via the Import CIX scratchpad option.
  142.  
  143. Import scratchpad
  144. ---------------------------
  145. After prompting for a file name this option will read through a scratchpad in the same manner as above. the only difference is that this option looks for a scratchpad which has been created with the COMPACT HEADER YES option set on CIX. This option is used in OLR's such as AMEOL .
  146.  
  147. Post Newsgroups
  148. --------------------------
  149. After prompting for a file name this option will read through a scratchpad downloaded with the News script and post the messages to a message file called News. All Newsgroups will be posted to the News file, must as topics are posted to on conference file.
  150. After posting the scratchpad will be saved in the same manner as a CIX scratchpad described above.
  151.  
  152. Delete Scratchpad.
  153. -----------------------------
  154. Delete the downloaded scratchpad.
  155.  
  156. CIX
  157. ===
  158.  
  159. Join Conference/Topic
  160. --------------------------------
  161. This option will prompt for a conference or topic to join on CIX, if you just enter a conference you will be joined to all topics, specifing a topic will restrict the joining to that topic. Only the 5 most recent messages are collected on first joining topic to reduce the amount of storage used.
  162.  
  163. Resign Conference/Topic
  164. ------------------------------------
  165. This works as above but allows the resigning of either a conference or topic.
  166.  
  167. Read Resume
  168. ---------------------
  169. Select a previously downloaded resume for reading. The Script Resume can be used to log on and retrieve a resume, the script prompts for a user name and logs on and downloads the resume to a file called resume.txt. ReadCIX will then prompt for a new unique name and store the resume in \cix\resume\ on your default drive.
  170.  
  171. Delete Resume
  172. -----------------------
  173. Deletes one or all downloaded resumes.
  174.  
  175. Restore Pointers
  176. ------------------------
  177. This option will restore the message pointers to enable the recovery of a lost scratchpad.
  178.  
  179. Display File list
  180. -----------------------
  181. Display a previosly downloaded topic file list.
  182.  
  183. Delete File list
  184. ---------------------
  185. Deletes one or all of the downloaded file lists
  186.  
  187. Switch Files On/Off
  188. -------------------------------
  189. This toggle simply sets a switch which the script Readall can see. If it is set ON then the script will prompt for File names to upload or download. The switch is reset on completion of a logon session.
  190.  
  191. ****Notes.
  192.  
  193. If the Switch Files toggle is ON ie. the option is showing Switch Files OFF, then the Readall script will display a menu after asking for the scratchpad name and before logging on to CIX.
  194. The menu has 5 options.
  195.  
  196. Download file
  197. Upload File
  198. Download Binmail
  199. Upload Binmail
  200. No File action.
  201.  
  202. For the File options you are prompted for a conference/topic name and the location of the file and a name.For Uploads you are also prompted for a description/size. For the Binmail options you are prompted for names and locations only.
  203.  
  204. The No file action will not attempt any file actions.
  205.  
  206. This part of the script will be run after all normal processing so do not attempt to send Binmail from ReadCIX that is being uploaded in the same session.
  207.  
  208. Mail
  209. ====
  210.  
  211. Clear Inbasket
  212. Clear Outbasket
  213. ------------------------
  214. These options will clear the relevant basket on CIX
  215.  
  216. Mark Mail Unread
  217. --------------------------
  218. This option prompts for a Mail Message number from your Inbasket and will mark it unread.
  219.  
  220. Binmail File
  221. ------------------
  222. If you have Uploaded a file to your personal directory on CIX this option will allow you to send the file to another CIX user. You are prompted for the file name and a recipient.
  223.  
  224. Erase Binmail
  225. --------------------
  226. This allows you to delete a file in your personal directory on CIX
  227.  
  228. Display Basket Contents
  229. -------------------------------------
  230. Allows the displaying of  In/Out baskets If you have used the script Baskets to download the contents of your mail In and Out baskets.
  231.  
  232. Delete Basket File
  233. ----------------------------
  234. Deletes the above file, this does not delete any item in you In/Out Baskets
  235.  
  236. Create
  237. ======
  238.  
  239. Create mail
  240. -----------------
  241. You are prompted for a To: Name and Title: Use the up and down arrow keys to move between the fields. Press enter to move to the Writing area.
  242.  
  243. You are placed in the built in Text editor and can the compose your message, word wrap is not supported in the text editor so remember to hit enter at the end of each line. Whilst you are in the text editor, ReadCIX is paused displaying a message untill you exit from the editor. 
  244.  
  245. Psion x will return you to ReadCIX.
  246.  
  247. Create message
  248. -------------------------
  249. You are prompted for a conference and topic to post the message to and also a title for the message. Please make sure you are joined to both the conference and topic you select as the created script does no checking on this.
  250. Once again press enter to move to the writing area.
  251.  
  252. See above for full description.
  253.  
  254. Create FAX
  255. -----------------
  256. You are prompted for a FAX Number. The remaining fields are used to make up the cover page of the FAX.
  257. Once again press enter to move to the writing area.
  258. See above for full description.
  259.  
  260. Reply File
  261. ========
  262.  
  263. Edit Reply file.
  264. ----------------------
  265. Any new mail or messages or replies or FAX's you create are stored in a file called Reply.txt in the \cix\ directory on the internal drive. This option starts the built in Word processor in text mode to allow you to edit or add to a previously created message. If you have anything in your reply.txt file the screen will look something like this.
  266.  
  267. JOIN psion/series3
  268. SAY
  269. TITLE: ReadCIX
  270. Hi this is a demo reply file
  271.  
  272.  
  273.  
  274.  
  275. .
  276. QUIT
  277. MAIL
  278. TO: salex
  279. TITLE: ReadCIX
  280. What a good program ReadCIX is, I have sent the required 12.00 registration fee.
  281.  
  282. Fred
  283. .
  284. SEND
  285. QUIT
  286.  
  287. You should be able to see the text of your message in between the Capitalised commands. You can edit the message and add as much extra text as you wish as long as the commands or their relative positions are not altered. If you are an expert on CIX there is no reason why you could not add extra commands to the file to perform other functions.
  288.  
  289. You exit the Word processor in the normal way with Psion X
  290.  
  291. Clear Reply file
  292. -----------------------
  293. This option will clear the created reply file Reply.txt in the \cix\ directory of the internal drive.
  294.  
  295. Recover Reply file
  296. --------------------------
  297. This option will copy the saved reply file back to reply.txt file if necessary.
  298.  
  299. **** Notes
  300.  
  301. After running the Full connect, Connect and upload or Run Script options from the Connect menu you are prompted with a question asking if the connection completed OK. If you reply Yes the reply file (Reply.txt in the \cix\ directory of the internal drive) is copied to reply.bak  and the reply.txt file cleared. If you reply No the reply file is not cleared or copied.  This does not happen for the Terminal option.
  302.  
  303. This Backup file can be recovered using the Recover Reply file option from the connect menu or renamed reply.txt if the replies are needed again for some reason.
  304.  
  305. Special.
  306. ========
  307.  
  308. Configure ReadCIX.
  309. ----------------------------
  310. This allows you to define the following.
  311.  
  312.                 Drive for Message files
  313.                 Drive  for scratchpad
  314.                 Path for additional scripts used in the connect menu
  315.         Use sound Yes or No
  316.         Use the message reply notification Yes or No
  317.                 User Def 1
  318.                 User Def 2
  319. ****Notes
  320.  
  321. Switching off the reply notification will show a slight increase in speed of posting the scratchpad.
  322. The user def options are for advanced users. Using the Configure User Defind option, names can be given to the options shown in the Configure ReadCIX dialog. These User defined options can be used to control the action of user written, or the supplied scripts. Each option, if selected, will create a file on the m drive in the \cix directory called Rhsc-opt.xxx where xxx can be 091-095 depending on the option selected. See the supplied scripts for examples of how to use this tchnique.
  323.  
  324. Configure Comms
  325. --------------------------
  326. This allows you to define the following
  327.  
  328.          CIX User Name
  329.          CIX Password
  330.          CIX Phone Number to Dial
  331.          Modem Initialisation string
  332.          Dialing Prefix- ATDT for Tone, ATDP for pulse.
  333.          Baud Rate to use
  334.          Type of Handshaking to use
  335.                  Download Protocol
  336. ****Notes
  337.  
  338. If you require a number to be inserted for a outside line on a switchboard place it after the ATDT/ATDP command.
  339. It is best to leave the Handshaking option at the default unless you are experiencing problems.
  340.  
  341. Printer.
  342. --------------
  343. The printer setup menu allows you to specify a parallel or serial printer, and if serial the settings for the serial port.
  344.  
  345. Register.
  346. -------------
  347. ReadCIX is shareware, you have a 20 day evaluation period. After this time the program will not go beyond the initial screen. Obtain your registration number and enter it here along with
  348. your name. Once registered this option will not show.
  349.  
  350. About.
  351. ----------
  352. Displays brief details of ReadCIX.
  353.  
  354. Reading Messages.
  355. ##################
  356.  
  357. Whilst reading messages,  the help key will show a reminder of the available keys, these are 
  358.  
  359.                 Esc- Return to Menu
  360.                 Help- Basic help text
  361.                 Enter- Show next page of message 
  362.                 Space- Show next page of message
  363.                 Up Arrow- Previous message
  364.                 Down Arrow- Next message 
  365.                 Menu-Call up SubMenu 
  366.                 Psion+END- Goto last message of Conference
  367.                 Psion+HOME-Goto first message of Conference
  368.                 Psion+PGUP-Jump to Original message if Comment
  369.  
  370. As Noted above pressing menu  will bring up a sub menu with options that can be performed.
  371.  
  372. Replies
  373. =======
  374.  
  375. The options here are the same as found in the Create menu with the exception of Reply to message. This will not prompt for a Conference/Topic or title but will create a Comment on the current message. 
  376.  
  377. Messages
  378. =========
  379.  
  380. Save Messages
  381. ---------------------------
  382. This will prompt for a file name to save the current message to. If the file exists it will be overwritten.
  383.  
  384. Print Message
  385. ---------------------
  386. This will allow the current message to be printed to the printer specified in the Configure menu.
  387.  
  388. Edit
  389. ====
  390.  
  391. Find
  392. -------
  393. This will allow searching for a text string in the body of a message. The search starts from the next message and searches the current message file only. You will be positioned at the message containing the text. This option does not effect the last read message pointer so a search through an unread conference will not stop later reading.
  394.  
  395. Special
  396. ======
  397.  
  398. Write note
  399. ---------------
  400. This  will switch to the word processor application of the Series 3a to allow the writing of
  401. notes. You will be asked if you require a new file or wish to use a existing one.
  402.  
  403. Zoom  View
  404. -----------------
  405. This option cycles through the three available Zoom levels.
  406.  
  407. Register EOL / Ignore EOL
  408. ---------------------------------------
  409. This option will try to preserve the layout of a message rather than fit as much as possible on the screen. This option acts as a toggle. In the smallest font view this option is not available as the default is to preserve the layout at this level.
  410.  
  411. Message Number
  412. ----------------------------
  413. Displays the current message number
  414.  
  415. Sound
  416. ======
  417.  
  418. Sound is used in four places.
  419.  
  420. 1. On the startup screen. (Welcome.wve)
  421. 2. On completion of a Connection. (Finish.wve)
  422. 3. On completion of posting. (Finish.wve)
  423. 4. On detecting a Mail Message. (Mail.wve)
  424.  
  425. Each file can be deleted if the sound is not required, or the can be recorded over to customise your setup.
  426.  
  427.  Any problems or request can be referred to my CIX ID salex or my CIS ID 100034,2641.
  428.  
  429.  
  430. Acknowledgements.
  431.  
  432. My thanks to Chris Hennings of Right Hand Software for the Comms DYL. RHSCMS.DYL is supplied strictly for ReadCIX and cannot be used for any other purpose.
  433.  
  434.  
  435.