@database BB-TopWr
@master Coding:Sources/C/Tempest/BB-TopWr/BB-TopWr.guide
@$VER: 0.9b (06-14-96)
@author "BiLBo BaGGins/MoTioN"
@(c) "1996 MoTioN"
@help "main"
@wordwrap
@index main

@node "main" "Guide to BB-TopWr v0.9b by BiLBo BaGGins/MoTioN"
@next "intro"
                                  _______ 
    _____________________________/______/_____ _____________ ____________
  __\________      /\______/    /____________/_\______/    /_\____      /
 /_____/____/     /____________/______/      /____________/______/     /__
           /_____/                   /______/tre!/(!            /_____//_/

                        -^-  Tempest Innovations  -^-


                               BB-TopWr v0.9b

                         Code: BiLBo BaGGins/MoTioN


                      @{"          Introduction          " link "intro" 0} 
                      @{"          Installation          " link "install" 0} 
                      @{"           How to use           " link "usage" 0} 
                      @{"          Future Plans          " link "plans" 0} 
                      @{"           Bug Report           " link "bugs" 0} 
                      @{"           Greetings            " link "greets" 0} 
                      @{"       Motion Information       " link "motion" 0}
                      @{"             Thanks             " link "thanks" 0} 
                      @{"         Latest Updates         " link "update" 0}
                      @{"              Exit              " quit} 
@endnode

@node "intro" "-^- Introduction -^-"
@next "install"
@prev "main"

  BB-TopWr is a top writer door/util.

  Features:
  - shows name, location and posts
  - can show as many users as the User can display on his Screen
  - can show users in 1 or 2 rows
  - run as util or door
  - external designs
  - easy configuration
  - design chooseable by user
  - able to run resident
  - low memory fragmentation and usage

  Requirements:
  - Kickstart v39
  - Tempest v3.48


                            @{" back to main menu " link "main" 0}
@endnode

@node "install" "-^- Installation -^-"
@next "usage"
@prev "intro"

  Copy BB-TopWr, BB-TopWrConfig, BB-TopWr.output.<x> and
  BB-GlobalConfig to Doors:



  Make BB-TopWr resident:
  -----------------------

  Edit your Tempest-Startup script:
  -------------------------> cut here <-------------------------
  resident Tempest:Doors/BB-TopWr Tempest:Doors/BB-TopWr pure
  -------------------------> cut here <-------------------------



  Start as door:
  --------------

  Edit your Optional/Bulletins.opt file:
  -------------------------> cut here <-------------------------
  [20-,*,*,*,*] =topwr |T-DOOR|Tempest:Doors/BB-TopWr
  [255,*,*,*,*] =topwrc|T-DOOR|Tempest:Doors/BB-TopWrConfig
  -------------------------> cut here <-------------------------

  Edit your Optional/GlobalMenu.opt file:
  -------------------------> cut here <-------------------------
  [20-,*,*,*,*] =config|T-DOOR|Tempest:Doors/BB-GlobalConfig
  -------------------------> cut here <-------------------------



  Start as util:
  --------------

  Edit your Optional/Bulletins.opt file:
  -------------------------> cut here <-------------------------
  [20-,*,*,*,*] =topwr |PRINT|<Bulletin>
  [255,*,*,*,*] =topwrc|T-DOOR|Tempest:Doors/BB-TopWrConfig
  -------------------------> cut here <-------------------------

  Edit your Optional/GlobalMenu.opt file:
  -------------------------> cut here <-------------------------
  [20-,*,*,*,*] =config|T-DOOR|Tempest:Doors/BB-GlobalConfig
  -------------------------> cut here <-------------------------

  Edit your Scripts/Logoff.bat files:
  -------------------------> cut here <-------------------------
  Tempest:Doors/BB-TopWr <ConfigFile>
  -------------------------> cut here <-------------------------



  Use TopWrConfig:
  ----------------

  Enter "topwrc" for starting TopWrConfig and configurating the TopWr.
  First you have to enter the name of the configfile you want to edit/
  create. A default-name is given, that the door is trying to open:
  <DoorsPath>BB-TopWr.cfg
    DoorsPath: Path of Tempest Doors.

  When starting BB-TopWr as door, it always tries to open the config-
  file with default-name. You can only use a custom name if you run it as
  util.


  After loading the configfile comes a menu with the following items:

  Global options:

  (A) Number of users in bulletin..............: 10
  (B) Number of the design to use..............: 1
  (C) Screenclear before bulletin..............: YES
  (D) Pause prompt after bulletin..............: YES

  Door only options:

  (E) Global design............................: NO

  Util only options:

  (F) Add nonstop toggle before bulletin.......: NO
  (G) Append bulletin to existing file.........: NO
  (H) Path & name of bulletin..................:
      T:Test

  Commands in the menu:
  
  A  Number of users to be displayed in the bulletin. (0 for screenlength)
  B  The number of the design for the bulletin. (0 for random)
  C  Make screenclear before showing the bulletin.
  D  Make a pause prompt after showing the bulletin.
  E  Using the global design
  F  Add a nonstop toggle (~+) in front of the bulletin.
  G  Append the bulletin to an existing file.
  H  Path and name of the bulletin.
  S  Save and quit
  Q  Quit



  Use GlobalConfig:
  -----------------

  Edit Tempest:Accounts/BB-GlobalConfig.default:
  -------------------------> cut here <-------------------------
  4
  -------------------------> cut here <-------------------------
  Enter the number of the default design. 0 for random.

  Edit Tempest:Accounts/BB-GlobalConfig.design:
  -------------------------> cut here <-------------------------
  BiLBo BaGGins/M!
  BiLBo BaGGins/M!
  Shapechanger/AL
  Treach!/(!
  -------------------------> cut here <-------------------------
  Enter the available designs.

  Enter "config" for starting GlobalConfig and configurating your personal
  Design. A list with all designs is listed where you can choose your
  favourite one for all doors. Save your configuration with "S" or leave
  it without saving with "Q".



  Edit the external designs:
  --------------------------

  The name of the external designfile must be:
  <DoorsPath>BB-TopWr.output.<Number>[.ansi|.amiga|.ibm]
    DoorsPath: Path of Tempest Doors.
       Number: Number of the design.
        .ansi: Extension for Ansi.
       .amiga: Extension for Amiga-Ansi.
         .ibm: Extension for Ibm-Ansi.

  The door looks for the ansitype of the user, tries to open the belonging
  designfile and displays it. If it can`t open the designfile it tries to
  open the ansi and than the non-ansi designfile.

  The util tries to open every designfile(s) and creates all bulletins.


  The datas are inserted into the keywords in the designfile(s).

  The keyword has a variable length and option to insert data to the left
  or right. The first character of it is always "@".

   They look like that: "@HANDLE=====....["
                               /       |  \
                             a/       b|  c\

   a: Beginning of the keyword.
      (e.g.: "@HANDLE=====" for the username)
   b: Fillers. You can place as much fillers as long as you want to have
      the inserted data. A filler can be every character except "[" and
      "]".
      (e.g.: "....")
   c: Ending of the keyword. Must be "[" or "]". With "[" the data is
      inserted to the left and with "]" to the right.


  Structure of the designfile(s):

  The line(s) at the top are written between @TOP and @END.
  The line for the user is written after @LINE.
  The line(s) at the bottom are written between @BOTTOM and @END.

  Example:
  -------------------------> cut here <-------------------------
  @TOP
  Global TopWriter:
  @END
   @N] @HANDLE=========[ @LOCATION=======[ @MSG==]
  @LINE
  @BOTTOM
  Uploaded @MBUL=] MBytes in @FIUL=] Files.
  @END
  -------------------------> cut here <-------------------------


  Keywords for the user-line (1 row):
  '@N'             for entry number
  '@HANDLE====='   for Handle
  '@LOCATION==='   for Location
  '@MSG=='         for posted Messages

  Keywords for the user-line (2 rows):
  '@N'             for entry number       (left side)
  '@HANDLE====='   for Handle             (left side)
  '@MSG=='         for posted Messages    (left side)
  '@n'             for entry number       (right side)
  '@handle====='   for Handle             (right side)
  '@msg=='         for posted Messages    (right side)

  Keywords for top and bottom-lines:
  '@CALL='         for total Calls
  '@MSGS='         for total Messages
  '@FIUL='         for total Files uploaded
  '@FIDL='         for total Files downloaded
  '@MBUL='         for total MBytes uploaded
  '@MBDL='         for total MBytes downloaded


                            @{" back to main menu " link "main" 0}
@endnode

@@node "usage" "-^- How to use -^-"
@next "plans"
@prev "install"

  User can`t do anything except reading it.


                            @{" back to main menu " link "main" 0}
@endnode

@node "plans" "-^- Future Plans -^-"
@next "bugs"
@prev "usage"

  Currently nothing is planned with this tool.


                            @{" back to main menu " link "main" 0}
@endnode

@node "bugs" "-^- Bug Report -^-"
@next "greets"
@prev "plans"

  No known Bugs at the moment. If you find some try to contact me on Deep
  Space Nine, Sado City , Dawn of Eternity or irc.


                            @{" back to main menu " link "main" 0}
@endnode

@node "greets" "-^- Greetings flow out to -^-"
@next "motion"
@prev "bugs"

                        my personal greetings go to
                     ¯ ¯¯ ¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ ¯¯¯ ¯¯ ¯
   Agent - Alpha One/DLT - AMO/ORS - APEX - Apollo/TRSI -  BBC/M! -  Ben/M!
   Bezzzerk/M!^MXM - Calypso/LGC -  Castor -  cOUGAR/HLM -  Deathknight/PSG
   Demax^Agressor/DLT -  dONALD/M! -  Dr. Dre/TRSI  -  Duke/M!  -  ECS/TRSI
   E.F.A./M! -  Fnord/M! -  Fury/M!^PSG  -  H2o/C!  -  Intercode/BB  -  JAF
   Jazy/HF -  Joe Cool -  Joker -  Juan/TRSI -   Kingpin/M! -  Lenny Dee/HF
   Logic/M! - Mario/TRSI - Marky&Power/BLH - Mogue/AL - Mr.Solo - Pitch/QTX
   Playmate/M! - Princip/M! - Pyro/HF - Relief/oS - Rhetor/M! -  sCANDIC/M!
   SchwabenPower/M! - Shane/CRX -   Shapechanger/AL -  Sisko/M! -  Skeleton
   Skywalker - sLIME/M! - sNIKE - Spider/ORS - Striker/PSG -  The Addict/M!
   Tom/FLT - tRAITOR/M! - Treach/C! - Vampire/TRSI -  Voyage/M! -  Zinko/PB

                          to the following Groups
                       ¯ ¯¯ ¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯ ¯¯¯ ¯¯ ¯  
   Advanced Chemistry - Arclite - Contra - Fairlight -  Hellfire -  Hoodlum
   Logic -  Maximum -  Osiris  -  Prestige  -  Prodigy  -  Quartex  -  TRSI

               and of course to all Motion members worldwide


                            @{" back to main menu " link "main" 0}
@endnode

@node "motion" "-^- MoTioN Informations -^-"
@next "thanks"
@prev "greets"

                       the crazy ones behind Motion are 
                    ¯ ¯¯ ¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ ¯¯¯ ¯¯ ¯
                BBC · Ben · BiLBo BaGGins · Bloodwolf · Bowen
             Disque Bleu · Donald · Duke · E.F.A. · Fnord · Fury
                KiNGPin · lOGIC · pLaYmAte · ¶r¡nçe Øf Th¡eves
               pRINCIP · Rhetor · RTD · sCANDIC · SchwabenPower
            sISKO · sLIME&vOYAGE · tHE aDDICT · tRAITOR · Wendigo

                       call our crazy boards worldwide
                    ¯ ¯¯ ¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ ¯¯¯ ¯¯ ¯
            WHQ.....Mortuary................+1-aSK-fOR-iT!...6nDZ
            EHQ.....Deep Space Nine........+49-aSK-fOR-iT!...6nDZ
            GHQ.....Fast File System.......+49-aSK-fOR-iT!...9nDZ
            SWIHQ...Dial Hard..............+41-aSK-fOR-iT!...5nDZ
            SHQ.....Interchange............+46-aSK-fOR-iT!...3nDZ
            OZHQ....Dark Sun...............+61-aSK-fOR-iT!...3nDZ
            DKHQ....Northern Palace........+45-aSK-fOR-iT!...3nDZ
            NHQ.....Checkpoint.............+47-aSK-fOR-iT!...2nDZ
            FINHQ...Zillion Hours.........+358-aSK-fOR-iT!...2nDZ


                            @{" back to main menu " link "main" 0}
@endnode

@node "thanks" "-^- Thanks -^-"
@next "update"
@prev "motion"

                Many thanks must go to my following betatesters

                                   sISKO
                                 ] Joker [
                                   E.F.A.
                                  Treach!
                                    AMO
                                   sNIKE
                                 Intercode
                                 The Bird

                      for all the bugreports and ideas.


                            @{" back to main menu " link "main" 0}
@endnode

@node "update" "-^- Latest updates -^-"
@prev "thanks"

  You can get the latest updates from all my tools/doors on Deep Space
  Nine. Just ask me on irc to get an account. 


                            @{" back to main menu " link "main" 0}
@endnode