home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / fp30b4.zip / filepage.doc < prev    next >
Text File  |  1998-09-29  |  39KB  |  1,206 lines
  1. rev3/07161998
  2.  
  3.  
  4.       ███████╗ ██╗ ██╗      ███████╗ ██████╗   █████╗   ██████╗  ███████╗
  5.       ██╔════╝ ██║ ██║      ██╔════╝ ██╔══██╗ ██╔══██╗ ██╔════╝  ██╔════╝
  6.       █████╗   ██║ ██║      █████╗   ██████╔╝ ███████║ ██║  ███╗ █████╗
  7.       ██╔══╝   ██║ ██║      ██╔══╝   ██╔═══╝  ██╔══██║ ██║   ██║ ██╔══╝
  8.       ██║      ██║ ███████╗ ███████╗ ██║      ██║  ██║ ╚██████╔╝ ███████╗
  9.       ╚═╝      ╚═╝ ╚══════╝ ╚══════╝ ╚═╝      ╚═╝  ╚═╝  ╚═════╝  ╚══════╝ 
  10.  
  11.                                     v3.0 (beta 4)
  12.  
  13.                (c)Copyright 1998 Payne-Mennie Computing Services
  14.  
  15.  
  16.  
  17.  
  18. COPYRIGHT/LEGAL:
  19. ===============
  20. This software is provided on an "as-is" basis.  We offer no warranty on this
  21. software whatsoever, and you use it at your own risk. FilePage is unable to
  22. modify files other than its own for internal processing purposes.
  23.  
  24. The files contained in this package may not be modified or reverse-engineered
  25. or decompiled in any form for any reason. Problems with the executable or
  26. documentation should be brought to the attention of Payne-Mennie Computing 
  27. Services for correction.
  28.  
  29. FilePage v3.0 (beta-4) is being made available to the public as FREEWARE and 
  30. replaces all previous versions. If you find that the software serves your
  31. needs, please take the time to email us and let us know at:
  32.  
  33.         planetwide@bmtmicro.com
  34.  
  35. Further development of the software depends on the reponse by the OS/2 
  36. shareware/freeware application supporters.
  37.  
  38.  
  39. This software is not to be redistributed as part of another software package
  40. without the written consent of Payne-Mennie Computing Services.
  41.  
  42. Filepage and PlanetWide Web Server for OS/2 are (c)Copyright 1996,1997,1998 
  43. Payne-Mennie Computing Services.
  44.  
  45.  
  46.  
  47.  
  48. Freeware Notice:
  49. ----------------
  50.  
  51. - FilePage v3.0 is now being release to the public as FREEWARE. In doing
  52.   so, no warranties, expressed or implied are offered in the operation of
  53.   the software package. Although we guarantee that FilePage will reduce
  54.   the maintenance time for your web distribution site(s).
  55.  
  56.   We appreciate all of those who have registered their shareware and have
  57.   supported many many OS/2 developers. These are the people that we develop
  58.   for; to give them the choice of quality native OS/2 software.  Enjoy.
  59.  
  60.  
  61.  
  62.  
  63. What is FilePage?:
  64. ------------------
  65.  
  66. FilePage is a standalone program that creates html file-lists. To take this
  67. a bit further than the basic idea; FilePage will index your file distribution
  68. directories on your web server, and created customizable html output for your
  69. web visitors to use as a navigating tool.
  70.  
  71. FilePage is totally configurable, meaning that you can make alterations to
  72. the foreground and background colours, table cell properties, file exclusions,
  73. even choose your graphical icons, and much much more. 
  74.  
  75. Once you have FilePage configured to your liking, let it loose on your file
  76. directories and let it do the hard work of maintaining your web site. What
  77. would take the webmaster several hours is completed in seconds. No kidding!
  78.  
  79. If this sounds interesting to you, read the rest of the documentation to
  80. discover more about one of the best web tools for OS/2.
  81.  
  82.  
  83.  
  84.    Best Regards,
  85.  
  86.  
  87.    Chris Payne
  88.    planetwide@bmtmicro.com
  89.    http://www.pr.uoguelph.ca/cpayne/planet.htm
  90.    Payne-Mennie Computing Services
  91.  
  92.  
  93.  
  94.  
  95. FilePage v3.0 Release Notes:
  96. ----------------------------
  97.  
  98. - FilePage is now faster while indexing sub-directories.
  99.  
  100.  
  101. - FilePage is now FREEWARE, and will no longer expire. Enjoy!
  102.  
  103.  
  104. - FilePage now requires an environment variable to locate necessary files.
  105.  
  106.  
  107. - FilePage now requires a configuration file which controls all aspects
  108.   of processing.
  109.  
  110.  
  111. - FilePage supports command line parameters. Parameters previously included
  112.   in earlier versions of the program, as well as many new parameters.
  113.  
  114.  
  115. - FilePage is now capable of indexing entire directory structures with 
  116.   the user maintaining full control of directories processed.
  117.  
  118.  
  119. - FilePage is now capable of including user-defined banner information
  120.   in the header of the html output.
  121.  
  122.  
  123. - FilePage is now even faster than earlier versions.
  124.  
  125.  
  126. - All attributes of the html output are controllable within the configuration
  127.   file. Key control functions can also be controlled from the command line.
  128.  
  129.  
  130.  
  131.  
  132. Requirements:
  133. -------------
  134.  
  135.  - OS/2 installed and operational.
  136.  
  137.  - An HPFS partition.
  138.  
  139.  - PlanetWide Web Server for OS/2, or Http server supporting relative pathing
  140.    such as IBM GoServe(EWS).
  141.  
  142.  - InfoZIP (UNZIP)tools (available at most OS/2 web/ftp sites)
  143.  
  144.     try: [FTP]  ftp.cdrom.com
  145.          [WWW]  hobbes.nmsu.edu
  146.          [WWW]  www.infomagic.com
  147.  
  148.  
  149.  
  150.  
  151. The Filepage files:
  152. -------------------
  153.  
  154. filepage.exe    - The FilePage executable file.
  155. filepage.cnf    - Configuration file for FilePage.
  156. filepage.doc    - This documentation file.
  157. readme.1st      - Quick reference text file.
  158. banner          - Sample banner file.
  159. exclude.cnf     - Sample file-exclusion control file.
  160. extension.cnf   - Sample file-extension/Icon control file.
  161. fp3icons.zip    - GIF89a transparent Icons for use with FilePage v3
  162. fp_1.gif        - Sample Image included in BANNER (above).
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169. First Time Installation:
  170. ------------------------
  171.  
  172. Note: If you have a previous version of FilePage installed in your system,
  173.       please skip down to the UPGRADING FROM AN EARLIER VERSION in this
  174.       documentation.
  175.  
  176.  
  177.  
  178.  
  179. 1 - Unzip the FILEPAGE ZIP archive into a temporary directory.
  180.  
  181.  
  182.  
  183. 2 - Copy FilePage.exe into a directory within the path of your OS/2 system,
  184.     or create a new directory for the software. If you created a new directory
  185.     as part of your installation, be sure to add the direcotry to your system
  186.     path in the config.sys.
  187.  
  188.       (eg:  C:\OS2\APPS    )
  189.  
  190.  
  191.  
  192. 3 - Copy two special files from the temporary directory into a directory
  193.     where they may be easily accessed by the webmaster. It is suggested
  194.     that these files be placed in the virtual-root of the web server
  195.     (the directory where your server executable file is located), for
  196.     simplicity.
  197.  
  198.     You may place these files into the newly created filepage directory,
  199.     if one was created in Step#2.
  200.  
  201.  
  202.     Copy these files:
  203.  
  204.        - FILEPAGE.CNF  
  205.        - EXTENSION.CNF
  206.  
  207.  
  208.  
  209. 4 - Using your favourite text editor, edit your OS/2 config.sys file and add 
  210.     the new FilePage environment variable. This environment path is the exact
  211.     directory where you have copied the two special files: FILEPAGE.CNF and
  212.     EXTENSION.CNF.( It is not necessary to add a trailing slash or backslash
  213.     in the environment path statement ).
  214.  
  215.       (eg:  SET FILEPAGE=C:\WEBSERV )
  216.  
  217.  
  218.  
  219. 5 - Create a new subdirectory under your web server directory called /ICONS
  220.     which will contain the icons for FilePage to use during processing.
  221.  
  222.       (eg:  MD C:\WEBSERV\ICONS  )
  223.  
  224.  
  225.  
  226. 6 - Unzip FP30ICON.ZIP into the newly created directory in Step#5. This 
  227.     step will create many GIF89a transparent icons which FilePage can use 
  228.     in the html output.  See Configuring EXTENSION.CNF in this documentation.
  229.  
  230.  
  231.  
  232. 7 - You must now shutdown and restart your system for the new environment
  233.     variable to take affect. FilePage will not, and can not run without
  234.     this variable being set.
  235.  
  236.  
  237.     The installation is now completed.
  238.  
  239.  
  240.  
  241.  
  242. Upgrading From An Earlier Version:
  243. ----------------------------------
  244.  
  245. Note: This method is only to be used if you are UPGRADING from a previous 
  246.       version of the FilePage program. 
  247.  
  248.  
  249.  
  250. 1 - Unzip the FILEPAGE ZIP archive into a temporary directory.
  251.  
  252.  
  253.  
  254. 2 - Copy FilePage.exe into the directory containing your previous version
  255.     of the program. You may wish to rename/backup your previous version first.
  256.  
  257.  
  258.  
  259. 3 - Copy two special files from the temporary directory into a directory
  260.     where they may be easily accessed by the webmaster. It is suggested
  261.     that these files be placed in the virtual-root of the web server
  262.     (the directory where your server executable file is located), for
  263.     simplicity.
  264.  
  265.     Note: if you have added new line entries in your previous installed
  266.           copy of EXTENSION.CNF, be sure to copy/paste them into the new
  267.           EXTENSION.CNF.  Also note that the GIF89a icons have new names.
  268.  
  269.     Copy these files:
  270.  
  271.        - FILEPAGE.CNF  
  272.        - EXTENSION.CNF
  273.  
  274.  
  275.  
  276. 4 - Using your favourite text editor, edit your OS/2 config.sys file and add 
  277.     the new FilePage environment variable. This environment path is the exact
  278.     directory where you have copied the two special files: FILEPAGE.CNF and
  279.     EXTENSION.CNF. ( It is not necessary to add a trailing slash or backslash
  280.     in the environment path statement ) .
  281.  
  282.       (eg:  SET FILEPAGE=C:\WEBSERV )
  283.  
  284.  
  285.  
  286. 5 - Remove any icon images from the X:/server/ICONS directory created during
  287.     installation of a previous release of FilePage.
  288.  
  289.  
  290.  
  291. 6 - Unzip FP30ICON.ZIP into your X:/SERVER/ICONS/ directory. This step will
  292.     create many new GIF89a transparent icons which FilePage can use in the
  293.     html output.  See Configuring EXTENSION.CNF in this documentation.
  294.  
  295.  
  296.  
  297. 7 - You must now shutdown and restart your system for the new environment
  298.     variable to take affect. FilePage will not, and can not run without
  299.     this variable being set.
  300.  
  301.  
  302.     The upgrade is now completed.
  303.  
  304.  
  305.  
  306.  
  307. Configuring FILEPAGE.CNF:
  308. -------------------------
  309.  
  310. FilePage uses a text configuration file to allow the webmaster to control
  311. almost every attribute in the html output. If this file is not located by
  312. FilePage during processing, processing is terminated.
  313.  
  314. Explanation of the KEYWORDS and OPTION SETTNIGS are presented below. Some
  315. of these setting may be used on the command-line to override those settings
  316. in the FILEPAGE.CNF.  See COMMAND LINE PARAMETERS in this documentation.
  317.  
  318.  
  319. Note: The FILEPAGE.CNF file must reside in the directory specified by the
  320.       SET FILEPAGE=  environment variable.
  321.  
  322.  
  323.       Keywords and option settings are NOT case-sensitive. 
  324.  
  325.       Keywords with their respectives may appear anywhere in the configuration
  326.       file. FilePage will actively search for each required keyword during 
  327.       initialization. You may reorder the file as necessary, but DO NOT rename
  328.       any keywords.
  329.  
  330.  
  331.  
  332.  
  333.  
  334. BANNER: [ Command Line Available - see (Command Line Parameters) ]
  335.  
  336.         This command will force FilePage to search the current working 
  337.         directory for a file with the name BANNER and insert the 
  338.         contents of BANNER at the top of the html output during processing.
  339.  
  340.         This is just a simple way to include special notes from the
  341.         webmaster, or advertisement banners at the top of the html
  342.         output file.
  343.  
  344.         Simply create an HTML document and save it with the file-
  345.         name of BANNER.  Save a copy in each directory that you 
  346.         wish to include the banner information.
  347.  
  348.  
  349.         Note: DO NOT use the <HTML>, <BODY>, <HEAD>, or <TITLE>
  350.               tags.  If you do include these tags in your banner
  351.               file, the html output created by FilePage is not 
  352.               guaranteed.
  353.                           
  354.               Be sure to include BANNER in your EXCLUDE.CNF file,
  355.               if you do wish to prevent banner file from being 
  356.               included as a downloadable file.
  357.  
  358.  
  359.         Valid BANNER options are: Yes, NO.
  360.  
  361.  
  362.       (eg: BANNER  yes)
  363.  
  364.  
  365.  
  366. DIR_ICON: The proper name of the GIF icon to use to signify a directory in 
  367.           the html output. This setting must be set in the FILEPAGE.CNF.
  368.           
  369.       (eg:   dir_icon   dir_1.gif )
  370.  
  371.  
  372.  
  373. UPDIR_ICON: The proper name of the GIF icon to use to signify an upper-level
  374.           directory in the html output. This setting must be set in the 
  375.           FILEPAGE.CNF.
  376.            
  377.       (eg:   updir_icon updir_1.gif )
  378.  
  379.  
  380.  
  381. FILE_ICON: The default GIF icon to use when FilePage is unable to located
  382.            the EXTENSION.CNF file.
  383.  
  384.       (eg:   file_icon  default.gif )
  385.  
  386.  
  387.  
  388. SERVER_EXE: This keyword option is used to specify the proper name of the web
  389.             server executable. FilePage actively searches recursively until
  390.             this server executable is located.  This is how the relative paths
  391.             are created in the html output. FilePage will not, and can not run
  392.             without this information. If the server exe is not located, the 
  393.             program terminates.
  394.  
  395.       (eg:   SERVER_EXE  webserv.exe )
  396.  
  397.  
  398.  
  399. FILENAME: [ Command Line Available - see (Command Line Parameters) ]
  400.           This is the proper name of the html output file created by FilePage.
  401.           The name must contain at least (1)one legal character, and the file
  402.           extension .html or .htm, otherwise INDEX.HTM becomes the default.
  403.  
  404.       (eg:   FILENAME  index.html )
  405.  
  406.  
  407.  
  408. ICON_DIR: This is the RELATIVE path to the X:\webserver_dir in which the GIF89a
  409.           transparent icons are located. If this path is not specified, then
  410.           the icons will not appear in the html output.  Do not add a trailing
  411.           slash or backslash.
  412.  
  413.       (eg:   ICON_DIR  /icons  )
  414.  
  415.  
  416.  
  417. FORMAT: This is the desired complexity of the html output being generated.
  418.         FilePage is capable of various levels of output detail which can 
  419.         effictively reduce the filesize, and increase appearance of directories
  420.         containing many files. 
  421.  
  422.         Legal output formats are:   FULL, BARE, and PRE.
  423.  
  424.       (eg:   FORMAT  full  )
  425.  
  426.  
  427.  
  428. MASK_LINK: [ Command Line Available - see (Command Line Parameters) ]
  429.  
  430.         This keyword option is used to enable/disable file reference masking
  431.         to web clients supporting this feature.  Taking advantage of the 
  432.         "OnMouseOver=" feature in HTML 3.0 capable browsers.
  433.  
  434.       (eg:   MASK_LINK   yes )
  435.  
  436.  
  437.  
  438. DIR: [ Command Line Available - see (Command Line Parameters) ]
  439.  
  440.      This keyword option is used to determine whether or not to display the 
  441.      current-working-directory path at the top of the html output.
  442.  
  443.       (eg:   DIR   no )
  444.  
  445.  
  446.  
  447. SUB: [ Command Line Available - see (Command Line Parameters) ]
  448.  
  449.      This keyword option is used to determine whether or not to index sub-
  450.      directories located. 
  451.  
  452.       (eg:   SUB   yes )
  453.  
  454.  
  455.  
  456. EXCLUDE:  [ Command Line Available - see (Command Line Parameters) ]
  457.  
  458.      This keyword option is used to determing whether or not to index
  459.      files listed within the EXCLUDE.CNF file. See CONFIGURING EXCLUDE.CNF
  460.      in this documentation.
  461.  
  462.       (eg:   EXCLUDE  yes )
  463.  
  464.  
  465.  
  466. ROBOTS: Not yet used.
  467.  
  468.       (eg:   ROBOTS   no )
  469.  
  470.  
  471.  
  472. WEB_BG: This keyword specifies the default background colour of the html
  473.         output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
  474.         A medium blue background would be defined as:
  475.  
  476.       (eg:   web_bg  0000CC )
  477.  
  478.  
  479.  
  480. WEB_TEXT: This keyword specifies the default text foreground colour of the html
  481.           output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
  482.           White text would be defined as:
  483.  
  484.       (eg:   web_text  FFFFFF )
  485.  
  486.  
  487.  
  488. WEB_LINK: This keyword specifies the default LINK foreground colour of the html
  489.           output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
  490.           Yellow link text would be defined as:
  491.  
  492.       (eg:   web_link  FFEE33 )
  493.  
  494.  
  495.  
  496. WEB_VLINK: This keyword specifies the default VLINK foreground colour of the
  497.            html output. The colour scheme is stated as(RRGGBB) RED GREEN BLUE.
  498.            A duller Yellow vlink text would be defined as:
  499.  
  500.       (eg:   web_vlink  FFEE00 )
  501.  
  502.  
  503.  
  504. WEB_IMAGE: This keyword specifies a GIF or JPG image file to be tiled as the
  505.            web page background. Simply specify the name and path of the image
  506.            relative_path to the server root directory and it will be included
  507.            in the html output. 
  508.  
  509.       (eg:   web_image   /images/blueswirl.gif )
  510.  
  511.  
  512.  
  513. BYTES_COLOR: This keyword specifies the colour of the text in the BYTES 
  514.              column of the output table. This colour is used in the html
  515.              <FONT> tag, and will be seen by most web clients. The colour 
  516.              scheme is stated as(RRGGBB) RED GREEN BLUE. A bright Yellow text
  517.              would be defined as:
  518.  
  519.       (eg:   bytes_color EEEEEE )
  520.  
  521.  
  522.  
  523. DATE_COLOR: This keyword specifies the colour of the text in the DATE/TIME 
  524.             column of the output table. This colour is used in the html
  525.             <FONT> tag, and will be seen by most web clients. The colour 
  526.             scheme is stated as(RRGGBB) RED GREEN BLUE. A bright purple text
  527.             would be defined as:
  528.  
  529.       (eg:   date_color  CCCCFF )
  530.  
  531.  
  532.  
  533. DESC_COLOR: This keyword specifies the colour of the text in the DESCRIPTION 
  534.             column of the output table. This colour is used in the html
  535.             <FONT> tag, and will be seen by most web clients. The colour 
  536.             scheme is stated as(RRGGBB) RED GREEN BLUE. A bright cyan text
  537.             would be defined as:
  538.  
  539.       (eg: desc_color  33FFFF )
  540.  
  541.  
  542.  
  543. ICON_BGCOLOR: This keyword specifies the background colour of the ICON
  544.               column of the output table. This colour is used in the html
  545.               <FONT> tag, and will be seen by most web clients. The colour 
  546.               scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
  547.               background would be defined as:
  548.  
  549.       (eg:   icon_bgcolor  0000CC )
  550.  
  551.  
  552.  
  553. FILENAME_BGCOLOR: This keyword specifies the background colour of the FILENAME
  554.                   column of the output table. This colour is used in the html
  555.                   <FONT> tag, and will be seen by most web clients. The colour 
  556.                   scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
  557.                   background would be defined as:
  558.  
  559.       (eg:   filename_bgcolor 0000CC )
  560.  
  561.  
  562.  
  563. BYTES_BGCOLOR: This keyword specifies the background colour of the BYTES
  564.                column of the output table. This colour is used in the html
  565.                <FONT> tag, and will be seen by most web clients. The colour 
  566.                scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
  567.                background would be defined as:
  568.  
  569.       (eg:   bytes_bgcolor  0000CC )
  570.  
  571.  
  572.  
  573. DATE_BGCOLOR: This keyword specifies the background colour of the DATE/TIME
  574.               column of the output table. This colour is used in the html
  575.               <FONT> tag, and will be seen by most web clients. The colour 
  576.               scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
  577.               background would be defined as:
  578.  
  579.       (eg:   date_bgcolor  0000CC )
  580.  
  581.  
  582.  
  583. DESC_BGCOLOR: This keyword specifies the background colour of the DESCRIPTION
  584.               column of the output table. This colour is used in the html
  585.               <FONT> tag, and will be seen by most web clients. The colour 
  586.               scheme is stated as(RRGGBB) RED GREEN BLUE. A medium blue 
  587.               background would be defined as:
  588.  
  589.       (eg:   desc_bgcolor  0000CC )
  590.  
  591.  
  592.  
  593. ICON_HEADER_BGCOLOR: This keyword specifies the background colour of the 
  594.                      ICON HEADER of the output table. This colour is used in
  595.              the html <FONT> tag, and will be seen by most web clients. The 
  596.              colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright blue 
  597.              background would be defined as:
  598.  
  599.       (eg:   icon_header_bgcolor   0000FF )
  600.  
  601.  
  602.  
  603. FILENAME_HEADER_BGCOLOR: This keyword specifies the background colour of the 
  604.                          FILENAME HEADER of the output table. This colour is
  605.              used in the html <FONT> tag, and will be seen by most web clients.
  606.              The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
  607.              blue background would be defined as:
  608.  
  609.       (eg:   filename_header_bgcolor 0000FF )
  610.  
  611.  
  612.  
  613. BYTES_HEADER_BGCOLOR: This keyword specifies the background colour of the 
  614.                       BYTES HEADER of the output table. This colour is used
  615.              in the html <FONT> tag, and will be seen by most web clients.
  616.              The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
  617.              blue background would be defined as:
  618.  
  619.       (eg:   bytes_header_bgcolor  0000FF )
  620.  
  621.  
  622.  
  623. DATE_HEADER_BGCOLOR: This keyword specifies the background colour of the 
  624.                      DATE/TIME HEADER of the output table. This colour is
  625.              used in the html <FONT> tag, and will be seen by most web clients.
  626.              The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
  627.              blue background would be defined as:
  628.  
  629.       (eg:   date_header_bgcolor  0000FF )
  630.  
  631.  
  632.  
  633. DESC_HEADER_BGCOLOR: This keyword specifies the background colour of the 
  634.                      DESCRIPTION HEADER of the output table. This colour is
  635.              used in the html <FONT> tag, and will be seen by most web clients.
  636.              The colour scheme is stated as(RRGGBB) RED GREEN BLUE. A bright 
  637.              blue background would be defined as:
  638.  
  639.       (eg:  desc_header_bgcolor  0000FF )
  640.  
  641.  
  642.  
  643.  
  644. TABLE_WIDTH: This keyword specifies the overall width of the table in the html
  645.              output. The width is a (%)percentage of the total width of the 
  646.              web client screen, but do not include the (%)percent character.
  647.  
  648.       (eg:   table_width   100 )
  649.  
  650.  
  651.  
  652. TABLE_BORDER_SIZE: This keyword specifies the size of the table border in the 
  653.                    html output. The width is specified in pixels. By default,
  654.                    a width of (0)zero is set, you may change this setting.
  655.  
  656.       (eg:   table_border_size  0 )
  657.  
  658.  
  659.  
  660. ICON_WIDTH: This keyword specifies the width of the ICON table cell. The width
  661.             is a (%)percentage of the total width of the table, but do not 
  662.             include the (%)percent character.
  663.  
  664.       (eg:   icon_width  5 )
  665.  
  666.  
  667.  
  668. FILENAME_WIDTH: This keyword specifies the width of the FILENAME table cell.
  669.                 The width is a (%)percentage of the total width of the table,
  670.                 but do not include the (%)percent character.
  671.  
  672.       (eg:   filename_width  25 )
  673.  
  674.  
  675.  
  676. BYTES_WIDTH: This keyword specifies the width of the BYTES table cell. The
  677.              width is a (%)percentage of the total width of the table, but do
  678.              not include the (%)percent character.
  679.  
  680.       (eg:   bytes_width  10 )
  681.  
  682.  
  683.  
  684. DATE_WIDTH: This keyword specifies the width of the DATE/TIME table cell. The
  685.             width is a (%)percentage of the total width of the table, but do
  686.             not include the (%)percent character.
  687.  
  688.       (eg:   date_width  20 )
  689.  
  690.  
  691.  
  692. DESC_WIDTH: This keyword specifies the width of the DESCRIPTION table cell. The
  693.             width is a (%)percentage of the total width of the table, but do
  694.             not include the (%)percent character.
  695.  
  696.       (eg:   desc_width  40 )
  697.  
  698.  
  699.  
  700. ICON_SIZE: Not yet used.
  701.  
  702.       (eg:   icon_size  -1 )
  703.  
  704.  
  705.  
  706. FILENAME_SIZE: Not yet used.
  707.  
  708.       (eg:   filename_size  -1 )
  709.  
  710.  
  711.  
  712. BYTES_SIZE: Not yet used.
  713.  
  714.       (eg:   bytes_size  -1 )
  715.  
  716.  
  717.  
  718. DATE_SIZE: Not yet used.
  719.  
  720.       (eg:    date_size  -1 )
  721.  
  722.  
  723.  
  724. DESC_SIZE: Not yet used.
  725.  
  726.       (eg:   desc_size  -1 )
  727.  
  728.  
  729.  
  730. ICON_ALIGN: This keyword specifies the horizontal alignment of the ICON table
  731.             cell in the html ouput. Valid responses are Left,Center,Right.
  732.  
  733.       (eg:   icon_align   center )
  734.  
  735.  
  736.  
  737. FILENAME_ALIGN: This keyword specifies the horizontal alignment of the FILENAME
  738.                 table cell in the html ouput. Valid responses are Left,Center,
  739.                 and Right.
  740.  
  741.       (eg:   filename_align  left )
  742.  
  743.  
  744. BYTES_ALIGN: This keyword specifies the horizontal alignment of the BYTES table
  745.              cell in the html ouput. Valid responses are Left,Center,Right.
  746.  
  747.       (eg:   bytes_align   center )
  748.  
  749.  
  750.  
  751. DATE_ALIGN: This keyword specifies the horizontal alignment of the DATE/TIME
  752.             table cell in the html ouput. Valid responses are Left,Center,
  753.             and Right.
  754.  
  755.       (eg:   date_align   center )
  756.  
  757.  
  758.  
  759. DESC_ALIGN: This keyword specifies the horizontal alignment of the DESCRIPTION
  760.             table cell in the html ouput. Valid responses are Left,Center,
  761.             and Right.
  762.  
  763.       (eg:   desc_align   left )
  764.  
  765.  
  766.  
  767.  
  768.  
  769. Command Line Parameters:
  770. ------------------------
  771. FilePage supports many function settings from the command line. The command
  772. line options are typically used to override the default settings present in
  773. the FILEPAGE.CNF configuration file.  
  774.  
  775. Note: Keywords are not case-sensitive. They may also appear on the command 
  776.       line in any order. 
  777.  
  778.       If a command is issed (eg: SUB ), and then ( NOSUB ) is also issued on
  779.       the same command line, the latter overrides. I don't know why someone
  780.       would do this, but it could happen.
  781.  
  782.  
  783.         DIR       - instructs FilePage to place the full output path above the
  784.                     description header cell field.
  785.  
  786.  
  787.         NODIR     - instructs FilePage not to place the full output path above
  788.                     the description header cell field.
  789.  
  790.  
  791.         BANNER    - specifying this command line option will force FilePage
  792.                     to search the current working directory for a file with
  793.                     the name BANNER and insert the contents of BANNER at the 
  794.                     top of the html output during processing.
  795.  
  796.                     This is just a simple way to include special notes from the
  797.                     webmaster, or advertisement banners at the top of the html
  798.                     output file.
  799.  
  800.                     Simply create an HTML document and save it with the file-
  801.                     name of BANNER.  Save a copy in each directory that you 
  802.                     wish to include the banner information.
  803.  
  804.  
  805.                     Note: DO NOT use the <HTML>, <BODY>, <HEAD>, or <TITLE>
  806.                           tags.  If you do include these tags in your banner
  807.                           file, the html output created by FilePage is not 
  808.                           guaranteed.
  809.                           
  810.                           Be sure to include BANNER in your EXCLUDE.CNF file,
  811.                           if you do wish to prevent banner file from being 
  812.                           included as a downloadable file.
  813.                     
  814.         NOBANNER  - Disables the BANNER option specified on the command line,
  815.                     or specified in the FILEPAGE.CNF file.
  816.  
  817.  
  818.         EXCLUDE   - instructs FilePage to use the EXCLUDE.CNF file exclusion
  819.                     file, if one is located in the current working directory.
  820.  
  821.  
  822.         NOEXCLUDE - instruct FilePage not to use the EXCLUDE.CNF file exclusion
  823.                     file; it will not search the current working directory.
  824.  
  825.  
  826.         LINK      - specifying this command parameter will LINK the new output
  827.                     file being created to an upper level directory; a web link
  828.                     of the same name(ie: index.htm ).
  829.  
  830.                     FilePage does not check to see if an upper level link
  831.                     is available, so one must already exist.
  832.  
  833.                     Note: This option is great if you wish to update lower
  834.                           level sub-directories without processing entire 
  835.                           directory structures. LINK will attach your page
  836.                           being updated to a page of the same name in the
  837.                           directory-level above the current working directory.
  838.  
  839.  
  840.         NOLINK    - specifying this command parameter will disable the LINK 
  841.                     command in the FILEPAGE.CNF file.
  842.  
  843.  
  844.         MASK      - enable file reference masking using the "OnMouseOver="
  845.                     statement.
  846.  
  847.  
  848.         NOMASK    - disable file reference masking. 
  849.  
  850.  
  851.         SUB       - enable subdirectory indexing. FilePage will follow and index
  852.                    all subdirectories located.
  853.  
  854.  
  855.         NOSUB     - disable subdirectory indexing. Quit once current directory
  856.                   is processed.
  857.  
  858.  
  859.         FILE:filename.ext - supply a new output htm/html filename on the fly.
  860.                             The specified filename will be created throughout 
  861.                             the entire directory tree if the SUB option is 
  862.                             enabled.
  863.  
  864.                             Filename must be at least (1)one character in 
  865.                             length, AND it MUST have the file extension, .HTM,
  866.                             or .HTML.  If the filename is invalid, the setting
  867.                             associated with FILENAME in the FILEPAGE.CNF will
  868.                             become the default output filename.
  869.  
  870.                             Failing this, INDEX.HTM becomes the output default.
  871.  
  872.  
  873.         SCHEME:filename.scm - supply a (.scm)SCHEME filename, and each of the
  874.                             attributes stored within the (.scm)SCHEME file will
  875.                             be used to configure the html output. 
  876.  
  877.                             All (.scm)SCHEME files must reside in the directory
  878.                             specified by the  SET FILEPAGE=  environment 
  879.                             variable.
  880.  
  881.                             A (.scm)SCHEME filename must be at least (1)one 
  882.                             character in length, AND it MUST have the .SCM
  883.                             file extension.
  884.  
  885.                             If the SCHEME file does not meet this criteria,
  886.                             settings are read from the FILEPAGE.CNF file.
  887.  
  888.                             Failing this, internal defaults are used.
  889.  
  890.                              
  891.                             Note: Keywords and option settings are NOT case-
  892.                                   sensitive.
  893.  
  894.                                   Any attributes missing in the .scm file will
  895.                                   be set to default internally by FilePage 
  896.                                   during initialization.
  897.  
  898.  
  899.  
  900.  
  901.  
  902. Including File Descriptions: 
  903. ----------------------------
  904.  
  905. FilePage uses a text file named DESCRIPTIONS to obtain descriptions for each
  906. file in your processed directories. FilePage will search the DESCRIPTIONS file 
  907. for the TITLE= keyword, to obtain the title for the html output.
  908.  
  909. Using the DESCRIPTIONS file is optional. If the file does not exist, it will
  910. be assumed that there are no descriptions to include.
  911.  
  912.  
  913.    Note: filename entries in the DESCRIPTIONS file are not case-sensitive.
  914.  
  915.  
  916.  
  917.  
  918.    DESCRIPTIONS entry format:  <FILENAME.EXTENSION> <FILE DESCRIPTION>
  919.  
  920.  
  921. 1. Create a file called DESCRIPTIONS with your favourite text editor.
  922.  
  923. 2. Place one file entry per line, and separate the FILENAME and DESCRIPTION
  924.    with a blank<SPACE> character.
  925.  
  926. 3. Limit each line entry to 1,256(MAX) characters, otherwise FilePage will 
  927.    truncate the description. This allows for a long filename(255 characters),
  928.    and a lengthy file description(1,000 characters).
  929.  
  930.  
  931.    Note: #HASH marks may be used to add comments in the file. FILEPAGE will
  932.          ignore #HASH-commented lines.
  933.  
  934.  
  935.  
  936.  
  937.    Sample Description file entries:
  938.  
  939.    
  940.    jet_f14.jpg  An F14 jet flying over the desert.
  941.    image.gif    Picture of my OS/2 desktop in 256 colours.
  942.    scream.wav   A wav file of someone screaming.
  943.  
  944.  
  945.  
  946.  
  947.  
  948. Web Page Title:
  949. ---------------
  950.  
  951. By default, FilePage places the TITLE "HTTP FILE LIST" at the top of your HTML
  952. output.  You may place your customized title in the HTML output by doing the
  953. following steps:
  954.  
  955.  
  956. 1. Follow the above steps to create a DESCRIPTIONS text file.
  957.  
  958.  
  959. 2. Add an entry into the DESCRIPTIONS file starting with the keyword:
  960.   
  961.    TITLE=
  962.  
  963.  
  964. 3. Place your HTML output title following the keyword(Max 80 characters).
  965.  
  966.  
  967.    Example:   TITLE= My OS/2 Shareware Page
  968.  
  969.  
  970.  
  971.  
  972. Excluding (hiding) Files:  ( EXCLUSION.CNF )
  973. -------------------------
  974.  
  975. When FilePage is executed, it looks for an EXCLUDE.CNF text file. Any files
  976. listed within EXCLUDE.CNF will not be processed in the final HTML output.
  977.  
  978. A copy of this file should be created/copied to each directory which contains
  979. files that must be excluded.
  980.  
  981.  
  982.  
  983. 1. Create a text file in your working directory called EXCLUDE.CNF, using 
  984.    your favourite text editor.
  985.  
  986.  
  987. 2. Place the filename of any "files to be excluded" in this file.
  988.  
  989.  
  990. 3. Do not include any path information.
  991.  
  992.  
  993. 4. File entries should occur, one filename per line.
  994.  
  995.  
  996. 5. Save this file.
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002. Using Icons: (EXTENSION.CNF)
  1003. ------------
  1004.  
  1005. The EXTENSION.CNF file contains an entry for each type of file in your file
  1006. direcotries. FilePage matches an icon to each file extension processed, to
  1007. an extension types entry listed within EXTENSION.CNF.
  1008.  
  1009. You are free to edit this file with your favourite text editor. Add an 
  1010. unlimited number of custom file entries as required.
  1011.  
  1012.  
  1013. Note: The EXTENSION file must reside in the directory specified by the
  1014.       SET FILEPAGE=  environment variable.
  1015.  
  1016.       Entries made into the extension.cnf file should NOT include any path
  1017.       information. Path to the icons is specified in the FILEPAGE.CNF file.
  1018.  
  1019.  
  1020.  
  1021.   Extension entry format:  <Extension> <Image_Name.ext>
  1022.  
  1023.   *Note: #HASH marks may be used to add comments in the file. FILEPAGE will
  1024.          ignore #HASH-commented lines.
  1025.  
  1026.  
  1027.  
  1028. Sample EXTENSION.CNF file entries:
  1029.  
  1030.  
  1031. # ARCHIVE ICONS #
  1032. arc   archive_4.gif
  1033. lhz   archive_4.gif
  1034. lzh   archive_4.gif
  1035. ice   archive_4.gif
  1036. dsk   archive_1.gif
  1037. zip   archive_1.gif
  1038.  
  1039.  
  1040. # IMAGE ICONS #
  1041. bmp   image_3.gif
  1042. fon   font_1.gif
  1043. fot   font_1.gif
  1044. ttf   font_2.gif
  1045. gif   image_4.gif
  1046. ico   icon2.gif
  1047. iff   image_3.gif
  1048. jpg   image_4.gif
  1049. mac   image_2.gif
  1050. pcx   image_2.gif
  1051. pic   image_2.gif
  1052. tga   image_3.gif
  1053. tif   image_3.gif
  1054. wpg   image_2.gif
  1055. wrz   wrl.gif
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061. Troubleshooting:
  1062. ----------------
  1063.  
  1064. Q. [ ICONS show up as broken image links in the web browser.]
  1065.  
  1066.   A1. Make sure that the sub-directory \ICONS  was created and all of the
  1067.       icons from the installation were created(unZIPed with InfoZIP).
  1068.  
  1069.  
  1070.   A3. Make sure that the users viewing the FILE LIST has rights to read from
  1071.       the \ICONS directory. See IP FILTERING in PlanetWide WEBSERV documentaion.
  1072.  
  1073.  
  1074.  
  1075. Q. [ All output entries have a DEFAULT ICON but I have added new icons in the
  1076.     \ICONS directory. ]
  1077.  
  1078.   A1. Make sure that your new icons are registered in the EXTENSION.CNF file.
  1079.       Add one entry for each file_type to use the new icon(s).
  1080.  
  1081.   A2. Make sure that you are working from an HPFS partition since the EXTENSION
  1082.       file does not fit the DOS(8.3) format and will not be recognized by
  1083.       FILEPAGE.
  1084.  
  1085.  
  1086.  
  1087. Q. [ My links on the HTML output page are invalid! ]
  1088.  
  1089.   A1. FilePage automatically perfroms a reverse-search from the current
  1090.       working directory to locate the first occurance of WEBSERV.EXE.
  1091.       It uses this path to determine the relative path for the HTML output.
  1092.       If you have multiple copies of WEBSERV.EXE in your directory structure, 
  1093.       FilePage may choose the incorrect copy as the file reference. 
  1094.   
  1095.       Be sure not to store multiple copies of WEBSERV.EXE in your directory
  1096.       structure.
  1097.  
  1098.  
  1099.  
  1100. Q. [ FilePage terminates with an error, "Sorry, output filename is missing..."]
  1101.  
  1102.   A1. FilePage will return this error if the following conditions are true:
  1103.  
  1104.         - Disk is write protected.
  1105.         - Disk is out of disk space.
  1106.         - A duplicate filename exists AND is write-protected.
  1107.         - User has specified the /F: parameter with no filename, or with an
  1108.           invalid filename.
  1109.  
  1110.        Check for any of these conditions, and rerun FilePage once you have
  1111.        solved the problem.
  1112.  
  1113.  
  1114.  
  1115. Q. [ FilePage only creates the HTML output file called "INDEX.HTM". ]
  1116.  
  1117.   A1. You must specify the command line parameter FILE:filename.htm/html if you
  1118.       wish to create an output file other than the default, INDEX.HTM.
  1119.  
  1120.  
  1121.   A2. Edit the FILEPAGE.CNF file and change the FILENAME keyword setting 
  1122.       to the required filename.
  1123.  
  1124.  
  1125.  
  1126. Q. [ The MASKING of the links does not work properly, even though I used the 
  1127.      MASK command line parameter. ]
  1128.  
  1129.  
  1130.   A1. The MASK feature is only supported by newer releases of Netscape Navigator
  1131.       and Internet Explorer, and Netscape Communicator(to our knowledge). 
  1132.       The effect of the MASK feature is not 100% foolproof, it is merely a 
  1133.       deterant.
  1134.  
  1135.       We have seen Netscape disregard the MASK feature on the local machine,
  1136.       but remote users are presented with the masking information.  No reasons
  1137.       for this occurance.
  1138.  
  1139.       If your client does not support the "OnMouseOver=" command, masking will
  1140.       not work.
  1141.  
  1142.  
  1143.  
  1144. Q. [ When I specify command the line parameters, they make no effect on final 
  1145.      processing. ]
  1146.  
  1147.   A1. Be sure that you specify your commands correctly.
  1148.  
  1149.  
  1150.   A2. If you enable a function and disable a function on the same command line,
  1151.       the last command specified will override the previous command.
  1152.  
  1153.  
  1154.  
  1155. Q. [ FilePage places a default TITLE "HTTP FILE LIST" at the top of the output
  1156.      file processed. ]
  1157.  
  1158.   A1. Follow the instructions for WEB PAGE TITLE in this doecument.
  1159.  
  1160.       The KEYWORD  "TITLE="  must be in upper case, and must be added to the
  1161.       DESCRIPTIONS text file. Do not include the quotation marks.
  1162.  
  1163.  
  1164.  
  1165.  
  1166. Conclusion:
  1167. -----------
  1168.  
  1169. This program was written for our many PlanetWide users.  We thank everyone 
  1170. who has provided valuable suggestions and testing information for PlanetWide
  1171. OS/2 Web Server and FilePage web indexer.
  1172.  
  1173. We are also greatful that IBM(tm) continues the support and improve upon OS/2,
  1174. the great operating system that it is.
  1175.  
  1176.  
  1177. If you have questions, suggestions relating to our products, or if you just
  1178. wish to say "HI!", write to us.
  1179.  
  1180.  
  1181.  EMAIL:  planetwide@bmtmicro.com
  1182.  
  1183.    WEB:  http://www.pr.uoguelph.ca/cpayne/planet.htm
  1184.  
  1185.   POST:  Payne-Mennie Computing Services
  1186.          57 Moss Place, Guelph, On, Canada, N1G 4V2
  1187.  
  1188.  
  1189.  
  1190. *Send us the web://URL of YOUR web site and we'll visit you online!
  1191.  
  1192.  
  1193.  
  1194. Trade marks:
  1195. ===========
  1196.  
  1197. OS/2 is a trade mark of INTERNATIONAL BUSINESS MACHINES(IBM).
  1198.  
  1199. IBM WEBEXPLORER is a trade mark of INTERNATIONAL BUSINESS MACHINES(IBM).
  1200.  
  1201. NETSCAPE NAVIGATOR is a trade mark of NETSCAPE COMMUNICATIONS LTD.
  1202.  
  1203. INTERNET EXPLORER is a trademark of MicroSoft Corp.
  1204.  
  1205. --End
  1206.