-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
executable file
·896 lines (895 loc) · 45.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Documentation for teian</title>
<link rel="stylesheet" href="docbook.css" type="text/css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"/>
<meta name="description" content="teian is a standalone, web-based annotator for texts in XML format. It works by directly annotating the respective XML file or fragment. The end user does not have to know the XML markup, but just choose the text to annotate, and select an annotator. teian can be easily extended in order to use new XML annotators"/>
<link rel="home" href="index.html" title="Documentation for teian"/>
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Documentation for teian</th>
</tr>
</table>
<hr/>
</div>
<div class="article" title="Documentation for teian">
<div class="titlepage">
<div>
<div>
<h2 class="title">
<a id="id2684338"/>Documentation for teian</h2>
</div>
<div>
<div class="author">
<h3 class="author">
<span class="firstname">Claudius</span>
<span class="surname">Teodorescu</span>
</h3>
<div class="affiliation">
<span class="jobtitle">XML Consultant<br/>
</span>
<div class="address">
<p>
<code class="email"><claudius.teodorescu at gmail.com></code>
</p>
</div>
</div>
</div>
</div>
<div>
<p class="pubdate">2011-09-20</p>
</div>
<div>
<div class="abstract" title="Abstract">
<p class="title">
<b>Abstract</b>
</p>
<p>
<span class="strong">
<strong>teian</strong>
</span> is a standalone, web-based annotator for texts in XML format. It works by directly annotating the respective XML file or fragment. The end user does not have to
know the XML markup, but just choose the text to annotate, and select an annotator.</p>
<p>
<span class="strong">
<strong>teian</strong>
</span> can be easily extended in order to use new XML annotators</p>
</div>
</div>
</div>
<hr/>
</div>
<div class="toc">
<p>
<b>Table of Contents</b>
</p>
<dl>
<dt>
<span class="sect1">
<a href="index.html#id2757576">Scope</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="sect2">
<a href="index.html#id2757581">Description</a>
</span>
</dt>
<dt>
<span class="sect2">
<a href="index.html#id2757601">Localization</a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="sect1">
<a href="index.html#id2797562">Installation</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="sect2">
<a href="index.html#id2797568">Prerequisites</a>
</span>
</dt>
<dt>
<span class="sect2">
<a href="index.html#id2797645">Installation of the annotator</a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="sect1">
<a href="index.html#id2797695">Usage</a>
</span>
</dt>
<dt>
<span class="sect1">
<a href="index.html#id2755745">Description of annotators</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="sect2">
<a href="index.html#id2755750">Generalities</a>
</span>
</dt>
<dt>
<span class="sect2">
<a href="index.html#id2755854">Types of annotators</a>
</span>
</dt>
<dt>
<span class="sect2">
<a href="index.html#id2755917">Description of annotator types</a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="sect1">
<a href="tests/index.html">Unit tests</a>
</span>
</dt>
</dl>
</div>
<div class="sect1" title="Scope">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a id="id2757576"/>Scope</h2>
</div>
</div>
</div>
<div class="sect2" title="Description">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2757581"/>Description</h3>
</div>
</div>
</div>
<p>
<span class="strong">
<strong>teian</strong>
</span> is a standalone, web-based annotator for texts in XML.</p>
<p>It runs in all major modern browsers: Opera, Firefox, Google Chrome, Safari, and Internet Explorer (8+).</p>
</div>
<div class="sect2" title="Localization">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2757601"/>Localization</h3>
</div>
</div>
</div>
<p>
<span class="strong">
<strong>teian</strong>
</span>'s default language is English.
For other languages, copy the <span class="emphasis">
<em>$TEIAN_HOME/config/lang/en.xml</em>
</span>
file with a new name, of type <span class="emphasis">
<em>language-abbreviation.xml</em>
</span>,
and add a new <span class="emphasis">
<em>lang</em>
</span> child element to
<span class="emphasis">
<em>ui-languages</em>
</span> element of
<span class="emphasis">
<em>$TEIAN_HOME/config/configuration-options.xml</em>
</span> file.
</p>
</div>
</div>
<div class="sect1" title="Installation">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a id="id2797562"/>Installation</h2>
</div>
</div>
</div>
<div class="sect2" title="Prerequisites">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2797568"/>Prerequisites</h3>
</div>
</div>
</div>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>jQuery, the core library.</p>
</li>
<li class="listitem">
<p>
jQuery UI, the core library, and the position, widget,
and dialog plugins.
</p>
</li>
<li class="listitem">
<p>
<a class="ulink" href="http://code.google.com/p/rangy/" target="_top">rangy</a>,
a cross-browser JavaScript range and selection library.
</p>
</li>
<li class="listitem">
<p>
<a class="ulink" href="http://sourceforge.net/projects/kyer/" target="_top">kyer</a>,
data binding and templating engine.
</p>
</li>
<li class="listitem">
<p>
<a class="ulink" href="http://sourceforge.net/projects/simpath/" target="_top">simpath</a>,
simpathetic cross-browser XPath processor.
</p>
</li>
</ul>
</div>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25">
<img alt="[Note]" src="note.png"/>
</td>
<th align="left">Note</th>
</tr>
<tr>
<td align="left" valign="top">
<p>
These dependencies have to be installed in the same folder as teian.
They are archived by default in the <span class="strong">
<strong>teian</strong>
</span>
package.
</p>
</td>
</tr>
</table>
</div>
</div>
<div class="sect2" title="Installation of the annotator">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2797645"/>Installation of the annotator</h3>
</div>
</div>
</div>
<p>
Create a base folder and copy within it the <span class="strong">
<strong>teian</strong>
</span>
folder and all dependecies from the <span class="strong">
<strong>teian</strong>
</span>
package.
</p>
<p>
Access page <span class="emphasis">
<em>http://server-name:port/url-to-teian-base-folder/core/teian.html</em>
</span>
and add a <span class="emphasis">
<em>doc-url</em>
</span> parameter to the address, having as
value the URL of the XML document to annotate.
</p>
<div class="example">
<a id="id2797679"/>
<p class="title">
<b>Example 1. Example of access URL for teian:</b>
</p>
<div class="example-contents">
<pre class="programlisting">http://localhost/teian/core/teian.html?doc-url=http://localhost/data/01.xml</pre>
</div>
</div>
<br class="example-break"/>
</div>
</div>
<div class="sect1" title="Usage">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a id="id2797695"/>Usage</h2>
</div>
</div>
</div>
<p>Each XML element to be used for annotation has to be defined as follows:</p>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
in <span class="emphasis">
<em>$TEIAN_HOME/config/annotator-specifications.xml</em>
</span>
file, according to its type (see below the detailed description of
annotators' types).
</p>
</li>
<li class="listitem">
<p>
in <span class="emphasis">
<em>$TEIAN_HOME/config/lang/language-abbreviation.xml</em>
</span>
file(s), according to the needs for localization of
<span class="strong">
<strong>teian</strong>
</span>.
</p>
</li>
<li class="listitem">
<p>
in <span class="emphasis">
<em>$TEIAN_HOME/config/css/elements.css</em>
</span> file(s),
according to presentation desired for each XML element.
</p>
</li>
<li class="listitem">
<p>
in <span class="emphasis">
<em>$TEIAN_HOME/core/teian.html</em>
</span> file(s), as child
of <span class="emphasis">
<em>kyer:menu</em>
</span> element, according to the way
desired for rendering the annotator in the page's toolbar (button,
drop-down menu, etc.). This <span class="emphasis">
<em>kyer:menu</em>
</span> element
is an implementation in kyer of this <a class="ulink" href="https://docs.google.com/document/d/1NActoq8gbknSN2ibpsvWV8x-TXXrv1LkI9k3lCQGB7o/edit?hl=en_GB" target="_top">element</a>.
</p>
</li>
</ul>
</div>
</div>
<div class="sect1" title="Description of annotators">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both">
<a id="id2755745"/>Description of annotators</h2>
</div>
</div>
</div>
<div class="sect2" title="Generalities">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2755750"/>Generalities</h3>
</div>
</div>
</div>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
The annotators are defined in
<span class="emphasis">
<em>$TEIAN_HOME/config/annotator-specifications.xml</em>
</span>
file.
</p>
</li>
<li class="listitem">
<p>
The localization is defined in <span class="emphasis">
<em>$TEIAN_HOME/config/lang/en.xml</em>
</span>,
or other file, according to choosen language -
for examples of usage, see below.
</p>
</li>
<li class="listitem">
<p>
One has to provide for each annotator an unique id (@id),
a name (@name), which is the corresponding XML element
name, and a type code (@type-code), which is the type of
the respective annotator.
</p>
</li>
<li class="listitem">
<p>
In order to provide an annotated XML document that is
conformant to its schema, one has to provide for each
annotator the name of the parent and preceding sibling
XML elements (annotator-possible-parent-element-names
and annotator-possible-preceding-sibling-element-names).
</p>
</li>
<li class="listitem">
<p>
Also, for each annotator has to be provided the description
of each attribute of the respective XML element (if any),
according to examples, and the name for annotator's icon
(this is the icon that will appear on toolbar; the
respective file should be located into
<span class="emphasis">
<em>$TEIAN_HOME/config/images</em>
</span> folder).
</p>
</li>
<li class="listitem">
<p>
In case when the annotator has as UI a dialog panel, the
respective panel and its tabs has to be defined according
to the examples below.
</p>
<p>
Principially speaking, this web-annotator allows user, by
means of an panel (for certain annotators), to attach
desired strings to the respective XML element's attributes.
For this, each panel has text fields and/or lists, having
their values as result of a query to a server or not; each
text field/list is thus attached to an XML element's
attribute and its content can be validated against a
regular expression contained by
annotator-panel-field-validation-regex element.
</p>
<p>
The labels for each text fiels/list are defined in the
respective language file.
</p>
<p>
Note that the annotators of "selected-wrap-server" type
have a common panel definition, which is entered
separately into annotator-specifications.xml file.
</p>
</li>
<li class="listitem">
<p>
The annotators' localization definitions have to closely
follow the annotator definition, namely to have the same
id (@id). Also, one has to define the text that will appear
when user hovers over the annotator's button
(toolbar-button-title).
</p>
</li>
</ul>
</div>
</div>
<div class="sect2" title="Types of annotators">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2755854"/>Types of annotators</h3>
</div>
</div>
</div>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
<a class="link" href="index.html#insert-annotator-description">insert</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="index.html#insert-parametrized-annotator-description">insert-parametrized</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="index.html#selected-wrap-annotator-description">selected-wrap</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="index.html#selected-wrap-parameterized-annotator-description">selected-wrap-parameterized</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="index.html#selected-wrap-server-annotator-description">selected-wrap-server</a>
</p>
</li>
</ul>
</div>
</div>
<div class="sect2" title="Description of annotator types">
<div class="titlepage">
<div>
<div>
<h3 class="title">
<a id="id2755917"/>Description of annotator types</h3>
</div>
</div>
</div>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>
<a id="insert-annotator-description"/>
Annotator of "insert" type. This type of annotator includes
the XML elements that are simply inserted into text.
</p>
<p>
Example of annotator definition:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator" name="lb" type-code="insert">
<teian:annotator-description-text>
Insert a line break at the insertion point. Only for inside p and div tags.
</teian:annotator-description-text>
<teian:annotator-possible-parent-element-names>
cl m phr s span w abbr add addrLine address author bibl biblScope cit corr date del distinct
editor email emph expan foreign gloss head headItem headLabel hi imprint item l label lg list
listBibl measure mentioned name note num orig p pubPlace publisher q quote ref reg resp rs
said series sic soCalled sp speaker stage street term time title unclear
activity channel constitution derivation domain factuality interaction locale preparedness
purpose case colloc def dictScrap entry entryFree etym form gen gram gramGrp hom hyph iType
lang lbl mood number orth per pos pron re sense stress subc syll tns usg xr actor camera
caption castGroup castItem castList epilogue performance prologue role roleDesc set sound
tech view cell figure table authority change classCode creation distributor edition extent
funder geoDecl handNote language principal scriptNote sponsor typeNote ab seg accMat acquisition
additions catchwords collation colophon condition custEvent decoNote explicit filiation
finalRubric foliation heraldry incipit layout material msItem musicNotation objectType
origDate origPlace origin provenance rubric secFol signatures source stamp summary support
surrogates textLang watermark addName affiliation age birth bloc country death district
education faith floruit forename genName geogName langKnown nameLink nationality occupation
orgName persName person placeName region residence roleName settlement sex socecStatus
surname graph u writing valDesc app lem rdg wit witDetail argument back body byline closer
dateline div div1 div2 div3 div4 div5 div6 div7 docAuthor docDate docEdition docImprint
docTitle epigraph floatingText front group imprimatur opener postscript salute signed text
titlePage titlePart trailer damage fw restore supplied surplus metSym rhyme
</teian:annotator-possible-parent-element-names>
<teian:annotator-possible-preceding-sibling-element-names/>
<teian:annotator-attribute/>
<teian:annotator-icon-name>lineBreak.gif</teian:annotator-icon-name>
</teian:annotator>
</pre>
<p>
Example of annotator localization:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator">
<teian:toolbar-button-title>Insert a line break</teian:toolbar-button-title>
<teian:toolbar-button-label>lb</teian:toolbar-button-label>
</teian:annotator>
</pre>
</li>
<li class="listitem">
<p>
<a id="insert-parametrized-annotator-description"/>
Annotator of "insert-parametrized" type. This type of
annotator is similar to "insert" type annotators, with the
difference that the corresponding XML element has attributes,
which are the annotator's parameters; these parameters can
be set in a dialog panel.
</p>
<p>
Example of annotator definition:
</p>
<pre class="programlisting">
<teian:annotator id="pb-annotator" name="pb" type-code="insert-parametrized">
<teian:annotator-description-text>
Insert a page break at the insertion point. Only for inside p and div tags.
Note that page breaks can have three attributes.
</teian:annotator-description-text>
<teian:annotator-possible-parent-element-names>
cl m phr s span w abbr add addrLine address author bibl biblScope cit corr date del
distinct editor email emph expan foreign gloss head headItem headLabel hi imprint item l
label lg list listBibl measure mentioned name note num orig p pubPlace publisher q quote
ref reg resp rs said series sic soCalled sp speaker stage street term time title unclear
activity channel constitution derivation domain factuality interaction locale preparedness
purpose case colloc def dictScrap entry entryFree etym form gen gram gramGrp hom hyph iType
lang lbl mood number orth per pos pron re sense stress subc syll tns usg xr actor camera
caption castGroup castItem castList epilogue performance prologue role roleDesc set sound
tech view cell figure table authority change classCode creation distributor edition extent
funder geoDecl handNote language principal scriptNote sponsor typeNote ab seg accMat
acquisition additions catchwords collation colophon condition custEvent decoNote explicit
filiation finalRubric foliation heraldry incipit layout material msItem musicNotation
objectType origDate origPlace origin provenance rubric secFol signatures source stamp
summary support surrogates textLang watermark addName affiliation age birth bloc country
death district education faith floruit forename genName geogName langKnown nameLink
nationality occupation orgName persName person placeName region residence roleName
settlement sex socecStatus surname graph u writing valDesc app lem rdg wit witDetail
argument back body byline closer dateline div div1 div2 div3 div4 div5 div6 div7 docAuthor
docDate docEdition docImprint docTitle epigraph floatingText front group imprimatur opener
postscript salute signed text titlePage titlePart trailer damage fw restore supplied
surplus metSym rhyme
</teian:annotator-possible-parent-element-names>
<teian:annotator-possible-preceding-sibling-element-names/>
<teian:annotator-icon-name>pageBreak.gif</teian:annotator-icon-name>
<teian:annotator-attribute>n</teian:annotator-attribute>
<teian:annotator-attribute>xml:id</teian:annotator-attribute>
<teian:annotator-attribute>facs</teian:annotator-attribute>
<teian:annotator-panel>
</teian:annotator-panel>
</teian:annotator>
</pre>
<p>
Example of annotator localization:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator">
<teian:toolbar-button-title>Insert a page break</teian:toolbar-button-title>
<teian:toolbar-button-label>pb</teian:toolbar-button-label>
</teian:annotator>
</pre>
</li>
<li class="listitem">
<p>
<a id="selected-wrap-annotator-description"/>
Annotator of "selected-wrap" type. This type of annotator
is used for the XML elements needed for styling (bold,
italic, etc.).
</p>
<p>
Example of annotator definition:
</p>
<pre class="programlisting">
<teian:annotator id="strong-annotator" name="hi" type-code="selected-wrap">
<teian:annotator-description-text>
Wrap bold tags around the selected text.
</teian:annotator-description-text>
<teian:annotator-possible-parent-element-names>
cl phr s w abbr add addrLine author bibl biblScope corr date del distinct editor email
emph expan foreign gloss head headItem headLabel hi item l label measure mentioned name
note num orig p pubPlace publisher q quote ref reg rs said sic soCalled speaker stage
street term time title unclear case colloc def dictScrap entryFree etym form gen gram
gramGrp hyph iType lang lbl mood number orth per pos pron re sense stress subc syll tns
usg xr actor camera caption castItem role roleDesc sound tech view cell distributor
edition extent geoDecl handNote scriptNote typeNote ab seg accMat acquisition additions
catchwords collation colophon condition custEvent decoNote explicit filiation finalRubric
foliation heraldry incipit layout material musicNotation objectType origDate origPlace
origin provenance rubric secFol signatures source stamp summary support surrogates
textLang watermark addName affiliation birth bloc country death district education faith
floruit forename genName geogName nameLink nationality occupation orgName persName
placeName region residence roleName settlement sex socecStatus surname u writing lem
rdg wit witDetail byline closer dateline docAuthor docDate docEdition docImprint imprimatur
opener salute signed titlePart trailer damage fw restore supplied surplus rhyme
</teian:annotator-possible-parent-element-names>
<teian:annotator-possible-preceding-sibling-element-names/>
<teian:annotator-icon-name>bold.gif</teian:annotator-icon-name>
<teian:annotator-attribute name="rend" value="strong"/>
</teian:annotator>
</pre>
<p>
Example of annotator localization:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator">
<teian:toolbar-button-title>Insert strong style</teian:toolbar-button-title>
<teian:toolbar-button-label>
<b>B</b>
</teian:toolbar-button-label>
</teian:annotator>
</pre>
</li>
<li class="listitem">
<p>
<a id="selected-wrap-parameterized-annotator-description"/>
Annotator of "selected-wrap-parameterized" type. This type
of annotator is similar to "selected-wrap" type annotators,
with the difference that the corresponding XML element has
attributes, which are the annotator's parameters; these
parameters can be set in a dialog panel.
</p>
<p>
Example of annotator definition:
</p>
<pre class="programlisting">
<teian:annotator id="date-annotator" name="date" type-code="selected-wrap-parameterized">
<teian:annotator-description-text>Wrap date tags around the selected text and display the date selector panel.</teian:annotator-description-text>
<teian:annotator-icon-name>calendar.png</teian:annotator-icon-name>
<teian:annotator-possible-parent-element-names>
cl phr s w abbr add addrLine author bibl biblScope corr date del distinct editor email
emph expan foreign gloss head headItem headLabel hi item l label measure mentioned name
note num orig p pubPlace publisher q quote ref reg rs said sic soCalled speaker stage
street term time title unclear case colloc def dictScrap entryFree etym form gen gram
gramGrp hyph iType lang lbl mood number orth per pos pron re sense stress subc syll tns
usg xr actor camera caption castItem role roleDesc sound tech view cell distributor edition
extent geoDecl handNote scriptNote typeNote ab seg accMat acquisition additions catchwords
collation colophon condition custEvent decoNote explicit filiation finalRubric foliation
heraldry incipit layout material musicNotation objectType origDate origPlace origin
provenance rubric secFol signatures source stamp summary support surrogates textLang
watermark addName affiliation birth bloc country death district education faith floruit
forename genName geogName nameLink nationality occupation orgName persName placeName
region residence roleName settlement sex socecStatus surname u writing lem rdg wit
witDetail byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener
salute signed titlePart trailer damage fw restore supplied surplus rhyme
</teian:annotator-possible-parent-element-names>
<teian:annotator-possible-preceding-sibling-element-names/>
<teian:annotator-attribute name="when" value=""/>
<teian:annotator-panel>
<div id="date-dialog" title="">
<label for="teian-date-when"
ref="simpath:instance('ui-lang')//teian:annotator[@id = 'date-annotator']/teian:annotator-panel/teian:annotator-panel-element[@id = 'date-when-label']"/>
<input type="text" id="teian-date-when"/>
</div>
<script type="text/javascript" charset="utf-8">
$("#date-dialog").attr('title', $x.xpath("simpath:instance('ui-lang')//teian:annotator[@id = 'date-annotator']/teian:annotator-panel/teian:annotator-panel-title/text()"));
$("label[for='teian-date-when']").text($($x.xpath($("label[for='teian-date-when']").attr('ref'))[0]).text());
teian.ui['date-annotator'] = $("#date-dialog").dialog({
autoOpen: false,
width : 700,
height : 200,
modal : true,
buttons: {
"Save": function() {
$( this ).dialog( "close" );
$($("#date-annotator")[0]['oAnnotatorMarkup']).attr('when', $("#teian-date-when").val());
teian.annotator[0]($("#date-annotator")[0]);
$($("#date-annotator")[0]['oAnnotatorMarkup']).attr('when', '');
$("#teian-date-when").val('');
},
"Cancel": function() {
$( this ).dialog( "close" );
teian.utils.oSavedSelection = null;
$("#teian-date-when").val('');
}
}
});
</script>
</teian:annotator-panel>
</teian:annotator>
</pre>
<p>
Example of annotator localization:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator">
<teian:toolbar-button-title>Date</teian:toolbar-button-title>
<teian:toolbar-button-label>date</teian:toolbar-button-label>
<teian:annotator-panel>
<teian:annotator-panel-title>Enter date in format YYYY-MM-DD</teian:annotator-panel-title>
<teian:annotator-panel-element id="date-when-label">Enter date: </teian:annotator-panel-element>
</teian:annotator-panel>
</teian:annotator>
</pre>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25">
<img alt="[Note]" src="note.png"/>
</td>
<th align="left">Note</th>
</tr>
<tr>
<td align="left" valign="top">
<p>
Note: Each annotator should have a definition of
the dialog panel's content, contained by
<span class="emphasis">
<em>annotator-panel</em>
</span> element.
</p>
</td>
</tr>
</table>
</div>
</li>
<li class="listitem">
<p>
<a id="selected-wrap-server-annotator-description"/>
Annotator of "selected-wrap-server" type. This type of
annotator is similar to "selected-wrap-parameterized"
type annotators, with the difference that the values of
the corresponding XML elements' attributes are set based
upon the response to a query sent to a server.
</p>
<p>
Example of annotator definition:
</p>
<pre class="programlisting">
<teian:annotator id="persName-annotator" name="persName" type-code="selected-wrap-server">
<teian:annotator-description-text>Wrap the person tags around the selected text and display the person selection panel.</teian:annotator-description-text>
<teian:annotator-icon-name>person.png</teian:annotator-icon-name>
<teian:annotator-id-service-uri>http://demoedb.richmond.edu/exist/rest/db/urbml/apps/tei/utils/teian/services/suggest.xql?type=people&word=</teian:annotator-id-service-uri>
<teian:annotator-possible-parent-element-names>
cl phr s span abbr add addrLine address author bibl biblScope corr date del desc distinct
editor email emph expan foreign gloss head headItem headLabel hi item l label measure
meeting mentioned name note num orig p pubPlace publisher q quote ref reg resp respStmt
rs said sic soCalled speaker stage street term time title unclear activity channel
constitution derivation domain factuality interaction locale preparedness purpose setting
case colloc def dictScrap entryFree etym form gen gram gramGrp hyph iType lang lbl mood
number orth per pos pron re sense stress subc syll tns usg xr actor camera caption castItem
role roleDesc sound tech view cell figDesc authority catDesc change classCode creation
distributor edition extent funder geoDecl handNote language principal rendition scriptNote
sponsor tagUsage typeNote fDescr fsDescr ab seg accMat acquisition additions catchwords
collation colophon condition custEvent decoNote explicit filiation finalRubric foliation
heraldry incipit layout material musicNotation objectType origDate origPlace origin
provenance rubric secFol signatures source stamp summary support surrogates textLang
watermark addName affiliation age birth bloc country death district education faith floruit
forename genName geogName langKnown nameLink nationality occupation org orgName persName
person personGrp placeName region residence roleName settlement sex socecStatus surname
u writing valDesc lem rdg wit witDetail witness byline closer dateline docAuthor docDate
docEdition docImprint imprimatur opener salute signed titlePart trailer damage fw restore
supplied surplus metSym rhyme
</teian:annotator-possible-parent-element-names>
<teian:annotator-possible-preceding-sibling-element-names/>
<teian:annotator-attribute name="corresp" value=""/>
</teian:annotator>
</pre>
<p>
Example of annotator localization:
</p>
<pre class="programlisting">
<teian:annotator id="lb-annotator">
<teian:toolbar-button-title>Person</teian:toolbar-button-title>
<teian:toolbar-button-label>persName</teian:toolbar-button-label>
<teian:annotator-panel>
<teian:annotator-panel-title>Person</teian:annotator-panel-title>
</teian:annotator-panel>
</teian:annotator>
</pre>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25">
<img alt="[Note]" src="note.png"/>
</td>
<th align="left">Note</th>
</tr>
<tr>
<td align="left" valign="top">
<div class="itemizedlist">
<ul class="itemizedlist" type="circle">
<li class="listitem">
<p>
The dialog panel for this type of annotator
has a standard format, which is defined by
the <span class="emphasis">
<em>common-panel</em>
</span> element
with @id = "selected-wrap-server-annotator-panel"
in <span class="emphasis">
<em>$TEIAN_HOME/config/annotator-specifications.xml</em>
</span>
file.
</p>
</li>
<li class="listitem">
<p>
In <span class="emphasis">
<em>$TEIAN_HOME/config/annotator-specifications.xml</em>
</span>
file, the first attribute for annotators of
this type will automatically receive the
value selected by user from the results
returned by server.
</p>
</li>
</ul>
</div>
</td>
</tr>
</table>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<P xmlns="" xmlns:fo="http://www.w3.org/1999/XSL/Format" class="copyright">© 2011 - 2019 Claudius Teodorescu</P>
<div class="navfooter">
<hr/>
</div>
</body>
</html>