tidysimple.xqm 6.67 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
22
23
import module namespace console="http://exist-db.org/xquery/console";
import module namespace simpleHelpers="http://fontane-nb.dariah.eu/teisimplehelpers" at "teisimplehelpers.xqm";

MRodz's avatar
MRodz committed
24

25
declare variable $tidySimple:valid-hands :=
26
27
(:    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
28
29
30
31
    return
        $res//tei:handNote[@script = "contemporary"]/@xml:id/string();


MRodz's avatar
MRodz committed
32
declare function tidySimple:main($tei as node()*) as xs:string* {
33
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."))
    }
    let $text := $doc//tei:text
40
41
42
    let $clear-invalid-hands := tidySimple:sort-out-invalid-hands($text)
    let $clear-surplus-hands := tidySimple:sort-out-surplus-hands($clear-invalid-hands)
    let $text-with-sections := tidySimple:make-structure($clear-surplus-hands)
43
44
45
46
47
48
49
50
51
52
53
    let $store := xmldb:store("/db/apps/SADE/resources/xml/", "tei-simple-tmp.xml", <div>{$text-with-sections}</div>)
    return ""
(:    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
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
declare function tidySimple:sort-out-invalid-hands($nodes as node()*) 
as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            $node
        
        case element(tei:handShift) return
            if(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $node)) then
                tidySimple:copy-element($node, "post")
            else
                ()
                
        default return
            tidySimple:copy-element($node, "post")
};


declare function tidySimple:sort-out-surplus-hands($nodes as node()*) 
as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            $node
        
        case element(tei:handShift) return
            if(simpleHelpers:is-prev-hand-same($node)) then
                ()
            else
                tidySimple:copy-element($node, "surplus")
                
        default return
            tidySimple:copy-element($node, "surplus")
};

MRodz's avatar
MRodz committed
91
92
93
94
95
96

declare function tidySimple:tidy($nodes as node()*) as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            $node
97
            
MRodz's avatar
MRodz committed
98
        case element(tei:handShift) return
99
100
            if(simpleHelpers:is-hand-valid($tidySimple:valid-hands, $node)
            and not(simpleHelpers:is-prev-valid-hand-same($tidySimple:valid-hands, $node))) then
101
                tidySimple:clear-handshift($node)
MRodz's avatar
MRodz committed
102
103
            else
                ()
104
                
MRodz's avatar
MRodz committed
105
        default return
106
            if(simpleHelpers:belongs-to-valid-hand($tidySimple:valid-hands, $node)) then
107
108
109
110
111
112
113
114
115
116
117
118
119
120
                tidySimple:copy-element($node, "tidy")
            else
                ()
};

declare function tidySimple:make-structure($nodes as node()*) as node()* {
    for $node in $nodes return
        typeswitch ($node)
        case text() return
            $node
                
        case element(tei:milestone) return
            if($node/@unit = "section") then
                tidySimple:make-section($node)
121
            else
122
123
124
125
                tidySimple:make-paragraph($node)
                
        default return
            if($node[preceding::tei:milestone]) then
126
                ()
127
128
            else
                tidySimple:copy-element($node, "structure")
129
130
131
};


132
declare function tidySimple:copy-element($node as node(), $flag as xs:string)
133
134
135
as node() {
    element {QName("http://www.tei-c.org/ns/1.0", $node/name())}{
        $node/@*,
136
137
        if($flag = "structure") then
            tidySimple:make-structure($node/node())
138
139
140
141
        else if($flag = "post") then
            tidySimple:sort-out-invalid-hands($node/node())        
        else if($flag = "surplus") then
            tidySimple:sort-out-invalid-hands($node/node())
142
143
        else
            tidySimple:tidy($node/node())
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    }
};


declare function tidySimple:clear-handshift($node as element(tei:handShift))
as element(tei:handShift) {
    element tei:handShift {
        if($node/@new = "") then
            ()
        else
            $node/@new,
        if($node/@script = "") then
            ()
        else
            $node/@script,
        if($node/@medium = "") then
            ()
        else
            $node/@medium
    }
};
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



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
        $node/following::*[. << $target]
};


declare function tidySimple:make-paragraph($node as element(tei:milestone)) 
as element(tei:p) {
    element tei:p {
        tidySimple:get-paragraph-chunk($node)
    }
};


(:~
 : Returns all nodes between a tei:milestone[@unit = "paragraph"] and the next
 : one.
 :
 : @author Michelle Rodzis
 : @param the current tei:milestone element
 : @return all nodes between the current element and the next tei:milestone[@unit = "paragraph"]
 :)
declare function tidySimple:get-paragraph-chunk($node as element(tei:milestone)) 
as node()* {
    let $target := $node/following::tei:milestone[@unit = "paragraph"]
    return
        $node/following::*[. << $target]
};