Changeset 1796

Show
Ignore:
Timestamp:
2006-01-12 15:36:58 (3 years ago)
Author:
ctford
Message:

README updated and CGI files moved to new directory.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • phpannodex/trunk/README

    r1790 r1796  
    22------------------- 
    33 
    4         phpannodex-cgi has been tested specifically for the following versions 
    5         of PHP and Apache, but should work with any PHP 5 and Apache 2. 
     4        phpannodex has been tested specifically for the following versions 
     5        of PHP and Apache, but should work with any PHP 5 and Apache 2. This 
     6        installation, relying as it does on make, is tailored for *nix systems. 
    67 
    78        * PHP 5.0.5 
    89        * Apache 2.0.55 
    910 
     11 
    1012What does it do? 
    1113---------------- 
    1214 
    13 phpannodex-cgi provides full support for Annodex.net media. For more details 
     15phpannodex is an extension for PHP that provides object oriented PHP wrappings 
     16for libannodex, a C library for manipulating Annodex media. For more details 
    1417about the annodex format, see http://www.annodex.net/ 
    15  
    16 phpannodex-cgi is a handler for type application/x-annodex. It provides the 
    17 following features: 
    18  
    19         * dynamic generation of Annodex media from CMML files. 
    20  
    21         * handling of timed query offsets, such as 
    22  
    23           http://media.example.com/annodex/fish.anx?t=npt:01:20.8 
    24          
    25         * dynamic retrieval of CMML summaries, if the Accept: header 
    26           prefers type text/x-cmml over application/x-annodex. 
    2718 
    2819 
    2920Building and installing 
    3021---------------------- 
    31         *) cd to the "phpannodex-cgi.X.X/src". 
    32         *) "phpize" 
    33         *) "./configure" 
    34         *) Add "-lannodex" to the CFLAGS of the Makefile. 
    35         *) "make install" 
    36         *) restart Apache 
     22        * cd to the "src" directory. 
     23        * "phpize" 
     24        * "./configure" 
     25        * Add "-lannodex" to the CFLAGS of the Makefile. 
     26        * "make install" 
     27        * restart Apache 
    3728         
    3829        This will install the phpannodex extension core. 
    3930 
    40         *) Copy the "phpannodex-cgi.X.X/phpannodex" into a  
    41            directory in php's include path. This will usually be 
    42            "/usr/local/lib/php" on *nix systems. 
     31        * Copy the "phpannodex" directory into php's include  
     32          path. This will usually be "/usr/local/lib/php" on *nix systems. 
    4333 
    4434        This will make the phpannodex classes visible to all your php  
    …… 
    4636 
    4737 
    48 Configuration 
    49 ------------- 
    50          
    51         For the cgi to work correctly, Apache must know to use it to respond 
    52         to requests from ".anx" files. 
    53  
    54         *) Open "phpannodex-cgi.conf" in a text editor, and replace CGI_DIR with 
    55            the full path of the "phpannodex-cgi-X.X/phpannodex-cgi" directory. 
    56         *) Copy "phpannodex-cgi.conf" into Apache's "conf.d" directory,  
    57            probably "/etc/apache2/conf.d/". 
    58         *) Restart Apache 
    59  
    60         Requests for ".anx" files should now be answered by the cgi.