library module: http://transkribusapi.mhdbdb.sbg.ac.at

Table of Contents

• Functions: trapi:getDocuments#1, trapi:getDocument#2, trapi:getDocumentId#1, trapi:getRegionTypes#2, trapi:getTextualAnnotationTags#2, trapi:getTextualAnnotationTagProperties#3, trapi:getTextualAnnotationTagPropertyValues#4, trapi:getPages#2, trapi:getCurrentPage#1, trapi:getPageNumber#1, trapi:getPageRange#1, trapi:getRegion#2, trapi:getRegions#1, trapi:getRegions#2, trapi:getRegionType#1, trapi:getFollowingRegions#2, trapi:getFollowingRegions#3, trapi:getFollowingTextRegions#3, trapi:getPrecedingRegions#2, trapi:getPrecedingRegions#3, trapi:getchapterHeading#3, trapi:getTextRegions#3, trapi:getLines#1, trapi:getLines#2, trapi:getLines#3, trapi:getLines#4, trapi:hasRegionType#2, trapi:parseTranskribusCustomAttribute#1, trapi:replaceTranskribusEscapedEntities#1, trapi:_getTextMetadata#4, trapi:_getTextData#4, trapi:getDocumentsJSON#1, trapi:getDocumentJSON#2, trapi:getTextsJSON#5, trapi:getTextJSON#5

Functions

trapi:getDocuments#1

trapi:getDocuments($db as xs:string?
) as element()*

Params

• $db as xs:string?

Returns

• element()*

trapi:getDocument#2

trapi:getDocument($db as xs:string?, $docId as xs:string?
) as element()

Params

• $db as xs:string?

• $docId as xs:string?

Returns

• element()

trapi:getDocumentId#1

trapi:getDocumentId($document as element()
) as xs:string

Params

• $document as element()

Returns

• xs:string

trapi:getRegionTypes#2

trapi:getRegionTypes($db as xs:string?, $docId as xs:string?
) as xs:string*

Params

• $db as xs:string?

• $docId as xs:string?

Returns

• xs:string*

trapi:getTextualAnnotationTags#2

trapi:getTextualAnnotationTags($db as xs:string?, $docId as xs:string?
) as xs:string*

Params

• $db as xs:string?

• $docId as xs:string?

Returns

• xs:string*

trapi:getTextualAnnotationTagProperties#3

trapi:getTextualAnnotationTagProperties($db as xs:string?, $docId as xs:string?, $tag as xs:string
) as xs:string*

Params

• $db as xs:string?

• $docId as xs:string?

• $tag as xs:string

Returns

• xs:string*

trapi:getTextualAnnotationTagPropertyValues#4

trapi:getTextualAnnotationTagPropertyValues($db as xs:string?, $docId as xs:string?, $tag as xs:string, $property as xs:string
) as xs:string*

Params

• $db as xs:string?

• $docId as xs:string?

• $tag as xs:string

• $property as xs:string

Returns

• xs:string*

trapi:getPages#2

trapi:getPages($db as xs:string?, $docId as xs:string?
) as element()*

Params

• $db as xs:string?

• $docId as xs:string?

Returns

• element()*

trapi:getCurrentPage#1

trapi:getCurrentPage($element as element()
) as element()

Params

• $element as element()

Returns

• element()

trapi:getPageNumber#1

trapi:getPageNumber($element as element()
) as xs:string

Params

• $element as element()

Returns

• xs:string

trapi:getPageRange#1

trapi:getPageRange($textRegions as element()*
) as xs:string

Params

• $textRegions as element()*

Returns

• xs:string

trapi:getRegion#2

trapi:getRegion($pages as element()*, $regionId as xs:string
) as element()

Params

• $pages as element()*

• $regionId as xs:string

Returns

• element()

trapi:getRegions#1

trapi:getRegions($pages as element()*
) as element()*

Params

• $pages as element()*

Returns

• element()*

trapi:getRegions#2

trapi:getRegions($pages as element()*, $regionType as xs:string?
) as element()*

Params

• $pages as element()*

• $regionType as xs:string?

Returns

• element()*

trapi:getRegionType#1

trapi:getRegionType($region as element()
) as xs:string?

Params

• $region as element()

Returns

• xs:string?

trapi:getFollowingRegions#2

trapi:getFollowingRegions($pages as element()*, $startRegion as element()
) as element()*

Params

• $pages as element()*

• $startRegion as element()

Returns

• element()*

trapi:getFollowingRegions#3

trapi:getFollowingRegions($pages as element()*, $startRegion as element(), $followingRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()

• $followingRegionType as xs:string?

Returns

• element()*

trapi:getFollowingTextRegions#3

trapi:getFollowingTextRegions($pages as element()*, 
            $startRegion as element(),
            $followingRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()

• $followingRegionType as xs:string?

Returns

• element()*

trapi:getPrecedingRegions#2

trapi:getPrecedingRegions($pages as element()*, $startRegion as element()
) as element()*

Params

• $pages as element()*

• $startRegion as element()

Returns

• element()*

trapi:getPrecedingRegions#3

trapi:getPrecedingRegions($pages as element()*, $startRegion as element(), $precedingRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()

• $precedingRegionType as xs:string?

Returns

• element()*

trapi:getchapterHeading#3

trapi:getchapterHeading($pages as element()*, $startRegion as element(), $chapterRegionType as xs:string
) as xs:string

Params

• $pages as element()*

• $startRegion as element()

• $chapterRegionType as xs:string

Returns

• xs:string

trapi:getTextRegions#3

trapi:getTextRegions($pages as element()*, 
            $startRegion as element(), 
            $followingRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()

• $followingRegionType as xs:string?

Returns

• element()*

trapi:getLines#1

trapi:getLines($elements as element()*
) as element()*

Params

• $elements as element()*

Returns

• element()*

trapi:getLines#2

trapi:getLines($textRegions as element()*,
        $tag as xs:string
) as element()*

Params

• $textRegions as element()*

• $tag as xs:string

Returns

• element()*

trapi:getLines#3

trapi:getLines($textRegions as element()*,
        $tag as xs:string,
        $key as xs:string
) as element()*

Params

• $textRegions as element()*

• $tag as xs:string

• $key as xs:string

Returns

• element()*

trapi:getLines#4

trapi:getLines($textRegions as element()*,
        $tag as xs:string,
        $key as xs:string, 
        $value as xs:string
) as element()*

Params

• $textRegions as element()*

• $tag as xs:string

• $key as xs:string

• $value as xs:string

Returns

• element()*

trapi:hasRegionType#2

trapi:hasRegionType($region as element(), $regionType as xs:string
) as xs:boolean

Params

• $region as element()

• $regionType as xs:string

Returns

• xs:boolean

trapi:parseTranskribusCustomAttribute#1

trapi:parseTranskribusCustomAttribute($custom as xs:string?
) as element()

Params

• $custom as xs:string?

Returns

• element()

trapi:replaceTranskribusEscapedEntities#1

trapi:replaceTranskribusEscapedEntities($string as xs:string?
) as xs:string

Params

• $string as xs:string?

Returns

• xs:string

trapi:_getTextMetadata#4

trapi:_getTextMetadata($pages as element()*, 
        $startRegion as element()?, 
        $followingRegionType as xs:string?, 
        $chapterRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()?

• $followingRegionType as xs:string?

• $chapterRegionType as xs:string?

Returns

• element()*

trapi:_getTextData#4

trapi:_getTextData($pages as element()*, 
        $startRegion as element()?, 
        $followingRegionType as xs:string?, 
        $chapterRegionType as xs:string?
) as element()*

Params

• $pages as element()*

• $startRegion as element()?

• $followingRegionType as xs:string?

• $chapterRegionType as xs:string?

Returns

• element()*

trapi:getDocumentsJSON#1

trapi:getDocumentsJSON($db as xs:string?
) as xs:string

Params

• $db as xs:string?

Returns

• xs:string

trapi:getDocumentJSON#2

trapi:getDocumentJSON($db as xs:string?, $docId as xs:string?
) as xs:string

Params

• $db as xs:string?

• $docId as xs:string?

Returns

• xs:string

trapi:getTextsJSON#5

trapi:getTextsJSON($db as xs:string?, 
        $docId as xs:string?, 
        $startRegionType as xs:string?, 
        $followingRegionType as xs:string?, 
        $chapterRegionType as xs:string?
) as xs:string

Params

• $db as xs:string?

• $docId as xs:string?

• $startRegionType as xs:string?

• $followingRegionType as xs:string?

• $chapterRegionType as xs:string?

Returns

• xs:string

trapi:getTextJSON#5

trapi:getTextJSON($db as xs:string?, 
        $docId as xs:string?, 
        $startRegionId as xs:string?, 
        $followingRegionType as xs:string?, 
        $chapterRegionType as xs:string?
) as xs:string

Params

• $db as xs:string?

• $docId as xs:string?

• $startRegionId as xs:string?

• $followingRegionType as xs:string?

• $chapterRegionType as xs:string?

Returns

• xs:string

Generated by xquerydoc