


                                     SyncEdit
                         The Synchronet Full-Screen Editor


                        (c) Copyright 1995 Robert D. Bouman
 
                                ALL RIGHTS RESERVED


                                 Robert D. Bouman
                                94 W Roosevelt Ave.
                                Zeeland, MI  49464
                                        USA

                             Fido:  1:2201/11
                         Internet:  bouman@macatawa.org




     
     As this document covers both the freely distributable and registered 
     versions, not all items apply to the demo version and are identified as 
     such throughout the document.  



     Ŀ 
                               Description                         ۲ 
      

     This product provides an integrated full-screen ANSI message editor for
     use with the Synchronet bulletin board package.



     Ŀ 
                               Disclaimer                          ۲ 
      

     The entire SyncEdit package is provided as is and comes with no warranty
     of any kind, either expressed or implied.  In no event will Robert
     Bouman be liable for damage resulting from the direct or indirect use of
     this software.

     The user of these programs bears all risks as to their quality and
     performance.  

     Users are encouraged to use common sense and back up all important system 
     files using industry accepted methods before using this or any other
     newly obtained application.  


     Ŀ 
                             Special Thanks                        ۲ 
      

     We would like to thank the beta testers and others who have been most
     instrumental in getting SyncEdit to where it is today.  They have been
     very helpful in the debugging process and provided numerous suggestions
     which have been included in SyncEdit.

                   The testers include, in no particular order -

                          Jim Knight of 21st Century
                          Kelly Wright of Tele-Star
                          Bill Cronkhite of The Game Room



     Ŀ 
                             Included Files                        ۲ 
      

     HISTORY.TXT        Revision history of SyncEdit
     REGISTER.FRM       Registration form
     SYNCEDIT.DOC       What you're reading now, the documentation
     UPGRADE.DOC        Information on upgrading to this version of SyncEdit.
     SYNCEDIT.EXE       The executable text editor
     KEYGEN.EXE         Program to generate key file
     SYNCEDIT.MAC       Example macro file
     FEATURES.TXT       List of features included in SyncEdit to date
        
     Note:  The dictionary is distributed as a seperate archive, and will not 
     be used by the editor until a key code is obtained.  The dictionary can
     be found at various locations as SYEDTDIC.ZIP.



     Ŀ 
                           System Requirements                     ۲ 
      

     An operational Synchronet BBS system, version 2.00 or greater. ANSI
     emulation is required for the remote user of course, DOS 3.0+, a fossil
     driver may be needed if you are currently using Digiboard or similar
     product.  SYNCEDIT SUPPORTS FOSSIL AND DIRECT COMPORT I/O ONLY!



     Ŀ 
                           Distribution Method                     ۲ 
      
  
     Freely distributable shareware.  This package may be uploaded, placed in
     CD-ROM collections, or otherwise be freely disseminated as long as the
     archive remains intact.  Only reasonable fees may charged for copying or
     distributing, and no copyright or ownership may be claimed by parties
     other than Robert Bouman.  This product is NOT in the "public domain".
  
     The latest version is always available via file request at 1:2201/11 as
     SYNCEDIT.  



     Ŀ 
                               Limitations                         ۲ 
      

     The registered version of SyncEdit is designed to operate with a KEY 
     file, which activates the registered features of the editor.  Operation 
     of the editor without a key will invoke the editor in demo mode.  A key 
     file is not distributed with SyncEdit, it can be generated with KEYGEN
     and a key code from Robert Bouman.
     
     The demo version is a very functional editor, with no time limitations or 
     restrictions on usage except as noted above under "Distribution method".  
     The demo contains complete block editing and file functions, but the menu 
     items indicated by a light grey color, SEARCH, SPELL CHECKER, and 
     GRAPHICS, are not active in the demo version.  Also, the demo does not 
     allow the use of Sysop definable TAGLINES.  There is a three second delay 
     upon entry to the editor as well.  

     The key file activates SEARCH, SPELL CHECKING, GRAPHICS, Sysop definable 
     TAGLINES and removes the entry delay screen.  

     See "Registration" for specifics on how to obtain a key code.

     Both versions of SyncEdit are limited to a maximum of 500 lines of text.  



     Ŀ 
                              Installation                         ۲ 
      

     SyncEdit is installed as an external message editor, and if one is
     familiar with Synchronet and installing doors, there should be little
     difficulty. However, it is assumed that the reader is familiar with
     Synchronet and how to configure the BBS software.


                                      Step 1

     Decide where you wish to place the external files, ie the SYNCEDIT.DIC,
     SYNCEDIT.KEY and TAGLINE files, all of which are only activated by a
     registered key file.  As mentioned earlier, remember that the dictionary
     is distributed as a separate archive.

     If you plan on using a different directory from \SBBS\EXEC, create the
     directory using any valid DOS name and path, with the DOS "MD"    
     command.
  
     If used, copy SYNCEDIT.DIC into the directory you just created, and make
     a note of the full path and name of this directory as you'll need that
     information in a moment.  Otherwise, if using the BBS EXEC directory,
     copy SYNCEDIT.DIC into \SBBS\EXEC.

     When you later get to the step of setting up the editor within 
     Synchronet, you will need to be sure your second command line argument 
     points to the directory containing the external files.  


                                      Step 2
     SYNCEDIT.EXE may be installed in any convenient directory, though we
     suggest the \SBBS\EXEC subdirectory or a directory beneath \SBBS\EXEC
     called SYNCEDIT.  If you place SYNCEDIT.EXE in a directory that's NOT
     in your system path statement, then you must provide the full path to
     this directory on the command line with the executable 
     (C:\SYNCEDIT\SYNCEDIT %l .. .. ). 


                                      Step 3
     Add SYNCEDIT to your BBS's external on-line programs menu via the
     Synchronet configuration utility:  External Programs -> External Editors

     Before we get to installing SyncEdit, please note the command line used 
     with SyncEdit:  

     syncedit [<EXTERNAL DIR>] [<NUM LINES>] [PATH\FILE] 
                                        or
     %!syncedit [<EXTERNAL DIR>] [<NUM LINES>] [PATH\FILE] 


     A typical command line example might be:  

                          syncedit %! %l %f

     Left to right:  the name of the executable, the path to the external 
     directory (for the dictionary files, tag files, and SYNCEDIT.KEY), maximum
     number of lines allowed in the editor, and the optional path\file_name
     to read into the editor.

     The external directory (first argument) is where the dictionary, and when 
     obtained, the SYNCEDIT.KEY should be placed.  The external directory 
     argument MUST be defined, even if you don't have a key file and don't 
     intend to install the dictionary.  The count of the arguments must be at 
     least two, with the last item, PATH\FILE_NAME being the only truly
     optional parameter.  

     Assuming you've placed SYNCEDIT.EXE in the \SBBS\EXEC directory and the 
     \SBBS\EXEC path is properly defined in your system setup, it shouldn't be 
     necessary to use the "%!"  in front of the executable name.  However, if 
     you have difficulty getting SyncEdit to run, try placing the %! at the
     beginning of the command line as in the second example above.  

     The Synchronet parameter %l may be substituted for NUM LINES.  This is
     handy if you wish the editor to use the default number of lines as 
     configured within each of your BBS user levels.  

     Note that in our example we used the path to the \SBBS\EXEC directory as 
     our external directory (%!), received the maximum editor lines from the 
     BBS (%l) and received the path & name of the file to read into the editor 
     from the BBS (%f).  If %f isn't used, SyncEdit will default to reading 
     the INPUT.MSG text dropped by the BBS in the respective NODE directory.  

     If we wished to use a different external directory, and pass on the 
     command line a specific number of lines to allow, we could have done 
     something like:  

                      syncedit c:\sbbs\exec\syncedit\ 80 %f

     This example assumes a directory called "syncedit" exists in the
     c:\sbbs\exec directory and will be used for our external files.  80
     is the maximum lines allowed in the editor.  

     We suggest the use of a separate external directory with the 
     availability of user dictionaries.  Otherwise, the \EXEC directory may
     become cluttered with dictionary files.


     Hit INSERT on a blank line to start the process of adding the editor.  

     Below is an example intended to show a typical setup for SyncEdit, and 
     should work for the vast majority of users.  Please note, SyncEdit 
     *requires* the use of the XTRN.DAT drop file so be sure to configure 
     Synchronet to drop the file as indicated below.


                                  SyncEdit Editor
ͻ
 Name                            SyncEdit                               
 Internal Code                   SYNCEDIT                               
 Local Command Line              syncedit %! %l %f                      
 Remote Command Line             syncedit %! %l %f                      
 Access Requirements             ANSI                                   
 Intercept I/O Interrupts        No                                     
 Quote Text                      Prompt User                            
 QuickBBS Style Editor (MSGTMP)  No                                     
 Expand line feeds to CRLF       No                                     
 BBS Drop File Type              Synchronet      XTRN.DAT               
ͼ


     Once again, this example will work if you have the directory where you 
     placed SYNCEDIT.EXE in your path, and you placed your external files in
     \SBBS\EXEC.  Otherwise, you will need to modify the above to match
     your setup.

     If memory is tight, or you experience difficulties, add SyncEdit to your 
     BBS global swap list.  This is accomplished within the Synchronet 
     configuration utility.  


     That's it, you and your users should now be able to use the editor!  



     Ŀ 
                            Using the Editor                       ۲ 
      

     As SyncEdit contains an extensive built-in help system, we will not go 
     into great detail here on the commands or how to use the editor.  

     All functions are available from the menu at the top of the screen by 
     using CTRL-key combinations.  For instance, on-line help is available by 
     using CTRL-P.  There are also several keyboard shortcuts, such as CTRL-O
     for quick save, as well as the traditional "slash" commands (/A, /ABT,
     /N, /S, /?).  Again, be sure to review the help system when you first
     use the editor for more detailed information.

     The menu bar at the bottom of the editor reflects (left to right):
  
                registration information (who the editor is registered to)
                maximum lines allowed
                number of lines used
                insert/delete mode status
                date
                time


     Ŀ
                          Sysop File Functions                     ۲ 
      

     There are two Sysop only commands available from the File menu that are
     accessible, and visible, only to user groups 90 and above (co-Sysops and
     Sysops).  These commands are LoadFile and SaveFile which do exactly what
     their names imply.

     LoadFile reads a separate text file into the current editing session.  
     This function does not overwrite existing text, but rather inserts the
     file at the current cursor position.

     SaveFile saves the current text to a file in ASCII format.

     Both LoadFile and SaveFile expect a full DOS path.



     Ŀ
                            Sysop Hot Keys                         ۲ 
      

     Several functions are also available to the sysop both when used locally
     and when a remote user is using SyncEdit.  They are defined below.

     ALT+C - Allows you to chat with the remote user while they are editing a
     message.  This function is only available when the user is at the main
     editing screen.  ALT+C again to return to normal screen.

     ALT+H - Hang up on user and exit from SyncEdit.

     ALT+J - Drop to DOS.  This is available when the user is on-line as well
     as when the editor is used locally.  It is available when the remote
     user or local user is in the main editing screen only.

     ALT+K - When this key is pressed, SyncEdit will ignore key strokes from
     the remote user.  Pressing this key again will return the editor to
     normal function.

     ALT+D - Drops user to BBS without hanging up on them.

     F1 - Will display a status bar containing the sysop key information from
     above.

     F9 - Will return the status bar to the normal user information display.

     F10 - Will remove the status bar completly from screen.

     ALT-+/- - Increase or decrease the amount of time the user has in
     SyncEdit to write or edit a message.


     Ŀ 
            Creating TAGLINE Files (registered version only)       ۲ 
      

     The registered version of SyncEdit allows for the use of up to 20 
     different tag lines.  Remember, all the *.TAG files, must be placed in 
     the external directory pointed to by the first command line argument.  

     Each TAG file may be up to 600 bytes in length.  If these limits are
     exceed, the file will be truncated.  Tag files may contain both ANSI or
     ASCII text and must be named using any valid DOS name, with an extension
     of .TAG.  These names may be descriptive, as in ANSI.TAG, ASCII.TAG,
     simple as in 1.TAG, 2.TAG, or any other scheme you prefer.  Use
     desecration when using tag lines, particularly those containing ANSI
     escape codes as they can quickly become overdone and irritating to
     readers of your messages (and network administrators).

     If more than one *.TAG file is found, SyncEdit will randomly select
     a different *.TAG file each time the editor is called by the BBS.  
     For example, if you have two *.TAG files, the odds are approximately 
     50-50 that a particular tag file will be used.  If you have three tag 
     files, the odds are 1 in 3, and so on.  If you only wish to have one tag 
     line added by the editor, only define one tag file, for example 1.TAG.  
     If you don't want any tag lines added, simply don't define any.  

     Note, the unregistered "SyncEdit" tear line is not user definable or 
     modifiable.  The tear line is not appended by the registered version.



     Ŀ 
                         Sysop (only) Macro Files                  ۲ 
      

     For the macros, a file named SYNCEDIT.MAC must be in the external
     directory.  We have included a basic macro file so you have a reference
     point for creating your own.

     There is a maximum of 40 macros lines allowed.  If this number is 
     exceeded, only 40 will be used.  Lines that have a ';' in column one
     will be skipped, which is primarily used for adding comments to the
     macro file.  Blank lines are skipped also.  Everything else is   
     considered a macro line.

     Macro lines 1-10 correspond to F1-F10 on the keyboard; 11-20 to
     shift+F1-f10; 21-30 to ctrl+F1-F10; and finally 31-40 to alt+F1-F10.  For
     example, if you have 11 lines that are considered macro lines, then you 
     can insert those lines into your message by pressing F1-F10 and shift+F1.
     If you press shirt+F2, the computer will beep telling you that there isn't
     a macro associated with that key.

     One common use of a macros as implemented within SyncEdit is to allow
     the Sysop to easily use different signatures, depending on the target
     audience of the message.



     Ŀ
                            User Dictionaries                      ۲ 
     

     Any user that is allowed to use SyncEdit will be able to create their own 
     custom dictionary.  SyncEdit will provide a menu item entitled ADD when 
     it encounters a word during a spell checking session that it doesn't
     believe is spelled correctly.  By simply choosing the add option the
     highlighted word will be added to the users personal dictionary (*not*
     the master dictionary).  Please note, SyncEdit doesn't delete user
     dictionaries when there are changes to the BBS database.  Consequently,
     if a user is deleted from the BBS database, the next person that has
     the same user number will inherit the old dictionary.



     Ŀ 
                      Registration Cost and Process                ۲ 
      

     Registration fee is $20.00 (twenty dollars US).  That's right, only
     twenty dollars.  This will get you a key code which you can use to
     generate a customized key file that will activate all the editors
     features.

     Please review, complete and return the REGISTER.FRM (enclosed).  

     Save yourself the time and expense of calling us to determine if we 
     accept on-line orders or credit cards.  We don't.  Currently, the only 
     way to register is to follow the procedure outlined above.  When this 
     changes, we'll be sure to announce it.  



     Ŀ 
                                Cautions                           ۲ 
      

     This product was designed specifically to interface with the Synchronet 
     BBS system, and has not been tested with other BBS packages.  Though it 
     may work with other BBS systems, we make no representation that it will.  



     Ŀ 
                            Technical Support                      ۲ 
      

     Support is provided by calling the SyncEdit support BBS; The Game Room
     (616)857-3135 and either posting a message to "Playster" in the SyncEdit
     message section or by sending private e-mail, via FidoNet netmail
     (1:2201/11) addressed to Robert Bouman or Internet e-mail addressed to
     bouman@macatawa.org.

     Please note, we will do everything possible to assist folks in getting 
     the freely distributable version up and running.  However, technical 
     support is primarily intended for registered users.  They are after all, 
     our paying customers.  

     Apparent bug reports should be forwarded as identified above.  Please 
     provide as much detail as possible regarding your difficulty, ie hardware 
     configuration, BBS setup (paths, etc), and a specific description of the 
     problem.  

     Suggestions regarding new features, and comments in general are welcome 
     from all users and should be forwarded as indicated above.  



     Ŀ 
                            Known "Anomalies"                      ۲ 
      

     o SyncEdit is limited to a maximum of 500 lines of text.  If attempts are 
       made to use more than 500 lines, the editor will continue to load and
       enter into an editing session.  However, only the first 500 lines of
       text will actually be edited and saved.

     o There seems to be some incompatibilities when SyncEdit is used under 
       Novell DOS v7.  In particular, the problem occurs when attempting an
       editing session from the WFC screen.  Usage of the editor from within
       the BBS is not generally affected.

     o Due to the spelling library SyncEdit currently uses, there are times
       the spell checker will flag words as misspelled when in fact the word 
       is spelled correctly.  This may be most noticeable when adding words to 
       one's personal dictionary.  We are aware of the problem, but due to the 
       fact that we don't have the source code to the library we can't easily 
       correct the problem.  The solution lies in either writing our own 
       library from scratch or locating another spelling library.  We are 
       investigating the options are planning to correct this situation in a
       future release.



     Ŀ 
                             Upgrade Policy                        ۲ 
      

     Registering SyncEdit is a one time ONLY process.  By purchasing the
     registered version of SyncEdit, you get a life long "subscription" to
     all future versions of SyncEdit.



     Ŀ 
                              Miscellaneous                        ۲ 
      

     SyncEdit reads either the INPUT.MSG placed in the node directories by
     the BBS, or the file passed to it from the BBS via the %f parameter,
     EDITOR.INF, QUOTES.TXT, and Synchronet's drop file XTRN.DAT.  No other
     files are read from or written to.

     If the LoadFile or SaveFile commands are used, SyncEdit will load and
     save to the path\file provided by the user.  It does not, however,
     modify any BBS system files on it's own.


     SyncEdit is a trademark of Robert D. Bouman.
     Synchronet is a trademark of Digital Dynamics.
     All other brands are trademarks or registered trademarks of their
     respective companies.
