indexing_formats_folia.html
17.3 KB
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
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-12-19
| Rendered using Apache Maven Fluido Skin 1.5
-->
<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="20171219" />
<meta http-equiv="Content-Language" content="en" />
<title>Multi Tier Annotation Search – FoLiA</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.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.5.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>MTAS</h2>
</div>
</div>
<div class="pull-right"> <a href="http://www.meertens.knaw.nl/" id="bannerRight">
<img src="images/meertens.png" alt="Meertens Instituut" width="93" height="104"/>
</a>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="projectVersion">Version: 7.1.0.5-SNAPSHOT
<span class="divider">|</span>
</li>
<li class="">
<a href="index.html" title="Mtas">
Mtas</a>
<span class="divider">/</span>
</li>
<li class="active ">FoLiA</li>
<li id="publishDate" class="pull-right">Last Published: 2017-12-19</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Mtas</li>
<li>
<a href="index.html" title="Introduction">
<span class="none"></span>
Introduction</a>
</li>
<li>
<a href="features.html" title="Features">
<span class="none"></span>
Features</a>
</li>
<li>
<a href="installation.html" title="Getting started">
<span class="icon-chevron-right"></span>
Getting started</a>
</li>
<li>
<a href="indexing.html" title="Indexing">
<span class="icon-chevron-down"></span>
Indexing</a>
<ul class="nav nav-list">
<li>
<a href="indexing_configuration.html" title="Configuration">
<span class="none"></span>
Configuration</a>
</li>
<li>
<a href="indexing_mapping.html" title="Mapping">
<span class="none"></span>
Mapping</a>
</li>
<li>
<a href="indexing_formats.html" title="Formats">
<span class="icon-chevron-down"></span>
Formats</a>
<ul class="nav nav-list">
<li class="active">
<a href="#"><span class="none"></span>FoLiA</a>
</li>
<li>
<a href="indexing_formats_tei.html" title="TEI">
<span class="none"></span>
TEI</a>
</li>
<li>
<a href="indexing_formats_chat.html" title="CHAT">
<span class="none"></span>
CHAT</a>
</li>
<li>
<a href="indexing_formats_sketch.html" title="Sketch">
<span class="none"></span>
Sketch</a>
</li>
<li>
<a href="indexing_formats_crm.html" title="CRM">
<span class="none"></span>
CRM</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="search.html" title="Search">
<span class="icon-chevron-right"></span>
Search</a>
</li>
<li>
<a href="download.html" title="Download">
<span class="none"></span>
Download</a>
</li>
<li class="nav-header">Project Documentation</li>
<li>
<a href="project-info.html" title="Project Information">
<span class="icon-chevron-right"></span>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
<span class="icon-chevron-right"></span>
Project Reports</a>
</li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<h1>FoLiA</h1>
<p>For indexing <a class="externalLink" href="https://proycon.github.io/folia/">FoLiA</a> resources, the <i>mtas.analysis.parser.MtasFoliaParser</i> extending the abstract <i>MtasXMLParser</i> is available; full examples of configuration files are provided on <a class="externalLink" href="https://github.com/meertensinstituut/mtas/tree/master/conf/parser/mtas">GitHub</a>.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><!-- START CONFIGURATION MTAS PARSER -->
<parser name="mtas.analysis.parser.MtasFoliaParser">
...
<!-- START MAPPINGS -->
<mappings>
...
</mapping>
<!-- END MAPPINGS --->
...
</parser>
<!-- END CONFIGURATION MTAS PARSER -->
</pre></div></div>
<p>The <a href="indexing_configuration.html#configuration">configuration file</a> defining the <a href="indexing_mapping.html">mapping</a> has some specific settings for the FoLiA parser distinguishing several types of elements within the XML-based FoLiA resource: </p>
<ul>
<li><a href="indexing_formats_folia.html#word">words</a> : the basic tokenisation layer</li>
<li><a href="indexing_formats_folia.html#wordAnnotation">wordAnnotations</a> : annotations occurring within a word</li>
<li><a href="indexing_formats_folia.html#group">groups</a> : containing one or multiple words</li>
<li><a href="indexing_formats_folia.html#groupAnnotation">groupAnnotations</a> occurring within a group</li>
<li><a href="indexing_formats_folia.html#relation">relations</a> : containing one or multiple references</li>
<li><a href="indexing_formats_folia.html#reference">references</a> : elements referring to (typically) words by id</li>
</ul>
<p>Inside the <i>mappings</i> part of the configuration file, all elements are defined that may be mapped onto the index structure : <i>words</i>, <i>wordAnnotations</i>, <i>groups</i>, <i>groupAnnotations</i> and <i>relations</i>. Outside the <i>mappings</i> part the references can be defined, since a reference itself will never be mapped directly onto the index structure. </p>
<p>The use and meaning of the different elements is illustrated and explained by some examples. </p>
<p><a name="word"></a><b>Words</b></p>
<p>In the parser configuration, a word can be defined by </p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="word" name="w">
</mapping>
</pre></div></div>
<p>This will recognize every occurring w-tag within the FoLiA-resource as a word, defining the basic tokenization to be used in the mapping. To add a token for each occurring word, we have to add a token definition, for example</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="word" name="w">
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
</pre>
</token>
</mapping>
</pre></div></div>
<p>Here the <i>prefix</i> is chosen to equal the <i>name</i> of the matching tag, and no <i>offset</i>, <i>realOffset</i> or <i>parent</i> will be included. To only add tokens conditionally, and/or to include the value from for example a provided attribute, we can define for example</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="word" name="w">
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
</pre>
<post>
<item type="attribute" name="class" />
</post>
</token>
<condition>
<item type="attribute" name="class" />
<item type="attribute" name="class" not="true" condition="WORD" />
</condition>
</mapping>
</pre></div></div>
<p>This will add tokens to the index for all w-tags with the attribute <i>class</i> set and unequal to “WORD”. The resulting single position tokens will have <i>prefix</i> value “w” and <i>postfix</i> value equal to the provided <i>class</i>.</p>
<p>If <i>parent</i> was set to <i>true</i>, the id of the first parenting <a href="indexing_formats_group.html">group</a> would have been used as <i>parentId</i> for the resulting token.</p>
<p><a name="wordAnnotation"></a><b>Word annotations</b></p>
<p>All elements occurring within a <a href="indexing_formats_folia.html#word">word</a> can be defined as <i>wordAnnotation</i>. </p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="wordAnnotation" name="lemma">
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
</pre>
<post>
<item type="attribute" name="class" />
</post>
</token>
<condition>
<item type="attribute" name="class" />
</condition>
</mapping>
</pre></div></div>
<p>As illustrated in the next sample, not only attributes can be used, but also the text value within a matching tag. Furthermore, also multiple tokens can be generated from the same matching element. Finally, a filter may be applied.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="wordAnnotation" name="t">
<token type="string" offset="false" parent="true">
<pre>
<item type="name" />
</pre>
<post>
<item type="text" />
</post>
</token>
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
<item type="string" value="_lc" />
</pre>
<post>
<item type="text" filter="ascii,lowercase" />
</post>
</token>
</mapping>
</pre></div></div>
<p>If <i>parent</i> is set to true, the id of the first parenting <a href="indexing_formats_group.html">group</a> will be used as <i>parentId</i> for the generated token.</p>
<p><a name="group"></a><b>Groups</b></p>
<p>Elements containing one or multiple <a href="index_formats_folia.html#word">words</a> can be defined as <i>group</i>.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="group" name="s">
<token type="string" offset="false" parent="true">
<pre>
<item type="name" />
</pre>
<post>
<item type="attribute" name="class" />
</post>
</token>
</mapping>
</pre></div></div>
<p>The id of the first parenting group is used as <i>parentId</i>.</p>
<p><a name="groupAnnotation"></a><b>Group annotations</b></p>
<p>Elements within a <a href="index_formats_folia.html#group">group</a> and not containing one or multiple <a href="index_formats_folia.html#word">words</a> can be defined as <i>groupAnnotation</i>.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="groupAnnotation" name="lang">
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
</pre>
<post>
<item type="attribute" name="class" />
</post>
</token>
</mapping>
</pre></div></div>
<p>If <i>parent</i> was set to <i>true</i>, the id of the first parenting <a href="indexing_formats_group.html">group</a> would have been used as <i>parentId</i> for the resulting token.</p>
<p><a name="relation"></a><b>Relations</b></p>
<p>Elements containing one or multiple <a href="index_formats_folia.html#reference">references</a> and not containing one or multiple <a href="index_formats_folia.html#word">words</a> can be defined as <i>relation</i>.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><mapping type="relation" name="entities">
</mapping>
<mapping type="relation" name="entity">
<token type="string" offset="false" realoffset="false" parent="false">
<pre>
<item type="name" />
</pre>
<post>
<item type="attribute" name="class" />
</post>
<payload>
<item type="attribute" name="confidence" />
</payload>
</token>
<condition>
<item type="ancestor" number="1" />
<item type="ancestorName" condition="entities" />
</condition>
</mapping>
</pre></div></div>
<p><a name="reference"></a><b>References</b></p>
<p>Elements may be defined as <i>reference</i> to a word, for example <i>wref</i> elements referring in the <i>ref</i> attribute to the <i>id</i> of words. </p>
<div class="source">
<div class="source"><pre class="prettyprint"><references>
<reference name="wref" ref="id" />
</references>
</pre></div></div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright © 2017
<a href="http://www.meertens.knaw.nl/">Meertens Institute</a>.
All rights reserved.
</p>
</div>
</div>
</footer>
</body>
</html>