Annotation of libwww/Library/src/WWWApp.html, revision 2.2

2.1       frystyk     1: <HTML>
                      2: <HEAD>
2.2     ! frystyk     3: <TITLE>Non-Mandatory Application Include File</TITLE>
        !             4: <!-- Changed by: Henrik Frystyk Nielsen, 14-Nov-1995 -->
2.1       frystyk     5: <NEXTID N="z11">
                      6: </HEAD>
                      7: <BODY>
                      8: 
2.2     ! frystyk     9: <H1>Non-Mandatory Application Include File</H1>
2.1       frystyk    10: 
                     11: <PRE>
                     12: /*
                     13: **     (c) COPYRIGHT MIT 1995.
                     14: **     Please first read the full copyright statement in the file COPYRIGH.
                     15: */
                     16: </PRE>
                     17: 
                     18: In addition top the basic W3C Reference Library include file called <A
                     19: HREF="WWWLib.html">WWWLib.h</A> you <EM>can</EM> also include this
                     20: file called WWWApp.h depending on the needs of your
                     21: application. However, it is not required and none of the files
                     22: included below are ever used in the core part of the Library
                     23: itself. Only if this file is included, the extra modules will get
                     24: included in the linked object code. It is also possible to include
                     25: only a subset of the files below if the functionality you are after is
                     26: covered by them.
                     27: 
                     28: <PRE>
                     29: #ifndef WWWAPP_H
                     30: #define WWWAPP_H
                     31: </PRE>
                     32: 
                     33: <H2>Application Specific Library Includes</H2>
                     34: 
                     35: <PRE>
                     36: #ifdef __cplusplus
                     37: extern "C" { 
                     38: #endif
                     39: </PRE>
                     40: 
                     41: <H2>Initialization</H2>
                     42: 
                     43: The core parts of the Library is a framework for adding
                     44: functionailty. It has hooks for adding protocol modules, like for
                     45: example HTTP, FTP, and also for adding streams that can convert from
                     46: one media type to some other type, or presenting the result to the
                     47: user. In the distribution file of the Library you will find a large
                     48: set of porotocol modules and streams already implemented. However, in
                     49: order to use these you need to initialize them. This can be done by
                     50: using the files in the <A HREF="HTInit.html">HTInit</A> module. You
                     51: can modify this module as you like to fit your particular needs.
                     52: 
                     53: <PRE>
2.2     ! frystyk    54: #include "<A HREF="HTInit.html">HTInit.h</A>"
        !            55: </PRE>
        !            56: 
        !            57: <H2>Generating the First Anchor</H2>
        !            58: 
        !            59: This module provides some "make life easier" functions in order to get
        !            60: the application going. They help you generate the first anchor, also
        !            61: called the <EM>home anchor</EM>. It also contains a nice set of
        !            62: default WWW addresses.
        !            63: 
        !            64: <PRE>
        !            65: #include "<A HREF="HTHome.html">HTHome.h</A>"
2.1       frystyk    66: </PRE>
                     67: 
                     68: <H2>Logging</H2>
                     69: 
                     70: Often it is required to log the requests issued to the Library. This
                     71: can either be the case if the application is a server or it can also
                     72: be useful in a client application. This module provides a simple
                     73: logging mechanism which can be enabled if needed.
                     74: 
                     75: <PRE>
2.2     ! frystyk    76: #include "<A HREF="HTLog.html">HTLog.h</A>"
2.1       frystyk    77: </PRE>
                     78: 
                     79: <H2>History Management</H2>
                     80: 
                     81: Another type of logging is keeping track of which documents a user has
                     82: visited when browsing along on the Web. The Library history manager
                     83: provides a basic set of functionality to keep track of a linear
                     84: history list.
                     85: 
                     86: <PRE>
2.2     ! frystyk    87: #include "<A HREF="HTHist.html">HTHist.h</A>"
2.1       frystyk    88: </PRE>
2.2     ! frystyk    89: 
        !            90: <H2>Rule File Management</H2>
        !            91: 
        !            92: Another way to initialize applications is to use a rule file, also
        !            93: known as a configuration file. This is for example the case with the
        !            94: W3C httpd and the W3C Line Mode Browser. This module provides basic
        !            95: support for configuration file management and the application can use
        !            96: this is desired. The module is not referred to by the Library.
        !            97: 
        !            98: <PRE>
        !            99: #include "<A HREF="HTRules.html">HTRules.h</A>"
        !           100: </PRE>
        !           101: 
2.1       frystyk   102: 
                    103: End of application specific modules
                    104: 
                    105: <PRE>
                    106: #ifdef __cplusplus
                    107: } /* end extern C definitions */
                    108: #endif
                    109: 
                    110: #endif
                    111: </PRE>
                    112: 
                    113: End of WWWAPP definition
                    114: 
                    115: </BODY>
                    116: </HTML>

Webmaster