home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / b / boxmsg2.zip / BOXMSG.DOC < prev    next >
Text File  |  1992-10-13  |  21KB  |  748 lines
  1.    
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.    
  13.    
  14.    
  15.    
  16.    
  17.    Welcome to BoxMsg, the offline mail quoter with style and class.  What
  18. will BoxMsg do for me you ask?  The following is what a typical message
  19. found on a typical echo'ed board would look like:
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27. example:
  28.  
  29. ***************************************************************************
  30.  FM>RR>hello fred,  whats up?  I've noticed that your starting to use some
  31.  FM>RR>sort of fancy message quoting system.  It's really cool!   What's
  32.  FM>RR>it called?  Is it easy to use?
  33.  
  34.  FM>RR> are you going to the pizza party this month?
  35.  
  36.  FM> Yes I can't wait to blow you guys away with some of new stuff I've
  37.  FM>picked up since last month.
  38.  
  39.  Great,  I'll see you there.
  40.  
  41.  FM>   Not much Mark.  How are you doing?    Yes, as a matter of fact I am
  42.  FM>using a new message quoter.  It's called BoxMsg.  This thing is great!
  43.  FM>I just edit my messages like I normally do, then BoxMsg turns all
  44.  FM>the lines that I quoted into cool boxes with the original writers
  45.  FM>full name at the top.   It makes my quotes look like they were 
  46.  FM>written with GAP's **on line** message editor,  but I can really use
  47.  FM>any **offline** reader that I wish.
  48.  
  49.       Your right Fred, this thing is great!  I just picked up BoxMsg from
  50.  my favorite board, and I'm already quoting away.
  51.  
  52.    -- Rick Ricarrdo
  53.  
  54. *****************************************************************************
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. Now look at how much nicer  this message looks when you have BoxMsg
  67. installed on your system.
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75. example:
  76.  
  77. ┌─Rick Riccardo─────────────────────────────────────────────────────┐
  78. │hello Fred,  whats up?  I've noticed that your starting to use some│
  79. │sort of fancy message quoting system.  It's really cool!   What's  │
  80. │it called?  Is it easy to use?                                     │
  81. │                                                                   │
  82. │ are you going to the pizza party this month?                      │
  83. └───────────────────────────────────────────────────────────────────┘
  84.  
  85. ┌─Fred Mertz────────────────────────────────────────────────────────┐
  86. │ Yes I can't wait to blow you guys away with some of new stuff I've│
  87. │picked up since last month.                                        │
  88. └───────────────────────────────────────────────────────────────────┘
  89.  
  90. Great,  I'll see you there.
  91.  
  92. ┌─Rick Riccardo─────────────────────────────────────────────────────────┐
  93. │   Not much Ricky,  How are you doing?    Yes, as a matter of fact I am│
  94. │ using a new message quoter.  It's called BoxMsg.  This thing is great!│
  95. │ I just edit my messages like I normally do, then BoxMsg turns all      │
  96. │the lines that I quoted into cool boxes with the original writers     │
  97. │full name at the top.   It makes my quotes look like they were         │
  98. │written with GAP's **on line** message editor,  but I can really use    │
  99. │any **offline** reader that I wish.                                    │
  100. └───────────────────────────────────────────────────────────────────────┘
  101.      
  102.      Your right Fred, this thing is great!  I just picked up BoxMsg from
  103. my favorite board, and I'm already quoting away.
  104.  
  105.  -- Ricky Riccardo
  106.  
  107. ****************************************************************************
  108.  
  109.     If this is the type of thing your looking for then please read on!
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.               REGISTER FOR ONLY $5
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.        BetaBetaBetaBetaBetaBetaBetaBe
  143.  
  144.      Note:   This is the second Beta copy of BoxMsg.
  145.          by installing this program on your system
  146.          you are taking on the full responsibility
  147.          of a Beta tester.   Any changes made to
  148.          any text files filtered through BoxMsg are
  149.          made with your complete consent regardless 
  150.          of the outcome.   As a Beta tester, you are
  151.          expected to report **all** problems or
  152.          enhancement requests to the author, Matthew
  153.          Rice as soon as possible.
  154.  
  155.        BetaBetaBetaBetaBetaBetaBetaBe
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.                               SET UP
  169.                           =================
  170.  
  171. Following are directions for setting up BoxMsg with SLMR, SpeedRead and
  172. EZ-reader.   If you use any other system, read through these to get an idea
  173. of how you should set things up.
  174.  
  175.  
  176.  
  177.               Configuration of SLMR\OLX
  178.            ===============================
  179.  
  180.  
  181. Note:  SLMR (and most other readers) unzips you QWK mail pak into a temporary
  182. directory which it creates off of the current directory.  (In my case it's
  183. called MR$WORK) Because this directory may change depending on where you've 
  184. called your mail reader from, or what directory you downloaded your packet 
  185. to, (I put the damn things all over the place <grin>)  it is necessary
  186. to specify the complete path of your editor and BoxMsg, but pass only the
  187. file name which SLMR provides without a path.
  188.  
  189.  
  190.  
  191.        press alt-C at the first SLMR menu for configuration.
  192.  
  193.  
  194.  
  195.        choose General.
  196.          Enable swapping                   YES
  197.        
  198.        press F10
  199.  
  200.  
  201.  
  202.  
  203.        choose Editor.
  204.          Editor Command line               C:\qmodem\mail\box.bat
  205.        
  206.        press F10
  207.  
  208.  
  209.  
  210.  
  211.        choose Replies.
  212.          Reply Quoting style               ALL
  213.          Quoting Prefix string             >
  214.          Message header in quoted reply    YES
  215.        
  216.        press F10
  217.  
  218.  
  219.  
  220.        --   A batch file similar to the following should be used. --
  221.  
  222. \utils\qedit\q.exe %1
  223. \qmodem\mail\boxMsg %1
  224. type %1 | more
  225. pause
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.               CONFIGURATION FOR SpeedRead
  241.               ====================================
  242.  
  243.  
  244.        press alt-C for configuration.
  245.  
  246.  
  247.        choose General setup.
  248.          
  249.          QUOTING
  250.                Initials:  ALL
  251.            Quote String:  >
  252.           Smart Quoting:  OFF
  253.  
  254.          EXTERNAL PROGRAMS
  255.              Editor:  command /c c:\qmodem\mail\boxsr.bat %s
  256.  
  257.        press TAB
  258.  
  259.  
  260.  
  261.        Choose Toggles and Options.
  262.  
  263.  
  264.          Swapping:  ON
  265.               .
  266.               .
  267.          Reply Header:  ON
  268.  
  269.        press TAB
  270.  
  271.  
  272.        --   A batch file similar to the following should be used. --
  273.  
  274. \utils\qedit\q.exe %1
  275. \qmodem\mail\boxMsg -r5 %1
  276. type %1 | more
  277. pause
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.               CONFIGURATION FOR EZ-reader
  288.               ====================================
  289.  
  290.  
  291.        press F2 for configuration.
  292.  
  293.  
  294.        choose Editor.
  295.          
  296.                    Editor:   c:\qmodem\mail\boxEZ.bat 
  297.  
  298.        press ESC
  299.  
  300.  
  301.        choose Flags
  302.  
  303.              Print Header in Reply:  YES
  304.         
  305.        press ESC
  306.  
  307.  
  308.        choose Replies.
  309.        choose Prefixes.
  310.  
  311.            Add a prefix to replies:  INITIALS
  312.                  Prefix String:  >
  313.           Header divider character:  =
  314.          Message divider character: -
  315.        
  316.        press ESC
  317.  
  318.  
  319.  
  320.  
  321.        --   A batch file similar to the following should be used. --
  322.  
  323. \utils\qedit\q.exe %1
  324. \qmodem\mail\boxMsg -r3 %1
  325. type %1 | more
  326. pause
  327.  
  328.  
  329. That should do the trick.  If you cannot get your system to work with these
  330. settings, ask for help in a mail reader conference, or drop me a line.
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.     NOTE: ( This program was designed using SLMR as the test editor.
  348.         Since initial BETA I have modified BoxMsg to work with
  349.         SpeedRead and EZ-reader.
  350.         It should work with others as well,  but I have not
  351.         tested them.   If You use a mail editor which you find
  352.         to be incompatible with this system( again, most should be)
  353.         please drop me a line and I'll see what I can do! )
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.             Set Up Troubleshooting  Guide
  362.      ===========================================================
  363.  
  364.  
  365.  
  366. In order for BoxMsg to work properly, it needs to be looking for the 
  367. correct information.  This means that your Mail reader needs to be set
  368. up in a 'Standard' way.   BoxMsg grabs the full first and last names
  369. which it uses at the top of it's boxes from a header that your mail reader
  370. should be set up to add at the top of the message file.  Your mail reader
  371. should probably also be set up to swap to extended memory or disk whenever
  372. you call your external editor.  Instead of calling an external editor from
  373. within the reader, set it to call a batch file.  Have the batch file first
  374. call your editor, then call BoxMsg.  Remember to pass filenames to both
  375. of these programs.
  376.  
  377. Also make sure that your editor places capitol initials and a '>'
  378.  
  379.  MR>
  380.  MR>
  381.  
  382. in front of **every** line of the original quote.  Any character used 
  383. besides '<' or '>'  will cause that quote not to be boxed.
  384.  
  385.  
  386.  
  387.  NOTE:   This version now supports some
  388.      of the more esoteric techniques and characters people use to 
  389.      quote their messages on large Net systems.   
  390.  
  391.          -->     MR>      MR║       ╗
  392.          -->       >      MR║       ║       ...etc
  393.          -->       >      MR║       ║
  394.      
  395.      So far,  BoxMsg works great
  396.      for me the way it is now,  but if enough REGISTERED users
  397.      want it to support this stuff,   I'm willing to do it.   In
  398.      fact, I've made a pact with myself.   If so much as ONE person
  399.      out there in cyber land sends me the measly 5 bucks,  I'll
  400.      do it...AND mail them back a copy of the update.    Let's
  401.      see how it goes.....
  402.      
  403.  
  404. Most mail readers allow you to swap the reader out of memory, then call
  405. an external text editor for replying to messages.   instead of calling
  406. the editor directly, Set this up to call a batch file similar to the 
  407. following:
  408.  
  409.  
  410.                 
  411.                 # The offline reader should pass a filename in %1
  412. \utils\qedit\q %1           # Q is the call to my text editor.
  413. \qmodem\mail\BoxMsg %1      # I then call BoxMsg and pass it the file name.
  414. type %1 | more              # You can view the modified file, 
  415. pause                       # Give you a chance to see it before returning.
  416.  
  417.  
  418.     BoxMsg will take care of the rest, including stripping the header
  419.     which the mail reader has placed in the file. 
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.                 Use and Explanations
  432.             =====================================
  433.  
  434.  
  435.      So how does it work?   How difficult is it going to be to set it up
  436. to work with my mail reader?    Do I have to use the arrow keys to 
  437. pinpoint where I want my quote boxes drawn like I do with those other 
  438. message quote systems?  Can I use my own editor or do I have to use one 
  439. you provide?
  440.                              -- Elvis Presley
  441.  
  442.  
  443. Well Elvis,  It's really quite simple.  The most important step is to
  444. set the configuration parameters of your mail reader up properly so that
  445. when it sends you to your editor, the message looks like this:
  446.  
  447.  
  448.  example:   message as passed to text editor.
  449.  
  450.  ===========================================================================
  451.   BBS: The Cookie Jar
  452.  Date: 06-11-92 (10:18)             Number: 569
  453.  From: ELVIS PRESLEY                Refer#: 568
  454.    To: MATTHEW RICE                  Recvd: NO  
  455.  Subj: quotes                         Conf: (4) Programming
  456.  ---------------------------------------------------------------------------
  457. EP>     So how does it work?   How difficult is it going to be to set it up 
  458. EP>to work with my mail reader?    Do I have to use the arrow keys to       
  459. EP>pinpoint where I want my quote boxes drawn like I do with those other    
  460. EP>message quote systems?  Can I use my own editor or do I have to use one  
  461. EP>you provide?                                                             
  462. EP>                                                         -- Elvis Presley
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469. You then go ahead and edit the message as you normally would, using any text
  470. editor that you prefer. You may insert comments into the middle of a
  471. quoted paragraph...any where you'd like!   Remember to delete extraneous
  472. lines from the message that your quoting.... BoxMsg can handle them but
  473. they're considered 'bad taste' on the Nets and will make you unpopular.
  474.  
  475.  
  476.  
  477.  example:  message after finished editing in text editor.
  478.  
  479.  ===========================================================================
  480.   BBS: The Cookie Jar
  481.  Date: 06-11-92 (10:18)             Number: 569
  482.  From: ELVIS PRESLEY                Refer#: 568
  483.    To: MATTHEW RICE                  Recvd: NO  
  484.  Subj: quotes                         Conf: (4) Programming
  485.  ---------------------------------------------------------------------------
  486.  
  487.  EP>     So how does it work?   How difficult is it going to be to set it up
  488.  
  489.  It works by putting itself between your text editor and your mail reader.
  490.  
  491.  EP>to work with my mail reader?    Do I have to use the arrow keys to 
  492.  EP>pinpoint where I want my quote boxes drawn like I do with those other 
  493.  EP>message quote systems?  
  494.  
  495.  You don't have to do any work.  Just edit your message as you normally would.
  496.  When you through, control will pass to BoxMsg which will search for lines
  497.  which you have left quoted in your finished message.  These lines will
  498.  have a variable length box drawn around them with the original authors
  499.  name at the top. Control then passes back to your mail editor which will
  500.  append your tagline to the file, and compress it into QWK mail format.
  501.  
  502.  XX>Can I use my own editor or do I have to use one 
  503.  EP>you provide?
  504.  Because the choice of editors is controlled by a batch file, you can
  505.  use any ASCII text editor that you choose.
  506.                           - Matthew Rice -
  507.  
  508.  
  509.  
  510. example of finished quote:
  511.  
  512. ┌─Elvis Presley──────────────────────────────────────────────────────────┐
  513. │     So how does it work?   How difficult is it going to be to set it up│
  514. └────────────────────────────────────────────────────────────────────────┘
  515.  
  516. It works by putting itself between your text editor and your mail reader.
  517.  
  518. ┌─Elvis Presley────────────────────────────────────────────────────────┐
  519. │to work with my mail reader?    Do I have to use the arrow keys to    │
  520. │pinpoint where I want my quote boxes drawn like I do with those other │
  521. │message quote systems?                                                │
  522. └──────────────────────────────────────────────────────────────────────┘
  523.  
  524. You don't have to do any work.  Just edit your message as you normally would.
  525. When you through, control will pass to BoxMsg which will search for lines
  526. which you have left quoted in your finished message.  These lines will
  527. have a variable length box drawn around them with the original authors
  528. name at the top. Control then passes back to your mail editor which will
  529. append your tagline to the file, and compress it into QWK mail format.
  530.  
  531. ┌─Elvis Presley──────────────────────────────────┐
  532. │Can I use my own editor or do I have to use one │
  533. │you provide?                                    │
  534. └────────────────────────────────────────────────┘
  535. Because the choice of editors is controlled by a batch file, you can
  536. use any ASCII text editor that you choose.
  537.                           - Matthew Rice -
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.    I think that you'll agree... This is a heck of a lot classier than what
  559.     the reader gives you, and it makes the quote more clear as well.  Of 
  560.     course, your reader will then add its own advertising and tagline to 
  561.     this file and put it into QWK mail format.
  562.  
  563.  
  564.  
  565.  
  566. NOTE: In order for BoxMsg to place full names at the top of each quote
  567.  box, a header must be present before the quote is encountered in the file.
  568.  BoxMsg strips this ugly header from the file once it is read in.   It must
  569.  strip the portion of this header which looks like this:
  570.  
  571. ------------------------------------------------------------------------
  572.                     &
  573. ========================================================================
  574.  
  575.  If you write a message in which you draw either of these two lines, BoxMsg
  576.  will strip it from the file as well!  Note: this will only happen if your
  577.  line is the **exact** length of the lines of a header.  If you are unsure,
  578.  simply space your line in by one, and BoxMsg should <grin> leave it alone.
  579.  
  580. ex:
  581.  ------------------------------------------------------------------------
  582.    this line will be left alone while the former line would be striped.
  583.  
  584.  
  585.  
  586.  
  587. NOTE: If your reader does not place a header at the top of the file, BoxMsg
  588.  will still  draw a nifty box around it; it just won't feature the name
  589.  of the quo tee at the top.  If your mail reader does provide inclusion of a
  590.  header, but boxMsg gives you blank boxes try experimenting with the -r
  591.  parameter. e.g.  -R3 will cause BoxMsg to look for the FROM: line in you 
  592.  header 3 characters from the left of your screen.  Set this value to the 
  593.  indentation (0-9) your reader uses and you should start seeing proper
  594.  names appearing.
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602. *****************************************************************************
  603. --
  604. --  BoxMsg also offers 4 command line options.
  605. --
  606. --               -L for long quote boxes.
  607. --
  608. --               -S for a space on either side of the quo tee's name.
  609. --
  610. --               -F for FIDO net's which don't allow ANSI characters
  611. --
  612. --               -R for SpeedRead & EZ-reader Compatibility
  613. --
  614. ****************************************************************************
  615.  
  616.  
  617.                 $5 registration fee!!
  618.  
  619.  
  620. examples:
  621. =========
  622.  
  623. c:\>BoxMsg reply.msg
  624.  
  625. ┌─Michael Jackson──────────────────────┐
  626. │ I think that BoxMsg is the greatest. │
  627. │ I think that everyone should register│
  628. │ a copy right away!                   │
  629. └──────────────────────────────────────┘
  630.  
  631. c:\>BoxMsg -s reply.msg
  632.  
  633. ┌ Michael Jackson ─────────────────────┐
  634. │ I think that BoxMsg is the greatest. │
  635. │ I think that everyone should register│
  636. │ a copy right away!                   │
  637. └──────────────────────────────────────┘
  638.  
  639. c:\>boxMsg -L reply.msg
  640.  
  641. ┌─Michael Jackson────────────────────────────────────────────────────────────┐
  642. │ I think that BoxMsg is the greatest.                                       │
  643. │ I think that everyone should register                                      │
  644. │ a copy right away!                                                         │
  645. └────────────────────────────────────────────────────────────────────────────┘
  646.  
  647. c:\>boxMsg -f reply.msg
  648.  
  649.  -Michael Jackson----------------------
  650. | I think that BoxMsg is the greatest. |
  651. | I think that everyone should register|
  652. | a copy right away!                   |
  653.  --------------------------------------
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.               Special Nifty Option!
  661.           ==============================
  662.  
  663. One other option is provided for.  If set up your mail reader to preface
  664. your quotes with '<' instead of '>', BoxMsg will draw a variable length box
  665. around your quote, then center it in order to make it stand out more.
  666. You can manually change this character as well while editing so that
  667. you can use both centered and non centered boxes in the same quote!
  668.  
  669.  EP<I think that BoxMsg is the greatest.
  670.  EP<I think that everyone should register
  671.  EP<a copy right away!                   
  672.  
  673.            ┌─Elvis Presley───────────────────────┐
  674.            │I think that BoxMsg is the greatest. │
  675.            │I think that everyone should register│
  676.            │a copy right away!                   │
  677.            └─────────────────────────────────────┘
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693. BetaBetaBetaBetaBetaBetaBetaBe
  694. --
  695. --  This is the first BETA copy of this program.  By deciding to give it a
  696. --   try you are also volunteering to be a beta tester.   If you encounter
  697. --   any area's which BoxMsg does not perform properly... or if their are
  698. --   any nifty enhancements you would like to see added to BoxMsg please
  699. --   let me know.
  700. --                                               - Matthew Rice -
  701. BetaBetaBetaBetaBetaBetaBetaBe
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720. Well,  Thank you very much for using BoxMsg.  Special thanx go to Jay
  721. Heyl and Richard Brown at the Cookie Jar (714)997-0350 for their help
  722. and suggestions while I was Alpha testing.
  723.  
  724. To register BoxMsg, please send me your name, address, and if your a
  725. sysop, the number of your board, so that I can send any fixes or up-dates
  726. to you as soon as possible.   I'd also appreciate it if you include a small
  727. donation of $5 so that I can show my girlfriend that all the time I spend
  728. at the computer is going to be worth something some day.   If you think that
  729. five bucks is too high,   send me what you think its worth.  I'm curious to 
  730. see what kind of responce I get from this.  If your just plain cheap,  At 
  731. least have the decency to drop me a letter or mail me a message telling me
  732. what you think, or suggesting things that might make nice enhancements.
  733.  
  734. My address is:
  735.    Matthew Rice
  736.    3285 Garden Grove Blvd.  #70
  737.    Orange   Ca,  92668
  738.  
  739. I'm going to be checking into the offline mail reader conferences on 
  740. I'Link so I'll probably get any messages that you leave me there.
  741.  
  742. The fastest way to reach me would be through my fav board,  The Cookie
  743. Jar.   The Sysop is Jay Heyl who in his infinite graciousness has Ok'ed
  744. it for people to leave messages concerning BoxMsg on the main board there.
  745. California phone is (714)-997-0350.
  746.                                
  747.                                - Matthew Rice -
  748.