

 ͸
                           YAPPDEX.EXE versie 7.2                          
                           By Max PE1RCY @ DDS.NL                          
                                22 March 1998                              
 ;

 - Yappdex 7.2 is identical to 7.1, only the expire date has been changed
   to 31-december-1999. Everywhere 7.1 is mentioned in this documentation
   it also applies for version 7.2.


 Contents:

 1. Intro.
 2. Licence.
 3. Installation and usage.
 4. Explanation of files.
 5. Program fases of YAPPDEX.
 6. History.
 7. Soon to be released.
 8. Finally.


 1. Intro.

    YAPPDEX.EXE is a utility for FBB 5.15x.
    YAPPDEX is an improvement on the earlier released YAPPSORT v3.0 of me,
    and thus the sort-method is the same.

    YAPPDEX has extra functionality as described below, read and now
    make your own BBS-files-list !

    1 The program sorts the wellknown YAPPLBL.SYS file, which contains all
      file-descriptions of your bbs.
      All files that no longer exist in your directories, will be removed
      from the YAPPLBL.SYS.
    2 Makes FILES.BBS files in all (sub-)directories.
    3 Makes an INDEX.TXT (with new-file indication * ).
    4 Shows all files on-screen during YAPPDEX-proces. (for examination)
  * 5 Makes DESCRIPT.ION files in all (sub-)directories.
  * 6 Gives file Totals in INDEX.TXT, sub-dir totals and overall totals !

*   Usage of a Disk-Cache-program is HIGHLY recommended, it increases the
*   the sorting process considerably, and reduces the numerous seek actions
*   of your harddisk !



 2. Licence.

    YAPPDEX.EXE 7.1 is ShareWare. The author is NOT responsible for any
    damage caused by or due to the use of YAPPDEX. However the program
    has no copyrights, still some limitations:

    It is NOT allowed to:
    - make any changes to the program
    - distribute the program without the following files:
        FILE_ID  DIZ           259 01-03-97   7:10a
        NIEUW    TXT         1,144 01-03-97   7:10a
        CHANGES  TXT           994 01-03-97   7:10a
        LEESMIJ  TXT        14,682 01-03-97   7:10a
        README   TXT        14,580 01-03-97   7:10a
        EXAMPLE  TXT         8,690 01-03-97   7:10a
        YAPPDEX  INF           597 01-03-97   7:10a
        YAPPDEX  CFG           548 01-03-97   7:10a
        YAPPDEX  EXE        39,730 01-03-97   7:10a
        YDEX_NL  ZIP         1,186 01-03-97   7:10a
        YDEX_GB  ZIP         1,189 01-03-97   7:10a

    You ARE allowed to:
    - use this program for non-commercial purposes
    - make unlimited copies of this program
    - pass it on to anyone else.

 3. Installation and usage.

 3.1 Installation.

    YAPPDEX.EXE DOES NOT use the INIT.SRV file !
                ========
    Place the YAPPDEX-files in any directory you want !
    Eg.: C:\FBB\YAPPDEX\

    Be carefull that you do not accidentally delete your original .TOP,.DTP
    or .BOT !

      C:\FBB\YAPPDEX\ YAPPDEX.EXE
      C:\FBB\YAPPDEX\ YAPPDEX.CFG
      C:\FBB\YAPPDEX\ YAPPDEX.TOP    *    \
      C:\FBB\YAPPDEX\ YAPPDEX.DTP    *     |- YDEX_GB.ZIP / YDEX_NL.ZIP
      C:\FBB\YAPPDEX\ YAPPDEX.BOT    *    /

    ad. * :  You'll find these files in a zip-file, use the desired
             language, and put the files in the FBB\ dir. (only 1
             language can be used of course)

    First edit the files YAPPDEX.CFG and YAPPDEX.TOP/.DTP/.BOT to meet
    your own preferences. (The YAPPDEX.DTP does not require alterations.)

    The YAPPDEX.CFG file contains comments/information about the parameters
    in this file. I think the explanation in that file is clearly enough
    to understand the possibilities. Lines starting with a '#' in the first
    column are comment-lines and not read by YAPPDEX.

    For more information about YAPPDEX.CFG parameters, see below.



 3.2 Usage.

 Start YAPPDEX when the BBS is NOT running !!
 Start YAPPDEX from the FBB dir, where you placed the YAPPDEX file.

 THE INDEX.TXT FILE WILL BE PLACED IN THE FBB\SYSTEM DIR, THERE WHERE
 ALSO YOUR YAPPLBL.SYS IS.!!!

 YAPPDEX uses command-line parameters to active different functions.
 This means that you start YAPPDEX behind the DOS-prompt with a space
 and fout optional LETTERS.
 eg.:  C:\FBB\YAPPDEX FIST

 The LETTERS (extra commandline-parameters) are explained below:
 F  - create FILES.BBS files in every (sub-)DIRECTORY.        (Files.bbs)
 D  - create DESCRIPT.ION files in every (sub-)DIRECTORY.     (Descript.ion)
 I  - create YAPPDEX.TXT file (allfiles.txt of all files)     (Index)
 S  - show all files on screen during YAPPDEX-run.            (Show)
 T  - keep all files in YAPPLBL.SYS (no longer existing files are
      still written in the new YAPPLBL.SYS)                   (T=keep)
 L  - make a Log-file of the program-vars (only for debuging) (Logging)

 NORMALLY you use the parameters F and I, for sorting the yapplbl.sys,
 making files.bbs files and an index.txt.
 eg.:  C:\FBB\YAPPDEX FI

 ONLY SORTING is possible by starting YAPPDEX  WTIHOUT any parameters.
 eg.:  C:\FBB\YAPPDEX

 Short summary of possible combinations:
 YAPPDEX      - only sorting
 YAPPDEX I    - sorting and index.txt
 YAPPDEX IF   - sorting; files.bbs files and index.txt
 YAPPDEX FTI  - sorting (keep all files); files.bbs and index.txt
 YAPPDEX SI   - sorting; show on-screen and index.txt
 YAPPDEX FDIL - sorting; files.bbs, descript.ion, index.txt and yappdex.log
 You see different combinations are possible. Order of the letters
 is not fixed.


*   ATTENTION !:
*
*   I recommend NOT to run YAPPDEX every day in your housekeeping when you
*   have large number of files and descriptions in your yapplbl.sys.
*   It unnecessary delays your everyday 'housekeeping'. You better run
*   YAPPDEX every now and then manually.



4.  Explanation of files.

YAPPDEX uses different files. The function and explanation of these files
is described below.

4.1.  YAPPDEX.CFG.

In this file you have to change the BBS-call in your own BBS-call. And
change the pathnames according to your system-setup.

The order of the 'parameters' is fixed and cannot be changed !
Lines starting with a '#' are comment-lines and are skipped when the file
is read by YAPPDEX.

#
# >>>>   YAPPDEX.CFG config-file for YAPPDEX v7.1   <<<<<
#
# Do not change the sequence/order in this file, your YAPPDEX
# simple won't work right ! Lines starting with # are comments.
#
# Callsign of the BBS.
NB1BBS
#
# NEW!!  FBB-system directory where your YAPPLBL.SYS is situated.
C:\FBB\SYSTEM\
#
# Drive and corresponding path to INCLUDE in YAPPDEX.TXT.
# You can define only 2 lines, thus only 2 different paths.
# YOU MUST END THE PATH WITH A '\'  !!
# ex.:  C: D:\USERS\
#       P: D:\P\
C: D:\USERS\
P: D:\DONATEUR\


The drive and path indications work as follows:
First you must indicate what drive/path will be shown in the INDEX.TXT,
eg.  C:  behind this you place the real path ! eg. D:\USERS\

In this way you can simply show a P: drive, while the real path is the
D:\DONATORS\ directory.


Example of the INDEX.TXT file:
͸
 Dir : P:\DONATORS\                                                           
   Donators dir.                                        
;

 INFO.ZIP          133  28-07-95    Info file donators.
 TEST.ZIP        13756  28-07-95    Test for this doc.
 NEW.ZIP         14698  28-07-95    New donators info.

͸
 Dir : C:\7PLUS\                                                              
   Several 7plus-files.                                 
;

 7INF.ZIP          133  28-07-94    Info file over 7+.
 7MIN.ZIP        13756  28-07-94    ?
 7P.ZIP          13756  28-07-94    7+ easily uploading/downloading.

 //-- END Yappdex --//



4.2.  YAPPDEX.TOP

The YAPPDEX.TOP file is a text-file which will be placed in TOP of the
INDEX.TXT. This text-file can contain a maximum of 100 lines (80 char.).

Standaard-contents YAPPDEX.TOP:
/***************************************************************************/
/*                            YAPPDEX.TOP                                  */
/*               PLACE HERE GENERAL INFORMATION ABOUT THE FILES            */
/*                            IN YOUR BBS                                  */
/***************************************************************************/




4.3.  YAPPDEX.DTP

YAPPDEX.DTP is a file that requires extra attention.

Basically the file is setup like this:
͸
 Dir : $dir70$                                                                
   $label40$                                            
;

It's all about the words  $dir70$  and  $label40$ .

$dir70$ indicates that on this place a Directory-path-length of 70 characters
        will be written. The Minimum is also 70 characters ! So place this
        keyword ($dir70$) somewhere in the first 10 columns of the .DTP
        file, otherwise the path will be displayed corrupted...
$label40$ indicates that on this place the Label of the directory will be
          written. Miximum and Minimum 40 characters..
          Place the keyword somewhere in the first 40 columns of the .DTP
          file..

You can experiment with this file, but the results can be surprising.

The YAPPDEX.DTP file has a limit of 10 lines of 80 characters..

Example that also works:
͸
͵
   $label40$                                 
 Dir :  $dir70$                                                               
͵
;

4.4.  YAPPDEX.BOT

YAPPDEX.BOT is a text-file that will be placed at the end of the INDEX.TXT
file. The YAPPDEX.BOT file can contain a maximum of 100 lines (80 char.).

Standard-contents YAPPDEX.BOT:
/***************************************************************************/
/*                           YAPPDEX.BOT                                   */
/*               PLACE HERE INFO ABOUT YOUR BBS FOR EXAMPLE                */
/*                                                                         */
/***************************************************************************/

4.5   YAPPDEX.DAT

YAPPDEX.DAT is a file that will be created if it doesn't exist yet.
YAPPDEX places this file in the same dir where YAPPDEX.EXE is (C:\FBB).
This file is used to determine when the last YAPPDEX-run completed.
If this file doesn't exist, all files labeled the last month will be marked
with the new-file indication (*) in the INDEX.TXT.


5.1 Operating method:

    - YAPPDEX searches for YAPPLBL.SYS in the system-dir, as you stated
      in the YAPPDEX.CFG !
    - You can manually start YAPPDEX.EXE by typing eg.:
      C:\FBB\YAPPDEX\>YAPPDEX <ENTER>
    - YAPPDEX supports multiple volumes (C:, D: ).
      Yappsort must be able to access these drives !
      CD-rom drives must contain a/THE CD !
    - If any error occurs during the sorting process, the programm stops and
      the original YAPPLBL.SYS file is unchanged and available for FBB.
      Possibly a file is created with the name YAPPLBL.NEW. This file cannot
      be used.
      Only after existence-control and correct sorting, the original file
      YAPPLBL.SYS will be renamed to YAPPLBL.OLD. An already existing file
      YAPPLBL.OLD will be deleted first ! Next YAPPLBL.NEW will be renamed
      to YAPPLBL.SYS.



5.2 Program fases of YAPPDEX.

    - Determine number of yapplabel-records.
    - Read table of yapplabel pointers.
    - Existence control of files.
    - Sorting of table.
    - Write YAPPLBL.NEW.
    - Option printing on screen.      C:\FBB\YAPPDEX>yappdex S
    - Option FILES.BBS creation in all (sub-)dirs.
    - Option DESCRIPT.ION creation in all (sub-)dirs.
    - Option INDEX.TXT creation in FBB\SYSTEM dir.
    - Delete previous YAPPLBL.OLD.
    - Rename YAPPLBL.SYS to YAPPLBL.OLD.
    - Rename YAPPLBL.NEW to YAPPLBL.SYS.

    - Example of sorting before and after YAPPDEX, see the file EXAMPLE.TXT.



 6. History.

    Ver. 3.1  February 1995
    - First version of YAPPDEX.EXE, never released.
        
    Ver. 5.2  7 October 1995
    - Program 'streamlined', never released.

    Ver. 6.0  16 December 1995
    - Program released, added a documentation.

    Ver. 7.0  23 Januari 1997
    - Program changed, speed increased, options added.
    - Beta version in test at NL3ONB.

    Ver. 7.1  15 Februari 1997
    - Program documentation changed.
    - Making ready for release of version 7.1.

                     Ik ben er helaas nog niet aan toegekomen om hier tijd
                     in te stoppen zodat het programma vrijgegeven kan
                     worden. Hopelijk kan ik er z.s.m. aan werken.

 7. Soon to be released:

    - IMPORT v2.0    Import program that imports files.bbs file in the
                     Yapplbl.sys file.
                     Unfortunately I have not been able to put time in this
                     program to make it free for use. Possibly I will soon
                     finish this program.

 8. Finally.

    I developed YAPPDEX because there was no program that makes a good
    INDEX for the YAPPLBL.SYS of FBB.

    This programme is not an attempt to compete with already existing 
    YAPPLBL-sorting/indexing programs.

    Special thanks to NL3ONB for the beta-testing of YAPPDEX, it resulted
    in an even better YAPPDEX !

    Ok, succes with YAPPDEX !

    73 de Max, PE1RCY @ WORLDACCESS.NL (Internet)
               PE1RCY @ PI8GCB.#NH2.NLD.EU (Packet-Radio)

- EOF -
