diff --git a/README.md b/README.md index eb4624d4f6f9d201333f4ebf47c2e5a31aa9eade..16c70c1bef82bd38e9d3f516d49a7eb36583a712 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,37 @@ Scripts to convert bdn-TEI into an intermediate-format dealing with reading mark ## rest/intermediate_function.xql - This is the REST script running the conversion on a given document within eXist-DB - - place it in your app somewhere or as suggested here in a subfolder /rest + - place it in your app somewhere or as suggested here in a subfolder /rest -# running the conversion - - call intermediate_format.xql via REST with the GET-Parameter "path" - - "path" must be a XML-URI existing in your app context (There is no exitence check yet) +# Running the conversion + - call intermediate_format.xql via REST with the GET-Parameter "path" (exemplary call: "http://localhost:8080/exist/rest/apps/YOUR_APP/rest/intermediate_format.xql?path=/db/apps/bdn/data/samples/griesbach_full.xml") + - "path" must be a XML-URI existing in your app context (There is no existence-check yet) - wait -# Sample call -http://localhost:8080/exist/rest/apps/YOUR_APP/rest/intermediate_format.xql?path=/db/apps/bdn/data/samples/griesbach_full.xml +# Changes of the Intermediate Format + - note: All changes are done (not quite right) in the tei-namespace! + +## "editorialNotes Section" + - Section as last child of tei:TEI where all note[@type="editorial"] are collected during the preprocessing. Every note[@type="editorial"] is thus ignored in its original context + +## "aligned" + - new element; all tei:hi[@rend ="right-aligned" or @rend="center-aligned"] are converted to aligned[@rend ="right-aligned" or @rend="center-aligned"] + - name: "aligned", + - attributes: same as tei:hi in original data + +## "seg[@type='item' or @type='head' or @type='row']" vs tei:item or tei:head or tei:row + - conversion of seg[@type='item' or @type=''head or @type='row'] into tei:item or tei:head or tei:row + +## "rdgMarker" + - new element representing Siglae + - name: "rdgMarker" + - attributes: @wit(Witness without '#'), @ref(Reference to @id of tei:lem or tei:rdg without '#'), @type(same as tei:rdg), @mark('open' or 'close'), @context(Context of the Marker - "rdg" or "lem") + +## "tei:rdg" or "tei:lem" + - new attribute: @id(generated id during the preprocessing, serving as referenced id by the rdgMarkers) + +## "tei:pb[@break="no"]" + - new attribute: @break="no"(In cases a tei:pb is directly preceeded or followed by a character not self whitespace) + +## text() and whitespace + - All whitespaces in text() are replaced by NON-BREAKING SPACE (U+00A0,  ) to save whitespace during the processing