tidysimple.xqm 11.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
xquery version "3.1";

(:~
 : This modules handles the conversion of the Fontante-TEI/XML into TEI simplePrint
 : for the edited text. The resulting TEI simplePrint is the basis for the "Editerter
 : Text" (edited text) view on the website and the book. It represents the latest
 : layer of text.
 :
 : @author Michelle Rodzis
 : @version 0.1
 : @since TODO
 :)

module namespace tidySimple ="http://fontane-nb.dariah.eu/tidysimple";

MRodz's avatar
MRodz committed
16

17
declare namespace tei="http://www.tei-c.org/ns/1.0";
MRodz's avatar
MRodz committed
18
declare namespace test="http://exist-db.org/xquery/xqsuite";
19

MRodz's avatar
MRodz committed
20
import module namespace config="http://textgrid.de/ns/SADE/config" at "../../config/config.xqm";
21
import module namespace console="http://exist-db.org/xquery/console";
22
import module namespace functx="http://www.functx.com";
23
24
import module namespace simpleHelpers="http://fontane-nb.dariah.eu/teisimplehelpers" at "teisimplehelpers.xqm";

MRodz's avatar
MRodz committed
25

26
declare variable $tidySimple:valid-hands :=
27
28
    for $res in collection("/db/sade-projects/textgrid/data/xml/data")
(:    for $res in collection("/db/apps/SADE/resources/xml"):)
MRodz's avatar
MRodz committed
29
30
31
32
    return
        $res//tei:handNote[@script = "contemporary"]/@xml:id/string();


33
declare function tidySimple:main($tei as node()*) {
34
35
36
37
38
39
  let $doc :=
    try {
      (doc($config:app-root || "/resources/xml/tei-simple-pre.xml"))
    } catch * {
      (console:log("It was not possible to open the requested file tei-simple-pre.xml."))
    }
40
    let $text := $tei//tei:text
41
    let $clear-invalid-hands := tidySimple:sort-out-invalid-hands($text)
42
    let $clear-surplus-hands := tidySimple:sort-out-surplus-elements($clear-invalid-hands)
MRodz's avatar
MRodz committed
43
44
45
46
    let $text-with-sections := tidySimple:make-structure($clear-surplus-hands)
    let $header := $tei/tei:teiHeader
    let $store := xmldb:store("/db/apps/SADE/resources/xml/", "tei-simple-tmp.xml", <TEI xmlns="http://www.tei-c.org/ns/1.0">{$header}{$text-with-sections}</TEI>)
(:    let $store := xmldb:store("/db/apps/SADE/resources/xml/", "tei-simple-tmp.xml", <div>{$clear-surplus-hands}</div>):)
47
    return "done"
48
49
50
51
52
53
54
55
56
(:    let $doc := doc($config:app-root || "/resources/xml/tei-simple-tmp.xml"):)
(:    let $tidied-text := tidySimple:tidy($doc//tei:text):)
(:    let $final-tei:=:)
(:        <TEI xmlns="http://www.tei-c.org/ns/1.0">:)
(:            {$tei//tei:teiHeader}:)
(:            {$tidied-text}:)
(:        </TEI>:)
(::)
(:    return xmldb:store("/db/apps/SADE/resources/xml/", "tei-simple.xml", $final-tei):)
MRodz's avatar
MRodz committed
57
58
};

59
60
61
62
63
declare function tidySimple:sort-out-invalid-hands($nodes as node()*) 
as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
MRodz's avatar
MRodz committed
64
65
            if($node/preceding::tei:milestone[@unit = "handshift"][1] 
            and not(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $node/preceding::tei:milestone[@unit = "handshift"][1]))) then
MRodz's avatar
MRodz committed
66
67
68
                ()
            else
                $node
69
        
70
71
72
73
        (: all lines have to be preserved because of the editorial commentary
        which references the lines in the notebooks. if we omitted @unit = "line"
        referencing wouldn't work any longer :)        
        case element(tei:milestone) return
MRodz's avatar
MRodz committed
74
            let $prev-handshift := $node/preceding::tei:milestone[@unit = "handshift"][1]
75
                return
MRodz's avatar
MRodz committed
76
                if($node/@unit = "handshift" and
77
78
79
                    simpleHelpers:is-hand-valid($tidySimple:valid-hands, $node)) then
                    tidySimple:clear-handshift($node)  
                    
MRodz's avatar
MRodz committed
80
                else if($node/@unit = "handshift") then
81
82
83
84
85
86
87
88
89
90
91
92
93
                    ()
                    
                else if($prev-handshift
                and $node/@unit = "line" 
                and not(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $prev-handshift))) then
                    tidySimple:copy-element($node, "post")
                
                else if($prev-handshift
                and not(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $prev-handshift))) then
                    ()
                
                else
                    tidySimple:copy-element($node, "post")
94
95
                
        default return
MRodz's avatar
MRodz committed
96
            let $prev-handshift := $node/preceding::tei:milestone[@unit = "handshift"][1]
97
98
99
100
101
102
            return
                if($prev-handshift
                and not(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $prev-handshift))) then
                    ()
                else
                    tidySimple:copy-element($node, "post")
103
104
105
};


106
declare function tidySimple:sort-out-surplus-elements($nodes as node()*) 
107
108
109
110
111
112
as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            $node
        
113
        case element(tei:milestone) return
MRodz's avatar
MRodz committed
114
            if($node/@unit = "handshift") then
115
116
117
118
119
                if(simpleHelpers:is-prev-hand-same($node)
                or not(tidySimple:has-hand-text($node))) then
                    ()
                else
                    tidySimple:clear-handshift($node)
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
                    
            else if($node/@unit = "line") then
                let $next-pb := $node/following::tei:pb[1]
                let $nodes-on-page := $node/preceding::tei:pb[1]/following::node()[. << $next-pb][functx:node-kind(.) = "text"]
                let $contains-text :=
                    for $node-pb in $nodes-on-page return
                        if(normalize-space($node-pb) != "") then
                            true()
                        else 
                            false()
                return
                    if(functx:is-value-in-sequence(true(), $contains-text)) then
                        element {QName("http://www.tei-c.org/ns/1.0", $node/name())} {
                            $node/@*,
                            tidySimple:sort-out-surplus-elements($node/node())
                        }
                    else
                        ()
                
139
            else
140
141
                element {QName("http://www.tei-c.org/ns/1.0", $node/name())} {
                    $node/@*,
142
                    tidySimple:sort-out-surplus-elements($node/node())
143
                }                
144
145
                
        default return
146
147
            element {QName("http://www.tei-c.org/ns/1.0", $node/name())} {
                $node/@*,
148
                tidySimple:sort-out-surplus-elements($node/node())
149
            }
150
151
};

152
declare function tidySimple:has-hand-text($node as element(tei:milestone))
153
as xs:boolean {
MRodz's avatar
MRodz committed
154
    let $next-handshift := $node/following::tei:milestone[@unit = "handshift"][1]
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
    let $nodes-between := $node/following::node()[. << $next-handshift]
    let $is-text-node :=
        for $node-between in $nodes-between
        return 
            if ($node-between[self::text()]
            and not(normalize-space($node-between) = "")) then
                true()
            else
                false()
    return 
        if($next-handshift 
        and functx:is-value-in-sequence(true(), $is-text-node)) then
            true()
        else if(not($next-handshift)) then
            true()
        else
            false()
};

MRodz's avatar
MRodz committed
174

175
declare function tidySimple:copy-element($node as node(), $flag as xs:string)
176
 {
177
178
    element {QName("http://www.tei-c.org/ns/1.0", $node/name())}{
        $node/@*,
179
180
        if($flag = "structure") then
            tidySimple:make-structure($node/node())
181
182
183
184
        else if($flag = "post") then
            tidySimple:sort-out-invalid-hands($node/node())        
        else if($flag = "surplus") then
            tidySimple:sort-out-invalid-hands($node/node())
185
186
        else
            tidySimple:tidy($node/node())
187
188
189
    }
};

190
(:~
MRodz's avatar
MRodz committed
191
 : Purges surplus attributes from tei:milestone[@unit = "handshift"].
192
193
 : 
 : @author Michelle Rodzis
MRodz's avatar
MRodz committed
194
195
 : @param $node the current tei:milestone[@unit = "handshift"]
 : @return the purged tei:milestone[@unit = "handshift"]
196
 :  :)
197
198
199
declare function tidySimple:clear-handshift($node as element(tei:milestone))
as element(tei:milestone) {
    element tei:milestone {
MRodz's avatar
MRodz committed
200
        attribute unit {"handshift"},
201
        if($node/@subtype = "") then
202
203
            ()
        else
204
205
            $node/@subtype,
        if($node/@rend = "") then
206
207
            ()
        else
208
            $node/@rend
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
(:~ 
 : 
 :  :)
declare function tidySimple:make-structure($nodes as node()*) as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            if(tidySimple:is-in-section($node)) then
                ()
            else
                $node
                
        case element(tei:milestone) return 
            if($node/@unit = "section") then
                tidySimple:make-section($node)
                
            else if($node/@unit = "paragraph") then
                tidySimple:copy-element($node, "structure")
            
            (: lines in sections have to be ignored since they are copied into 
            the section with get-section-chunk :)    
            else if($node/@unit = "line"
            and tidySimple:is-in-section($node)) then
                ()
            else
                tidySimple:copy-element($node, "structure")
                
        case element(tei:anchor) return
            if (matches($node/preceding::tei:milestone/@spanTo, $node/@xml:id)) then
                ()
            else
                tidySimple:copy-element($node, "structure")
                
        default return 
            if(tidySimple:is-in-section($node)) then
                ()
            else
                tidySimple:copy-element($node, "structure")
};
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
(:~
 : Checks if a given node is between a tei:milestone[@unit = "section"] and its
 : corresponing tei:anchor.
 : 
 : @author Michelle Rodzis
 : @param the current node
 : @return xs:boolean
 :  :)
declare function tidySimple:is-in-section($node as node()) as xs:boolean {
    let $prev-section-marker := $node/preceding::tei:milestone[1][@spanTo]
    let $target-id := replace($prev-section-marker, "#", "")
    let $next-anchor := $node/following::tei:anchor[matches(@xml:id, $target-id)]
    return
        if($prev-section-marker 
        and $next-anchor) then
            true()
        else
            false()
};


(:~
 : Creates a tei:div from a given tei:milestone[@unit = "section"] that contains 
 : all elements from a given tei:milestone to its corresponding tei:anchor.
 : 
 : Since the nodes between the current and the target one may also contain 
 : structural information (e.g. tei:milestone[@unit = "paragraph"]), these nodes
 : cannot simply be copied but have to be transformed as well.
 : 
 : @author Michelle Rodzis
 : @param $node the current tei:milestone[@unit = "section"]
 : @return element(tei:div)
 :  :)
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
declare function tidySimple:make-section($node as element(tei:milestone)) 
as element(tei:div) {
    element tei:div {
        attribute type {"section"},
        tidySimple:get-section-chunk($node)
    }
};


(:~
 : Returns all nodes between a tei:milestone[@unit = "section"] and its 
 : corresponding tei:anchor.
 :
 : @author Michelle Rodzis
 : @param the current tei:milestone element
 : @return all nodes between the current element and the respective tei:anchor
 :)
declare function tidySimple:get-section-chunk($node as element(tei:milestone)) 
as node()* {
    let $target-id := substring-after($node/@spanTo, "#")
    let $target := $node/following::tei:anchor[matches(@xml:id, $target-id)]
    return
308
        $node/following-sibling::node()[. << $target]
309
310
311
};


312
313
declare function tidySimple:tidy($nodes as node()*) as node()* {
    ()
314
};