home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DCTED004.ZIP / DCTEDIT.TXT < prev    next >
Text File  |  1998-01-05  |  39KB  |  789 lines

  1.  
  2.                             DCTEdit v0.04 Gamma
  3.                              By Dan Traczynski
  4.                          Released January 5, 1998.
  5.  
  6.          Copyright (C) 1997, 1998 Dan Traczynski.  All rights reserved.
  7.  
  8. ──────────────────────────────────────────────────────────────────────────────
  9. ││││││││││││││││││││││││││    Table of Contents    │││││││││││││││││││││││││││
  10. ──────────────────────────────────────────────────────────────────────────────
  11.  
  12.                    »         Contact Information         «
  13.                    »            Introduction             «
  14.                    »            Installation             «
  15.                    »       Command-Line Parameters       «
  16.                    »         Tagline Management          «
  17.                    »          Language Support           «
  18.                    »             Menu Editor             «
  19.                    »         SysOp Function Keys         «
  20.                    »          Global DCT Files           «
  21.                    »        SCRUTIL.EXE Explained        «
  22.                    »           Imbedded Codes            «
  23.                    »      Distribution & Disclaimer      «
  24.                    »   Author's Notes and Support Info   «
  25.                    »    History - Notes from the Past    «
  26.  
  27.  
  28. ──────────────────────────────────────────────────────────────────────────────
  29. ││││││││││││││││││││││││││    Contact Information    │││││││││││││││││││││││││
  30. ──────────────────────────────────────────────────────────────────────────────
  31.  
  32.     E-mail              dant@sfu.ca (best method of contacting the author)
  33.     Netmail             Dan Traczynski, 1:153/757
  34.     FidoNet EchoMail    RA_UTIL
  35.     WWW                 http://www.sfu.ca/~dant/
  36.                         http://www.worldnet.net/~island/dct.htm
  37.     FTP                 ftp://ftp.canbbs.net/pub/DCT_Productions/
  38.     Mailing List        dctprod@madmanmark.ml.org
  39.                         To subscribe:
  40.                           Send a message to <majordomo@madmanmark.ml.org>
  41.                           with only the text "subscribe dctprod" (sans
  42.                           quotes) in the message text.
  43.  
  44.  
  45. ──────────────────────────────────────────────────────────────────────────────
  46. │││││││││││││││││││││││││││││    Introduction    │││││││││││││││││││││││││││││
  47. ──────────────────────────────────────────────────────────────────────────────
  48.  
  49.    DCTEdit is a full-screen message editor which should run under any BBS
  50. that supports external editors.  DCTEdit was designed to be more like a word
  51. processor than a remote text editor, and employs an easy to use pull-down
  52. menu interface.  Offline mail readers are also supported.
  53.  
  54.    DCTEdit has been tested with and found to work under the following BBSs:
  55.       RemoteAccess 2.xx       Ezycom 1.20
  56.       ProBoard 2.15           Tornado 1.52g
  57.       Telegard 3.02
  58.  
  59.    This does not mean that DCTEdit will not work with other systems, it just
  60. means that I haven't personally had the opportunity to test it with any other
  61. systems.
  62.  
  63.  
  64. ──────────────────────────────────────────────────────────────────────────────
  65. ││││││││││││││││││││││││││    Installation Guide    ││││││││││││││││││││││││││
  66. ──────────────────────────────────────────────────────────────────────────────
  67.  
  68. To install DCTEdit on your BBS, simply follow the steps listed below.  If you
  69. are upgrading from a previous version of DCTEdit, please refer to UPGRADE.DOC.
  70.  
  71. 1.  Unzip DCTEdit into its own directory.  The directory C:\BBS\DOORS\DCTEDIT
  72.     will be used throughout this text.
  73.  
  74. 2.  Run CONFIG.EXE and configure DCTEdit to your system.  If you run RA 2.xx,
  75.     Telegard 3.xx, ProBoard 2.1x, or Ezycom 1.20/newer, and CONFIG detects
  76.     the BBS on your system, you will be prompted if you would like to do an
  77.     auto-install.  This means that CONFIG will extract any relevant
  78.     information from your BBS setup and then automatically install itself
  79.     as the external full-screen editor into the BBS for you.  If you answer
  80.     YES to this prompt, you can skip installation step 3.
  81.  
  82. 3.  Add DCTEdit to your BBS configuration.  Each system is different, so a
  83.     command-line that will work under every setup cannot be given.  The best
  84.     and recommended method of invoking DCTEdit would be
  85.     "C:\BBS\DOORS\DCTEDIT\DCTEDIT.EXE /P<path to drop file> /N<node number>".
  86.     Batch files are not needed and DCTEdit does not have to be run in the
  87.     current directory.  DCTEdit will look for the drop file and the
  88.     MSGTMP/MSGINF files in the path to the drop file.  If your BBS uses a
  89.     different file than MSGTMP, you may use the /F command-line parameter to
  90.     instruct DCTEdit to load this different file.  Please see the
  91.     "Command-Line Parameters" section for a detailed list of parameters.
  92.  
  93. 4.  Add any inappropriate words you want filtered out to
  94.     'CONFIG.Editor.Filters'.  No words have been pre-defined to filter out,
  95.     so I leave it up to your imagination to pick the words.
  96.  
  97. 5.  DCTEdit should now be working on your system.
  98.  
  99.  
  100. ──────────────────────────────────────────────────────────────────────────────
  101. │││││││││││││││││││││││    Command-Line Parameters    ││││││││││││││││││││││││
  102. ──────────────────────────────────────────────────────────────────────────────
  103.  
  104. The switch for each command-line parameter can be either a hyphen or a slash.
  105. For example, "-L" will yield the same result as "/L".  A colon may also be
  106. used between the parameter and the data following it, so "/N:1" is the
  107. equivalent of "-N1".
  108.  
  109.  /A     Forbids the user from aborting the message.  Useful for new user
  110.         messages when you want to make sure the user posts you a message.
  111.  
  112.  /Bnnn  Specifies the locked baud rate.  This parameter overrides anything
  113.         set in the configuration.
  114.         ie. /B38400
  115.             - Sets the locked baud rate to 38400 baud.
  116.  
  117.  /Dxxx  Loads an alternate screen definition instead of the one specified in
  118.         'CONFIG.System.Settings.Images File'.  Any path or file extension
  119.         given is stripped.
  120.         ie. /DCUSTOM
  121.             - Loads the screen definition file CUSTOM.EDS in the DCTEdit
  122.               directory.
  123.  
  124.  /E     Tells DCTEdit that it is loading a text file rather than a message
  125.         for editing.  DCTEdit will ignore the uppercase and quote limits and
  126.         will also suppress adding a tagline or signature at the end.  Please
  127.         also refer to the note at the end of this section on this parameter.
  128.         ie. DCTEDIT /E /FC:\BBS\*.BAT
  129.             - Lets the SysOp (or anyone else with the access) edit any .BAT
  130.               file in the C:\BBS directory remotely.
  131.  
  132.  /Fxxx  Specifies an alternate file to load and save instead of MSGTMP.  This
  133.         is useful when using DCTEdit with an offline reader or a BBS which
  134.         uses its own naming convention.
  135.         ie. /FC:\BBS\MSGTMP.1
  136.             - Loads and saves C:\BBS\MSGTMP.1.
  137.  
  138.  /L     Used for testing DCTEdit in local mode.
  139.  
  140.  /Nnn   Passes the node number to DCTEdit.  This parameter must be specified
  141.         on multinode systems or conflicts may arise when two users enter the
  142.         door and both windows of DCTEdit think they're on the same node.  If
  143.         this parameter is not specified (ie. on single node systems), node 1
  144.         is assumed.
  145.         ie. /N2
  146.             - Tells DCTEdit the user is on node 2.
  147.  
  148.  /O     Instructs DCTEdit that it is being run from an offline reader.  This
  149.         parameter is usually accompanied by the /F parameter.
  150.         ie. DCTEDIT -O -F@F
  151.             - Command-line used if running DCTEdit from Blue Wave.
  152.         ie. DCTEDIT /O /PC:\TERMINAT
  153.             - Command-line used if running DCTEdit from Terminate.  The /P
  154.               parameter indicates that the MSGINFO.SYS file is in the
  155.               C:\TERMINAT directory.
  156.  
  157.  /Pxxx  Specifies the path to the drop file and the MSGTMP/MSGINF files.
  158.         ie. /PC:\BBS\NODE1
  159.             - DCTEdit will then look for the drop file in C:\BBS\NODE1.
  160.  
  161.  /R     Loads the file read-only (useful for using DCTEdit as a text file
  162.         viewer).  Only allowed if used in conjunction with the /E parameter.
  163.  
  164.  /Snnn  Passes the user's security level to DCTEdit.
  165.         ie. /S1000
  166.             - Gives the user security level 1000 regardless of what the drop
  167.               file says.
  168.  
  169.  /Tnnn  Passes the user's time remaining to the door.  This setting overrides
  170.         anything in the drop file.
  171.         ie. /T20
  172.             - Gives the user 20 minutes of time regardless of what the drop
  173.               file says.
  174.  
  175.  /W     A DOS only network is present.
  176.  
  177.  
  178.     ┌───────────────────────────────────────────────────────────────────┐
  179.     │ NOTE ABOUT /E PARAMETER!                                          │
  180.     │                                                                   │
  181.     │ This is a very powerful and useful option that can also be very   │
  182.     │ destructive if access is given to the wrong person.  DCTEdit      │
  183.     │ should only be executed with the /E parameter from the SysOp menu │
  184.     │ or some other place that only the SysOp can access.  You          │
  185.     │ essentially have the power to view and edit almost any file on    │
  186.     │ the hard drive remotely with this feature.  If the /E parameter   │
  187.     │ is not specified, DCTEdit will never allow the user to select     │
  188.     │ which file to edit.  DCTEdit will only load ASCII text files (ie. │
  189.     │ batch files) and will not allow editing of any file which         │
  190.     │ contains characters below ASCII 32 (which means ANSI files can't  │
  191.     │ be loaded either).  If there is even a remote chance that a user  │
  192.     │ might be able to access this option, I strongly urge you to set   │
  193.     │ the 'CONFIG.System.Settings.Edit Password' field so that a        │
  194.     │ password must first be entered before allowing remote access to   │
  195.     │ this option.  The password is stored as a CRC-32 value and thus   │
  196.     │ cannot easily be decrypted.                                       │
  197.     └───────────────────────────────────────────────────────────────────┘
  198.  
  199.  
  200. ──────────────────────────────────────────────────────────────────────────────
  201. ││││││││││││││││││││││││││    Tagline Management    ││││││││││││││││││││││││││
  202. ──────────────────────────────────────────────────────────────────────────────
  203.  
  204.    DCTEdit implements its own internal tagline support, so there is no need
  205. for an external tagline door like DCTTag.  Approximately 1400 taglines have
  206. been supplied with this program, but you may wish to add your own or edit the
  207. existing ones.  To do so, simply edit the file DCTEDIT.TAG with any text
  208. editor (DOS' EDIT.EXE works very well).  DCTEDIT.TAG is a plain ASCII file in
  209. the format of one tagline per line, and no compiling to a tagline database
  210. file is required.  Taglines cannot be longer than 74 characters.  If they are,
  211. only the first 74 characters will be used.
  212.  
  213.    No sorting utility has been provided as the SORT.EXE that is packaged with
  214. DOS is quite capable of performing this job.  If you wish to sort the tagline
  215. file, a command-line similar to the following may be used:
  216.  
  217.    SORT.EXE <DCTEDIT.TAG >DCTEDIT.TAG
  218.  
  219.    Imbedded codes, such as the name of the recipient, may also be used in
  220. the taglines.  The following codes may be used:
  221.  
  222.    @BBS@   Name of BBS
  223.    @D@     Current date (DD-Mmm-YY)
  224.    @F@     Sender's full name
  225.    @FF@    Sender's first name
  226.    @FL@    Sender's last name
  227.    @FN@    Recipient's first name
  228.    @FROM@  Sender's full name
  229.    @LN@    Recipient's last name
  230.    @N@     Recipient's full name
  231.    @TO@    Recipient's full name
  232.  
  233.    DCTEdit also has the capability of stealing taglines out of the quoted text
  234. of a message the user is replying to.  To enable this option, set
  235. 'CONFIG.System.Taglines.Adopt Taglines' to YES.  Taglines are saved to the
  236. binary data file NEWTAG.ED which you can view from the Acquired Tagline
  237. Manager.  More on this manager is explained below.
  238.  
  239.    If 'CONFIG.System.Taglines.Log Additions' has been enabled, any custom
  240. taglines that users add to their messages will be logged to the binary data
  241. file NEWTAG.ED.  You can then view this file and copy any taglines you like
  242. to DCTEDIT.TAG via the Acquired Tagline Manager.
  243.  
  244.    The Acquired Tagline Manager allows you to view taglines which DCTEdit has
  245. obtained and decide what to do with them.  You can export each tagline to the
  246. DCTEDIT.TAG file, remove the "Add Tagline" access of the user who added the
  247. tagline, or simply delete it.  The manager may be accessed from
  248. 'CONFIG.Editor.Taglines'.
  249.  
  250.  
  251. ──────────────────────────────────────────────────────────────────────────────
  252. │││││││││││││││││││││││││││    Language Support    │││││││││││││││││││││││││││
  253. ──────────────────────────────────────────────────────────────────────────────
  254.  
  255.    DCTEdit supports multiple language files so that each user can run DCTEdit
  256. in his or her own native language (provided that the language file exists).
  257. Language files can be edited from 'CONFIG.Editor.Languages', and the following
  258. imbedded codes may be used in the applicable strings.
  259.  
  260.   %U      User's name.
  261.   %S      Board name.
  262.   %1      A temporary string that varies with each language prompt.
  263.   %%      Displays a single per cent symbol.
  264.   @1..9   Changes the colour to one selected in 'CONFIG.Colours':
  265.                1  Box
  266.                2  Lightbar
  267.                3  Highlight
  268.                4  Disabled
  269.                5  Message text
  270.                6  Quoted text
  271.                7  Title
  272.                8  Window text
  273.                9  Input Fields
  274.  
  275.  
  276. ──────────────────────────────────────────────────────────────────────────────
  277. │││││││││││││││││││││││││││││    Menu Editor    ││││││││││││││││││││││││││││││
  278. ──────────────────────────────────────────────────────────────────────────────
  279.  
  280.    Don't want a certain option in the pull-down menu?  Do you want "Abort" to
  281. come before "Save"?  Or how about displaying the menus in a different
  282. language?  This can all be configured through 'CONFIG.Editor.Menus'.  You may
  283. configure up to 6 pull-down menus and 6 items per menu, for a total of 36
  284. user options (DCTEdit currently has 14 menu options to play with).  You will
  285. first be presented with a list of the 6 menus, from which you may choose one
  286. to edit.  In the editing screen, simply select the item to change, then hit
  287. [Enter] to make the changes.  The following text should help explain what each
  288. option means.
  289.  
  290.  TYPE
  291.  
  292.    Instructs DCTEdit as to what it should do when this option is selected.
  293.  
  294.  DISPLAY
  295.  
  296.    Text which is displayed to the user in the menu picklist.  A caret (^)
  297. symbol is used to denote what the item's hotkey will be (ie. S^ave tells
  298. DCTEdit to use 'A' as the item's hotkey).  If there are two items in the same
  299. menu with the same hotkey, only the first one will be honoured.
  300.  
  301.  SECURITY
  302.  
  303.    You wouldn't want your users to have the ability to import text files from
  304. anywhere on your hard drive into the message, so setting the SECURITY option
  305. tells DCTEdit to restrict access to certain people only.  "SysOp" will
  306. restrict access to only those with security level greater than or equal to
  307. 'CONFIG.System.Site Info.SysOp Security' and "Local" forces DCTEdit to only
  308. make the option available when running in local mode.
  309.  
  310.  HOTKEY
  311.  
  312.    This item cannot be configured directly, rather it simply displays what
  313. you have selected as the hotkey in 'DISPLAY'.
  314.  
  315.  
  316. ──────────────────────────────────────────────────────────────────────────────
  317. │││││││││││││││││││││││││    SysOp Function Keys    ││││││││││││││││││││││││││
  318. ──────────────────────────────────────────────────────────────────────────────
  319.  
  320.    DCTEdit allows you to define up to 9 function keys to run external
  321. programs.  Some possible uses are editing files locally in DOS' edit, running
  322. an external SysOp-User chat door, running an external user editor, running
  323. a "who's online" program, etc.  The F2 through F10 keys may be configured, F1
  324. being the key that displays what the rest do in DCTEdit.  The function keys
  325. may be configured through 'CONFIG.Editor.Fn Macros'.  The following imbedded
  326. codes may be used in the command-line:
  327.  
  328.  *Axxx; Tells DCTEdit to change to the directory 'xxx' before shelling out.
  329.         The trailing backslash is not required.  Many programs require that
  330.         you change to their directory first and creating a batch file to
  331.         simply change directories before executing the program is a waste of
  332.         space, thus the need for this parameter.
  333.         ie. *AC:\RA;
  334.             - Shells to DOS in the C:\RA directory.
  335.  
  336.  *B     User's baud rate, 0 if logged in locally.
  337.  
  338.  *C     Full path and name to COMMAND.COM or other operating system obtained
  339.         via COMSPEC environment variable.
  340.  
  341.  *D     Instructs DCTEdit to create a DORINFO1.DEF drop file in the DCTEdit
  342.         directory.  If used in conjunction with the *R option, you could
  343.         execute an external door from within DCTEdit.
  344.  
  345.  *N     The current node number, as specified by DCTEdit's /Nx command-line
  346.         parameter.
  347.  
  348.  *P     Communications port being used.
  349.  
  350.  *R     Normally, DCTEdit does not redraw the screen remotely after the
  351.         program has completed execution.  If this shell will run a program
  352.         which displays text remotely (ie. a door), specifying '*R' in the
  353.         command-line will force DCTEdit to redraw the screen remotely upon
  354.         returning.
  355.  
  356.  *S     User's security level.
  357.  
  358.  *T     Time remaining (in minutes).
  359.  
  360.  *Uxxx; If you wish to obtain user input before running the external program,
  361.         you can use this code.  The text 'xxx' will be displayed to the user,
  362.         and whatever the user enters will be inserted into the command-line
  363.         where the '*U' is placed.  You can specify multiple *U user inputs in
  364.         one command-line.
  365.  
  366.  *W     Instructs DCTEdit to wait for a local keypress after the external
  367.         program has terminated and DCTEdit has not yet redrawn the screen.
  368.         Useful if doing a directory listing.
  369.  
  370.  **     Replaced by a single asterisk.
  371.  
  372.  
  373.     ┌───────────────────────────────────────────────────────────────────┐
  374.     │ USEFUL TIPS                                                       │
  375.     │                                                                   │
  376.     │ * If running an external door, be sure to add the *D and *R codes │
  377.     │   to the command-line.  You can also add the *A code if the door  │
  378.     │   requires you to change to its directory before running it (thus │
  379.     │   avoiding another batch file).                                   │
  380.     │   ie. '*AC:\RA\DCTCALL;DCTCALL.EXE *D *R' would execute DCTCall   │
  381.     │       after changing to the C:\RA\DCTCALL directory.              │
  382.     │       (Technically, DCTCall doesn't need to be run from its own   │
  383.     │       directory.)                                                 │
  384.     │                                                                   │
  385.     │ * A "*C /C" prefix is not required to run a batch file (it's      │
  386.     │   handled internally), but it is required if you want to run an   │   
  387.     │   internal DOS command (ie. DIR).                                 │
  388.     │                                                                   │
  389.     └───────────────────────────────────────────────────────────────────┘
  390.  
  391.  
  392. ──────────────────────────────────────────────────────────────────────────────
  393. │││││││││││││││││││││││││││    Global DCT Files    │││││││││││││││││││││││││││
  394. ──────────────────────────────────────────────────────────────────────────────
  395.  
  396.    Any files with a .DCT extension can be copied to other DCT Productions
  397. which support them thus making setup just a little bit quicker.  As of this
  398. release, the following files may be interchanged:
  399.  
  400.   FILTER.DCT    Text to censor from user input.
  401.    └> DCTEdit v0.03
  402.    └> DCT UserChat v0.02
  403.  
  404.   XLAT.DCT      Translation table.
  405.    └> DCTEdit v0.03
  406.    └> DCT UserChat v0.02
  407.  
  408.  
  409. ──────────────────────────────────────────────────────────────────────────────
  410. ││││││││││││││││││││││││    SCRUTIL.EXE Explained    │││││││││││││││││││││││││
  411. ──────────────────────────────────────────────────────────────────────────────
  412.  
  413. SCRUTIL.EXE is the program which will allow you to customise the way DCTEdit
  414. looks to the users.  It is completely command-line driven, and will import or
  415. export ANSI images to/from the screen definition file.
  416.  
  417.  
  418.   Command-Line Parameters
  419.  ─────────────────────────
  420.  
  421.    SCRUTIL [Def File] [/?] [/CREATE] [/ADD <Screen> <File Name>]
  422.            [/EXTRACT <Screen> <File Name>] [/IMPORT [Ctl File]]
  423.            [/EXPORT [Ctl File]] [/BORDER]
  424.  
  425.   [Def File]
  426.  
  427.      The definition file is the image file that SCRUtil will work with and
  428.   what DCTEdit will load and use.  If it is not specified, the default
  429.   DCTEDIT.EDS will be used.
  430.  
  431.   [/?]
  432.  
  433.      Displays a brief help screen summarising the commands.
  434.  
  435.   [/CREATE]
  436.  
  437.      Creates a default definition file with no images in it.  It is then up
  438.   to you to add the images in.
  439.  
  440.   [/ADD <Screen> <File Name>]
  441.  
  442.      This option will add an ANSI file into the definition file.  The
  443.   <screen> variable is the image number that the ANSI file will be added as.
  444.   <File name> specifies the ANSI file to add.
  445.  
  446.   [/EXTRACT <Screen> <File Name>]
  447.  
  448.      This option is the reverse of ADD.  Instead of adding the ANSI, SCRUtil
  449.   will extract it and save it as <file name>.
  450.  
  451.   [/IMPORT [Ctl File]]
  452.  
  453.      This option will allow you to import a group of images at once.  In
  454.   order to do this, you must first create a control file listing all of the
  455.   file names and image numbers.  The format is the same as with the ADD
  456.   parameter.  If [Ctl File] is not specified, the default SCRUTIL.CTL is
  457.   used.  The following is a sample control file:
  458.  
  459.       0 CMDLIST.ANS
  460.       1 GENHELP.ANS
  461.       2 PROGINFO.ANS
  462.       3 TOPBORD.ANS
  463.       4 BOTBORD.ANS
  464.  
  465.      If this were the file, CMDLIST.ANS would be added as image 0,
  466.   GENHELP.ANS as image 1, and so on.
  467.  
  468.   [/EXPORT [Ctl File]]
  469.  
  470.      This parameter is the reverse of the IMPORT parameter, and takes the
  471.   same arguments as the IMPORT parameter.  If the above sample control file
  472.   were used, image 0 would be exported to HDR.ANS, image 1 would be exported
  473.   to FTR.ANS, and so on.  A sample SCRUTIL.CTL file has been included with
  474.   this archive.
  475.  
  476.   [/BORDER]
  477.  
  478.      Allows you to edit what characters to use as border lines in the
  479.   pull-down menus.
  480.  
  481.  
  482. ──────────────────────────────────────────────────────────────────────────────
  483. │││││││││││││    Imbedded Codes in the Screen Definition File    │││││││││││││
  484. ──────────────────────────────────────────────────────────────────────────────
  485.  
  486.    Each code follows a simple format, that being an @ sign followed by the
  487. code, then the data field, then the terminating pipe symbol.  Codes may be
  488. imbedded as many times as you wish, so long as the fully translated code is
  489. no longer than 255 characters.  The file SCRUTIL.CTL contains the specific
  490. information on what each screen in the images file is used for.
  491.  
  492.  Name      Description                Example
  493.  --------  -------------------------  ---------------------------------------
  494.  AREANAME  Message area name          @AreaName|
  495.                                       Returns the area that the message has
  496.                                       been posted in.
  497.  
  498.  AREANUM   Area number                @AreaNum|
  499.                                       Returns the number of the area the
  500.                                       message is being posted in.
  501.      
  502.  BBSNAME   System name                @BBSName|
  503.                                       Returns the name of the BBS configured
  504.                                       in 'CONFIG.System.Site Info.BBS Name'.
  505.  
  506.  CLEARWIN  Clear window               @ClearWin.2,2,80,10,1|
  507.                                       Clears a window of the screen, making
  508.                                       the background blue (1).  In this
  509.                                       example, the window cleared would start
  510.                                       at (2, 2) and end at (80, 10).
  511.  
  512.  COLOUR    Change to colour           @Colour.1|
  513.                                       Changes the colour to blue (1).
  514.  
  515.  CURTIME   Current time               @CurTime.0|
  516.                                       Returns the current time in HH:MMp
  517.                                       format.  If the hour is less than 10,
  518.                                       the '0' in the data field specifies
  519.                                       that the hour field should be padded
  520.                                       with a '0' (ie. 09:00p).  If nothing is
  521.                                       specified in the data field, a zero is
  522.                                       used.
  523.  
  524.  DEFCOL    Return default colour      @DefCol.5|
  525.                                       Returns the colour of the fifth item in
  526.                                       the colour configuration, that being
  527.                                       "message text."  An optional ",<H|L>"
  528.                                       may be used after the number, defining
  529.                                       whether to change to the bright or
  530.                                       normal colour (ie. @DefCol.5,H| returns
  531.                                       15, @DefCol.5,L| returns 7, assuming
  532.                                       the item is set to 7, white).  See the
  533.                                       Language Support section for a list of
  534.                                       the configurable colours.
  535.  
  536.  EVAL      Evaluate math              @Eval.20-4/2*4|
  537.                                       Evaluates a mathematical string.  In
  538.                                       this case, the result will be 32 and
  539.                                       the order of operations (BEDMAS) are
  540.                                       always ignored (so it evaluates
  541.                                       20-4=16, then 16/2=8, then 8*4=32).
  542.                                       Valid characters are '+', '-', '/', and
  543.                                       '*'.  Parentheses are not supported in
  544.                                       this version.
  545.  
  546.  FROMNAME  Sender's name              @FromName|
  547.                                       Returns the name the message is from.
  548.  
  549.  LENGTH    Return length of string    @Length.@ToName||
  550.                                       Returns the length of the string
  551.                                       @ToName|, that being the name of the
  552.                                       person the message is to.
  553.  
  554.  LNG       Language string            @Lng.2|
  555.                                       Returns language string #2.
  556.  
  557.  NUMLINES  Number of lines on screen  @NumLines|
  558.                                       Returns the number of lines on the
  559.                                       screen available to the user.  For
  560.                                       example, if the screen is in 25 line
  561.                                       mode and there is a status line,
  562.                                       @NumLines| will return 24.  If there is
  563.                                       no status line, @NumLines| returns 25.
  564.  
  565.  PAD       Pad string                 @Pad.@ToName|,20|
  566.                                       Pads the string @ToName| with spaces so
  567.                                       that it equals 20 characters.
  568.  
  569.  PADC      Pad char                   @PadC.-,20|
  570.                                       Returns the character '-' 20 times.
  571.  
  572.  PAUSE     Pause                      @Pause|
  573.                                       Waits for a keypress while displaying a
  574.                                       pulsing prompt.
  575.  
  576.  RAND      Random write               @Rand.──────,4,12|
  577.                                       Writes the string "──────" in the random
  578.                                       colours red and bright red (4,12).
  579.  
  580.  RESTSCR   Restore screen             @RestScr.1,1,80,24|
  581.                                       Restores a segment of the screen saved
  582.                                       by @SaveScr|, starting at (1, 1) and
  583.                                       ending at (80, 24).
  584.  
  585.  SAVESCR   Save screen                @SaveScr|
  586.                                       Saves the current screen.
  587.  
  588.  SUBJECT   Message subject            @Subject|
  589.                                       Returns the subject of the message.
  590.                                       If in module mode, this will return the
  591.                                       title to be displayed.
  592.  
  593.  TIMELEFT  Time left                  @TimeLeft|
  594.                                       Returns the number of minutes left.
  595.  
  596.  TONAME    Recipient's name           @ToName|
  597.                                       Returns the name the message is to.
  598.  
  599.  TRUNC     Truncate variable          @Trunc.@AreaName|,20|
  600.                                       If the length of @AreaName| is greater
  601.                                       than 20 characters, only the first 20
  602.                                       characters will be displayed.
  603.                                       Otherwise, it is displayed as is
  604.                                       without any whitespace padding added to
  605.                                       the end.
  606.  
  607.  UPDOFF    Disallow screen updates    @UpdOff|
  608.                                       Turns off screen updates (ie. the time
  609.                                       and time left being displayed in the
  610.                                       header).
  611.  
  612.  UPDON     Allow screen updates       @UpdOn|
  613.                                       Turns on screen updates (ie. the time
  614.                                       and time left being displayed in the
  615.                                       header).
  616.  
  617.  VER       Version number             @Ver|
  618.                                       Returns the version number of DCTEdit.
  619.  
  620.  
  621. ──────────────────────────────────────────────────────────────────────────────
  622. ││││││││││││││││││││││    Distribution & Disclaimer    │││││││││││││││││││││││
  623. ──────────────────────────────────────────────────────────────────────────────
  624.  
  625.    DCTEdit is copyright (C) 1997, 1998 by Dan Traczynski.  All rights
  626. reserved.  I encourage you to distribute it, but DO NOT by any means alter
  627. any of the files within the original archive.  DCTEdit may not be included on
  628. any CD-ROM collections.  The archive should be named DCTED004.ZIP, preferably
  629. kept in its ZIP format.
  630.  
  631.    The author, Daniel Traczynski, will take no responsibility to anything
  632. that this program may or may not do to your system.  Although the program has
  633. been tested thoroughly by the support team, no guarantee can be given that it
  634. will do what it was made to do.  Nevertheless, if anything should happen, the
  635. user is totally responsible and the author will be under no obligations what-
  636. soever.  By using this program you agree to this disclaimer.
  637.  
  638.  
  639. ──────────────────────────────────────────────────────────────────────────────
  640. │││││││││││││││││││││││    Author's Notes/Support    │││││││││││││││││││││││││
  641. ──────────────────────────────────────────────────────────────────────────────
  642.  
  643.    Many of the features that I add to this door are requests made by SysOps,
  644. so if you would like to see a new feature added to this door, by all means
  645. send me e-mail and I will try to add in your request.  I can be reached at
  646. dant@sfu.ca.  If you do not have Internet e-mail access, I can also be
  647. contacted via the FidoNet RA_Util echo or by netmail at 1:153/757.
  648.  
  649. DCTEdit and other DCT Productions can be found on the Internet at:
  650.                                      http://www.worldnet.net/~island/dct.htm
  651.                                      http://www.sfu.ca/~dant/bbs/dct.htm
  652.                                      ftp://ftp.canbbs.net/pub/DCT_Productions/
  653.  
  654. Thanks go to Francois Massonneau for hosting the worldnet site and Jason
  655. Feasby for hosting the FTP site.
  656.  
  657.  
  658. ──────────────────────────────────────────────────────────────────────────────
  659. ││││││││││││││││││││││││││││    Release Notes    │││││││││││││││││││││││││││││
  660. ──────────────────────────────────────────────────────────────────────────────
  661.  
  662.   + Added a new feature/Something was improved.
  663.   - Removed something.
  664.   * General comment.
  665.   > Bug fix.
  666.  
  667.  
  668.  Version 0.04 Gamma -=- January 5, 1998.
  669.    + Added spell checking routines.
  670.    + DCTEdit now auto-configures itself to RA/PB/TG/EZY BBSs when CONFIG is
  671.      first run.
  672.    + Added Telegard 3.0x and Ezycom 2.10/newer support to the override
  673.      manager.
  674.    + Improved the override manager; it's now much easier to change the flag
  675.      settings of areas.
  676.    + DCTEdit can now 'adopt' taglines out of the quoted text in message
  677.      replies.
  678.    + Added the MAKEDICT.EXE program to compile DCTEdit's dictionary.  Run it
  679.      without any parameters for program usage information.
  680.    > Fixed a bug when DCTEdit was reformatting quoted text.
  681.    > Users could add their own taglines to messages regardless of whether it
  682.      was enabled in CONFIG; DCTEdit just wouldn't display the option on the
  683.      screen if it was disabled.  Fixed.
  684.    * The System.Preferences, System.Limits, and System.General menus in
  685.      CONFIG have been merged into two new System.Site Info and System.General
  686.      menus.
  687.    > Pressing the left or right cursor keys in the user setup menu no longer
  688.      exits it.
  689.    + Added the /A parameter.
  690.    + Added CLASSIC.EDS screen definition file.
  691.    > Fixed a problem when @F@ was used in the default signature for new
  692.      users.
  693.    + The character that begins a kludge line may now be configured.
  694.    + DCTEdit now supports node 0.
  695.    + DCTEdit will now properly display the message area name under Ezycom
  696.      systems.
  697.  
  698.  
  699.  Version 0.03 Gamma -=- October 4, 1997.
  700.    + Improved the censoring system.  DCTEdit no longer uses messy text files
  701.      but rather it reads in FILTER.DCT which may be edited through CONFIG.
  702.    + The maximum length of each line of quoted text may now be configured.
  703.    + Added macros/AutoCorrect/whatever you want to call it.
  704.    + Added message area overrides (RA/PB).
  705.    > Fixed some display bugs.
  706.    + Added @BBS@, @F@, @FF@, @FL@, and @FROM@ macro support to taglines.
  707.    + Added a new user default setup to CONFIG.  Any valid tagline macros may
  708.      also be used in the default user signature and are translated when the
  709.      user's record is first created (not every time s/he enters the door).
  710.    + Added code to automatically convert 'TExt LIke THis' to 'Text Like This'.
  711.    > DCTEdit was creating a log file if the user's time exceeded (normally it
  712.      only creates a log file if something goes wrong).  Fixed.
  713.    + Added the menu editor.  All of the pull-down menus can now be configured.
  714.    + Added a print message option.  Printing is always done to LPT1, so if
  715.      your setup is different, you can remove the option from within the menu
  716.      editor.  This option may only be activated by someone with SysOp access
  717.      who is logged in locally.  These security settings can be modified in
  718.      the menu editor if so desired.
  719.    + You can now have DCTEdit append text files to the end of messages posted
  720.      by message area or globally.
  721.    + Added Alt-J: Shell to DOS.
  722.    + Added the SysOp Fn key macros.
  723.    + The border characters in the pop-up windows may now be configured.  The
  724.      /BORDER command-line parameter has been added to SCRUTIL to accommodate
  725.      this new feature.
  726.    + DCTEdit now supports ProBoard.  Note that in the user editor, flag A1
  727.      equals ProBoard's user flag 'A' through to flag D8 which equals
  728.      ProBoard's user flag '6'.
  729.    + DCTEdit now searches both the real name and alias fields of each user
  730.      record rather than just the real name when editing the recipient's stats.
  731.    + Quote reformatting is now optional.  You can now opt to truncate lines
  732.      which are too long or split them and add the rest of the text to one or
  733.      more new lines underneath via 'CONFIG.System.Quoting.Quote Formatting'.
  734.    + Added Ctrl-C: Centre Line.
  735.    + Added Ctrl-J: Left justify line.
  736.    > Fixed a bug when Enter was pressed on the first column of a quoted line.
  737.    + Added two more colours to configure: Picklist and Menu Title.
  738.    + Added a German language file, written by Grischa Brockhaus.
  739.    + Added /T parm.
  740.    + Added imbedded codes "BBSNAME" and "TRUNC" to screen definition files.
  741.    + DCTEdit now checks that the user's terminal has ANSI capabilities before
  742.      letting him/her in.
  743.    + Added code to prevent duplicate taglines from appearing in the selection
  744.      box when saving the message.
  745.    > Fixed a problem when a user whose terminal supported 25 lines entered
  746.      the door and the SysOp's monitor was in 50-line mode.
  747.    + Added Ctrl-K: Paste Text.
  748.  
  749.  
  750.  Version 0.02 Gamma -=- August 11, 1997.
  751.    * Default uppercase limit changed to 35%.
  752.    + DCTEdit can now also be used as a remote text editor (useful for the
  753.      editing of batch files remotely by the SysOp).  The /E and /R parameters
  754.      have been added to support this.
  755.    + The lightbar colour may now be configured (before it would simply be the
  756.      box colour inverted).
  757.    + DCTEdit now reformats the quoted text so it doesn't look chunky.
  758.    + Hitting Enter somewhere on a quoted line now splits it in two with the
  759.      quoting initials added automatically.
  760.    + Added imbedded code "RAND" to screen definition files.
  761.    * Changed DCTEdit's appearance a bit; it now looks brighter and is more
  762.      fun to look at.
  763.    * Many changes made to the colour configuration.  You can now select the
  764.      background colour for most items.
  765.    + DCTEdit now converts codes such as "@TO@" in the taglines.
  766.    + Added Ctrl-F: Find Text.
  767.    + Added the translation table.
  768.    + Added support for the Ctrl-Home and Ctrl-End key combinations.  They can
  769.      be accessed remotely with Ctrl-\ and Ctrl-], respectively.
  770.    > DCTEdit would always force the uppercase ratio regardless of what it was
  771.      set to in CONFIG.  Fixed.  Thanks to Alan Ianson for spotting this one.
  772.    + Added the SysOp menu.
  773.    + DCTEdit can now import files into the message.  The shortcut hotkey on
  774.      the local end is Alt-I.
  775.    + DCTEdit now allows those with SysOp access to edit the recipient's stats
  776.      on a RemoteAccess 2.xx BBS.  Support for additional BBS software may be
  777.      added in future versions.
  778.    + DCTEdit now supports the MSGINFO.SYS file created by Terminate in offline
  779.      reader mode.
  780.  
  781.  
  782.  Version 0.01 Gamma -=- July 31, 1997.
  783.    * Initial release of DCTEdit.
  784.  
  785.  
  786. ──────────────────────────────────────────────────────────────────────────────
  787. ││││││││││││││││││││││││    End of documentation    ││││││││││││││││││││││││││
  788. ──────────────────────────────────────────────────────────────────────────────
  789.