This is FilePage v4.0 Alpha
rev1.0  7th July 2006

Chris Payne originally wrote this package, and 70% of the work is
due to Chris's programming skills, I have simply taken the code
and modified it to suit my own purposes while still trying to keep
it as generic as possible using the configuration files.

If you have any problems with this package please contact me at
ian 'at' os2site.com  or via the contact form at http://www.os2site.com

Filepage v4.0 Alpha is freeware, and if you have suggestions or needs
for modifications, or even sutle hints as to setting FilePage up, please
feel free to contact me.

If an earlier version is mentioned below, take it to mean the current version.

Cheers
Ian Manners

=======================================================


rev3/07161998


      ۻ ۻ ۻ      ۻ ۻ   ۻ   ۻ  ۻ
      ͼ ۺ ۺ      ͼ ۻ ۻ ͼ  ͼ
      ۻ   ۺ ۺ      ۻ   ɼ ۺ ۺ  ۻ ۻ
      ͼ   ۺ ۺ      ͼ   ͼ  ۺ ۺ   ۺ ͼ
      ۺ      ۺ ۻ ۻ ۺ      ۺ  ۺ ɼ ۻ
      ͼ      ͼ ͼ ͼ ͼ      ͼ  ͼ  ͼ  ͼ 

                                    v3.0 (beta 4)

               (c)Copyright 1998 Payne-Mennie Computing Services




COPYRIGHT/LEGAL:
===============
This software is provided on an "as-is" basis.  We offer no warranty on this
software whatsoever, and you use it at your own risk. FilePage is unable to
modify files other than its own for internal processing purposes.

The files contained in this package may not be modified or reverse-engineered
or decompiled in any form for any reason. Problems with the executable or
documentation should be brought to the attention of Payne-Mennie Computing 
Services for correction.

FilePage v3.0 (beta-4) is being made available to the public as FREEWARE and 
replaces all previous versions. If you find that the software serves your
needs, please take the time to email us and let us know.

This software is not to be redistributed as part of another software package
without the written consent of Payne-Mennie Computing Services, AND/OR
Ian Manners

Filepage and PlanetWide Web Server for OS/2 are (c)Copyright 1996,1997,1998 
Payne-Mennie Computing Services.

FilePage v3.1 is Copyright both Payne-Mennie Computing Services, and Ian Manners.


Freeware Notice:
----------------

- FilePage v3.0 is now being release to the public as FREEWARE. In doing
  so, no warranties, expressed or implied are offered in the operation of
  the software package. Although we guarantee that FilePage will reduce
  the maintenance time for your web distribution site(s).

  We appreciate all of those who have registered their shareware and have
  supported many many OS/2 developers. These are the people that we develop
  for; to give them the choice of quality native OS/2 software.  Enjoy.




What is FilePage?:
------------------

FilePage is a standalone program that creates html file-lists. To take this
a bit further than the basic idea; FilePage will index your file distribution
directories on your web server, and created customizable html output for your
web visitors to use as a navigating tool.

FilePage is totally configurable, meaning that you can make alterations to
the foreground and background colours, table cell properties, file exclusions,
even choose your graphical icons, and much much more. 

Once you have FilePage configured to your liking, let it loose on your file
directories and let it do the hard work of maintaining your web site. What
would take the webmaster several hours is completed in seconds. No kidding!

If this sounds interesting to you, read the rest of the documentation to
discover more about one of the best web tools for OS/2.



   Best Regards,


   Chris Payne
   http://www.pr.uoguelph.ca/cpayne/
   Payne-Mennie Computing Services




FilePage v3.0 Release Notes:
----------------------------

- FilePage is now faster while indexing sub-directories.


- FilePage is now FREEWARE, and will no longer expire. Enjoy!


- FilePage now requires an environment variable to locate necessary files.


- FilePage now requires a configuration file which controls all aspects
  of processing.


- FilePage supports command line parameters. Parameters previously included
  in earlier versions of the program, as well as many new parameters.


- FilePage is now capable of indexing entire directory structures with 
  the user maintaining full control of directories processed.


- FilePage is now capable of including user-defined banner information
  in the header of the html output.


- FilePage is now even faster than earlier versions.


- All attributes of the html output are controllable within the configuration
  file. Key control functions can also be controlled from the command line.




Requirements:
-------------

 - OS/2 installed and operational.

 - An HPFS partition.

 - PlanetWide Web Server for OS/2, or Http server supporting relative pathing
   such as IBM GoServe(EWS), Apache, Web/2, or other standard HTTP Server.

 - InfoZIP (UNZIP)tools (available at most OS/2 web/ftp sites)

    try: [FTP]  ftp.cdrom.com
         [WWW]  hobbes.nmsu.edu
         [WWW]  www.infomagic.com




The Filepage files:
-------------------

icon            - directory containing the modified/transparent Filepage icons
icon_org        - directory containing the original Filepage icons
filepage.exe    - The FilePage executable file.
filepage.cnf    - Configuration file for FilePage.
filepage.doc    - This documentation file.
readme.1st      - Quick reference text file.
banner          - Sample banner file.
banner_example  - Sample banner file with a bigger example.
exclude.cnf     - Sample file-exclusion control file.
extension.cnf   - Sample file-extension/Icon control file.
fp3icons.zip    - GIF89a transparent Icons for use with FilePage v3
fp_1.gif        - Sample Image included in BANNER (above).
change.log      - Whats changed.



First Time Installation:
------------------------

Note: If you have a previous version of FilePage installed in your system,
      please skip down to the UPGRADING FROM AN EARLIER VERSION in this
      documentation.




1 - Unzip the FILEPAGE ZIP archive into a temporary directory.



2 - Copy FilePage.exe into a directory within the path of your OS/2 system,
    or create a new directory for the software. If you created a new directory
    as part of your installation, be sure to add the directory to your system
    path in the config.sys.

      (eg:  C:\OS2\APPS    )


3 - Copy two special files from the temporary directory into a directory
    where they may be easily accessed by the webmaster. It is suggested
    that these files be placed in the virtual-root of the web server.

    Copy these files:

       - FILEPAGE.CNF  
       - EXTENSION.CNF

     to your web root, these files must be in your web root so filepage has
     a valid root reference when run (not required after if you only want to
     run filepage once).

4 - Using your favourite text editor, edit your OS/2 config.sys file and add 
    the new FilePage environment variable. This environment path is the exact
    directory where you have copied the two special files: FILEPAGE.CNF and
    EXTENSION.CNF.( It is not necessary to add a trailing slash or backslash
    in the environment path statement ).

      (eg:  SET FILEPAGE=C:\WEBSERV )



5 - Create a new subdirectory under your web server directory called /ICONS
    which will contain the icons for FilePage to use during processing.

      (eg:  MD C:\WEBSERV\ICONS  )



6 - Unzip FP30ICON.ZIP into the newly created directory in Step#5. This 
    step will create many GIF89a transparent icons which FilePage can use 
    in the html output.  See Configuring EXTENSION.CNF in this documentation.



7 - You must now shutdown and restart your system for the new environment
    variable to take affect. FilePage will not, and can not run without
    this variable being set.


    The installation is now completed.




Upgrading From An Earlier Version:
----------------------------------

Note: This method is only to be used if you are UPGRADING from a previous 
      version of the FilePage program. 



1 - Unzip the FILEPAGE ZIP archive into a temporary directory.



2 - Copy FilePage.exe into the directory containing your previous version
    of the program. You may wish to rename/backup your previous version first.



3 - Check for changes in the .CNF files and if required update your server
    copy's.


4 - Using your favourite text editor, edit your OS/2 config.sys file and add 
    the new FilePage environment variable. This environment path is the exact
    directory where you have copied the two special files: FILEPAGE.CNF and
    EXTENSION.CNF. ( It is not necessary to add a trailing slash or backslash
    in the environment path statement ) .

      (eg:  SET FILEPAGE=C:\WEBSERV )


5 - Remove any icon images from the X:/server/ICONS directory created during
    installation of a previous release of FilePage.



6 - Unzip FP30ICON.ZIP into your X:/SERVER/ICONS/ directory. This step will
    create many new GIF89a transparent icons which FilePage can use in the
    html output.  See Configuring EXTENSION.CNF in this documentation.



7 - You must now shutdown and restart your system for the new environment
    variable to take affect. FilePage will not, and can not run without
    this variable being set.


    The upgrade is now completed.




Configuring FILEPAGE.CNF:
-------------------------

FilePage uses a text configuration file to allow the webmaster to control
almost every attribute in the html output. If this file is not located by
FilePage during processing, processing is terminated.

Explanation of the KEYWORDS and OPTION SETTNIGS are presented below. Some
of these setting may be used on the command-line to override those settings
in the FILEPAGE.CNF.  See COMMAND LINE PARAMETERS in this documentation.


Note: The FILEPAGE.CNF file must reside in the directory specified by the
      SET FILEPAGE=  environment variable.


      Keywords and option settings are NOT case-sensitive. 

      Keywords with their respectives may appear anywhere in the configuration
      file. FilePage will actively search for each required keyword during 
      initialization. You may reorder the file as necessary, but DO NOT rename
      any keywords.





BANNER: [ Command Line Available - see (Command Line Parameters) ]

        This command will force FilePage to search the current working 
        directory for a file with the name BANNER and insert the 
        contents of BANNER at the top of the html output during processing.

        This is just a simple way to include special notes from the
        webmaster, or advertisement banners at the top of the html
        output file.

        Simply create an HTML document and save it with the file-
        name of BANNER.  Save a copy in each directory that you 
        wish to include the banner information.


        Note: DO NOT use the <HTML>, <BODY>, <HEAD>, or <TITLE>
              tags.  If you do include these tags in your banner
              file, the html output created by FilePage is not 
              guaranteed.
                          
              Be sure to include BANNER in your EXCLUDE.CNF file,
              if you do wish to prevent banner file from being 
              included as a downloadable file.


        Valid BANNER options are: Yes, NO.


      (eg: BANNER  yes)



DIR_ICON: The proper name of the GIF icon to use to signify a directory in 
          the html output. This setting must be set in the FILEPAGE.CNF.
          
      (eg:   dir_icon   dir_1.gif )



UPDIR_ICON: The proper name of the GIF icon to use to signify an upper-level
          directory in the html output. This setting must be set in the 
          FILEPAGE.CNF.
           
      (eg:   updir_icon updir_1.gif )



FILE_ICON: The default GIF icon to use when FilePage is unable to located
           the EXTENSION.CNF file.

      (eg:   file_icon  default.gif )



SERVER_EXE: This keyword option is used to specify the proper name of the web
            server executable. FilePage actively searches recursively until
            this server executable is located.  This is how the relative paths
            are created in the html output. FilePage will not, and can not run
            without this information. If the server exe is not located, the 
            program terminates.

      (eg:   SERVER_EXE  webserv.exe )



FILENAME: [ Command Line Available - see (Command Line Parameters) ]
          This is the proper name of the html output file created by FilePage.
          The name must contain at least (1)one legal character, and the file
          extension .html or .htm, otherwise INDEX.HTM becomes the default.

      (eg:   FILENAME  index.html )



ICON_DIR: This is the RELATIVE path to the X:\webserver_dir in which the GIF89a
          transparent icons are located. If this path is not specified, then
          the icons will not appear in the html output.  Do not add a trailing
          slash or backslash.

      (eg:   ICON_DIR  /icons  )



FORMAT: This is the desired complexity of the html output being generated.
        FilePage is capable of various levels of output detail which can 
        effictively reduce the filesize, and increase appearance of directories
        containing many files. 

        Legal output formats are:   FULL, BARE, and PRE.

      (eg:   FORMAT  full  )



MASK_LINK: [ Command Line Available - see (Command Line Parameters) ]

        This keyword option is used to enable/disable file reference masking
        to web clients supporting this feature.  Taking advantage of the 
        "OnMouseOver=" feature in HTML 3.0 capable browsers.

      (eg:   MASK_LINK   yes )



DIR: [ Command Line Available - see (Command Line Parameters) ]

     This keyword option is used to determine whether or not to display the 
     current-working-directory path at the top of the html output.

      (eg:   DIR   no )



SUB: [ Command Line Available - see (Command Line Parameters) ]

     This keyword option is used to determine whether or not to index sub-
     directories located. 

      (eg:   SUB   yes )



EXCLUDE:  [ Command Line Available - see (Command Line Parameters) ]

     This keyword option is used to determing whether or not to index
     files listed within the EXCLUDE.CNF file. See CONFIGURING EXCLUDE.CNF
     in this documentation.

      (eg:   EXCLUDE  yes )



ROBOTS: Not yet used.

      (eg:   ROBOTS   no )



WEB_BG: This keyword specifies the default background colour of the html
        output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
        A medium blue background would be defined as:

      (eg:   web_bg  0000CC )



WEB_TEXT: This keyword specifies the default text foreground colour of the html
          output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
          White text would be defined as:

      (eg:   web_text  FFFFFF )



WEB_LINK: This keyword specifies the default LINK foreground colour of the html
          output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
          Yellow link text would be defined as:

      (eg:   web_link  FFEE33 )



WEB_VLINK: This keyword specifies the default VLINK foreground colour of the
           html output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
           A duller Yellow vlink text would be defined as:

      (eg:   web_vlink  FFEE00 )



WEB_IMAGE: This keyword specifies a GIF or JPG image file to be tiled as the
           web page background. Simply specify the name and path of the image
           relative_path to the server root directory and it will be included
           in the html output. 

      (eg:   web_image   /images/blueswirl.gif )



BYTES_COLOR: This keyword specifies the colour of the text in the BYTES 
             column of the output table. This colour is used in the html
             <FONT> tag, and will be seen by most web clients. The colour 
             scheme is stated as(RRGGBB) RED GREEN BLUE. A bright Yellow text
             would be defined as:

      (eg:   bytes_color EEEEEE )



DATE_COLOR: This keyword specifies the colour of the text in the DATE/TIME 
            column of the output table. This colour is used in the html
            <FONT> tag, and will be seen by most web clients. The colour 
            scheme is stated as(RRGGBB) RED GREEN BLUE. A bright purple text
            would be defined as:

      (eg:   date_color  CCCCFF )



DESC_COLOR: This keyword specifies the colour of the text in the DESCRIPTION 
            column of the output table. This colour is used in the html
            <FONT> tag, and will be seen by most web clients. The colour 
            scheme is stated as(RRGGBB) RED GREEN BLUE. A bright cyan text
            would be defined as:

      (eg: desc_color  33FFFF )



ICON_BGCOLOR: This keyword specifies the background colour of the ICON
              column of the output table. This colour is used in the html
              <FONT> tag, and will be seen by most web clients. The colour 
              scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
              background would be defined as:

      (eg:   icon_bgcolor  0000CC )



FILENAME_BGCOLOR: This keyword specifies the background colour of the FILENAME
                  column of the output table. This colour is used in the html
                  <FONT> tag, and will be seen by most web clients. The colour 
                  scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
                  background would be defined as:

      (eg:   filename_bgcolor 0000CC )



BYTES_BGCOLOR: This keyword specifies the background colour of the BYTES
               column of the output table. This colour is used in the html
               <FONT> tag, and will be seen by most web clients. The colour 
               scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
               background would be defined as:

      (eg:   bytes_bgcolor  0000CC )



DATE_BGCOLOR: This keyword specifies the background colour of the DATE/TIME
              column of the output table. This colour is used in the html
              <FONT> tag, and will be seen by most web clients. The colour 
              scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
              background would be defined as:

      (eg:   date_bgcolor  0000CC )



DESC_BGCOLOR: This keyword specifies the background colour of the DESCRIPTION
              column of the output table. This colour is used in the html
              <FONT> tag, and will be seen by most web clients. The colour 
              scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
              background would be defined as:

      (eg:   desc_bgcolor  0000CC )



ICON_HEADER_BGCOLOR: This keyword specifies the background colour of the 
                     ICON HEADER of the output table. This colour is used in
             the html <FONT> tag, and will be seen by most web clients. The 
             colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright blue 
             background would be defined as:

      (eg:   icon_header_bgcolor   0000FF )



FILENAME_HEADER_BGCOLOR: This keyword specifies the background colour of the 
                         FILENAME HEADER of the output table. This colour is
             used in the html <FONT> tag, and will be seen by most web clients.
             The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
             blue background would be defined as:

      (eg:   filename_header_bgcolor 0000FF )



BYTES_HEADER_BGCOLOR: This keyword specifies the background colour of the 
                      BYTES HEADER of the output table. This colour is used
             in the html <FONT> tag, and will be seen by most web clients.
             The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
             blue background would be defined as:

      (eg:   bytes_header_bgcolor  0000FF )



DATE_HEADER_BGCOLOR: This keyword specifies the background colour of the 
                     DATE/TIME HEADER of the output table. This colour is
             used in the html <FONT> tag, and will be seen by most web clients.
             The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
             blue background would be defined as:

      (eg:   date_header_bgcolor  0000FF )



DESC_HEADER_BGCOLOR: This keyword specifies the background colour of the 
                     DESCRIPTION HEADER of the output table. This colour is
             used in the html <FONT> tag, and will be seen by most web clients.
             The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
             blue background would be defined as:

      (eg:  desc_header_bgcolor  0000FF )




TABLE_WIDTH: This keyword specifies the overall width of the table in the html
             output. The width is a (%)percentage of the total width of the 
             web client screen, but do not include the (%)percent character.

      (eg:   table_width   100 )



TABLE_BORDER_SIZE: This keyword specifies the size of the table border in the 
                   html output. The width is specified in pixels. By default,
                   a width of (0)zero is set, you may change this setting.

      (eg:   table_border_size  0 )



ICON_WIDTH: This keyword specifies the width of the ICON table cell. The width
            is a (%)percentage of the total width of the table, but do not 
            include the (%)percent character.

      (eg:   icon_width  5 )



FILENAME_WIDTH: This keyword specifies the width of the FILENAME table cell.
                The width is a (%)percentage of the total width of the table,
                but do not include the (%)percent character.

      (eg:   filename_width  25 )



BYTES_WIDTH: This keyword specifies the width of the BYTES table cell. The
             width is a (%)percentage of the total width of the table, but do
             not include the (%)percent character.

      (eg:   bytes_width  10 )



DATE_WIDTH: This keyword specifies the width of the DATE/TIME table cell. The
            width is a (%)percentage of the total width of the table, but do
            not include the (%)percent character.

      (eg:   date_width  20 )



DESC_WIDTH: This keyword specifies the width of the DESCRIPTION table cell. The
            width is a (%)percentage of the total width of the table, but do
            not include the (%)percent character.

      (eg:   desc_width  40 )



ICON_SIZE: Not yet used.

      (eg:   icon_size  -1 )



FILENAME_SIZE: Not yet used.

      (eg:   filename_size  -1 )



BYTES_SIZE: Not yet used.

      (eg:   bytes_size  -1 )



DATE_SIZE: Not yet used.

      (eg:    date_size  -1 )



DESC_SIZE: Not yet used.

      (eg:   desc_size  -1 )



ICON_ALIGN: This keyword specifies the horizontal alignment of the ICON table
            cell in the html ouput. Valid responses are Left,Center,Right.

      (eg:   icon_align   center )



FILENAME_ALIGN: This keyword specifies the horizontal alignment of the FILENAME
                table cell in the html ouput. Valid responses are Left,Center,
                and Right.

      (eg:   filename_align  left )


BYTES_ALIGN: This keyword specifies the horizontal alignment of the BYTES table
             cell in the html ouput. Valid responses are Left,Center,Right.

      (eg:   bytes_align   center )



DATE_ALIGN: This keyword specifies the horizontal alignment of the DATE/TIME
            table cell in the html ouput. Valid responses are Left,Center,
            and Right.

      (eg:   date_align   center )



DESC_ALIGN: This keyword specifies the horizontal alignment of the DESCRIPTION
            table cell in the html ouput. Valid responses are Left,Center,
            and Right.

      (eg:   desc_align   left )





Command Line Parameters:
------------------------
FilePage supports many function settings from the command line. The command
line options are typically used to override the default settings present in
the FILEPAGE.CNF configuration file.  

Note: Keywords are not case-sensitive. They may also appear on the command 
      line in any order. 

      If a command is issed (eg: SUB ), and then ( NOSUB ) is also issued on
      the same command line, the latter overrides. I don't know why someone
      would do this, but it could happen.


        DIR       - instructs FilePage to place the full output path above the
                    description header cell field.


        NODIR     - instructs FilePage not to place the full output path above
                    the description header cell field.


        BANNER    - specifying this command line option will force FilePage
                    to search the current working directory for a file with
                    the name BANNER and insert the contents of BANNER at the 
                    top of the html output during processing.

                    This is just a simple way to include special notes from the
                    webmaster, or advertisement banners at the top of the html
                    output file.

                    Simply create an HTML document and save it with the file-
                    name of BANNER.  Save a copy in each directory that you 
                    wish to include the banner information.


                    Note: DO NOT use the <HTML>, <BODY>, <HEAD>, or <TITLE>
                          tags.  If you do include these tags in your banner
                          file, the html output created by FilePage is not 
                          guaranteed.
                          
                          Be sure to include BANNER in your EXCLUDE.CNF file,
                          if you do wish to prevent banner file from being 
                          included as a downloadable file.
                    
        NOBANNER  - Disables the BANNER option specified on the command line,
                    or specified in the FILEPAGE.CNF file.


        EXCLUDE   - instructs FilePage to use the EXCLUDE.CNF file exclusion
                    file, if one is located in the current working directory.


        NOEXCLUDE - instruct FilePage not to use the EXCLUDE.CNF file exclusion
                    file; it will not search the current working directory.
 

        LINK      - specifying this command parameter will LINK the new output
                    file being created to an upper level directory; a web link
                    of the same name(ie: index.htm ).

                    FilePage does not check to see if an upper level link
                    is available, so one must already exist.

                    Note: This option is great if you wish to update lower
                          level sub-directories without processing entire 
                          directory structures. LINK will attach your page
                          being updated to a page of the same name in the
                          directory-level above the current working directory.


        NOLINK    - specifying this command parameter will disable the LINK 
                    command in the FILEPAGE.CNF file.


        MASK      - enable file reference masking using the "OnMouseOver="
                    statement.


        NOMASK    - disable file reference masking. 


        SUB       - enable subdirectory indexing. FilePage will follow and index
                   all subdirectories located.


        NOSUB     - disable subdirectory indexing. Quit once current directory
                  is processed.


        FILE:filename.ext - supply a new output htm/html filename on the fly.
                            The specified filename will be created throughout 
                            the entire directory tree if the SUB option is 
                            enabled.

                            Filename must be at least (1)one character in 
                            length, AND it MUST have the file extension, .HTM,
                            or .HTML.  If the filename is invalid, the setting
                            associated with FILENAME in the FILEPAGE.CNF will
                            become the default output filename.

                            Failing this, INDEX.HTM becomes the output default.


        SCHEME:filename.scm - supply a (.scm)SCHEME filename, and each of the
                            attributes stored within the (.scm)SCHEME file will
                            be used to configure the html output. 

                            All (.scm)SCHEME files must reside in the directory
                            specified by the  SET FILEPAGE=  environment 
                            variable.

                            A (.scm)SCHEME filename must be at least (1)one 
                            character in length, AND it MUST have the .SCM
                            file extension.

                            If the SCHEME file does not meet this criteria,
                            settings are read from the FILEPAGE.CNF file.

                            Failing this, internal defaults are used.

                             
                            Note: Keywords and option settings are NOT case-
                                  sensitive.

                                  Any attributes missing in the .scm file will
                                  be set to default internally by FilePage 
                                  during initialization.


 


Including File Descriptions: 
----------------------------

FilePage uses a text file named DESCRIPTIONS to obtain descriptions for each
file in your processed directories. FilePage will search the DESCRIPTIONS file 
for the TITLE= keyword, to obtain the title for the html output.

Using the DESCRIPTIONS file is optional. If the file does not exist, it will
be assumed that there are no descriptions to include.


   Note: filename entries in the DESCRIPTIONS file are not case-sensitive.




   DESCRIPTIONS entry format:  <FILENAME.EXTENSION> <FILE DESCRIPTION>


1. Create a file called DESCRIPTIONS with your favourite text editor.

2. Place one file entry per line, and separate the FILENAME and DESCRIPTION
   with a blank<SPACE> character.

3. Limit each line entry to 1,256(MAX) characters, otherwise FilePage will 
   truncate the description. This allows for a long filename(255 characters),
   and a lengthy file description(1,000 characters).


   Note: #HASH marks may be used to add comments in the file. FILEPAGE will
         ignore #HASH-commented lines.




   Sample Description file entries:

   
   jet_f14.jpg  An F14 jet flying over the desert.
   image.gif    Picture of my OS/2 desktop in 256 colours.
   scream.wav   A wav file of someone screaming.





Web Page Title:
---------------

By default, FilePage places the TITLE "HTTP FILE LIST" at the top of your HTML
output.  You may place your customized title in the HTML output by doing the
following steps:


1. Follow the above steps to create a DESCRIPTIONS text file.


2. Add an entry into the DESCRIPTIONS file starting with the keyword:
  
   TITLE=


3. Place your HTML output title following the keyword(Max 80 characters).


   Example:   TITLE= My OS/2 Shareware Page




Excluding (hiding) Files:  ( EXCLUSION.CNF )
-------------------------

When FilePage is executed, it looks for an EXCLUDE.CNF text file. Any files
listed within EXCLUDE.CNF will not be processed in the final HTML output.

A copy of this file should be created/copied to each directory which contains
files that must be excluded.



1. Create a text file in your working directory called EXCLUDE.CNF, using 
   your favourite text editor.


2. Place the filename of any "files to be excluded" in this file.


3. Do not include any path information.


4. File entries should occur, one filename per line.


5. Save this file.





Using Icons: (EXTENSION.CNF)
------------

The EXTENSION.CNF file contains an entry for each type of file in your file
direcotries. FilePage matches an icon to each file extension processed, to
an extension types entry listed within EXTENSION.CNF.

You are free to edit this file with your favourite text editor. Add an 
unlimited number of custom file entries as required.


Note: The EXTENSION file must reside in the directory specified by the
      SET FILEPAGE=  environment variable.

      Entries made into the extension.cnf file should NOT include any path
      information. Path to the icons is specified in the FILEPAGE.CNF file.



  Extension entry format:  <Extension> <Image_Name.ext>

  *Note: #HASH marks may be used to add comments in the file. FILEPAGE will
         ignore #HASH-commented lines.



Sample EXTENSION.CNF file entries:


# ARCHIVE ICONS #
arc   archive_4.gif
lhz   archive_4.gif
lzh   archive_4.gif
ice   archive_4.gif
dsk   archive_1.gif
zip   archive_1.gif


# IMAGE ICONS #
bmp   image_3.gif
fon   font_1.gif
fot   font_1.gif
ttf   font_2.gif
gif   image_4.gif
ico   icon2.gif
iff   image_3.gif
jpg   image_4.gif
mac   image_2.gif
pcx   image_2.gif
pic   image_2.gif
tga   image_3.gif
tif   image_3.gif
wpg   image_2.gif
wrz   wrl.gif





Troubleshooting:
----------------

Q. [ ICONS show up as broken image links in the web browser.]

  A1. Make sure that the sub-directory \ICONS  was created and all of the
      icons from the installation were created(unZIPed with InfoZIP).


  A3. Make sure that the users viewing the FILE LIST has rights to read from
      the \ICONS directory. See IP FILTERING in PlanetWide WEBSERV documentaion.
 


Q. [ All output entries have a DEFAULT ICON but I have added new icons in the
    \ICONS directory. ]

  A1. Make sure that your new icons are registered in the EXTENSION.CNF file.
      Add one entry for each file_type to use the new icon(s).

  A2. Make sure that you are working from an HPFS partition since the EXTENSION
      file does not fit the DOS(8.3) format and will not be recognized by
      FILEPAGE.



Q. [ My links on the HTML output page are invalid! ]

  A1. FilePage automatically perfroms a reverse-search from the current
      working directory to locate the first occurance of WEBSERV.EXE.
      It uses this path to determine the relative path for the HTML output.
      If you have multiple copies of WEBSERV.EXE in your directory structure, 
      FilePage may choose the incorrect copy as the file reference. 
  
      Be sure not to store multiple copies of WEBSERV.EXE in your directory
      structure.



Q. [ FilePage terminates with an error, "Sorry, output filename is missing..."]

  A1. FilePage will return this error if the following conditions are true:

        - Disk is write protected.
        - Disk is out of disk space.
        - A duplicate filename exists AND is write-protected.
        - User has specified the /F: parameter with no filename, or with an
          invalid filename.

       Check for any of these conditions, and rerun FilePage once you have
       solved the problem.



Q. [ FilePage only creates the HTML output file called "INDEX.HTM". ]

  A1. You must specify the command line parameter FILE:filename.htm/html if you
      wish to create an output file other than the default, INDEX.HTM.


  A2. Edit the FILEPAGE.CNF file and change the FILENAME keyword setting 
      to the required filename.



Q. [ The MASKING of the links does not work properly, even though I used the 
     MASK command line parameter. ]


  A1. The MASK feature is only supported by newer releases of Netscape Navigator
      and Internet Explorer, and Netscape Communicator(to our knowledge). 
      The effect of the MASK feature is not 100% foolproof, it is merely a 
      deterant.

      We have seen Netscape disregard the MASK feature on the local machine,
      but remote users are presented with the masking information.  No reasons
      for this occurance.

      If your client does not support the "OnMouseOver=" command, masking will
      not work.



Q. [ When I specify command the line parameters, they make no effect on final 
     processing. ]

  A1. Be sure that you specify your commands correctly.


  A2. If you enable a function and disable a function on the same command line,
      the last command specified will override the previous command.



Q. [ FilePage places a default TITLE "HTTP FILE LIST" at the top of the output
     file processed. ]

  A1. Follow the instructions for WEB PAGE TITLE in this doecument.

      The KEYWORD  "TITLE="  must be in upper case, and must be added to the
      DESCRIPTIONS text file. Do not include the quotation marks.




Conclusion:
-----------

Note: Payne-Mennie Computing Services nolonger supports this program, if you
have a question/query etc please contact myself, Ian Manners, via

    http://os2site.com
    or
    http://comkal.net


Trade marks:
===========

OS/2 is a trade mark of INTERNATIONAL BUSINESS MACHINES(IBM).

IBM WEBEXPLORER is a trade mark of INTERNATIONAL BUSINESS MACHINES(IBM).

NETSCAPE NAVIGATOR is a trade mark of NETSCAPE COMMUNICATIONS LTD.

INTERNET EXPLORER is a trademark of MicroSoft Corp.

--End
