Mercurial > hg > digilib
diff 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 |
line wrap: on
line diff
--- a/digilib-config.html Mon Nov 20 20:24:00 2017 +0000 +++ b/digilib-config.html Tue Nov 21 19:34:58 2017 +0000 @@ -1,13 +1,13 @@ <!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 – Configuring digilib</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -41,7 +41,7 @@ <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> @@ -215,7 +215,7 @@ <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’s directory as base.</p> -<p>You can inspect a summary of your running digilib configuration at the URL <tt><base_url>/server/dlConfig.jsp</tt>.</p> +<p>You can inspect a summary of your running digilib configuration at the URL <tt><base_url>/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> @@ -223,7 +223,7 @@ <div class="source"> <pre><parameter name="basedir-list" value="sample-images" /> </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"> @@ -254,7 +254,7 @@ <pre><parameter name="mapping-file" value="digilib-map.xml" /> </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 ‘virtual directory’ 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 ‘virtual directory’ 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> @@ -296,6 +296,12 @@ <div class="source"> <div class="source"> +<pre><parameter name="use-authorization" value="false" /> +</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><parameter name="auth-file" value="digilib-auth.xml" /> </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> @@ -316,13 +322,7 @@ <div class="source"> <pre><parameter name="authzops-class" value="digilib.auth.PathAuthzOps" /> </pre></div></div> -<p>The class to handle authorization.</p> - -<div class="source"> -<div class="source"> -<pre><parameter name="use-authorization" value="false" /> -</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> +<p>The class to handle authorization.</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> @@ -363,7 +363,7 @@ <div class="source"> <pre><parameter name="max-waiting-threads" value="20" /> </pre></div></div> -<p>The maximum number of requests waiting in the queue before sending “service unavailable”.</p> +<p>The maximum number of requests waiting in the queue before new requests get “service unavailable”.</p> <div class="source"> <div class="source"> @@ -377,7 +377,7 @@ </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"> @@ -404,40 +404,36 @@ <div class="source"> <pre><parameter name="log-config-file" value="log4j-config.xml" /> </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> -<p><b>TODO</b> move items to appropriate sections</p> +<h3><a name="Options_for_developers"></a>Options for developers</h3> +<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><parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" /> +<pre><parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" /> +</pre></div></div> +<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><parameter name="docuimage-hacks" value="" /> </pre></div></div> -<p>Class for <b>TODO</b>.</p> +<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><parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" /> +<parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" /> +</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><parameter name="docudirectory-class" value="digilib.io.BaseDirDocuDirectory" /> </pre></div></div> -<p>Class for <b>TODO</b>.</p> - -<div class="source"> -<div class="source"> -<pre><parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" /> -</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><parameter name="docuimage-hacks" value="" /> -</pre></div></div> -<p><b>TODO</b> elaborate</p> - -<div class="source"> -<div class="source"> -<pre><parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" /> -</pre></div></div> -<p>Class for <b>TODO</b>.</p></div></div> +<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> </div> </div>