Mercurial > hg > digilib

<!DOCTYPE html>
<!--
 | 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="20171121" />
    <meta http-equiv="Content-Language" content="en" />
    <title>digilib - The Digital Image Library &#x2013; Digilib Plugins</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" />


    <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>


            </head>
        <body class="topBarDisabled">


        <div class="container-fluid">
          <div id="banner">
        <div class="pull-left">
                                    <a href="https://robcast.github.io/digilib/" id="bannerLeft">
                <h2>digilib - a versatile image viewing environment for the internet</h2>
                </a>
                      </div>
        <div class="pull-right">                  <a href="https://robcast.github.io/digilib/" id="bannerRight">
                                                                                                <img src="images/digilib-logo-small.png" />
                </a>
      </div>
        <div class="clear"><hr/></div>
      </div>

      <div id="breadcrumbs">
        <ul class="breadcrumb">


                  <li id="publishDate">Last Published: 2017-11-21</li>
                  <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>


                            </ul>
      </div>


      <div class="row-fluid">
        <div id="leftColumn" class="span3">
          <div class="well sidebar-nav">


                <ul class="nav nav-list">
                    <li class="nav-header">Overview</li>

      <li>

                          <a href="index.html" title="About digilib">
          <i class="none"></i>
        About digilib</a>
            </li>

      <li>

                          <a href="features.html" title="digilib features">
          <i class="none"></i>
        digilib features</a>
            </li>

      <li>

                          <a href="digilib-short.html" title="How digilib works">
          <i class="none"></i>
        How digilib works</a>
            </li>

      <li>

                          <a href="history.html" title="Ancient history">
          <i class="none"></i>
        Ancient history</a>
            </li>
                              <li class="nav-header">Installation</li>

      <li>

                          <a href="build-maven.html" title="Building digilib">
          <i class="none"></i>
        Building digilib</a>
            </li>

      <li>

                          <a href="install-digilib.html" title="Installing digilib">
          <i class="none"></i>
        Installing digilib</a>
            </li>

      <li>

                          <a href="server-setups.html" title="Server setups">
          <i class="none"></i>
        Server setups</a>
            </li>
                              <li class="nav-header">Configuration</li>

      <li>

                          <a href="digilib-config.html" title="Configuring digilib">
          <i class="none"></i>
        Configuring digilib</a>
            </li>

      <li>

                          <a href="image-directories.html" title="Directory layout">
          <i class="none"></i>
        Directory layout</a>
            </li>

      <li>

                          <a href="java-settings.html" title="Java settings and tuning">
          <i class="none"></i>
        Java settings and tuning</a>
            </li>

      <li>

                          <a href="auth.html" title="Access control">
          <i class="none"></i>
        Access control</a>
            </li>
                              <li class="nav-header">Development</li>

      <li>

                          <a href="scaler-api.html" title="The digilib Scaler API">
          <i class="none"></i>
        The digilib Scaler API</a>
            </li>

      <li>

                          <a href="iiif-api.html" title="The digilib IIIF API">
          <i class="none"></i>
        The digilib IIIF API</a>
            </li>

      <li>

                          <a href="client-integration.html" title="Integrating digilib into your page">
          <i class="none"></i>
        Integrating digilib into your page</a>
            </li>

      <li class="active">

            <a href="#"><i class="none"></i>Digilib plugins</a>
          </li>
                              <li class="nav-header">Project Documentation</li>

      <li>

                          <a href="project-info.html" title="Project Information">
          <i class="icon-chevron-right"></i>
        Project Information</a>
                  </li>
            </ul>


          <hr class="divider" />

           <div id="poweredBy">
                            <div class="clear"></div>
                            <div class="clear"></div>
                            <div class="clear"></div>
                                                                                                                   <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
        <img class="builtBy"  alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png"    />
      </a>
                                                                                                    <a href="../../" title="Hosted by GitHub" class="builtBy">
        <img class="builtBy"  alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png"   width="200px"  />
      </a>
                                                                                                    <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
        <img class="builtBy"  alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png"    />
      </a>
                      </div>
          </div>
        </div>


        <div id="bodyColumn"  class="span9" >

            <h1>Digilib Plugins</h1>
<p>The basic client-side Javascript functions to control the Scaler image are provided by a jQuery plugin in the file &#x2018;jquery.digilib.js&#x2019; (in the &#x201c;jquery&#x201d; subdirectory of the webapp). The Digilib jQuery plugin comes with a number of its own (sub-)plugins which provide additional functionality, making extensive use of the jQuery javascript library.</p>
<p>All Digilib plugin code must be executed after jQuery and the main Digilib module (jquery.digilib.js).</p>
<div class="section">
<h2><a name="Cookie_plugin"></a>Cookie plugin</h2>
<p>Stores the settings of your current Digilib preferences and view settings in a cookie.</p></div>
<div class="section">
<h2><a name="Geometry_plugin"></a>Geometry plugin</h2>
<p>Required if you use the client side digilib functions in jquery.digilib.js. The plugin provides basic geometric functions which help calculating screen positions.</p></div>
<div class="section">
<h2><a name="Arrows_plugin"></a>Arrows plugin</h2>
<p>Adds divs containing navigation arrows around the scaled image.</p></div>
<div class="section">
<h2><a name="Auth_plugin"></a>Auth plugin</h2>
<p>Handles authentication.</p></div>
<div class="section">
<h2><a name="Birds_eye_plugin"></a>Bird&#x2019;s eye plugin</h2>
<p>Shows a small bird&#x2019;s eye view window with the highlighted current zoom area, useful when looking at zoomed images.</p></div>
<div class="section">
<h2><a name="Dialogs_plugin"></a>Dialogs plugin</h2>
<p>Provides dialogs to set the image calibration (for rendering the object on the image in its original size) and the scaling mode (screen size, predefined image size, or pixel of the original file).</p></div>
<div class="section">
<h2><a name="Range_plugin"></a>Range plugin</h2>
<p>Provides HTML5 range controls for setting brightness, contrast and color values of the scaled image.</p></div>
<div class="section">
<h2><a name="Marks_plugin"></a>Marks plugin</h2>
<p>Allows the user to set visual marks on top of the scaled image, defining and referencing points of interest. The marks are numbered and always point to the defined location even when the image is zoomed, rotated or mirrored. The positions of the marks are part of the address. The marks are reproduced when the URL is opened in another browser or computer.</p></div>
<div class="section">
<h2><a name="Regions_plugin"></a>Regions plugin</h2>
<p>Allows the user to draw visual regions over the scaled image, defining and referencing areas of interest. The regions are numbered and always point to the defined location even when the image is zoomed, rotated or mirrored. The positions of the regions are part of the address. User-defined regions are reproduced when the URL is opened in another browser or computer.</p>
<p>Regions can also be stored in the HTML code of the page. The code for each region may contain a link to an external resource. When the user clicks on a region, he is transferred to the external resource.</p>
<p>The regions plugin provides an additional set of buttons for defining and deleting regions. Regions can be queried and highlighted by entering coordinates or text.</p></div>
<div class="section">
<h2><a name="Annotator_plugin"></a>Annotator plugin</h2>
<p>Allows the user to add visual annotations on top of the scaled image, defining and referencing areas or points of interest. The annotations are loaded from an annotation server; new annotations can be inserted and edited. Annotations always point to the defined location even when the image is zoomed, rotated or mirrored.</p>
<h1>How to write your own plugin</h1>
<p>Start with the stub file <tt>jquery.digilib.pluginstub.js</tt> in the &#x201c;jquery&#x201d; subdirectory of your digilib webapp directory.</p></div>
                  </div>
            </div>
          </div>

    <hr/>

    <footer>
            <div class="container-fluid">
              <div class="row span12">Copyright &copy;                    2001-2017
                        <a href="https://robcast.github.io/digilib/">digilib Community</a>.
            All Rights Reserved.

      </div>


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