annotate client/doc/dokumentation_digilib.html @ 20:d407cb901df4

Initial revision
author robcast
date Thu, 17 Jan 2002 15:29:55 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d407cb901df4 Initial revision
robcast
parents:
diff changeset
1 <html>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
2 <head>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
3 <title>Untitled Document</title>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
d407cb901df4 Initial revision
robcast
parents:
diff changeset
5 </head>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
6
d407cb901df4 Initial revision
robcast
parents:
diff changeset
7 <body bgcolor="#FFFFFF" text="#000000">
d407cb901df4 Initial revision
robcast
parents:
diff changeset
8 <h1>Digital Document Library</h1>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
9 <h4>&nbsp; </h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
10 <table border="0" cellspacing="3" width="573">
d407cb901df4 Initial revision
robcast
parents:
diff changeset
11 <tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
12 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
13 <h4>Stand:</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
14 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
15 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
16 <h4>27. M&auml;rz 2001</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
17 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
18 </tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
19 <tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
20 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
21 <h4>&nbsp;</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
22 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
23 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
24 <h4>&nbsp;</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
25 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
26 </tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
27 <tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
28 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
29 <h4>Leitung:</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
30 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
31 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
32 <h4>Gerd Grasshoff (<a href="mailto:gerd.grasshoff@philo.unibe.ch">gerd.grasshoff@philo.unibe.ch</a>)</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
33 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
34 </tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
35 <tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
36 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
37 <h4>Autor:</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
38 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
39 <td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
40 <h4>Christian Luginb&uuml;hl (<a href="mailto:luginbuehl@student.unibe.ch">luginbuehl@student.unibe.ch</a>)</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
41 </td>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
42 </tr>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
43 </table>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
44 <h3>Inhalt</h3>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
45 <ol>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
46 <li>Einf&uuml;hrung</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
47 <li>Filestruktur</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
48 <li>Files</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
49 </ol>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
50 <h3>1. Einf&uuml;hrung</h3>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
51 <p>Das Projekt Digital Document Library hat zum Ziel, &quot;Dokumente&quot;mit
d407cb901df4 Initial revision
robcast
parents:
diff changeset
52 Heilfe eines Web-Browsers anschauen zu k&ouml;nnen. Diese Dokumente sind hochaufgel&ouml;ste
d407cb901df4 Initial revision
robcast
parents:
diff changeset
53 Bilddateien, die auf einem Server gespeichert sind. Um der Benutzerin, dem Benutzer
d407cb901df4 Initial revision
robcast
parents:
diff changeset
54 die M&ouml;glichkeit einer raschen Konsultation der Daten liefern zu k&ouml;nnen,
d407cb901df4 Initial revision
robcast
parents:
diff changeset
55 m&uuml;ssen diese Bilddaten auf eine vern&uuml;nftige Gr&ouml;sse verkleinert
d407cb901df4 Initial revision
robcast
parents:
diff changeset
56 und an die Anfragenden geschickt werden. Weiter sollen den Usern Hilfsmittel
d407cb901df4 Initial revision
robcast
parents:
diff changeset
57 zur Verf&uuml;gung stehen um in diesen Seiten zu navigieren. Diese Hilfsmittel
d407cb901df4 Initial revision
robcast
parents:
diff changeset
58 bestehen aus Funktionen um zwischen verschiedenen Seiten hin und her zu wechseln,
d407cb901df4 Initial revision
robcast
parents:
diff changeset
59 Ausschnitte aus einem Bild zu zoomen und der M&ouml;glichkeit Markierungen zu
d407cb901df4 Initial revision
robcast
parents:
diff changeset
60 setzen. Ein weiter wichtiges Feature dieses Programms ist es, Referenzen von
d407cb901df4 Initial revision
robcast
parents:
diff changeset
61 Seiten (inkl. Ausschnitte und Markierungen) verf&uuml;gbar zu machen, die dann
d407cb901df4 Initial revision
robcast
parents:
diff changeset
62 in beliebiegen anderen Dokumenten eingebaut werden k&ouml;nnen. Sofern die Lesenden
d407cb901df4 Initial revision
robcast
parents:
diff changeset
63 dieser Dokumente dann &uuml;ber einen Anschluss ins Internet verf&uuml;gen,
d407cb901df4 Initial revision
robcast
parents:
diff changeset
64 k&ouml;nnen diese Referenzen direkt konsultiert werden und so die Digital Document
d407cb901df4 Initial revision
robcast
parents:
diff changeset
65 Library als grosse Quelltextsammlung gebraucht werden.</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
66 <h3>2. Filestruktur</h3>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
67 <p>Die Digital Document Library ist als Client/Server-Modell aufgebaut, wobei
d407cb901df4 Initial revision
robcast
parents:
diff changeset
68 an dieser Stelle haupts&auml;chlich die Clientseite beschrieben wird. Zu einem
d407cb901df4 Initial revision
robcast
parents:
diff changeset
69 besseren Verst&auml;ndnis ist nun folgend eine Skizze mit den verschiedenen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
70 Files und Verzeichnissen anf&uuml;gt.</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
71 <p align="left"><img src="Digilib.gif" width="691" height="603" border="0" vspace="20" hspace="20"></p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
72 <p align="left">Da JavaScript auf den verschiedenen verf&uuml;gbaren Browsern
d407cb901df4 Initial revision
robcast
parents:
diff changeset
73 nicht genau gleich implementiert wurde und Digilib auf dieser Scriptsprache
d407cb901df4 Initial revision
robcast
parents:
diff changeset
74 aufsetzt, ist es wichtig in digilib.html eine geeignete Version von navigation_XX.js
d407cb901df4 Initial revision
robcast
parents:
diff changeset
75 zu finden. Das XX wird als Variable f&uuml;r unterschiedliche Anpassungen an
d407cb901df4 Initial revision
robcast
parents:
diff changeset
76 die Browser. Momentan sind Netscape 4 (navigation_n4.js) und Netscape 6 (navigation_n6.js)
d407cb901df4 Initial revision
robcast
parents:
diff changeset
77 unterst&uuml;tzt.<br>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
78 Beim Erstellen der Struktur wurde darauf geachtet, dass das Layout und die tats&auml;chliche
d407cb901df4 Initial revision
robcast
parents:
diff changeset
79 Funktionalit&auml;t voneinander getrennt sind. Dies erm&ouml;glicht eine besstm&ouml;gliche
d407cb901df4 Initial revision
robcast
parents:
diff changeset
80 Portabilit&auml;t des Codes, so dass es m&ouml;glich ist, Digilib f&uuml;r spezielle
d407cb901df4 Initial revision
robcast
parents:
diff changeset
81 Anwendungen anzupassen (vgl. Compago, Universit&auml;t Bern).</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
82 <h3 align="left">3. Files</h3>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
83 <h4>3.1 digilib.html</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
84 <p>Dies ist die Schnittstelle zwischen Layout und Funktion von Digilib. Die Aufgaben
d407cb901df4 Initial revision
robcast
parents:
diff changeset
85 dieser Datei sind, das Laden der richtigen navigation_XX.js-Datei und das Anpassen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
86 des Layouts. Hauptaufgabe jedoch ist das Lesen der Parameter aus der URL. digilib.html
d407cb901df4 Initial revision
robcast
parents:
diff changeset
87 ist so aufgebaut, dass ein Bild (inkl. Ausschnitte und Markierungen) vollst&auml;ndig
d407cb901df4 Initial revision
robcast
parents:
diff changeset
88 &uuml;ber Parameter in der URL angegeben werden kann. Nun folgend ist eine Liste
d407cb901df4 Initial revision
robcast
parents:
diff changeset
89 mit allen m&ouml;glichen Parametern, wobei nur gerade der erste gegeben sein
d407cb901df4 Initial revision
robcast
parents:
diff changeset
90 muss - alle andern haben Defaultwerte, die in Klammern angegeben sind:</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
91 <pre>http://penelope.uni.../digitallibrary/digilib.html?att0+[att1]+[att2]+...+[att8]</pre>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
92 <ul>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
93 <li><b>att0</b> gibt das Verzeichnis an, in dem das Bild gespeichert ist.</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
94 <li><b>att1</b> (1) gibt die Seitenzahl des Bildes an. Diese Zahl bezieht sich
d407cb901df4 Initial revision
robcast
parents:
diff changeset
95 nicht auf die Buchseite, sondern zeigt auf die x-te Datei im unter att0 angegebenen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
96 Verzeichnis.</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
97 <li><b>att2</b> (1) ist der Skalierungsfaktor. Ein Faktor von 1 zoomt das Bild
d407cb901df4 Initial revision
robcast
parents:
diff changeset
98 auf Framegr&ouml;sse, 2 macht das Bild doppelt so hoch und breit.</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
99 <li><b>att3</b> (&quot;&quot;) ist f&uuml;r zus&auml;tzliche Kommandos an das
d407cb901df4 Initial revision
robcast
parents:
diff changeset
100 Servlet gedacht und per default leer. Einziges unterst&uuml;tztes Argument
d407cb901df4 Initial revision
robcast
parents:
diff changeset
101 ist hier &quot;f&quot; um das Servlet anzuweisen auch gif-Images zu zoomen.</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
102 <li><b>att4</b> (0/0) enth&auml;lt die Informationen f&uuml;r Markierungspunkte.
d407cb901df4 Initial revision
robcast
parents:
diff changeset
103 Die x- und y-Koordinate verden mit &quot;/&quot; getrennt, verschiedene Markierungen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
104 mit &quot;;&quot; (es sind bis zu 8 m&ouml;glich). Die Makrierungen werden
d407cb901df4 Initial revision
robcast
parents:
diff changeset
105 relativ zur Bildbreite und -h&ouml;he von 0 bis 1 angegeben (0/0 wird nicht
d407cb901df4 Initial revision
robcast
parents:
diff changeset
106 gezeichnet).</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
107 <li><b>att5, att6</b> (0, 0) geben die linke ober Ecke des gew&uuml;nschten
d407cb901df4 Initial revision
robcast
parents:
diff changeset
108 Ausschnitts an (ebenfalls relativ - vgl. att4).</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
109 <li><b>att7, att8</b> (1, 1) geben die relative Breite bzw. H&ouml;he des Ausschnitts
d407cb901df4 Initial revision
robcast
parents:
diff changeset
110 an. (Standardm&auml;ssig sind die Parameter so gesetzt, dass das ganze Bild
d407cb901df4 Initial revision
robcast
parents:
diff changeset
111 angezeigt wird).</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
112 </ul>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
113 <p>Diese Parameter werden von digilib.html als ein Block gelesen und an navigation_XX
d407cb901df4 Initial revision
robcast
parents:
diff changeset
114 weitergeleitet, wo dieser Block dann auseinander genommen und im richitgen Format
d407cb901df4 Initial revision
robcast
parents:
diff changeset
115 gespeichert wird.</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
116 <h4>3.2 navigation.html</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
117 <p>Diese Datei l&auml;dt fw_menu.js, mit Funktionen f&uuml;r Events bei den Kn&ouml;pfen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
118 und Menus. Weiter ist hier das Layout der Navigationsleiste festgelegt und die
d407cb901df4 Initial revision
robcast
parents:
diff changeset
119 Texte f&uuml;r die Kontexthilfe sind hier gespeichert.</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
120 <h4>3.3 fw_menu.js</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
121 <p>In dieser von Fireworks generierten JavaScript-Datei werden die Events abgearbeitet,
d407cb901df4 Initial revision
robcast
parents:
diff changeset
122 die bei Mausbewegungen und -klicks &uuml;ber den Kn&ouml;pfen gesendet werden.
d407cb901df4 Initial revision
robcast
parents:
diff changeset
123 In dieser Datei ist auch eine Funktion f&uuml;r die kantextsensitive Hilfe der
d407cb901df4 Initial revision
robcast
parents:
diff changeset
124 einzelnen Kn&ouml;pfe gespeichert. Wenn sie eingeschaltet ist, dann wird beim
d407cb901df4 Initial revision
robcast
parents:
diff changeset
125 &Uuml;berfahren der Kn&ouml;pfe ein kleines Fenster ge&ouml;ffnet, in dem kurz
d407cb901df4 Initial revision
robcast
parents:
diff changeset
126 die Funktion und der Gebrauch dieses Knopfes erl&auml;utert.<br>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
127 </p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
128 <h4>3.4 navigation_XX.js</h4>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
129 <p>Diese Datei bildet das Kernst&uuml;ck des Digilib-Clients. Hier werden die
d407cb901df4 Initial revision
robcast
parents:
diff changeset
130 Funktionen angeboten um Seiten zu wechseln, Makierungen zu setzen, Referenzen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
131 zu erzeugen und Ausschnitte zu zoomen. Weiter werden hier die Parameter aus
d407cb901df4 Initial revision
robcast
parents:
diff changeset
132 digilib.html &uuml;berpr&uuml;ft und gespeichert, die Anfrage ans Servlet gemacht,
d407cb901df4 Initial revision
robcast
parents:
diff changeset
133 wenn ein neuer Ausschnitt bzw ein neues Bild gew&uuml;nscht wird und dieses
d407cb901df4 Initial revision
robcast
parents:
diff changeset
134 wird dann ebenfalls von dieser Datei aus im Browser ausgegeben.<br>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
135 Es gibt zwei wichtige globale Variablen in dieser Datei:</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
136 <ul>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
137 <li><b>whichFrame:</b> Diese Variable gibt an, in welchem Frame die erhaltenen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
138 Bilder dargestellt werden sollen. Man hat so die M&ouml;glichkeit von aussen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
139 auf diese Variable zuzugreiffen und so Anpassungen machen, wenn man ein anderes
d407cb901df4 Initial revision
robcast
parents:
diff changeset
140 Layout will (Bsp. Vergleichsbildschirm von Compago, Universit&auml;t Bern).
d407cb901df4 Initial revision
robcast
parents:
diff changeset
141 Das Format ist nach passendem DOM (Document Object Model - vgl. <a href="http://www.w3c.org">www.w3c.org</a>)
d407cb901df4 Initial revision
robcast
parents:
diff changeset
142 als relativer Pfad von der Stelle anzugeben, wo navigation_XX.js geladen wurde.</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
143 <li><b>att-Array: </b>In diesem Array sind die einzelnen Parameter gespeichert
d407cb901df4 Initial revision
robcast
parents:
diff changeset
144 wie sie in Kapitel 3.1 aufgef&uuml;hrt wurden. Der Grund weshalb diese Variable
d407cb901df4 Initial revision
robcast
parents:
diff changeset
145 global gehalten wurde, ist der, dass ein modifizierter Client Informationen
d407cb901df4 Initial revision
robcast
parents:
diff changeset
146 &uuml;ber eine Seite speichern und weiterverarbeiten kann (auch hier sei auf
d407cb901df4 Initial revision
robcast
parents:
diff changeset
147 den &quot;Vergleichsbildschirm&quot; des Projektes Compago der Universit&auml;t
d407cb901df4 Initial revision
robcast
parents:
diff changeset
148 Bern hingewiesen).</li>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
149 </ul>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
150 <p>&nbsp;</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
151 <p>Christian Luginb&uuml;hl</p>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
152 </body>
d407cb901df4 Initial revision
robcast
parents:
diff changeset
153 </html>