@database User-Editor.guide
@master CWORK:UserED/UserEd.guide
@$VER: User-Editor.guide V0.1 (02-17-96)
@author "SieGeL/tRSi"
@(c) "Copyright © 1996 (tRSi/F-iNNOVATiON)"
@index HeddleyAutoIndex
@remark Created with Heddley v1.1 (c) Edd Dumbill 1994

@node "Main" "User-Editor V0.2 - English documentation"
     @{b}@{fg shine} ............................... ...............................
     :::::::::: ...........:::::::::' `:::::::::..........  ..........
     :::::::::: :::::::::: :::::::::: .......... :::::::::: ::::::::::
     :::::::::: :::::::::: :::::::::: ::::::::::.:::::::::' ::::::::::@{ub}@{fg text}
    @{b}--[@{ub} Mo! @{b}]--------.----@{ub} @{b}@{fg shine}::::::::::@{ub}@{fg text} @{b}---------------------@{ub} @{b}@{fg shine}::::::::::@{ub}@{fg text} @{b}--.@{ub}
                     @{b}|@{ub}                  ( /F·INNOVATION )                @{b}|@{ub}
                     @{b}`---------------------------------------------------'@{ub}

                           iS pROUD tO pRESENT:

                 External MUI User-Editor for FAME Systems

                    wRITTEN bY SieGeL (tRSi/F-iNNOVATiON)

                      @{"INTRODUCTION " link "INTRO" 0}      @{"INSTALLATION " link "INSTALLATION" 0}
                      @{"START OPTIONS" link "START" 0}      @{"USING USER-ED" link "USAGE" 0}
                      @{" ABOUT FAME  " link "ABOUT" 0}      @{" ABOUT MUI   " link "MUI" 0}
@endnode

@node "INTRO" "What this Program does..."
@{u}Introduction@{uu}

I have been using the new FAME-BBS System for about 1 year now, and as
you all know validating New Users etc is a normal job.  If you only have
to validate one user and nothing more, it can be very cumbersome to enter
the BBS only for validation purposes.  So I decided to write my own
external User-Editor, allowing me to work on any user without going into
my BBS first.

The decision to use MUI was simple, I don't like hardcoded programs, which
don't allow you to configure the Program-Outfit to use other fonts, other
images etc...  Well, MUI is the right solution for this problem, as it is
100% user-configurable.  On the other Hand, MUI allows the coders not to
spend most of the Development Time in creating a GUI, but in developing
the program itself.  Creating a MUI-Interface is sooo simple..it takes me
three days to create the whole GUI for User-Ed!!  So if you don't have
MUI or don't like it, sit down in front of your Computer and start
creating a standard GUI which looks familiar to the current GUI...happy
guruing...:) 
@endnode

@node "INSTALLATION" "How to install User-Editor"
@{b}Requirements@{ub}

 To use User-Ed, you need the following things:

 - OS 2.04 or higher

 - MUI V2.2 or higher, MUI 3 is recommended to use all new features!

 - Completely installed FAME-System

 - For localisation you need locale.library v38+ or higher, otherwise 
   the User-Editor uses the built-in English language.

@{b}Installation@{ub}

 When you first install the FAME-System, the User-Editor is copied into
 the FAME:Modules/ drawer.  Also this Location is the default path set in
 'SystemEditor/FAME Modules'.  If you don't like this location, you could
 of course copy it to another, but since all external FAME modules are
 stored inside this drawer, it's the best idea by far to have all files
 stored in the same place!

 If you receive an Update of the User-Editor, simply overwrite your
 existing version with the new one, and also update all other files
 supplied with the update archive of User-Editor.

 If you want to use the User-Editor in your preferred language, copy the
 catalog-file of your language (if supplied) into your locale:Catalogs/
 <language>/drawer.  If you have choosen to install User-Editor to a
 different drawer from the default drawer 'FAME:Modules/', please make
 sure that the path for User-Editor set in 'SystemEditor/FAME Modules'
 points to the correct path!

 That's all for installation, now have fun using the User-Editor!
@endnode

@node "START" "Startoptions from User-Editor"
@{b}How to start User-Ed@{ub}

User-Ed can be started in different ways:

 1. Starting via Double-Click on its icon.

 2. Starting from FAME-Server.
    
 3. Starting from CLI

When you start it from CLI, you *MUST* enter the BBS-Location as the first
argument!  So a valid call is:

                          USER-EDITOR FAME:

Another possible call is:
 
                          USER-EDITOR FAME: <USERNUM>

You don't have to specify the <USERNUM> argument, but if given,
User-Editor loads in the specified User after opening the Window.  

The same call also works from the FAME-Server when starting the
User-Editor from the Gadget UsEd (behind the Info-Gadget).  See the
Server-Documentation for further information about the start-options of
the Server.

@endnode

@node "USAGE" "Usage of User-Editor"

@{b}Usage of User-Ed@{ub}

Please select chapter, for which you need more information:

       Buttons           Menu-Entries           Pages

      @{"  LOAD  " link "MAIN_BUTTON_LOAD" 0}           @{"First/Last User" link "MENU1" 0}
      @{"  SAVE  " link "MAIN_BUTTON_SAVE" 0}
      @{"REACTIVE" link "MAIN_BUTTON_REACTIVE" 0}
      @{"INACTIVE" link "MAIN_BUTTON_INACTIVE" 0}
      @{"NEW USER" link "MAIN_BUTTON_NEWUSER" 0}
      @{" DELETE " link "MAIN_BUTTON_DELETE" 0}
      @{"PRESETS " link "MAIN_BUTTON_PRESETS" 0}
      @{"PREVIOUS" link "BUTTON_PREVIOUS" 0}
      @{"  NEXT  " link "BUTTON_NEXT" 0}
     @{"SET TO USER" link "PRESET_SETUSER" 0}
      @{"  QUIT  " link "MAIN_BUTTON_QUIT" 0}
@endnode

@node "MAIN_BUTTON_LOAD" "BUTTON: Load"

 @{u}Load User@{uu}

When selected, User-Ed first checks out if you've changed the current
user settings.  If you have, the User-Ed asks you if you want to lose
these alterations.  Now User-Ed opens a Window containing a ListView
Gadget with an alphabetical sorted list of all your users, including
inactive/deleted users.  User-Ed jumps automatically to the position of
your name in the List and activate the Listview-Cursor on it.  Now you
can choose which user is to be loaded by using the CURSOR keys and Enter
to select or by simply using the Mouse, or by pressing the LOAD
Button..:) You can abort this action by pressing the ABORT Button or the
Close Gadget.  (ESC also closes the Window; this works with any
MUI-Window!).

When selecting a user, User-Ed loads in the specific data and closes the
Listview-Window.  
@endnode

@node "MAIN_BUTTON_SAVE" "BUTTON: Save"

 @{u}Save User@{uu}

When selected, User-Ed saves the current user's data to your user.data
and user.keys .

Nothing more to say about it I think..:)
@endnode

@node "MAIN_BUTTON_REACTIVE" "BUTTON: Re-Active"

 @{u}Re-Active@{uu}

This Button sets the current user-status to Validated.  If you have a new
user, you could validate him (give him access) by pressing this button.
But you will have to set all the other settings for yourself, i.e.  the
access level, online time etc.

If this is too much work for you, try the @{"Presets" link "MAIN_BUTTON_PRESETS" 0} Button, which makes all
the settings automatically for you.

See also: @{"Inactive" link "MAIN_BUTTON_INACTIVE" 0}, @{"New User" link "MAIN_BUTTON_NEWUSER" 0}, @{"Delete" link "MAIN_BUTTON_DELETE" 0}
@endnode

@node "MAIN_BUTTON_INACTIVE" "BUTTON: Inactive"

 @{u}Inactive@{uu}

This button switches current User's Status to Inactive.  In this Status,
the user-entry remains in your user.data, but the User itself is not able
to get into your BBS.  Good for users, which are i.e.  on holiday for a
few weeks, and don't want to get hacked...

See also: @{"Re-Activate" link "MAIN_BUTTON_REACTIVE" 0}, @{"New User" link "MAIN_BUTTON_NEWUSER" 0}, @{"Delete" link "MAIN_BUTTON_DELETE" 0}
@endnode

@node "MAIN_BUTTON_NEWUSER" "BUTTON: New User"
 @{u}New User@{uu}

With this button you could set the current user as a New User.  In this
state, you have to @{"validate" link "MAIN_BUTTON_INACTIVE" 0} the user, otherwise he's not able to do much
on your BBS.

See also: @{"Re-Activate" link "MAIN_BUTTON_REACTIVE" 0}, @{"Delete" link "MAIN_BUTTON_DELETE" 0}, @{"Inactive" link "MAIN_BUTTON_INACTIVE" 0}
@endnode

@node "MAIN_BUTTON_DELETE" "BUTTON: Delete"
 @{u}Delete@{uu}

By pressing this button, you set the current user's status to Deleted.  In
this state, the next New User who comes onto the BBS overwrites the deleted
account before the new user's data is appended to your user.data.  So you
can then be sure that you only have active or Inactive users in your
user.data, not deleted ones.

See also: @{"Re-Activate" link "MAIN_BUTTON_REACTIVE" 0}, @{"Inactive" link "MAIN_BUTTON_INACTIVE" 0}, @{"New User" link "MAIN_BUTTON_NEWUSER" 0}
@endnode

@node "MAIN_BUTTON_PRESETS" "BUTTON: Presets"

@{u}Presets@{uu}

When you want to validate a user, but also set all the requirements for 
the validated account automatically, you can use this Preset-Option.  
When pressed, a new Window appears, which shows you the first preset.  
Here you see the following things:

ConfAlias, AccessLevel, Ratio, RatioType, UserFileBase, daily bytes/files
and time limit.

This are the fields in the user.data, which are set by the preset option.
You can choose the desired Preset by clicking on the CycleGadget PRESET.
FAME allows you to have a maximum of 10 different presets including one
Preset for NewUser settings, which are configurable via SystemEditor/
Access/Presets. Select the Preset you need and press the button 
@{"Set to User" link "PRESET_SETUSER" 0}.  This sets all fields to the 
values seen in the Preset-Window.  To abort press the CloseGadget of the 
Window or the Cancel button.

@{u}NOTE:@{uu} Don't forget to save the current user-settings when using the Preset-
      option!!! Otherwise you lose the settings.
@endnode

@node "BUTTON_PREVIOUS" "BUTTON: Previous User"

 @{u}Previous User@{uu}

When pressing this, User-Ed loads in the previous user.  If you have made
any changes to the current user's settings, User-Ed asks you to confirm the
loading or to firstly save the changed user's data.  When you reach the
first user in your user.data, a small infotext appears in all 
Status/Username displays to inform you that you have reached the 
beginning.

See also: @{"Next" link "BUTTON_NEXT" 0}, @{"First/Last User" link "MENU3" 0}
@endnode

@node "BUTTON_NEXT" "BUTTON: Next User"

 @{u}Next User@{uu}

When pressing this, User-Ed loads in the next user.  If you have made any
changes to the current user's settings, User-Ed asks you to confirm the
loading or to firstly save the changed user's data.  When you reach the
last user in your user.data, a small infotext appears in all 
Status/Username displays to inform you that you have reached the end of 
the user.data.

See also: @{"Prev" link "BUTTON_PREVIOUS" 0}, @{"First/Last User" link "MENU3" 0}
@endnode

@node "MAIN_BUTTON_QUIT" "BUTTON: Quit User-Ed"

 @{u}Quit@{uu}

Exit Program...what else..:)
@endnode

@node "MENU1" "MENU: Last/First User"

 @{u}First/Last User@{uu}

With these two menu-entries you can jump directly to the beginning/end of
your user.data.  This is useful if you have many users and want to view
only the last few users etc.  
@endnode

@node "PRESET_SETUSER" "Preset/BUTTON: Set to User"

No information available yet.

@endnode

@node HeddleyAutoIndex "Index"
@remark Index auto-generated by Heddley
Index of database User-Editor.guide

Documents

@{"BUTTON: Delete" link "MAIN_BUTTON_DELETE"}
@{"BUTTON: Inactive" link "MAIN_BUTTON_INACTIVE"}
@{"BUTTON: Load" link "MAIN_BUTTON_INACTIVE"}
@{"BUTTON: New User" link "MAIN_BUTTON_NEWUSER"}
@{"BUTTON: Next User" link "BUTTON_NEXT"}
@{"BUTTON: Presets" link "MAIN_BUTTON_PRESETS"}
@{"BUTTON: Previous User" link "BUTTON_PREVIOUS"}
@{"BUTTON: Quit User-Ed" link "MAIN_BUTTON_QUIT"}
@{"BUTTON: Re-Active" link "MAIN_BUTTON_INACTIVE"}
@{"BUTTON: Save" link "BUTT2"}
@{"How to install User-Editor" link "INSTALLATION"}
@{"MENU: Last/First User" link "MENU1"}
@{"Preset/BUTTON: Set to User" link "PRESET_SETUSER"}
@{"Startoptions from User-Ed" link "START"}
@{"Usage of User-Ed" link "USAGE"}
@{"User-Editor V0.02 - English documentation" link "Main"}
@{"What this Program does..." link "INTRO"}

Buttons

@{" ABOUT FAME  " link "ABOUT" 0}
@{" ABOUT MUI   " link "MUI" 0}
@{"Delete" link "MAIN_BUTTON_DELETE" 0}
@{"First/Last User" link "MENU3" 0}
@{"Inactive" link "MAIN_BUTTON_INACTIVE" 0}
@{"INSTALLATION " link "INSTALLATION" 0}
@{"INTRODUCTION " link "INTRO" 0}
@{"New User" link "MAIN_BUTTON_NEWUSER" 0}
@{"Next" link "BUTTON_NEXT" 0}
@{"Presets" link "MAIN_BUTTON_PRESETS" 0}
@{"Prev" link "BUTTON_PREVIOUS" 0}
@{"Re-Activate" link "MAIN_BUTTON_INACTIVE" 0}
@{"Set to User" link "PRESET_SETUSER" 0}
@{"START OPTIONS" link "START" 0}
@{"USING USER-ED" link "USAGE" 0}
@{"validate" link "MAIN_BUTTON_INACTIVE" 0}
@endnode