XQuery Function Documentation

This library module contains XQSuite tests for the documentation app.

version	1.0.0
author	eXist-db

tests:equal-listing#2

tests:equal-listing($path1 as xs:string, $path2 as xs:string) as xs:boolean

Check if two listings that should be identical actually are. Txt and xml listings cannot be easily displayed via <xref> or xinclude so unfortunately this is necessary, to avoid conflicting information.

Parameters:

$path1
$path2

Returns:

xs:boolean : true (hopefully)

tests:missing-id#0

tests:missing-id() as item()*

see if all sections have an ID (now inforced via schema)

Returns:: item()* : empty-sequence otherwise name of document with faulty section

tests:no-ecaped-listings#0

tests:no-ecaped-listings() as item()*

Make sure that programlistings for xml do not contain string contents use <tag> for short snippets, listing-x.xml files for trees.

Returns:: item()* : empty-sequence or name of document with faulty listing

tests:no-txt-xmls#0

tests:no-txt-xmls() as item()*

Check if listings marked as xml are well-formed and stored as xml. While it is sometimes necessary to store xml as txt that is not well : formed, limiting this to when necessary helps us keep examples valid.

Returns:: item()*

tests:orphan-listing#0

tests:orphan-listing() as item()*

Run the diagnose listings page and see if there are new Errors

Returns:: item()* : empty-sequence, otherwise name of listing and parent collection

tests:toc-inline#0

tests:toc-inline() as item()*

See if ToC rendering is WAI

Returns:: item()*