view release on metacpan or  search on metacpan

docsrc/reference.xml  view on Meta::CPAN

       Default language outputed when no language is specified
       or request language is not available.  Defaults to
       <emphasis>en</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.default_page">
     <term>default_page</term>
     <listitem>
      <para>
       Default page user gets when no page is specified.  Defaults to
       <emphasis>index</emphasis>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.errorspan_begin_tag">
     <term>errorspan_begin_tag</term>
     <listitem>
      <para>
       Specifies the start tag for &lt;PKIT_ERRORSPAN ... &gt; and &lt;PKIT_ERRORFONT ... &gt;.
       Defaults to <emphasis>&lt;font color="&lt;PKIT_ERRORCOLOR&gt;"&gt;</emphasis>.
       <informalexample>
       <programlisting>
	errorspan_begin_tag = "&amp;lt;span class=error&amp;gt;"
        errorspan_end_tag = "&amp;lt;/span&amp;gt;"
       </programlisting>
      </informalexample>
      </para>
      <para>
      See also <literal><link linkend="config.global.errorspan_end_tag">errorspan_end_tag</link></literal>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry id="config.global.errorspan_end_tag">
     <term>errorspan_end_tag</term>
     <listitem>
      <para>
       Specifies the end tag for &lt;PKIT_ERRORSPAN ... &gt; and &lt;PKIT_ERRORFONT ... &gt;.
       Defaults to <emphasis>&lt;/font&gt;</emphasis>.
      </para>
      <para>
      See also <literal><link linkend="config.global.errorspan_begin_tag">errorspan_begin_tag</link></literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.fop_command">
     <term>fop_command</term>
     <listitem>
      <para>
       Command line that should be used to run Apache XML FOP to generate
       PDF output.  PageKit will append FO file and PDF file arguments at end.
      </para>
      <informalexample>
       <programlisting>
        # some example fop command lines
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.CommandLine"
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.CommandLine"
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.Fop"
	fop_command = "/usr/lib/java/bin/java -classpath /opt/fop-0.20.3/lib/xerces-1.2.3.jar:/opt/fop-0.20.3/lib/xalanj1compat.jar:/opt/fop-0.20.3/lib/xalan-2.0.0.jar:/opt/fop-0.20.3/lib/xalan-1.2.2.jar:/opt/fop-0.20.3/lib/stylebook.jar:/opt/fop-0.20.3/lib...
        
        # disable fop_command from Apache::PageKit 1.14 on 
        fop_command = ""
        # or remove the fop_command line option from Config.xml at all.

       </programlisting>
      </informalexample>
      <para>
       Can be overriden by specifying the server <link linkend="config.server.fop_command">fop_command</link> configuration option.
      </para>
      <para>
       As of version 1.13 of Apache::PageKit a error is issued, if no global <link linkend="config.global.fop_command">fop_command</link> or server <link linkend="config.server.fop_command">fop_command</link> is found in the Config.xml and a 'applica...
       
       Form Apache::PageKit 1.14 on, no error message is issued and no special action is taken.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.gzip_output">
     <term>gzip_output</term>
     <listitem>
      <para>
       If set to <emphasis>all</emphasis>, output is gzipped dynamic and static content for browsers that send a
       <literal>Accept-Encoding</literal> header containing <literal>gzip</literal>.  If set to <emphasis>static</emphasis>, output is gzipped for
static pages only.
       Defaults to
       <emphasis>none</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.login_page">
     <term>login_page</term>
     <listitem>
      <para>
       Page that gets displayed when user attempts to log in.  Defaults to
       <emphasis>login</emphasis>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.global.logout_kills_session">
   <term>logout_kills_session</term>
   <listitem>
   <para>
    When pkit_logout is called it normally resets just the pkit_id cookie.
    With logout_kills_session enabled (set to yes), pkit_logout will also
    reset pkit_session_id and forcing a new pkit_session_id cookie to be
    set with a new session_id.

       Defaults to <emphasis>yes</emphasis>.
   </para>
   </listitem>
  </varlistentry>
    <varlistentry id="config.global.model_base_class">
     <term>model_base_class</term>
     <listitem>
      <para>
Specifies the <link linkend="model.base">base Model class</link>
that typically contains code
that used across entire the web application, including methods for
authentication and connecting to the database.
      </para>

docsrc/reference.xml  view on Meta::CPAN

        This attribute is needed in every <SECTION> tag.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </sect2>



  <sect2>
   <title>Server Attributes</title>
   <para>
    These options are global over all pages, but are local to each server configuration
    (e.g. production, staging, development). They are located in the &lt;SERVERS&gt; tag of
    <filename>Config/Config.xml</filename>.
   </para>
   <variablelist>
    <varlistentry id="config.server.can_edit">
     <term>can_edit</term>
     <listitem>
      <para>
If set to <emphasis>yes</emphasis>, enables <link linkend="features.editing">on-line editing tools</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.server.cookie_domain">
     <term>cookie_domain</term>
     <listitem>
      <para>
       Domain for that cookies are issued.  Note that you must have
       at least two periods in the cookie domain.
      </para>
      <para>
       If not set then cookie issued for the current domain name.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.server.cookie_postfix">
     <term>cookie_postfix</term>
     <listitem>
      <para>
The content of <literal><link linkend="config.server.cookie_postfix">cookie_postfix</link></literal> is appended to <literal>pkit_id</literal>
and <literal>pkit_session_id</literal>. With this option it is possible to force different names for your cookies.
Usefull if for some reason your cookies overwrite eachother.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.server.fop_command">
     <term>fop_command</term>
     <listitem>
      <para>
       Command line that should be used to run Apache XML FOP to generate
       PDF output.  PageKit will append FO file and PDF file arguments at end.
      </para>
      <informalexample>
       <programlisting>
        # some example fop command lines
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.CommandLine"
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.CommandLine"
	fop_command = "/usr/java/jdk1.3.0_02/bin/java -cp /usr/local/javaclass/fop org.apache.fop.apps.Fop"
	fop_command = "/usr/lib/java/bin/java -classpath /opt/fop-0.20.3/lib/xerces-1.2.3.jar:/opt/fop-0.20.3/lib/xalanj1compat.jar:/opt/fop-0.20.3/lib/xalan-2.0.0.jar:/opt/fop-0.20.3/lib/xalan-1.2.2.jar:/opt/fop-0.20.3/lib/stylebook.jar:/opt/fop-0.20.3/lib...
       </programlisting>
      </informalexample>
     </listitem>
    </varlistentry>
    <varlistentry id="config.server.html_clean_level">
     <term>html_clean_level</term>
     <listitem>
      <para>
       Sets optimization level for <ulink url="http://kobesearch.cpan.org/search?dist=HTML-Clean">HTML::Clean</ulink>.  If set to 0, disables use of
<ulink url="http://kobesearch.cpan.org/search?dist=HTML-Clean">HTML::Clean</ulink>.  Levels range from 1 to 9.
Level 1 includes only simple fast optimizations.  Level 9 includes all
optimizations.  Defaults to <emphasis>0</emphasis>. A good choice for production is 3. Higher Levels might end up in wrong pages.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry id="config.server.reload">
     <term>reload</term>
     <listitem>
      <para>
If set to <emphasis>yes</emphasis>, check for new view, content and config xml files
on each request.  Should be set to <emphasis>no</emphasis> on production servers.
Default is <emphasis>no</emphasis>.
      </para>
      <para>
      If you change this from <emphasis>no</emphasis> to <emphasis>yes</emphasis> it is
      certainly that the server must be restarted to notice the change.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </sect2>
  <sect2>
   <title>User Attributes</title>
   <para>
    These options are like the &lt;GLOBAL&gt; tag. With the difference, that you can store any information here that you like.
    The are located in the &lt;USER&gt; tag of <filename>Config/Config.xml</filename>.
   </para>
   <para>
   You can retrieve this information with the
   <link linkend="model.api.pkit_get_config_attr">pkit_get_config_attr</link> function.
   </para>
  </sect2>
  <sect2>
   <title>View Attributes</title>
   <para>
    These options are local to each view, but are global across servers and pages.  Currently only the output media can be set, but there are plans to have a <literal>parent_view</literal>, so that there can be multiple levels of
derived views.
   </para>
   <variablelist>
    <varlistentry id="config.view.content_type">
     <term>content_type</term>
     <listitem>
      <para>
Sets the content type of the output sent to the client.  
Content types are strings like "text/plain", "text/html" or "application/xml".
This corresponds to the "Content-Type" header in the HTTP protocol. 
The following content types have default views and/or special handing
associated with them:
      </para>
      <informaltable frame="all">
       <tgroup cols="4">
        <tbody>
         <row rowsep="1" role="attrheader">
	  <entry role="th"><para><emphasis role="bold">content_type</emphasis></para></entry>
	  <entry role="th"><para><emphasis role="bold">Description</emphasis></para></entry>
	  <entry role="th"><para><emphasis role="bold">Default Views</emphasis></para></entry>
	  <entry role="th"><para><emphasis role="bold">Special Handing</emphasis></para></entry>
	 </row>
         <row>
	  <entry>text/html</entry>
	  <entry>
 	   HTML output.  This is for traditional screen browsers such as
           Netscape and Internet Explorer.
          </entry>
	  <entry>This is the default content_type for all views except for
             those listed below</entry>
	  <entry>PageKit translates sets the charset in the Content-Type headers and translates the output according
             to the <literal>Accept-Charset</literal> header.</entry>
         </row>
         <row>
	  <entry>application/pdf</entry>
	  <entry>
	   PDF Output, for display in Acrobat Reader.  Uses Apache XML FOP
          </entry>
	  <entry>pdf</entry>
	  <entry>PageKit uses Apache XML FOP to generate the PDF, if
            <link linkend="config.global.fop_command">fop_command</link>
            is set.</entry>
         </row>
         <row>
	  <entry>text/vnd.wap.wml</entry>
	  <entry>
 	   WML output.  This is for WAP handhelds such as Palmpilots
	   and cellphones.
          </entry>
	  <entry>wml</entry>
	  <entry><emphasis>None</emphasis></entry>
         </row>
         <row>
	  <entry>application/xml</entry>
	  <entry>
	   XML output, for Internet Explorer 5.0 and above.
          </entry>
	  <entry>xml</entry>
	  <entry><emphasis>None</emphasis></entry>
         </row>
        </tbody>
       </tgroup>
      </informaltable>
     </listitem>
    </varlistentry>
   </variablelist>
  </sect2>
  <sect2>
   <title>Page Attributes</title>
   <para>
    These options are local to each page on the site, but are global across each server and all views.
    The are located in the &lt;PAGES&gt; tag of <filename>Config/Config.xml</filename>.
   </para>
    <varlistentry id="config.page.browser_cache">