optional case-insensitivity for searching

[bse.git] / site / docs / config.pod
diff --git a/site/docs/config.pod b/site/docs/config.pod

index 070d3743fcd43ca33b8858c489bc1c109a951be8..6c0011fc0d09b9144b5833d9c3f33682c57881cd 100644 (file)
--- a/site/docs/config.pod
+++ b/site/docs/config.pod
@@ -186,15 +186,15 @@ article file wizard
  
  Catalog editor page.  Default admin/edit_catalog.tmpl
  
-=item 1
+=item Z<>1
  
-=item 2
+=item Z<>2
  
-=item 3
+=item Z<>3
  
-=item 4
+=item Z<>4
  
-=item 5
+=item Z<>5
  
  Article edit pages.  Default admin/edit_<number>.tmpl
  
@@ -244,6 +244,11 @@ tidy].
  The default tag formatting to use for C<< <:= ... :> >> tags.
  Default: C<html>.
  
+=item formatter_image_class
+
+The default class to use for image[...]  tags in body text.  Default:
+C<bse_image_inline>.
+
  =back
  
  =head2 [basic]
@@ -328,7 +333,8 @@ example.com.
  The expiry time for cookies.  This should be in the form supported by
  CGI.pm for the -expires parameter.  Typically you want a plus ('+'), a
  number, and a time character (s - seconds, m - minutes, h - hours, d -
-days, M - months).  Default: +3h
+days, M - months).  Set to an empty string for session cookies.
+Default: +3h
  
  =item cookie_name
  
@@ -353,6 +359,12 @@ gpopimage[] tags.  Default: popup.
  If set to 0, dynamic article iterators will no access control filter
  their results.  Default: 1.
  
+=item error_not_defined
+
+If non-zero, during dynamic page generation, inserts a message
+explaining which variable is not set, instead of just leaving the tag
+unreplaced.  Default: 1.
+
  =item http_only_session
  
  If this is non-zero, the default, the session cookie sent to the
@@ -830,6 +842,31 @@ module be installed.
  Articles with a higher level than this are indexed as their ancestor.
  Default: C<$SEARCH_LEVEL> which defaults to 5.
  
+=item case_sensitive
+
+Level of case-sensitivity in the search engine.  This can be one of:
+
+=over
+
+=item *
+
+C<none> - no case-sensitive searches
+
+=item *
+
+C<context> - case-sensitive if there are any upper-case characters in
+the search string, case-insensitive otherwise.
+
+=item *
+
+C<controlled> - case-sensitive via a query parameter.  This is
+currently not supported by the built-in search engie.
+
+=back
+
+Renegerate your search indexes after changing this value.  Default:
+context.
+
  =back
  
  =head2 [search highlight]
@@ -851,6 +888,12 @@ For example you can do:
    [search highlight]
    body_prefix=<span class="searchfound">
    body_suffix=</span>
+  
+The default prefix and suffix can also be redefined:
+
+  [search highlight]
+  prefix=<mark>
+  suffix=</mark>
  
  =head2 [shop]
  
@@ -2500,7 +2543,7 @@ in the audit log.  Default: 0.
  =item *
  
  mail_max_dump - if non-zero this is the size limit of the dump stored
-in the audit log when [audit log].mail is enabled.
+in the audit log when [audit log].mail is enabled.  Default: 50000.
  
  =back
  
@@ -2871,6 +2914,38 @@ Control account and IP address lockouts for admin user authentication.
  See L</[site user lockouts]> for details of the configuration
  possible.
  
+=head2 [pregenerate]
+
+Defines templates to be generated as base templates.
+
+Each entry is of the form:
+
+=over
+
+I<output-template>=I<profile-name>,I<input-template>
+
+=back
+
+where:
+
+=over
+
+=item *
+
+I<output-template> - the output template name, stored in the directory
+defined by [paths].templates
+
+=item *
+
+I<profile-name> - used to select a section in the config file to load
+dummy article settings from, as C<< [I<profile-name> settings] >>.
+
+=item *
+
+I<input-template> - the source template to generate from.
+
+=back
+
  =head1 AUTHOR
  
  Tony Cook <tony@develop-help.com>