identification.xqm

xquery version "3.0";
(:~
 : IDENTIFICATION Module ("ident", "http://bdn.edition.de/intermediate_format/identification")
 : *******************************************************************************************
 : This module defines functions and variables to set reading markers in tei:lem or tei:rdg elements.
 : The problem it solves is to identify non-Blocklevel-elements self not containing Blocklevel-elements
 : on their first or last decendants path to set textcritical markers required in the printed version of a
 : BdN digital edition.
 :
 : The basic idea is constructing some kind of left- and right-branch AXIS for reading nodes (tei:lem and tei:rdg) describing
 : a save axis of non-Blocklevel nodes (non-BLE) self not including BLEs on their own left- or right-branch AXIS down the tree.
 :
 : It includes the helping module "markerset" holding helper functions to collect and construct reading markers

 : @version 2.0 (2018-01-29)
 : @note This new versions identification algorithm is more flexible and much more configurable as in the old version 1
 : @status working
 : @author Uwe Sikora
 :)
module namespace ident="http://bdn-edition.de/intermediate_format/identification";
import module namespace markerset = "http://bdn-edition.de/intermediate_format/markerset" at "markerset.xqm";

declare default element namespace "http://www.tei-c.org/ns/1.0";


(:############################# Modules Variables #############################:)

(:~
 : ident:blocklevel-elements
 : Variable defining Blocklevel Elements (BLE) by name
 :
 : @version 2.0 (2018-01-29)
 : @author Uwe Sikora
 :)
declare variable $ident:blocklevel-elements := ('titlePage', 'titlePart', 'aligned', 'div', 'list', 'item', 'table', 'row', 'cell', 'head', 'p', 'note');

(:~
 : ident:apparatus
 : Variable defining Apparatus Elements by name
 :
 : @version 1.0 (2018-02-05)
 : @author Uwe Sikora
 :)
declare variable $ident:apparatus := ('app');

(:~
 : ident:apparatus-readings
 : Variable defining Apparatus-Child Elements by name
 :
 : @version 1.0 (2018-02-05)
 : @author Uwe Sikora
 :)
declare variable $ident:apparatus-readings := ('lem', 'rdg');

(:############################# Modules Functions #############################:)

(:~
 : ident:in-sequence()
 : This function checks if nodes are includes in a sequence of nodes
 :
 : @param $values the nodes to check against the sequence
 : @param $sequence a sequence of AtomicTypes
 : @return xs:boolean ('true' else 'false')
 :
 : @version 2.0 (2018-01-29)
 : @status working
 : @author Uwe Sikora
 :)
declare function ident:in-sequence
    ( $values as xs:anyAtomicType* , $sequence as xs:anyAtomicType* ) as xs:boolean {