Changeset 4388


Ignore:
Timestamp:
Aug 12, 2008, 9:11:47 AM (13 years ago)
Author:
Nicklas Nordborg
Message:

References #597: Write "Appendix: web.xml reference"

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/appendix/web.xml.xml

    r3675 r4388  
    2929<appendix id="appendix.web.xml">
    3030  <title>web.xml reference</title>
    31   <para>TODO</para>
     31  <para>
     32    The <filename>web.xml</filename> file is one step up from the main configuration
     33    directory. It is located in the <filename>&lt;basedir&gt;/www/WEB-INF</filename>
     34    directory. This configuration file has settings that are related to the web
     35    application only. Most settings in this file should not be changed since they
     36    are vital for the functionality of BASE.
     37  </para>
     38 
     39  <variablelist>
     40    <varlistentry>
     41      <term><sgmltag class="starttag">error-page</sgmltag></term>
     42      <listitem>
     43        <para>
     44        If an error occurs during a page request, the execution is
     45        forwarded to the specified JSP which will display more information
     46        about the error.
     47        </para>
     48      </listitem>
     49    </varlistentry>
     50   
     51    <varlistentry>
     52      <term><sgmltag class="starttag">context-param</sgmltag>: max-url-length</term>
     53      <listitem>
     54        <para>
     55        This setting is here to fix a potential problem with too long
     56        generated URL:s. This may happen when BASE needs to open a
     57        popup window and a user has selected a lot of items (eg. several
     58        hundreds). Typically the generated URL contains all selected ID:s.
     59        Some webservers have limitations on the length of an URL (eg.
     60        Apache has a default max of 8190 bytes). If the generated URL is
     61        longer that this setting, BASE will re-write the request to make
     62        the URL shorter and supply the rest of the parameters as part
     63        of a POST request instead. This functionality can disabled by
     64        setting this value to 0. For more information see
     65        <ulink url="http://base.thep.lu.se/ticket/1032">http://base.thep.lu.se/ticket/1032</ulink>.
     66        </para>
     67      </listitem>
     68    </varlistentry>
     69 
     70    <varlistentry>
     71      <term><sgmltag class="starttag">servlet</sgmltag>: BASE</term>
     72      <listitem>
     73        <para>
     74        A servlet that starts BASE when Tomcat starts and stops BASE
     75        when Tomcat stops. Do not modify.
     76        </para>
     77      </listitem>
     78    </varlistentry>
     79   
     80    <varlistentry>
     81      <term><sgmltag class="starttag">servlet</sgmltag>: view/download</term>
     82      <listitem>
     83        <para>
     84        File view/download servlet. It is possible to change the default
     85        MIME type to use for file with unknown type.
     86        </para>
     87      </listitem>
     88    </varlistentry>
     89   
     90    <varlistentry>
     91      <term><sgmltag class="starttag">servlet</sgmltag>: spotimage</term>
     92      <listitem>
     93        <para>
     94        Servlet for displaying spot images. Do not modify.
     95        </para>
     96      </listitem>
     97    </varlistentry>
     98   
     99    <varlistentry>
     100      <term><sgmltag class="starttag">servlet</sgmltag>: plotter</term>
     101      <listitem>
     102        <para>
     103        Servlet for the plot tool in the analysis section. You may
     104        specify max and default values for the width and height for the
     105        generated images. The supported image formats are "png" and "jpeg".
     106        </para>
     107      </listitem>
     108    </varlistentry>
     109   
     110    <varlistentry>
     111      <term><sgmltag class="starttag">servlet</sgmltag>: AxisServlet/AxisRESTServlet</term>
     112      <listitem>
     113        <para>
     114        Servlet handling web service requests. If you are not planning to access
     115        your BASE installation using web services, those servlets may be disabled.
     116        </para>
     117      </listitem>
     118    </varlistentry>
     119
     120    <varlistentry>
     121      <term><sgmltag class="starttag">servlet</sgmltag>: ExtensionsServlet</term>
     122      <listitem>
     123        <para>
     124        Servlet for handling startup/shutdown of the extensions system as well
     125        as requests to extension servlets. Do not modify. Do not disable even if you
     126        don't use extensions.
     127        </para>
     128      </listitem>
     129    </varlistentry>
     130   
     131    <varlistentry>
     132      <term><sgmltag class="starttag">servlet</sgmltag>: xjsp</term>
     133      <listitem>
     134        <para>
     135        Experimental servlet for compiling *.xjsp files used from
     136        extensions. The servlet redirects the compilation of *.xjsp
     137        files to a compiler that includes the extension's JAR file(s)
     138        on the class path.
     139        </para>
     140      </listitem>
     141    </varlistentry>
     142   
     143    <varlistentry>
     144      <term><sgmltag class="starttag">servlet</sgmltag>: compile</term>
     145      <listitem>
     146        <para>
     147        Experimental servlet for compiling all JSP files. This is
     148        mostly useful for developers who want to make sure that
     149        no compilation error exists in any JSP file. Can also be
     150        used to pre-compile all JSP files to avoid delays during
     151        browsing. This servlet is disabled by default.
     152        </para>
     153      </listitem>
     154    </varlistentry>
     155   
     156    <varlistentry>
     157      <term><sgmltag class="starttag">filter</sgmltag>: characterEncoding</term>
     158      <listitem>
     159        <para>
     160        A filter that sets the character encoding on the HTML that is
     161        generated from JSP files. We recommend leaving this at the
     162        default UTF-8 which should work with all modern browsers in most
     163        languages.
     164        </para>
     165      </listitem>
     166    </varlistentry>
     167  </variablelist>
    32168
    33169</appendix>
Note: See TracChangeset for help on using the changeset viewer.