home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / UEDIT55.ZIP / UEDIT.DOC < prev    next >
Encoding:
Text File  |  1993-03-20  |  20.1 KB  |  516 lines

  1. ===============================================================================
  2.   Virtual BBS External User Editor Version 5.5   By Scott 51@4121 VirtualNET
  3. ===============================================================================
  4.  
  5.         This is the seventh official release version of the VBBS EXTERNAL USER
  6.         EDITOR.  The main file UEDIT.EXE must be run within the VBBS main
  7.         Directory or whichever directory contains the configuration files.
  8.         The files needed by this program are SYSPATHS.CFG and USERFILE.DAT.
  9.         
  10.         
  11.         Your suggestions are welcomed and encouraged.  Please contact me at
  12.         51@4121 VirtulNET with any suggestions or bug reports.  This program
  13.         uses pulldown menus and supports a Microsoft Mouse.  It is recomended
  14.         to use the mouse for the best navigation of the editor.
  15.  
  16. Liability:
  17. ===============================================================================
  18.         Well here goes....
  19.  
  20.            If this program should cause you to have a bad day it is not my
  21.         responsibility.  This program is distributed "as is".  It has been
  22.         tested on several systems without incident.
  23.  
  24. ===============================================================================
  25.  
  26. Beta Testers.
  27.   
  28.    version 1.10:  
  29.    
  30.      I would like to take a moment to thank the following people for their help
  31. in getting the bugs ironed out of the early versions....  Silver Surfer 2@4123,
  32. Renegade 1@4121, and Beep 1@4120...... Thanks for the help guys!!!
  33.  
  34.    version 3.11:
  35.  
  36.      Once again,  Thanks to Renegade 1@4121 for the help and suggestions on
  37. version 3.11!
  38.  
  39.    version 4.0:
  40.  
  41.      Need I say it again?  Ok.....   Thanks Renegade.
  42.  
  43.    version 5.0:
  44.     
  45.      Renegade Once again!!
  46.  
  47.    version 5.5:
  48.  
  49.      No one....
  50.  
  51.  
  52. ===============================================================================
  53.  
  54.  
  55.  
  56.  
  57. The Menus......
  58.  
  59. To manuver the menus is simple.  Just put the mouse pointer on your selection
  60. and click the left button to select it.  If you are not using the mouse just
  61. hit the "Alt" key and then the highlited letter may be pressed to select an
  62. option or you may move the "highlight bar" with the arrow keys and then press
  63. enter on your selection.  You may also use the "Short-cut" keys F1 for
  64. View/Edit User F2 for List Users Etc....   This program is fairly self
  65. explanitory so you shouldn't have many problems getting around.
  66.  
  67.  
  68. Menu Choices....
  69. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
  70.  
  71.  ___________
  72. |           |
  73. | User Edit |
  74. |___________|
  75.  
  76. View/Edit User:
  77.  
  78.         This is just what is sounds like.  Once this option is selected you
  79.         will be prompted for a user number or name.  The number will take you
  80.         directly to that account and the name will search each record for a
  81.         match in either the "Handle Field" or the "Real Name Field".  The
  82.         Search string may be partial or complete, you will be prompted for each
  83.         matching name found by the program.  Once you have a user record on the
  84.         screen your cursor will be positioned on the cancel button.  The best
  85.         way to move around the screen is with the TAB key.  Shift+TAB moves
  86.         backwards.  Most of what is seen on this screen is self explanitory.
  87.         Just move to the item you want to change and then type in the new value
  88.         which you want to give it.  Some items will pop up a window and you
  89.         will edit the item in the window.  For example the Forward Mailbox
  90.         Window will pop up whenever you TAB past the item on the main screen.
  91.         On the Forward mail screen you can fill in each of the fields if you
  92.         want the users mail to be forwarded.  NOTE:  You must have the Mailbox
  93.         Forwarded marker X'd at the bottom of this window in order for the box
  94.         to actually be forwarded.  There are some additional windows that are
  95.         activated by pressing one of the buttons at the bottom of the screen.
  96.         In these windows you will find such items as the Extra Fields and the
  97.         Activities (Posts, Emails, U/L's, and D/L's).  You can also call a user
  98.         at his/her voice phone number by pushing the CALL button on the bottom
  99.         right side of the main edit window.  I would like to thank
  100.         Silly Boy #1 @5035 VirtualNET for this idea!  The first
  101.         time the dialer is run you will need to tell it which Com Port your
  102.         modem is on and whether to dial Tone or Pulse.  NOTE:  If you have
  103.         shelled to UEDIT while the user is ONLINE....  **DO NOT** use this
  104.         because obviously the user will be hung up on, unless you have more
  105.         than one modem.  To change the com port you can now go into the
  106.         'Options' Menu and select 'Com Select' and then choose the comport
  107.         that your system uses.  NOTE:  Some of the fields are not accessable
  108.         with the mouse such as the flags.  You must go to the Password field
  109.         and then hit TAB or Enter to get there.  There are a few other key
  110.         combinations that may be used in the main editor as well.
  111.  
  112.         
  113.         Search Up and Search Down:
  114.  
  115.             A newly added feature in UEDIT version 3.11 is the search feature.
  116.         This feature is very usefull for finding users' who have certian things
  117.         in common with their accounts.  First you must go to the 'Options' menu
  118.         and select 'Set Defaults' or modify them by hitting Alt-S. Once you set
  119.         the defaults then the 'Page Up' and 'Page Down' keys will search 
  120.         through the user file until it finds a matching account to the default
  121.         options.  Then the account will be displayed.  'Page Up' searches
  122.         forward through the accounts and 'Page Down' searches Backwards through
  123.         the accounts.  When using this option you must be on one of the buttons
  124.         at the bottom of the main edit window.
  125.  
  126.         
  127.         Left And Right Arrow Keys:
  128.  
  129.  
  130.           The left and right arrow keys will go backward and forward one user
  131.         number at a time.
  132.  
  133.         Atl-S:
  134.  
  135.           This from the editor will take you directly to the search defaults
  136.         settings.
  137.  
  138.         Alt-D:
  139.  
  140.           This will delete the current user.  Also deletes mail and oneliners.
  141.  
  142.         Alt-M:
  143.  
  144.           This will move a user.  CAUTION when using this!!  This can seriously
  145.         *@#& up your user file!!!  This option will take the current user and
  146.         ask you for a new number to give this user.  Once you answer, UEDIT
  147.         will then move the current user to that location and the old account
  148.         from that location will be moved to the current location.  Also all
  149.         email and oneliners will be changed to their new addresses.
  150.         
  151.         **NOTE:  make sure that both users know about this change because they
  152.                  WILL NOT be able to log on by their old user number.  This is
  153.                  because some users log on by number rather than by name.
  154.  
  155.         
  156.         F1 Key:
  157.  
  158.           Brings up the Help menu.
  159.  
  160.  
  161. List Users:
  162.  
  163.         List users is just for seeing the users' handles that are in your user
  164.         file.  If you select one of those users and push the "Ok" button you
  165.         will automaticaly be taken to the "View/Edit User" screen for that
  166.         user.
  167.  
  168.  
  169. Specific Users:
  170.  
  171.         This is a new section for UEDIT 5.0.  This will give you four choices
  172.         to choose a search item from.  Once you choose one, enter a search
  173.         string (partial or complete) and then UEDIT will search for any users
  174.         accounts that match that string.  Once the matching accounts are found
  175.         you will see them on a list.  If you select one of these accounts you
  176.         will be brought directly to the View/Edit screen for that account.
  177.         Apon Exiting the View/Edit screen you will be brought back to the list.
  178.         
  179.         **NOTE:  if you made any changes to the information shown in the list
  180.                  you will not see it change on the list.  This is because the
  181.                  information is still loaded in memory from before the changes
  182.                  were made.  If you want to update the list you must exit the
  183.                  list completely and then re-enter the search parameters.
  184.  
  185. Multiple Changes:
  186.  
  187.         This option will change a given field on EVERY user in your userfile.
  188.         If you only want to change a few then you must use the above option.
  189.         Once you select this option you will first be warned by a warning
  190.         screen that you have selected the mass changer then you will be asked
  191.         weather or not you would like to make a backup copy of your userfile.
  192.         If you answer yes to make a backup, UEDIT will make a backup in your
  193.         data directory called USERFILE.BAK.  This is a good Idea because if you
  194.         really louse something up then you can easily rename the USERFILE.BAK
  195.         to USERFILE.DAT and start over.  At this point you will be presented
  196.         with a list of options to change.  If you decide not to use this just
  197.         push the "Cancel" button or your escape key.  If you want to edit an
  198.         item just highlight that item then push the "Ok" button.  Once you have
  199.         done this then just enter the new value, and that value will be set in
  200.         EVERY user account in your userfile.
  201.  
  202.  
  203. Global Color Change:
  204.  
  205.         This will reset all of the colors in every user account to those that
  206.         are set in account #1.  Simply adjust the colors in your account the
  207.         way that you want all the others to be then run this option.
  208.  
  209.  
  210. Conditional Changer:
  211.  
  212.         This option will change only the accounts that match the criteria set
  213.         in the 'Defaults' section.  You may change any of the default settings
  214.         before running this option without making the changes perminant.  Once
  215.         you have set up the Search Options then you must Either select 'Find
  216.         and Verify' or 'Change All'.  'Find and Verify' will querry you before
  217.         changing each user that matches the settings.  'Change All' will just
  218.         make the changes.  For more details on the 'Defaults' see the section
  219.         on 'Set Defaults'.
  220.  
  221.  
  222. Quick Validate User:
  223.  
  224.  
  225.         This option makes it realy nice to validate users.  Here Only the
  226.         security related items are shown for editing.  Also the Case of the
  227.         Handle, Name, And Address fields are automaticaly fixed.
  228.         
  229.         **NOTE:  Any information left blank on this screen will go into the
  230.         user record that way.  So fill out all of the valid fields.  The one
  231.         exception is the 'Flags' field, this will add to what is already there.
  232.  
  233.  
  234. Exit:
  235.  
  236.         This option ends the editing session and returns you to DOS.
  237.  
  238. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  239.  ___________
  240. |           |
  241. |  Options  |
  242. |___________|
  243.  
  244. Color 1:
  245.  
  246.   This sets the screen color to Color 1
  247.  
  248. Color 2:
  249.  
  250.   This sets the screen color to Color 2 (May be suitable for some monochrome.)
  251.  
  252. Monochrome:
  253.  
  254.   Monochrome screen mode
  255.  
  256. Com Select:
  257.  
  258.   Sets up UEDIT to use your modem for the 'Call User' option.
  259.  
  260. Search Defaults:
  261.  
  262.  
  263.         This is where you will set the defaults for the Conditional Printer,
  264.         the Conditional Changer, and the search up and down.  The first field
  265.         is for the default SL.  once you enter a security level here now you
  266.         need to tell UEDIT wether to look for SL's of an equal value,
  267.         less than, or greater than the SL that you entered.  The next set of
  268.         fields are 'access flags' and 'flags' fields.  The last field is
  269.         changable from Time Bank, Credits, or Max time.  Just put the 'X' in
  270.         the apropriate box and then enter the value.  There is also a field on
  271.         this one for 'Equal to', 'less than', or 'greater than'.  You may omit
  272.         any of these fields you like.  If a field is left blank it is ignored.
  273.         You may also use as many simultaniously <SP?> as you like .  But
  274.         remember.....  in order for the user to be found their account must
  275.         match every field that you have an entry in.  If the Ratio Exempt Only
  276.         box is X'd then only those users who are ratio exempt will be counted.
  277.         Otherwise all users are counted.
  278.  
  279.  
  280. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  281.  ____________
  282. |            |
  283. | User Print |
  284. |____________|
  285.  
  286.  
  287. Print All Users (Long):
  288.  
  289.         This option will print a detailed list of each users account.  This
  290.         list will contain much of the information shown in the view user
  291.         screen or you can print a short version which will only print 4 lines
  292.         for each user.
  293.  
  294.  
  295. Print All Users (Short):
  296.  
  297.         Similar to the Long list only prints a few fields.
  298.  
  299.  
  300. Print Mailing Labels:
  301.  
  302.         This option will print out mailing labels of every user in your
  303.         userfile.  To abort the printing once it has started just hit the
  304.         escape key.
  305.  
  306.  
  307. Print Select Users:
  308.         
  309.         This is a new option for UEDIT 2.x.  You will first need to create a
  310.         text file called SELECT.LST, and in this file you will place the user
  311.         number of each user that you want printed in the order you like.  When
  312.         entering user numbers be sure to only place one user number per line.
  313.         UEDIT will print the users from the top of the list to the bottom in
  314.         the order in which they appear in SELECT.LST.  SELECT.LST must be
  315.         placed in the same directory as UEDIT.EXE.  This will print using the
  316.         macro files.
  317.  
  318.         **NOTE**  This feature is only available on Registered Copies!
  319.  
  320.  
  321. Conditional Print:
  322.  
  323.         This section is just like the conditional changer in that it uses the
  324.         Default setting to determine which users to print.  When you first
  325.         make this selection you will be prompted as to which type of printout
  326.         you want to make, Macro Print or a Detailed Listing.  Once the
  327.         printing begins you will be able to abort it by hitting the escape key.
  328.         It may take a moment for the buffer on your printer to empty.
  329.  
  330.         **NOTE**  This feature is only available on Registered Copies!
  331.  
  332.         
  333. Macro Print:
  334.  
  335.        Prints All users using one of the macro Files.
  336.  
  337.        ** See Macro Section.
  338.  
  339. ===============================================================================                  
  340.                      U E D I T   M a c r o   P r i n t i n g !
  341. ===============================================================================
  342.  
  343.      This is a brand new feature that I just added to UEDIT!  And I think you
  344. will like this one!
  345.  
  346.      New in UEDIT 5.0 is a Macro set that can be incorperated into a formatted
  347. text file created by you to print virtualy any type of report.  Each macro file
  348. is layed out in a special format.  This first line is the Title to be printed
  349. on each new page.  On line 2 there is simply just a number.  This number is the
  350. total number of user accounts to be printed on one page before sending a form
  351. feed.  After that lines 3 through 12 are used to lay out the printed form.  On
  352. lines 3 through 12 are either Literals or Variables.  A literal is just text as
  353. you would want it to appear on the paper.  The variables range from user
  354. account items to Tabbing and Spacing commands.  Below is the list of the
  355. variables used by UEDIT in the macro file.  Each macro file MUST end in the
  356. ".MAC" extention in order for it to be used by UEDIT!!
  357.  
  358.  
  359.  
  360.                                   Commands
  361.  
  362.              \Sxxx    Where xxx is the number of Spaces to add
  363.              
  364.              \Txxx    Position the print head at column xxx.
  365.                        ** This will not go backwards, the number xxx
  366.                           must be greater than the current print head
  367.                           position.
  368.  
  369.  
  370.           %HANDLE%    Prints the Users Handle
  371.  
  372.           %NAME%      Prints the Users Real Name
  373.  
  374.           %STREET%    Prints the Users Street address
  375.  
  376.           %CITY%      Prints the Users City
  377.  
  378.           %STATE%     Prints the Users State
  379.  
  380.           %ZIP%       Prints the Users Zipcode
  381.  
  382.           %PH1%       Prints the Users Phone #1 (Voice)
  383.  
  384.           %PH2%       Prints the Users Phone #2 (Data)
  385.  
  386.           %PASSWORD%  Prints the Users Password
  387.  
  388.           %BIRTHDAY%  Prints the Users Birthday (MM/DD/YYYY)
  389.  
  390.           %AGE%       Prints the Users Age (xx Years Old.)
  391.  
  392.           %FLAGS%     Prints the Users Flags
  393.  
  394.           %ACFLAGS%   Prints the Users Access Flags
  395.  
  396.           %SL%        Prints the Users Security Level
  397.  
  398.           %LASTON%    Prints the Date the user was last on.  (YYMMDD)
  399.  
  400.           %MAXTIME%   Prints the Users Time alowed per day.
  401.  
  402.           %TOT%       Prints the Users Total time on to date (mins.)
  403.  
  404.           %VIDEO%     Prints the Users Videomode (ex.  ASCII,  ANSI etc..)
  405.  
  406.           %RATIO%     Prints 'Yes' or 'No' depending on the users ratio
  407.                       exempt status.
  408.  
  409.           %VERIFY%    Prints 'Yes' or 'No' for the Verify Birthday setting.
  410.  
  411.           %EX1%       Prints the Extra variables in the users account.
  412.           .
  413.           .
  414.           %EX8%
  415.  
  416.           %UPK%       Prints the Users total U/L'd K.
  417.  
  418.           %UPF%       Prints the Users number of Files U/L'd.
  419.  
  420.           %DNK%       Prints the Users total D/L'd K.
  421.  
  422.           %DNF%       Prints the Users number of Files D/L'd.
  423.  
  424.           %POSTS%     Prints the number of posts written by user.
  425.  
  426.           %EMAILS%    Prints the number of Emails written by user.
  427.  
  428.           %TIMEBANK%  Prints the total time in the Users time bank.
  429.  
  430.           %CREDITS%   Prints the users total credits.
  431.  
  432.           %COMMENT%   Prints the User Comment.
  433.  
  434.           %CR%        Carridge Return & LF
  435.  
  436.           %TAB%       Tabs the print head to the next tab stop.
  437.  
  438.  
  439. That is the complete list of Macro commands for UEDIT 5.0.  It does not matter
  440. to UEDIT if the commands are Upper or Lower case.  There must be at least one
  441. space in between each command.
  442.  
  443. Rules:
  444.  
  445. If you use a litteral each space, tab, or group of spaces will be interpereted
  446. as 1 space!  If you want additional spaces, use the \S command.  Here is an
  447. example file for the Macro Printer.
  448.  
  449. --------------------------------------------------------------------------
  450.  
  451. This is UEDIT 5.0's new Macro Print Feature!    
  452. 7
  453. %cr% %cr% \S25 This will print with every user.
  454. %cr% %cr% User Name: %name% %tab% Handle: %handle% %cr%
  455. Age: %AGE% %tab% Video Mode: %video% %tab% Ratio Exempt: %ratio% %CR%
  456. Security Level: %SL% %tab% Sex: %ex1% %tab% %tab% Ph: %ph1% %cr%
  457.  
  458. --------------------------------------------------------------------------
  459.  
  460. Notice on line one:
  461.  
  462.   "This is UEDIT 5.0's new Macro Print Feature!"
  463.  
  464. This line will be centered at the top of each new page.
  465.  
  466.  
  467.  
  468. On line two you see the number 7.  What this means is that 7 user accounts will
  469. be printed per page.
  470.  
  471.  
  472. The rest of the file is the macros and literals.  For example on line 5:
  473.  
  474.   Age: %AGE% %tab% Video Mode: %video% %tab% Ratio Exempt: %ratio% %CR%
  475.    |     |     |
  476.    |     |     |__  Will move the print head to the next tab stop.
  477.    |     |
  478.    |     |__ Will be replaced with the users actual age.
  479.    |     
  480.    |_____  Literal, will be printed exactly as it is.
  481.  
  482.  
  483. Also Note:
  484.  
  485.   Age: %AGE% %tab% Video Mode: %video% %tab% Ratio Exempt: %ratio% %CR%
  486.  
  487. would be printed exactly the same as:
  488.  
  489.   Age: %AGE% 
  490.   %tab% Video    Mode: 
  491.   %video% %tab% Ratio Exempt: %ratio% %CR%
  492.  
  493. UEDIT will not do a Caridge Return until it encounters a %CR%.  Also the extra
  494. spaces are ignored.  1 space is the same as 40 spaces....  The use of one space
  495. is however recomended.
  496.  
  497.   Experiment with these commands and see what you can come up with...  There is
  498.   a sample macro included with this archive.  Use it and then compare the 
  499.   printout with the file and this will help you get a better understanding of
  500.   the UEDIT macros.
  501.  
  502. ================================================================================
  503.  
  504.  
  505.  
  506. Comments & Suggestions:
  507.  
  508.     Please Drop me an E-Mail at 51@4121 and let me know what you think.....
  509.  
  510.  
  511.     Or call Final Approach at (412)-843-7147
  512.     14.4K Baud Modem.
  513.  
  514.  
  515.  
  516.