/*                                           W3C Sample Code Library libwww File descriptions
                                    FILE DESCRIPTIONS
                                             
 */
/*
**      (c) COPYRIGHT MIT 1995.
**      Please first read the full copyright statement in the file COPYRIGH.
*/
/*

   directory listings are produced by this module. This may be overridden by another
   module for those who which descriptions to come from somewhere else. It's only HTTP
   directory listings that contain a description field (if enabled by the Directory
   browsing module.
   
   This module is implemented by HTDescpt.c, and it is a part of the W3C Sample Code
   Library.
   
 */
#ifndef HTDESCRIPT_H
#define HTDESCRIPT_H

/*

DESCRIPTION FILE

   HTDescriptionFile in the same directory as the directoy to be listed. The default value
   is .www_descript:
   
 */
extern char * HTDescriptionFile;
/*

 */
/*
**      DESCRIBE  welcome.html  Our welcome page
**      DESCRIBE  map*.gif      Map as a GIF image
**      DESCRIBE  map*.ps       Map as a PostScript image
*/
/*

HTML TITLES

   text/html, this module uses the HTML TITLE as the description. This feature can be
   turned off by setting the HTPeekTitles variable to false.
   
 */
extern BOOL HTPeekTitles;
/*

READ DESCRIPTION FILE

   HTReadDescriptions(), and the result returned by it is given as an argument when
   finding out a description for a single file.
   
 */
extern HTList * HTReadDescriptions (char * dirname);
/*

GET DESCRIPTION FOR A FILE

   HTReadDescriptions(), the function HTGetDescription() can be used to get a description
   for a given file:
   
 */
extern char * HTGetDescription (HTList *        descriptions,
                                       char *   dirname,
                                       char *   filename,
                                       HTFormat format);
/*

   format is WWW_HTML and description is not found, this module may be configured to use
   the HTML TITLE as the description.
   
   No string returned by this function should be freed!
   
FREEING DESCRIPTIONS

   HTReadDescriptions() must be freed by HTFreeDescriptions():
   
 */
extern void HTFreeDescriptions (HTList * descriptions);
/*

 */
#endif /* !HTDESCRIPT_H */
/*

   
   ___________________________________
   
                          @(#) $Id: HTDescpt.html,v 2.13 1998/05/14 02:10:22 frystyk Exp $
                                                                                          
   */
