digilib: digilib-config.html comparison

comparison digilib-config.html @ 1666:1beeb9319d78

Creating site for 2.5-SNAPSHOT

author	Robert Casties <casties@mpiwg-berlin.mpg.de>
date	Tue, 21 Nov 2017 19:34:58 +0000
parents	fe8300fdcd9d
children	8a9c66abb57c

comparison

equal deleted inserted replaced

-:fe8300fdcd9d
+:1beeb9319d78
 <!DOCTYPE html>
 <!--
-| Generated by Apache Maven Doxia at 2017-11-20
+| Generated by Apache Maven Doxia at 2017-11-21
 | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta charset="UTF-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-<meta name="Date-Revision-yyyymmdd" content="20171120" />
+<meta name="Date-Revision-yyyymmdd" content="20171121" />
 <meta http-equiv="Content-Language" content="en" />
 <title>digilib - The Digital Image Library &#x2013; Configuring digilib</title>
 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
 <link rel="stylesheet" href="./css/site.css" />
 <link rel="stylesheet" href="./css/print.css" media="print" />
 <div id="breadcrumbs">
 <ul class="breadcrumb">
-<li id="publishDate">Last Published: 2017-11-20</li>
+<li id="publishDate">Last Published: 2017-11-21</li>
 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
 <p>A more extensive example is included in the sources as <a class="externalLink" href="https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-config.xml.template">digilib-config.xml.template</a>.</p>
 <div class="section">
 <h2><a name="Available_parameters"></a>Available parameters</h2>
 <p>The documented parameter values below are the defaults.</p>
 <p>If relative paths are provided as file locations, these will be resolved with the web application&#x2019;s directory as base.</p>
-<p>You can inspect a summary of your running digilib configuration at the URL <tt>&lt;base_url&gt;/server/dlConfig.jsp</tt>.</p>
+<p>You can inspect a summary of your running digilib configuration at the URL <tt>&lt;base_url&gt;/server/dlConfig.jsp</tt> e.g. <a class="externalLink" href="http://localhost:8080/digilib/server/dlConfig.jsp">http://localhost:8080/digilib/server/dlConfig.jsp</a>.</p>
 <div class="section">
 <h3><a name="Image_locations"></a>Image locations</h3>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;basedir-list&quot; value=&quot;sample-images&quot; /&gt;
 </pre></div></div>
-<p>A list of directories where images are searched. See <a href="image-directories.html">this document</a> for details.</p>
+<p>A list of directories where images are searched. See <a href="image-directories.html">this document</a> for details (<b>required</b>).</p>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;denied-image&quot; value=&quot;img/digilib-denied.png&quot; /&gt;
 </pre></div></div>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;mapping-file&quot; value=&quot;digilib-map.xml&quot; /&gt;
 </pre></div></div>
 <p>The location of the mapping file. Refer to <a class="externalLink" href="https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-map.xml.template">digilib-map.xml.template</a> for an example. </p>
-<p>The file contains <tt>mapping</tt> elements with a <tt>link</tt> attribute containing a &#x2018;virtual directory&#x2019; name that is mapped to the directory given in the <tt>dir</tt> attribute.</p></div>
+<p>The file contains <tt>mapping</tt> elements with a <tt>link</tt> attribute containing a &#x2018;virtual directory&#x2019; name that is redirected to the directory given in the <tt>dir</tt> attribute.</p></div>
 <div class="section">
 <h3><a name="Image_processing_options"></a>Image processing options</h3>
 <div class="source">
 <div class="source">
 <h3><a name="Authentication_and_authorization"></a>Authentication and authorization</h3>
 <p>Details are provided in the <a href="auth.html">documentation on authentication and authorization</a>.</p>
 <div class="source">
 <div class="source">
+<pre>&lt;parameter name=&quot;use-authorization&quot; value=&quot;false&quot; /&gt;
+</pre></div></div>
+<p>Enables or disables all authorization. If <tt>use-authorization</tt> is <tt>true</tt> you also have to configure <tt>authnops-class</tt>, <tt>authzops-class</tt> and the <tt>auth-file</tt> and its contents.</p>
+<div class="source">
+<div class="source">
 <pre>&lt;parameter name=&quot;auth-file&quot; value=&quot;digilib-auth.xml&quot; /&gt;
 </pre></div></div>
 <p>Configuration file for authentication and authorization. The format and content of the configuration file is determined by the chosen authentication and authorization classes. </p>
 <div class="source">
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;authzops-class&quot; value=&quot;digilib.auth.PathAuthzOps&quot; /&gt;
 </pre></div></div>
-<p>The class to handle authorization.</p>
+<p>The class to handle authorization.</p></div>
-<div class="source">
-<div class="source">
-<pre>&lt;parameter name=&quot;use-authorization&quot; value=&quot;false&quot; /&gt;
-</pre></div></div>
-<p>Enable or disable all authorization. If <tt>use-authorization</tt> is <tt>true</tt> it also needs to be configured using <tt>authnops-class</tt> and <tt>authzops-class</tt> and the <tt>auth-file</tt>.</p></div>
 <div class="section">
 <h3><a name="IIIF_API_options"></a>IIIF API options</h3>
 <p>The options configure the IIIF interface. For more information see the <a href="iiif-api">digilib IIIF documentation</a></p>
 <div class="source">
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;max-waiting-threads&quot; value=&quot;20&quot; /&gt;
 </pre></div></div>
-<p>The maximum number of requests waiting in the queue before sending &#x201c;service unavailable&#x201d;.</p>
+<p>The maximum number of requests waiting in the queue before new requests get &#x201c;service unavailable&#x201d;.</p>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;worker-threads&quot; value=&quot;2&quot; /&gt;
 </pre></div></div>
 <div class="source">
 <pre>&lt;parameter name=&quot;worker-timeout&quot; value=&quot;60000&quot; /&gt;
 </pre></div></div>
 <p>Timeout for worker threads in milliseconds.</p></div>
 <div class="section">
-<h3><a name="Assorted_options"></a>Assorted options</h3>
+<h3><a name="Other_options"></a>Other options</h3>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;default-errmsg-type&quot; value=&quot;image&quot; /&gt;
 </pre></div></div>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;log-config-file&quot; value=&quot;log4j-config.xml&quot; /&gt;
 </pre></div></div>
-<p>Location of the logging configuration file. The current logger is <a class="externalLink" href="https://logging.apache.org/log4j/1.2/manual.html">Log4J 1.2</a>.</p></div>
+<p>Location of the logging configuration file. The current logging library is <a class="externalLink" href="https://logging.apache.org/log4j/1.2/manual.html">Log4J 1.2</a>.</p></div>
 <div class="section">
-<h3><a name="Unknown_category"></a>Unknown category</h3>
+<h3><a name="Options_for_developers"></a>Options for developers</h3>
-<p><b>TODO</b> move items to appropriate sections</p>
+<p>Using these options you can replace default classes used by digilib with your own implementations to change the behaviour of digilib. </p>
 <div class="source">
 <div class="source">
-<pre>&lt;parameter name=&quot;dirmeta-class&quot; value=&quot;digilib.meta.IndexMetaDirMeta&quot; /&gt;
+<pre>&lt;parameter name=&quot;docuimage-class&quot; value=&quot;digilib.image.ImageLoaderDocuImage&quot; /&gt;
 </pre></div></div>
-<p>Class for <b>TODO</b>.</p>
+<p>Class of the <tt>DocuImage</tt> instance. You can replace the <tt>digilib.image.DocuImage</tt> implementation to use a different image toolkit than Java ImageIO. (There are deprecated alternative implementations in the <tt>common-jai</tt>, <tt>common-imagej</tt> and <tt>common-bioformats</tt> modules.) </p>
+<div class="source">
+<div class="source">
+<pre>&lt;parameter name=&quot;docuimage-hacks&quot; value=&quot;&quot; /&gt;
+</pre></div></div>
+<p>Text string to selectively enable specific <tt>Hacks</tt> in the <tt>DocuImage</tt> implementation (see <a class="externalLink" href="https://github.com/robcast/digilib/blob/master/common/src/main/java/digilib/image/ImageLoaderDocuImage.java">the source</a>)</p>
+<div class="source">
+<div class="source">
+<pre>&lt;parameter name=&quot;filemeta-class&quot; value=&quot;digilib.meta.IndexMetaFileMeta&quot; /&gt;
+&lt;parameter name=&quot;dirmeta-class&quot; value=&quot;digilib.meta.IndexMetaDirMeta&quot; /&gt;
+</pre></div></div>
+<p>Classes of the <tt>digilib.meta.FileMeta</tt> and <tt>digilib.meta.DirMeta</tt> implementations. You can change these implementations to change the way digilib finds metadata about image files.</p>
+<p><tt>IndexMetaFileMeta</tt> and <tt>IndexMetaDirMeta</tt> read metadata from <tt>index.meta</tt> and <tt>*.meta</tt> XML files according to the <a class="externalLink" href="http://intern.mpiwg-berlin.mpg.de/digitalhumanities/mpiwg-metadata-documentation/formate/indexmeta-standard">index meta standard</a>.</p>
 <div class="source">
 <div class="source">
 <pre>&lt;parameter name=&quot;docudirectory-class&quot; value=&quot;digilib.io.BaseDirDocuDirectory&quot; /&gt;
 </pre></div></div>
-<p>Class for <b>TODO</b>.</p>
+<p>Class of the <tt>digilib.io.DocuDirectory</tt> implementation. You can change this implementation to change the way digilib finds image files (including different resolutions).</p></div></div>
-<div class="source">
-<div class="source">
-<pre>&lt;parameter name=&quot;docuimage-class&quot; value=&quot;digilib.image.ImageLoaderDocuImage&quot; /&gt;
-</pre></div></div>
-<p>Class for the <tt>DocuImage</tt> instance, <b>TODO</b> elaborate intended use</p>
-<div class="source">
-<div class="source">
-<pre>&lt;parameter name=&quot;docuimage-hacks&quot; value=&quot;&quot; /&gt;
-</pre></div></div>
-<p><b>TODO</b> elaborate</p>
-<div class="source">
-<div class="source">
-<pre>&lt;parameter name=&quot;filemeta-class&quot; value=&quot;digilib.meta.IndexMetaFileMeta&quot; /&gt;
-</pre></div></div>
-<p>Class for <b>TODO</b>.</p></div></div>
 </div>
 </div>
 </div>
 <hr/>

Mercurial > hg > digilib

comparison digilib-config.html @ 1666:1beeb9319d78