Mercurial > hg > digilib

annotate doc/src/site/markdown/plugins.md @ 1396:7a2de95a7b8e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation updated with Ubbo's codec tuning tips and IIIF API info.
author robcast
date Fri, 09 Oct 2015 16:45:40 +0200
parents 00eb2008b21b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1226
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
1 # Digilib Plugins #
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
2
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
3 The basic client-side Javascript functions to control the Scaler image are provided by a jQuery plugin in the file 'jquery.digilib.js' (in the "jquery" 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
4
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
5 All Digilib plugin code must be executed after jQuery and the main Digilib module (jquery.digilib.js).
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
6
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
7 ## Cookie plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
8
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
9 Stores the settings of your current Digilib preferences and view settings in a cookie.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
10
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
11 ## Geometry plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
12
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
13 Required if you use the client side digilib functions in jquery.digilib.js. The plugin provides basic geometric functions which help calculating screen positions.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
14
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
15 ## Arrows plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
16
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
17 Adds divs containing navigation arrows around the scaled image.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
18
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
19 ## Auth plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
20
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
21 Handles authentication.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
22
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
23 ## Bird's eye plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
24
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
25 Shows a small bird's eye view window with the highlighted current zoom area, useful when looking at zoomed images.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
26
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
27 ## Dialogs plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
28
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
29 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).
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
30
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
31 ## Range plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
32
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
33 Provides HTML5 range controls for setting brightness, contrast and color values of the scaled image.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
34
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
35 ## Marks plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
36
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
37 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
38
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
39 ## Regions plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
40
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
41 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
42
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
43 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
44
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
45 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
46
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
47 ## Annotator plugin ##
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
48
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
49 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.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
50
1240
00eb2008b21b small fixes.
robcast
parents: 1226
diff changeset
51 # How to write your own plugin #
1226
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
52
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
53 Start with the stub file `jquery.digilib.pluginstub.js` in the "jquery" subdirectory of your digilib webapp directory.
d9d004f706ef added documentation/examples for client integration and plugins
hertzhaft
parents:
diff changeset
54