Annotation of libwww/Library/src/WWWDir.html, revision 2.8

2.1       frystyk     1: <HTML>
                      2: <HEAD>
2.6       frystyk     3:   <TITLE>W3C Reference Library libwww Directory Listings</TITLE>
2.1       frystyk     4: </HEAD>
                      5: <BODY>
2.6       frystyk     6: <H1>
                      7:   Declaration of W3C Reference Directory Listings
                      8: </H1>
2.1       frystyk     9: <PRE>
                     10: /*
                     11: **     (c) COPYRIGHT MIT 1995.
                     12: **     Please first read the full copyright statement in the file COPYRIGH.
                     13: */
                     14: </PRE>
2.6       frystyk    15: <P>
                     16: This is the include file for the directory handling modules for parsing and
                     17: presenting directory listings - often in the form of a HTML document.
2.1       frystyk    18: <PRE>
                     19: #ifndef WWWDIR_H
                     20: #define WWWDIR_H
                     21: </PRE>
                     22: <PRE>
                     23: #ifdef __cplusplus
                     24: extern "C" { 
                     25: #endif
                     26: </PRE>
2.6       frystyk    27: <H3>
                     28:   System dependencies
                     29: </H3>
                     30: <P>
2.5       frystyk    31: The <A HREF="sysdep.html">sysdep.h</A> file includes system-specific include
2.6       frystyk    32: files and flags for I/O to network and disk. The only reason for this file
                     33: is that the Internet world is more complicated than Posix and ANSI.
2.1       frystyk    34: <PRE>
2.6       frystyk    35: #include "<A HREF="sysdep.html">sysdep.h</A>"
2.5       frystyk    36: </PRE>
2.7       frystyk    37: <H3>
                     38:   Directory listings
                     39: </H3>
                     40: <P>
                     41: The directory manager generates directory listings for FTP and HTTP requests.
                     42: This module contains the protocol independent code and it produces the HTML
                     43: object. It is only included if either the <A HREF="HTFTP.html">FTP</A> or
                     44: the <A HREF="HTFile.html">File</A> module is included.
                     45: <PRE>
                     46: #include "<A HREF="HTDir.html">HTDir.h</A>"
                     47: </PRE>
                     48: <H3>
2.6       frystyk    49:   Icons
2.7       frystyk    50: </H3>
2.6       frystyk    51: <P>
                     52: No directory listings without icons! The WWWDir interface contains support
                     53: for including references (URLs and ALT text tags) to icons in directory listings.
                     54: The icons are selected as a function of the media type and the content encoding
                     55: of the file in question. That is - you can set up icons for compressed files,
                     56: postscript files etc. There is also a small set of specific icons representing
                     57: directories etc.
                     58: <P>
                     59: <B>Note</B>: Icons are not set up by default! You must enable them yourself.
2.7       frystyk    60: The Library distribution contains a <A HREF="../../Icons/internal/">small
                     61: set of default icons</A> which you can find at
                     62: <CODE>$(datadir)/www-icons</CODE>, and they can be set up using the
                     63: <A HREF="HTInit.html#icons">HTIconInit() initialization</A> function in the
                     64: <A HREF="WWWInit.html">WWWInit startup interface</A>
2.8     ! frystyk    65: <PRE>#include "<A HREF="HTIcons.html">HTIcons.h</A>"
2.6       frystyk    66: </PRE>
2.7       frystyk    67: <H3>
2.6       frystyk    68:   File Descriptions
2.7       frystyk    69: </H3>
2.6       frystyk    70: <P>
                     71: Descriptions appearing in <A HREF="HTDir.html">directory listings</A> are
                     72: produced by this module. This may be overridden by another module for those
                     73: who which descriptions to come from somewhere else. It's only HTTP directory
                     74: listings that contain a description field (if enabled by the
                     75: <A HREF="HTDir.html">Directory browsing module</A>.
                     76: <PRE>
                     77: #include "<A HREF="HTDescpt.html">HTDescpt</A>.h"
                     78: </PRE>
                     79: <P>
2.1       frystyk    80: End of DIR module
                     81: <PRE>
                     82: #ifdef __cplusplus
                     83: } /* end extern C definitions */
                     84: #endif
                     85: 
                     86: #endif
                     87: </PRE>
2.6       frystyk    88: <P>
                     89:   <HR>
2.4       frystyk    90: <ADDRESS>
2.8     ! frystyk    91:   @(#) $Id: WWWDir.html,v 2.8 1996/07/20 06:46:06 eric Exp $
2.4       frystyk    92: </ADDRESS>
2.6       frystyk    93: </BODY></HTML>

Webmaster