$Id: README,v 1.6 2004/09/03 18:59:07 flacoste Exp $

This directory contains examples which can serve as
a starting point for your Lire customization:

Writing a new DLF converter
---------------------------

myschema.xml            A DLF schema specification. This is used to 
                        describe the logging data model of different 
                        applications.

                        This would be installed in $HOME/.lire/schemas or
                        <datadir>/lire/schemas

MyConverter.pm          An DLF converter. The MyConverter uses the
                        myschema DLF schema.
        
                        This would need to be installed in a directory
                        listed in perl's @INC. (See perl -V for the default
                        list.) You can use the PERL5LIB environment variable
                        to add directories to that search list:

                        $ mkdir $HOME/perl5lib
                        $ cp MyConverter.pm $HOME/perl5lib
                        $ PERL5LIB=$HOME/perl5lib
                        $ export PERL5LIB

myconverter_init        The DLF converter registration script.

                        This would installed in $HOME/.lire/plugins or
                        <datadir>/lire/plugins

myconverter_cfg_spec.xml 

                        The MyConverter example uses two configuration
                        variables. This file defines the configuration
                        structured used by this DlfConverter.

                        This would be installed in <datadir>/lire/config-spec


These are really trivial examples which are only meant as a starting
point for modules which actually do something useful. These files are
basically templates with documentation embedded as comments.

For more realistic examples, you should took a look at the existing DLF
converters (altough most of them weren't updated to the new API).

Writing a new DLF Categoriser
-----------------------------

This realistic example is described in the Developer's Manual.

www-category.xml        The Extended DLF Schema used by the categoriser.

                        This would be installed in $HOME/.lire/schemas or
                        <datadir>/lire/schemas

PageCategoriser.pm      The PageCategoriser implementation.
        
                        This would need to be installed in a directory
                        listed in perl's @INC. (See perl -V for the default
                        list.) You can use the PERL5LIB environment variable
                        to add directories to that search list:

                        $ mkdir -p $HOME/perl5lib/MyDlfAnalysers
                        $ cp PageCategoriser.pm $HOME/perl5lib/MyDlfAnalysers
                        $ PERL5LIB=$HOME/perl5lib
                        $ export PERL5LIB

page-categoriser_init   The registration script.

                        This would installed in $HOME/.lire/plugins or
                        <datadir>/lire/plugins

page-categoriser.xml 

                        The configuration for the categoriser. This categoriser
                        takes as configuration a list of regular expressions
                        to category mapping.

For more examples, you should took a look at the existing DLF
categorisers. You will find them in the Lire/DlfAnalysers subdirectory
in <datadir>/lire/perl5 once Lire is installed. Their registration
scripts will be found in <sysconfdir>/lire/plugins.

Writing a new DLF Analyser
--------------------------

The file MyAnalyser.pm contains a template that could be used to start
an analyser. You will also need to define a derived schema and a
registration script.

For an more complete example, you should took a look at the only
non-categoriser analyser defined in Lire :
Lire::DlfAnalysers::UserSessionAnalyser. You will find its
registration script in <sysconfdir>/lire/plugins/www-user_session_init
and its schema in <datadir>/schemas/www-user_session.xml.
