view release on metacpan or  search on metacpan

docsrc/reference.xml  view on Meta::CPAN

     <listitem>
      <para>
      Name for the Module, that is used to create the request class objects.
      Defaults to <emphasis>Apache::Request::PageKit</emphasis>. Which is a 
      subclass of Apache::Request. A own subclass is usefull, if you like to
      change the data container for your requstparameter or modify them on
      init() or new(). 
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.session_class">
     <term>session_class</term>
     <listitem>
      <para>
      Name for the Module, that is used to create the session objects.
      Defaults to <emphasis>Apache::SessionX</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.session_expires">
     <term>session_expires</term>
     <listitem>
      <para>
       Sets the expire time for the cookie that stores the session id on
       the user's computer.  If it is not set, then the expire time on the
       cookie will not be set, and the cookie will expire when the user closes
       their browser.
       <informalexample>
        <programlisting>
         session_expires = "+3h"
        </programlisting>
       </informalexample>
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.template_class">
     <term>template_class</term>
     <listitem>
      <para>
      Name for the Module, that is used to create the template objects.
      Defaults to <emphasis>HTML::Template</emphasis>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.uri_prefix">
     <term>uri_prefix</term>
     <listitem>
      <para>
       Prefix of URI that should be trimmed before dispatching to the Model code.
      </para>
      <para>
       See also <link linkend="model.api.pkit_fixup_uri">pkit_fixup_uri</link>
       in the Model API.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.use_locale">
     <term>use_locale</term>
     <listitem>
      <para>
       If set to <emphasis>yes</emphasis> pkit translates the original message to the language
       of the client if possible. If <link linkend="config.server.reload">reload</link>
       is set to <emphasis>yes</emphasis>, the translationtables are reloaded on every usage else only on first usage.
      </para>
      <para>
       Defaults to <emphasis>no</emphasis>.
       See also <link linkend="model.api.pkit_gettext">pkit_gettext</link> and
        <link linkend="model.api.pkit_gettext_message">pkit_gettext_message</link>
       in the Model API.
      </para>
     </listitem>
    </varlistentry>


    <varlistentry id="config.global.verify_page">
     <term>verify_page</term>
     <listitem>
      <para>
       Verify password form.  Defaults to <literal><link linkend="config.global.login_page">login_page</link></literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </sect2>

  <sect2>
   <title>Section Attributes</title>
   <para>
   These options are global across each server and all Views. They are in the
    &lt;SECTIONS&gt; tag of <filename>Config/Config.xml</filename>.
   </para>
   <para>
   All Page attributes are valid. &lt;SECTION&gt; Tags with the longest matching part of the id attribute
   provide the defaults for pages without the attribute in question.

   &lt;PAGE&gt; attributes written in the &lt;PAGE&gt; tag have the highest priority. If nothing is found the
   &lt;SECTION&gt; Tags are scanned for a default. The closest match wins and the search is over.
   See the line with /xyz in the example bellow, if we request /xyz/abc, the search ends at
   the line with id='/xyz' and the page does not require a login!

   </para>
      <informalexample>
       <programlisting>
        &lt;SECTIONS&gt;
        &lt;SECTION id='/' require_login='yes'/&gt;
        &lt;SECTION id='/xyz' request_param_in_tmpl='yes'/&gt;
        &lt;SECTION id='/free' require_login='no'/&gt;
        &lt;/SECTIONS&gt;
       </programlisting>
      </informalexample>

   <variablelist>
    <varlistentry id="config.section.id">
     <term>id</term>
     <listitem>
      <para>
        This is part of the uri path to the page where the defaults take place. '/' Means the whole site.
        This attribute is needed in every &lt;SECTION&gt; tag.