view release on metacpan or  search on metacpan

doc/catalog.texinfo  view on Meta::CPAN

#
# Uncomment to trigger special handling of the created field.
# If active, field whose name is 'created' will be filled with the 
# current date during insert.
# 
auto_created = yes
#
# Every update/delete/insert is passed to this hook
#
hook = Catalog::tools::hook_fulcrum
@end example

@node CGI configuration file, Install configuration file, MySQL configuration file, Configuration files
@section CGI configuration file

@cindex CGI derivation
@cindex cgi package 
@cindex package cgi

Used by the cgi package (cgi.pm).

@code{Catalog} depends on a modified CGI.pm package.
This configuration file deals with the additions specific to @code{Catalog}.

@table @samp

@cindex fct_dir, CGI configuration
@item fct_dir
The absolute pathname of the directory that will be used. When CGI is 
called recursively it creates a file in this directory that contains the
stack frame of the call. The file will be deleted when the CGI returns. 

@end table

Here is an example configuration file:

@example
#
# Derived cgi class (Catalog::cgi) configuration file
#
#
# Directory that will contain the saved execution contexts.
#
fct_dir = /usr/local/lib/interbat/cache
@end example

@node Install configuration file, SQL editor configuration file, CGI configuration file, Configuration files
@section Install configuration file

@cindex Install configuration
@cindex configuration parameters

Used by the sqledit package (sqledit.pm).

This configuration file is created during the installation. It is
used by @strong{sqledit} to find the location of the @code{Catalog}
components.

@table @samp

@cindex cgidir, installation parameter
@item cgidir (optional)
The absolute path of the cgi-bin directory.

@cindex cgipath, installation parameter
@item cgipath (optional)
The absolute location of the cgi-bin directory.

@cindex config_dir, installation parameter
@item config_dir (optional)
The absolute path of the directory containing configuration files.

@cindex htmldir, installation parameter
@item htmldir (optional)
The absolute location of the cgi-bin directory.

@cindex htmlpath, installation parameter
@item htmlpath (mandatory)
Absolute location of the @strong{Catalog} HTML material (/Catalog for 
instance). It contains the documentation, examples and an images
subdirectory (/Catalog/images for instance). This parameter will 
be available with the _HTMLPATH_ tag in every template.

@cindex infodir, installation parameter
@item infodir (optional)
The absolute path of the Emacs info directory where the
documentation was installed.

@end table

Here is an example configuration file:

@example
#
# Emacs info format documentat directory
#
infodir = 
#
# cgi-bin directory
#
cgidir = /home/httpd/cgi-bin
#
# cgi-bin directory HTML path
#
cgipath = /cgi-bin
#
# configuration files (*.conf) installation directory
#
config_dir = /home/httpd/cgi-bin
#
# Catalog material directory
#
htmldir = /home/httpd/html/Catalog
#
# Catalog material HTML path
#
htmlpath = /Catalog
@end example

@node SQL editor configuration file, Template configuration file, Install configuration file, Configuration files
@section SQL editor configuration file

@cindex SQL editor package 
@cindex sqledit package 
@cindex package sqledit
@cindex sqledit.conf

Used by the sqledit package (sqledit.pm). This module implements an HTML
interface to an SQL database. The instructions of this configuration file
modifies the behavior of the interface. 

@table @samp

@cindex read only access
@cindex limited access 
@cindex permissions

@item context_allow (optional, default *)
The list of allowed values for the @strong{context} cgi-bin parameter. 
The complete list of available context values is listed in the table
of content. Each value is described in a section and the name of the
section ends with the value of the context parameter, 
@xref{Catalog CGI, ,@code{Catalog CGI}}.

Alternatively, context_allow may be set to star (*, the default) to
allow every operations.

If the user is denied a specific operation, the following error message
will be displayed:

@cindex error messages
@cindex message string
@example
"%s context is not allowed"
@end example
@xref{Messages translation, ,@code{Messages translation}}.

Assuming that you want to give read-only access to your catalog, use
the following:

@example