README
changeset 1 1ae1a79094fa
parent 0 868dae1581ff
child 3 1b5eb968d2c4
--- a/README	Fri Jul 24 07:39:57 2009 -0700
+++ b/README	Fri Jul 24 07:49:06 2009 -0700
@@ -1,4 +1,4 @@
----------------------------------------------------------------------
+
                                                        WHAT IS THIS?
 ---------------------------------------------------------------------
 
@@ -13,14 +13,18 @@
 Now, I can just edit the otl files directly - skip the conversion step
 altogether, and let Apache make some delicious looking outlines.
 
----------------------------------------------------------------------
+
                                                         INSTALLATION
 ---------------------------------------------------------------------
 
-First off all, make sure you have a mod_perl enabled Apache2.
+First of all, prerequisites!
 
-1) Add the following lines in your httpd.conf, or in a
-   separate otl.conf in the apache Includes directory:
+    - apache2
+    - mod_perl2
+    - libapreq2 (Apache2::Request)
+
+Add the following lines in your httpd.conf, or in a
+separate otl.conf in the apache Includes directory:
 
     -------------------------
     PerlSwitches -I/path/to/perl/libraries
@@ -32,12 +36,11 @@
     </FilesMatch>
     -------------------------
 
-2) Put the included css at /otl_style.css in your document root.
+Doublecheck that your apreq2 module is setup to load, as well.
+
+That's it.  Apache will now pretty-print all your otl files.
 
 
-That's it!  Apache will now pretty-print all your otl files.
-
----------------------------------------------------------------------
                                                             SETTINGS
 ---------------------------------------------------------------------
 
@@ -55,34 +58,30 @@
 
 style
     Type: string
-    Default: /otl_style.css
+    Default: none
 
-    A path to the css style.
+    A path to css style(s).
+    Comma separated values load different files in order.
+    Media type defaults to 'screen', if the css name contains the
+    string 'print' anywhere, the media type is changed to print.
 
+    :style=/css/otl_style.css,/css/print_style.css
 
 js
     Type: string
     Default: none
 
-    Use javascript?  If set, loads an external javascript library,
-    and calls init_page() on body load.
-    See the example 'folding' javascript included.
+    Use javascript?  If set, loads an external javascript library.
+    Comma separated values load diff files in order.
 
 
-divs
+last_mod
     Type: boolean
     Default: 0
 
-    Wrap each outline group in a div class called "group"
-
+    Show modification time of the otl file?
 
-dividers
-    Type: boolean
-    Default: 0
-
-    Separate each outline group with a horizontal rule?
-
-
+    
 legend
     Type: boolean
     Default: 0
@@ -127,23 +126,29 @@
     Display how long the parser took to generate the html?
 
 
----------------------------------------------------------------------
+
                                                       INCLUDED FILES
 ---------------------------------------------------------------------
 
-otl_handler.pl
-    The mod_perl code itself.
-    Feel free to modify to taste.
-
-themes/*
-    Example css.  Again, modify to taste!
+/Apache/OTL.pm
+    The mod_perl content handler.
 
-otl.js
-    Example (but functional!) javascript.  If you use this
-    file, your top level items will be 'clickable' - expanding
-    the sub items underneath, but not initially showing them.
+/javascript/*
+    Example (but functional!) javascript.  Create line numbers,
+    various eye candies, and clickable folds.
 
-sample.otl
+    This requires the 'jquery.js' library, also included.
+
+/sample.otl
     An example vimoutliner file, with optional settings.
 
+/styles/*
+    "Theme" examples for customizing OTL display.
 
+
+                                                    ACKNOWLEDGEMENTS
+---------------------------------------------------------------------
+
+Thanks to Nathan Dabney <nathan.dabney@gmail.com> and
+Michael Granger <ged@faeriemud.org> for their help and advice!
+