CETEIcean 1.9.4 → 1.9.5

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "cSpell.words": [
+    "Ordinality",
+    "prefixdef"
+  ]
+}

package/TEI-CE_specification.md

@@ -0,0 +1,86 @@
+# TEI Custom Elements Specification and Contract
+
+When CETEIcean processes a TEI document, the document structures will by default be converted as follows:
+
+## Elements
+
+All tag names will be converted into [prefix]-[lowercased tagname]. The prefix can be defined in a behaviors object. There must be one prefix defined per XML namespace. There are three predefined prefixes:
+
+```js
+  "namespaces": {
+    "tei": "http://www.tei-c.org/ns/1.0",
+    "teieg": "http://www.tei-c.org/ns/Examples",
+    "rng": "http://relaxng.org/ns/structure/1.0"  
+  }   
+```
+
+These prefixes can be remapped in the behaviors object passed to CETEIcean.
+
+### CETEIcean-created Elements
+
+CETEIcean may add the following elements to markup it processes:
+
+* `<cetei-content>`: holds any content returned from a behavior function call.
+* `<cetei-original`: wraps any original content that has been hidden and replaced by the result of a behavior function call.
+
+## Attributes
+
+CETEIcean adds a number of data attributes when it processes an XML element:
+
+* `@data-origname`: contains the original tag name with whatever upper- or lowercasing it used. The HTML DOM normalizes tag names to uppercase.
+* `@data-origatts`: contains a list of attribute names on the element before it was processed with whatever upper- or lowercasing they used. The HTML DOM normalizes attribute names to lowercase.
+* `@data-processed`: a flag CETEIcean uses to determine whether elements have had behaviors applied. Normally, this will happen upon insertion into the browser DOM.
+* `@data-empty`: a flag CETEIcean uses to mark empty elements (these may not remain empty after behaviors have been applied).
+
+### Automatically Converted Attributes
+
+* `@xml:id` is preserved and the value copied to `@id`.
+* `@xml:lang` is preserved and the value copied to `@lang`.
+* `@xmlns` is removed and its value copied to `@data-xmlns`.
+* `@rendition` is preserved and its value copied to `@class`.
+
+## Processing Instructions and Comments
+
+PIs and comments are copied over into the result, so, for example, `<?xml-model?>` PIs pointing to a schema will be present before the root element of the converted document. The XML declaration, if present, is not a PI, and will not be copied over.
+
+## Document Type Declarations
+
+DTDs are not copied over into the result.
+
+## Contract
+
+If a source XML document has been processed into CETEIcean Custom Elements and is then re-serialized into XML using the `CETEI.utilities` instance method `resetAndSerialize()`, then the result will be logically equivalent to the source, provided that additional processing has not altered the document. Note that custom behaviors have direct access to the DOM, and thus are capable of directly manipulating the document in any way. No guarantees can be made as to the consistency of a serialized document if it has been rearranged, fo example.
+
+This contract means that CETEIcean can be used in conjunction with in-browser editing or annotation tools to produce prospectively valid output XML.
+
+For example, the built-in behavior for TEI `<ref>` is to create an HTML anchor tag with the content being the content of the `<ref>` and the `@href` attribute containing the pointer in the `@target` of the `<ref>` (or the first pointer if there are more than one). Given an element like
+
+```xml
+<ref target="https://github.com/TEIC/TEI/blob/dev/P5/Source/guidelines-en.xml" mimeType="application/tei+xml">guidelines-en.xml</ref>
+```
+
+The structure CETEIcean creates will look like this:
+
+```xml
+<tei-ref target="https://github.com/TEIC/TEI/blob/dev/P5/Source/guidelines-en.xml" mimetype="application/tei+xml" data-origname="ref" data-origatts="target mimeType" data-processed="">
+  <cetei-original hidden="" data-original="">guidelines-en.xml</cetei-original>
+  <a href="https://github.com/TEIC/TEI/blob/dev/P5/Source/guidelines-en.xml">guidelines-en.xml</a>
+</tei-ref>
+```
+
+If this element is loaded into a variable and then passed to the `CETEI.utilities.copyAndReset()` function, the result will be:
+
+```xml
+<tei-ref target="https://github.com/TEIC/TEI/blob/dev/P5/Source/guidelines-en.xml" mimetype="application/tei+xml" data-origname="ref" data-origatts="target mimeType">guidelines-en.xml</tei-ref>
+```
+
+that is, the element as it was after CETEIcean has loaded it, but before it was inserted into the document DOM and had behaviors applied to it.
+
+If this result is then passed to the `CETEI.utilities.serialize()` function, the output is
+
+```xml
+<ref target="https://github.com/TEIC/TEI/blob/dev/P5/Source/guidelines-en.xml" mimeType="application/tei+xml">guidelines-en.xml</ref>
+```
+
+CETEIcean's contract means that 
+

package/dist/CETEI.js

@@ -0,0 +1 @@
+var CETEI=function(){"use strict";var e={namespaces:{tei:"http://www.tei-c.org/ns/1.0",teieg:"http://www.tei-c.org/ns/Examples",rng:"http://relaxng.org/ns/structure/1.0"},tei:{eg:["<pre>","</pre>"],ptr:['<a href="$rw@target">$@target</a>'],ref:[["[target]",['<a href="$rw@target">',"</a>"]]],graphic:function(e){let t=e.ownerDocument.createElement("img");return t.src=this.rw(e.getAttribute("url")),e.hasAttribute("width")&&t.setAttribute("width",e.getAttribute("width")),e.hasAttribute("height")&&t.setAttribute("height",e.getAttribute("height")),t},list:[["[type=gloss]",function(e){const t=e.ownerDocument;let i=t.createElement("dl");for(let n of Array.from(e.children))if(1==n.nodeType){if("tei-label"==n.localName){let e=t.createElement("dt");e.innerHTML=n.innerHTML,i.appendChild(e)}if("tei-item"==n.localName){let e=t.createElement("dd");e.innerHTML=n.innerHTML,i.appendChild(e)}}return i}]],note:[["[place=end]",function(e){const t=e.ownerDocument;this.noteIndex?this.noteIndex++:this.noteIndex=1;let i="_note_"+this.noteIndex,n=t.createElement("a");n.setAttribute("id","src"+i),n.setAttribute("href","#"+i),n.innerHTML=this.noteIndex;let r=t.createElement("sup");r.appendChild(n);let a=t.querySelector("ol.notes");a||(a=t.createElement("ol"),a.setAttribute("class","notes"),this.dom.appendChild(a));let o=t.createElement("li");return o.id=i,o.innerHTML=e.innerHTML,a.appendChild(o),r}],["_",["(",")"]]],teiHeader:function(e){this.hideContent(e,!1)},title:[["tei-titlestmt>tei-title",function(e){const t=e.ownerDocument;let i=t.createElement("title");i.innerHTML=e.innerText,t.querySelector("head").appendChild(i)}]]},teieg:{egXML:function(e){const t=e.ownerDocument;let i=t.createElement("pre"),n=t.createElement("code");i.appendChild(n);let r=this.serialize(e,!0).replace(/</g,"&lt;"),a=r.match(/^[\t ]+/);return a&&(r=r.replace(new RegExp("^"+a[0],"mg"),"")),n.innerHTML=r,i}}};function t(e){const t=e.ownerDocument;let i=e=>{let n;switch(e.nodeType){case 1:n=t.createElement(e.nodeName);break;case 9:n=t.implementation.createDocument();break;case 11:n=t.createDocumentFragment();break;default:n=e.cloneNode(!0)}if(e.attributes)for(let t of Array.from(e.attributes))"data-processed"!==t.name&&n.setAttribute(t.name,t.value);for(let t of Array.from(e.childNodes))if(1==t.nodeType){if(t.hasAttribute("data-original")){for(let e of Array.from(t.childNodes)){let t=n.appendChild(i(e));1===t.nodeType&&t.hasAttribute("data-origid")&&(t.setAttribute("id",t.getAttribute("data-origid")),t.removeAttribute("data-origid"))}return n}t.hasAttribute("data-origname")&&n.appendChild(i(t))}else n.appendChild(t.cloneNode());return n};return i(e)}function i(e){return e.replace(/ .*$/,"")}function n(e){let t=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];const i=e.ownerDocument;if(e.childNodes.length>0){let n=i.createElement("cetei-original");e.appendChild(n),n.setAttribute("hidden",""),n.setAttribute("data-original",""),n.setAttribute("role","none");for(let t of Array.from(e.childNodes))if(t!==n){if(1===t.nodeType){t.setAttribute("data-processed","");for(let e of t.querySelectorAll("*"))e.setAttribute("data-processed","")}n.appendChild(e.removeChild(t))}if(t)for(let e of Array.from(n.querySelectorAll("*")))e.hasAttribute("id")&&(e.setAttribute("data-origid",e.getAttribute("id")),e.removeAttribute("id"))}}function r(e,t,i){let n="";const a=e=>!/[^\t\n\r ]/.test(e);if(9!==e.nodeType&&11!==e.nodeType||(n+='<?xml version="1.0" encoding="UTF-8"?>\n'),!t&&1==e.nodeType){n+="string"==typeof i&&""!==i?"\n"+i+"<":"<",n+=e.getAttribute("data-origname");let t=e.hasAttribute("data-origatts")?e.getAttribute("data-origatts").split(" "):[];for(let i of Array.from(e.attributes))i.name.startsWith("data-")||i.name.startsWith("tei-")||i.name.startsWith("aria-")||["id","lang","class"].includes(i.name)||(n+=" "+t.find((function(e){return e.toLowerCase()==i.name}))+'="'+i.value+'"'),"data-xmlns"==i.name&&(n+=' xmlns="'+i.value+'"'),i.name.startsWith("tei-")&&(n+=" "+t.find((function(e){return e.toLowerCase()==i.name.replace("tei-","")}))+'="'+i.value+'"');e.childNodes.length>0?n+=">":n+="/>"}for(let o of Array.from(e.childNodes))switch(o.nodeType){case 1:n+=r(o,!1,"string"==typeof i?i+"  ":i);break;case 7:n+=`<?${o.nodeName} ${o.nodeValue}?>`,9!==e.nodeType&&11!==e.nodeType||(n+="\n");break;case 8:n+=`\x3c!--${o.nodeValue}--\x3e`,9!==e.nodeType&&11!==e.nodeType||(n+="\n");break;default:if(t&&a(o.nodeValue)&&(n+=o.nodeValue.replace(/^\s*\n/,"")),"string"==typeof i&&a(o.nodeValue))break;n+=o.nodeValue}return!t&&1==e.nodeType&&e.childNodes.length>0&&(n+="string"==typeof i?"\n"+i+"</":"</",n+=e.getAttribute("data-origname")+">"),9!==e.nodeType&&11!==e.nodeType||(n+="\n"),n}function a(e){return e.includes(":"),e.replace(/:/,"-").toLowerCase()}function o(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null,i=arguments.length>2&&void 0!==arguments[2]&&arguments[2];try{window.customElements.define(a(e),class extends HTMLElement{constructor(){super(),this.matches(":defined")||t&&(t.call(this),this.setAttribute("data-processed",""))}connectedCallback(){this.hasAttribute("data-processed")||t&&(t.call(this),this.setAttribute("data-processed",""))}})}catch(t){i&&(console.log(a(e)+" couldn't be registered or is already registered."),console.log(t))}}var s=Object.freeze({__proto__:null,copyAndReset:t,defineCustomElement:o,first:i,getOrdinality:function(e,t){let i=1,n=e;for(;n&&null!==n.previousElementSibling&&(!t||n.previousElementSibling.localName==t)&&(i++,n=n.previousElementSibling,n.previousElementSibling););return i},getPrefixDef:function(e){return this.prefixDefs[e]},hideContent:n,normalizeURI:function(e){return this.rw(this.first(e))},repeat:function(e,t){let i="";for(let n=0;n<t;n++)i+=e;return i},resetAndSerialize:function(e,i,n){return r(t(e),i,n)},resolveURI:function(e){let t=this.prefixDefs[e.substring(0,e.indexOf(":"))];return e.replace(new RegExp(t.matchPattern),t.replacementPattern)},rw:function(e){return e.trim().match(/^(?:http|mailto|file|\/|#).*$/)?e:this.base+i(e.trim())},serialize:r,serializeHTML:function e(t,i,n){let r="";const a=e=>!/[^\t\n\r ]/.test(e);if(!i&&1==t.nodeType){r+="string"==typeof n&&""!==n?"\n"+n+"<":"<",r+=t.nodeName;for(let e of Array.from(t.attributes))r+=" "+e.name+'="'+e.value+'"';r+=">"}for(let o of Array.from(t.childNodes))switch(o.nodeType){case 1:r+=e(o,!1,"string"==typeof n?n+"  ":n);break;case 7:r+=`<?${o.nodeName} ${o.nodeValue}?>`,9!==t.nodeType&&11!==t.nodeType||(r+="\n");break;case 8:r+=`\x3c!--${o.nodeValue}--\x3e`,9!==t.nodeType&&11!==t.nodeType||(r+="\n");break;default:if(i&&a(o.nodeValue)&&(r+=o.nodeValue.replace(/^\s*\n/,"")),"string"==typeof n&&a(o.nodeValue))break;r+=o.nodeValue.replace(/</g,"&lt;")}return["area","base","br","col","embed","hr","img","input","link","meta","param","source","track","wbr"].includes(t.nodeName)||i||1!=t.nodeType||(r+="string"==typeof n?`\n${n}</`:"</",r+=`${t.nodeName}>`),9!==t.nodeType&&11!==t.nodeType||(r+="\n"),r},tagName:a,unEscapeEntities:function(e){return e.replace(/&gt;/,">").replace(/&quot;/,'"').replace(/&apos;/,"'").replace(/&amp;/,"&")}});function l(e){if(e.namespaces)for(let t of Object.keys(e.namespaces))this.namespaces.has(e.namespaces[t])||Array.from(this.namespaces.values()).includes(t)||this.namespaces.set(e.namespaces[t],t);for(let t of this.namespaces.values())if(e[t])for(let i of Object.keys(e[t]))this.behaviors[`${t}:${i}`]=e[t][i];if(e.functions)for(let t of Object.keys(e.functions))this.utilities[t]=e.functions[t].bind(this.utilities);e.handlers&&console.log("Behavior handlers are no longer used."),e.fallbacks&&console.log("Fallback behaviors are no longer used.")}function d(e,t,i){let n;if(e===Object(e))for(let t of Object.keys(e))this.namespaces.has(e[t])||(this.namespaces.set(e[t],t),n=t);else n=e;this.behaviors[`${n}:${t}`]=i}function c(e,t){let i;if(e===Object(e))for(let t of Object.keys(e))this.namespaces.has(e[t])||(this.namespaces.set(e[t],t),i=t);else i=e;delete this.behaviors[`${i}:${t}`]}class h{constructor(t){this.options=t||{},this.document=this.options.documentObject?this.options.documentObject:void 0,void 0===this.document&&("undefined"!=typeof window&&window.document?this.document=window.document:"undefined"!=typeof global&&global.document&&(this.document=global.document)),this.addBehaviors=l.bind(this),this.addBehavior=d.bind(this),this.removeBehavior=c.bind(this),this.utilities={};for(const e of Object.keys(s))["getPrefixDef","rw","resolveURI"].includes(e)?this.utilities[e]=s[e].bind(this):this.utilities[e]=s[e];if(this.els=[],this.namespaces=new Map,this.behaviors={},this.hasStyle=!1,this.prefixDefs=[],this.debug=!0===this.options.debug,this.discardContent=!0===this.options.discardContent,this.options.base)this.base=this.options.base;else try{window&&(this.base=window.location.href.replace(/\/[^\/]*$/,"/"))}catch(e){this.base=""}this.options.omitDefaultBehaviors||this.addBehaviors(e),this.options.ignoreFragmentId&&window&&window.removeEventListener("ceteiceanload",h.restorePosition)}async getHTML5(e,t,i){window&&window.location.href.startsWith(this.base)&&e.indexOf("/")>=0&&(this.base=e.replace(/\/[^\/]*$/,"/"));try{const n=await fetch(e);if(n.ok){const e=await n.text();return this.makeHTML5(e,t,i)}console.log(`Could not get XML file ${e}.\nServer returned ${n.status}: ${n.statusText}`)}catch(e){console.log(e)}}makeHTML5(e,t,i){return this.XML_dom=(new DOMParser).parseFromString(e,"text/xml"),this.domToHTML5(this.XML_dom,t,i)}preprocess(e,t,i){this.els=function(e,t){const i=e.documentElement;let n=1,r=function(e){return t.has(e.namespaceURI?e.namespaceURI:"")||t.set(e.namespaceURI,"ns"+n++),t.get(e.namespaceURI?e.namespaceURI:"")+":"+e.localName};const a=new Set(Array.from(i.querySelectorAll("*"),r));return a.add(r(i)),a}(e,this.namespaces);let n=e=>{let t;if(this.namespaces.has(e.namespaceURI?e.namespaceURI:"")){let r=this.namespaces.get(e.namespaceURI?e.namespaceURI:"");t=this.document.createElement(`${r}-${e.localName.toLowerCase()}`)}else t=this.document.importNode(e,!1);for(let a of Array.from(e.attributes))"xmlns"==a.name?t.setAttribute("data-xmlns",a.value):["role"].includes(a.name)||t.setAttribute(a.name,a.value),"xml:id"==a.name&&t.setAttribute("id",a.value),"xml:lang"==a.name&&t.setAttribute("lang",a.value),"rendition"==a.name&&t.setAttribute("class",a.value.replace(/#/g,"")),"role"==a.name&&t.setAttribute("tei-role",a.value);if(t.setAttribute("data-origname",e.localName),e.hasAttributes()&&t.setAttribute("data-origatts",e.getAttributeNames().join(" ")),0==e.childNodes.length&&t.setAttribute("data-empty",""),"head"==e.localName&&"http://www.tei-c.org/ns/1.0"==e.namespaceURI){function o(e){let t=0,i=e.parentElement;for(;i;){let e=i.children,n=0;for(;n<e.length;){if("head"===e[n].tagName.toLowerCase()&&"http://www.tei-c.org/ns/1.0"===e[n].namespaceURI){t++;break}n++}i=i.parentElement}return t}t.setAttribute("data-level",o(e))}if("tagsDecl"==e.localName){let s=this.document.createElement("style");for(let l of Array.from(e.childNodes))if(1==l.nodeType&&"rendition"==l.localName&&"css"==l.getAttribute("scheme")){let d="";l.hasAttribute("selector")?(d+=l.getAttribute("selector").replace(/([^#, >]+\w*)/g,"tei-$1").replace(/#tei-/g,"#")+"{\n",d+=l.textContent):(d+="."+l.getAttribute("xml:id")+"{\n",d+=l.textContent),d+="\n}\n",s.appendChild(this.document.createTextNode(d))}s.childNodes.length>0&&(t.appendChild(s),this.hasStyle=!0)}"prefixDef"==e.localName&&(this.prefixDefs.push(e.getAttribute("ident")),this.prefixDefs[e.getAttribute("ident")]={matchPattern:e.getAttribute("matchPattern"),replacementPattern:e.getAttribute("replacementPattern")}),"TEI"==e.localName&&t.setAttribute("role","main"),["body","front","back","div"].includes(e.localName)&&(t.setAttribute("role","region"),t.setAttribute("aria-label",e.getAttribute("xml:id")||e.getAttribute("n")||e.localName));for(let c of Array.from(e.childNodes))1==c.nodeType?t.appendChild(n(c)):t.appendChild(c.cloneNode());return i&&i(t,e),t};this.dom=this.document.createDocumentFragment();for(let t of Array.from(e.childNodes))1==t.nodeType&&this.dom.appendChild(n(t)),7==t.nodeType&&this.dom.appendChild(this.document.importNode(t,!0)),8==t.nodeType&&this.dom.appendChild(this.document.importNode(t,!0));if(this.utilities.dom=this.dom.firstElementChild,!t)return"undefined"!=typeof window&&window.dispatchEvent(u),this.dom;t(this.dom,this),window&&window.dispatchEvent(u)}domToHTML5(e,t,i){if(this.preprocess(e,null,i),this.applyBehaviors(),this.done=!0,!t)return"undefined"!=typeof window&&window.dispatchEvent(u),this.dom;t(this.dom,this),window&&window.dispatchEvent(u)}processPage(){var e;this.els=(e=this.document,new Set(Array.from(e.querySelectorAll("*[data-origname]"),(e=>e.localName.replace(/(\w+)-.+/,"$1:")+e.getAttribute("data-origname"))))),this.applyBehaviors(),window&&window.dispatchEvent(u)}unsetNamespace(e){this.namespaces.delete(e)}setBaseUrl(e){this.base=e}append(e,t){let i=this;if(!t||t.hasAttribute("data-processed"))return function(){if(!this.hasAttribute("data-processed")){let t=e.call(i.utilities,this);t&&i.appendBasic(this,t)}};{let n=e.call(i.utilities,t);n&&i.appendBasic(t,n)}}appendBasic(e,t){this.discardContent?e.innerHTML="":n(e,!0),e.appendChild(t)}bName(e){return e.tagName.substring(0,e.tagName.indexOf("-")).toLowerCase()+":"+e.getAttribute("data-origname")}childExists(e,t){return!(!e||e.nodeName!=t)||e&&e.nextElementSibling&&this.childExists(e.nextElementSibling,t)}decorator(e){if(Array.isArray(e)&&0==e.length)return function(e){};if(Array.isArray(e)&&!Array.isArray(e[0]))return this.applyDecorator(e);let t=this;return function(i){for(let n of e)if(i.matches(n[0])||"_"===n[0])return Array.isArray(n[1])?t.decorator(n[1]).call(this,i):n[1].call(this,i)}}applyDecorator(e){let t=this;return function(i){let n=[];for(let r=0;r<e.length;r++)n.push(t.template(e[r],i));return t.insert(i,n)}}getFallback(e,t){if(e[t])return e[t]instanceof Function?e[t]:this.decorator(e[t])}getHandler(e,t){if(e[t])return e[t]instanceof Function?this.append(e[t]):this.append(this.decorator(e[t]))}insert(e,t){let i=this.document.createElement("cetei-content");for(let t of Array.from(e.childNodes))1!==t.nodeType||t.hasAttribute("data-processed")||this.processElement(t);if(t[0].match("<[^>]+>")&&t[1]&&t[1].match("<[^>]+>"))i.innerHTML=t[0]+e.innerHTML+(t[1]?t[1]:"");else{i.innerHTML=t[0],i.setAttribute("data-before",t[0].replace(/<[^>]+>/g,"").length);for(let t of Array.from(e.childNodes))i.appendChild(t.cloneNode(!0));t.length>1&&(i.innerHTML+=t[1],i.setAttribute("data-after",t[1].replace(/<[^>]+>/g,"").length))}return i.childNodes.length<2?i.firstChild:i}processElement(e){if(e.hasAttribute("data-origname")&&!e.hasAttribute("data-processed")){let t=this.getFallback(this.bName(e));t&&(this.append(t,e),e.setAttribute("data-processed",""))}for(let t of Array.from(e.childNodes))1===t.nodeType&&this.processElement(t)}template(e,t){let i=e;if(e.search(/\$(\w*)(@([a-zA-Z:]+))/)){let n,r=/\$(\w*)@([a-zA-Z:]+)/g;for(;n=r.exec(e);)i=t.hasAttribute(n[2])?n[1]&&this.utilities[n[1]]?i.replace(n[0],this.utilities[n[1]](t.getAttribute(n[2]))):i.replace(n[0],t.getAttribute(n[2])):i.replace(n[0],"")}return i}applyBehaviors(){"undefined"!=typeof window&&window.customElements?this.define.call(this,this.els):this.fallback.call(this,this.els)}define(e){for(let t of e){o(t,this.getHandler(this.behaviors,t),this.debug)}}fallback(e){for(let t of e){let e=this.getFallback(this.behaviors,t);if(e)for(let i of Array.from((this.dom&&!this.done?this.dom:this.document).querySelectorAll(a(t))))i.hasAttribute("data-processed")||(this.append(e,i),i.setAttribute("data-processed",""))}}static savePosition(){window.sessionStorage.setItem(window.location+"-scroll",window.scrollY)}static restorePosition(){if(window.location.hash)setTimeout((function(){let e=this.document.querySelector(window.decodeURI(window.location.hash));e&&e.scrollIntoView()}),100);else{let e;(e=window.sessionStorage.getItem(window.location+"-scroll"))&&(window.sessionStorage.removeItem(window.location+"-scroll"),setTimeout((function(){window.scrollTo(0,e)}),100))}}}try{if("undefined"!=typeof window){window.CETEI=h,window.addEventListener("beforeunload",h.savePosition);var u=new Event("ceteiceanload");window.addEventListener("ceteiceanload",h.restorePosition)}}catch(e){console.log(e)}return h}();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "CETEIcean",
-  "version": "1.9.4",
+  "version": "1.9.5",
   "description": "JavaScript library to load a TEI XML document and register it as HTML5 custom elements.",
   "main": "src/CETEI.js",
   "type": "module",

package/src/CETEI.js

@@ -116,7 +116,9 @@ class CETEI {
             //Strip default namespaces, but hang on to the values
             newElement.setAttribute("data-xmlns", att.value);
           } else {
-            newElement.setAttribute(att.name, att.value);
+            if (!["role"].includes(att.name) ){
+              newElement.setAttribute(att.name, att.value);
+            }
           }
           if (att.name == "xml:id") {
             newElement.setAttribute("id", att.value);
@@ -127,6 +129,11 @@ class CETEI {
           if (att.name == "rendition") {
             newElement.setAttribute("class", att.value.replace(/#/g, ""));
           }
+          // @role has a name collision with the HTML5 role attribute, so we
+          // use a TEI-specific attribute instead.
+          if (att.name == "role") {
+            newElement.setAttribute("tei-role", att.value);
+          }
       }
       // Preserve element name so we can use it later
       newElement.setAttribute("data-origname", el.localName);
@@ -190,6 +197,14 @@ class CETEI {
           "replacementPattern": el.getAttribute("replacementPattern")
         };
       }
+      // Aria roles for landmark elements
+      if (el.localName == "TEI") {
+        newElement.setAttribute("role", "main");
+      }
+      if (["body", "front", "back", "div"].includes(el.localName)) {
+        newElement.setAttribute("role", "region");
+        newElement.setAttribute("aria-label", el.getAttribute("xml:id") || el.getAttribute("n") || el.localName);
+      } 
       for (let node of Array.from(el.childNodes)) {
           // Node.ELEMENT_NODE
           if (node.nodeType == 1 ) {

package/src/utilities.js

@@ -82,6 +82,7 @@ export function hideContent(elt, rewriteIds = true) {
     elt.appendChild(hidden);
     hidden.setAttribute("hidden", "");
     hidden.setAttribute("data-original", "");
+    hidden.setAttribute("role", "none");
     for (let node of Array.from(elt.childNodes)) {
       if (node !== hidden) {
         // nodeType 1 is Node.ELEMENT_NODE
@@ -184,12 +185,18 @@ export function serialize(el, stripElt, ws) {
     // HTML5 lowercases all attribute names; @data-origatts contains the original names
     let attrNames = el.hasAttribute("data-origatts") ? el.getAttribute("data-origatts").split(" ") : [];
     for (let attr of Array.from(el.attributes)) {
-      if (!attr.name.startsWith("data-") && !(["id", "lang", "class"].includes(attr.name))) {
+      if (!attr.name.startsWith("data-") 
+        && !attr.name.startsWith("tei-") 
+        && !attr.name.startsWith("aria-")
+        && !(["id", "lang", "class"].includes(attr.name))) {
         str += " " + attrNames.find(function(e) {return e.toLowerCase() == attr.name}) + "=\"" + attr.value + "\"";
       }
       if (attr.name == "data-xmlns") {
         str += " xmlns=\"" + attr.value +"\"";
       }
+      if (attr.name.startsWith("tei-")) {
+        str += " " + attrNames.find(function(e) {return e.toLowerCase() == attr.name.replace("tei-", "")}) + "=\"" + attr.value + "\"";
+      }
     }
     if (el.childNodes.length > 0) {
       str += ">";

package/test/1259.xml

@@ -0,0 +1,285 @@
+<?xml version="1.0" encoding="UTF-8"?><?xml-model href="../../schema/CairoUrbanNews.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0"?><?xml-model href="../../schema/CairoUrbanNews.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?><?xml-stylesheet type="text/css" href="../../css/oxygen.css"?><TEI xmlns="http://www.tei-c.org/ns/1.0">
+  <teiHeader>
+    <fileDesc>
+      <titleStmt>
+        <title>"Digital Cairo - Urbanism News from al-Waqāʾiʿ al-Miṣrīyah - An Ottoman Arabic Digital Humanities
+          Project"</title>
+        <editor xml:id="eNK">Nour Kanaan</editor>
+        <editor xml:id="eAM">Adam Mestyan</editor>
+        <editor xml:id="eDY">Danah Younis</editor>
+        <editor xml:id="eSG">Sarah Fathallah Gaara</editor>
+        <editor xml:id="eAE">Arif Erbil</editor>
+        <editor xml:id="eAK">Ahmed Kamal</editor>
+        <editor xml:id="eAS">Abram Smith</editor>
+        <editor xml:id="eCH">Clara Harms</editor>
+        <editor xml:id="eHS">Hüseyin Sağlam</editor>
+        <editor xml:id="eAT">Abdulrahman El-Taliawi</editor>
+        <editor xml:id="eHL">Hiba Laabadli</editor>
+        <editor xml:id="eOE">Othmane Echchabi</editor>
+        <editor xml:id="eFA">Fatemah Almahana</editor>
+        <editor xml:id="eMZ">Mahmoud Zaki</editor>
+        <editor xml:id="eNS">Nehal al-Shamy</editor>
+        <editor xml:id="eVJ">Vishal Jammulapati</editor>
+        <respStmt>
+          <resp>Project leader</resp>
+          <name>Hugh Cayless</name>
+        </respStmt>
+        <respStmt>
+          <resp>Project leader</resp>
+          <name>Adam Mestyan</name>
+        </respStmt>
+        <respStmt>
+          <resp>Project leader</resp>
+          <name>Mercedes Volait</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Sarah Fathallah Gaara</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Karima Nasr</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Rezk Nory</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Arif Erbil</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Ahmed Kamal</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Abram Smith</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Clara Harms</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Hüseyin Sağlam</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Abdulrahman El-Taliawi</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Hiba Laabadli</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Othmane Echchabi</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Fatemah Almahana</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Mahmoud Zaki</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Nehal al-Shamy</name>
+        </respStmt>
+        <respStmt>
+          <resp>Research Assistant</resp>
+          <name>Vishal Jammulapati</name>
+        </respStmt>
+        <sponsor>
+          <orgName>National Endowment for the Humanities</orgName>, <orgName>Institut français
+            d’archéologie orientale</orgName> (Ifao, Cairo); <orgName>Franklin Humanities Institute
+            and the Office of Global Affairs / Andrew W. Mellon Endowment for Global Studies, Duke
+            University</orgName>; <orgName>Duke University Libraries</orgName>; <orgName>Centre
+            national de la recherche scientifique</orgName>; <orgName>the Office of the Hungarian
+            Cultural Counsellor in Cairo</orgName>. </sponsor>
+      </titleStmt>
+      <publicationStmt>
+ <p>"XMl TEI Edition of Urbanism News in al-Waqāʾiʿ al-Miṣrīyah" in the project "La fabrique
+          du Caire moderne, 2018-2021" (Ifao-InVisu-Duke University).</p>
+        <p>"Digital Cairo" project sponsored by the National Endowment for the Humanities.</p>
+        <p>
+          <ref target="https://sites.duke.edu/cairemoderne/">Website</ref>
+        </p>
+        <p>Project directors: <persName>Adam Mestyan</persName>, <persName>Mercedes
+            Volait</persName>, <persName>Hugh Cayless</persName></p>
+      </publicationStmt>
+      <sourceDesc>
+        <p>Al-Waqāʾiʿ al-Miṣrīyah (Egyptian Affairs) newspaper, 1828–1914.</p>
+        <p>born digital document</p>
+      </sourceDesc>
+    </fileDesc>
+    <encodingDesc>
+      <projectDesc>
+        <p>This is a file in the "XMl TEI Edition of Urbanism News in al-Waqāʾiʿ al-Miṣrīyah" in the
+          project "La fabrique du Caire moderne, 2018-2021" (Ifao-InVisu-Duke University).</p>
+        <p>"Digital Cairo" project sponsored by the National Endowment for the Humanities.</p>
+      </projectDesc>
+      <editorialDecl>
+        <p>Rules of TEI XML MarkUp in This Project</p>
+        <p>We use the Arabic script but transliteration into Latin characters follows the Library of
+          Congress (LOC) <ref target="https://www.loc.gov/catdir/cpso/romanization/arabic.pdf">Arabic transliteration chart</ref>.</p>
+        <p>Each individual article has an individual xml:id number starting with "w1"</p>
+        <p>We only use persName, orgName, placeName elements, apart from bibliographical elements
+          and notes.</p>
+        <p>If the location or organization of responsibility is known from the text, it can be added
+          in an attribute to a persName.</p>
+        <p>"Mashaykhah" and "thumn" are orgNames and placeNames.</p>
+        <p>This project's schema considers Till Grallert's work in his <ref target="https://github.com/OpenArabicPE/OpenArabicPE_ODD">Open Arabic Periodical
+            Editions</ref>.</p>
+      </editorialDecl>
+      <charDecl>
+        <char xml:id="qhalf">
+          <localProp value="QIRMA FRACTION 1/2" name="name"/>
+          <unicodeProp value="1/2" name="Numeric_Value"/>
+          <mapping type="similar">𐋢</mapping>
+          <figure>
+            <graphic url="../../docs/images/qhalf.svg"/>
+          </figure>
+        </char>
+        <char xml:id="qthird">
+          <localProp value="QIRMA FRACTION 1/3" name="name"/>
+          <unicodeProp value="1/3" name="Numeric_Value"/>
+          <figure>
+            <graphic url="../../docs/images/qthird.svg"/>
+          </figure>
+        </char>
+        <char xml:id="qfourth">
+          <localProp value="QIRMA FRACTION 1/4" name="name"/>
+          <unicodeProp value="1/4" name="Numeric_Value"/>
+          <figure>
+            <graphic url="../../docs/images/qfourth.svg"/>
+          </figure>
+        </char>
+        <char xml:id="qsixth">
+          <localProp value="QIRMA FRACTION 1/6" name="name"/>
+          <unicodeProp value="1/6" name="Numeric_Value"/>
+          <figure>
+            <graphic url="../../docs/images/qsixth.svg"/>
+          </figure>
+        </char>
+        <char xml:id="qeighth">
+          <localProp value="QIRMA FRACTION 1/8" name="name"/>
+          <unicodeProp value="1/8" name="Numeric_Value"/>
+          <mapping type="similar">𐋤</mapping>
+          <figure>
+            <graphic url="../../docs/images/qeighth.svg"/>
+          </figure>
+        </char>
+        <char xml:id="qtwothirds">
+          <localProp value="QIRMA FRACTION 2/3" name="name"/>
+          <unicodeProp value="2/3" name="Numeric_Value"/>
+          <figure>
+            <graphic url="../../docs/images/qtwothirds.svg"/>
+          </figure>
+        </char>
+      </charDecl>
+      <refsDecl>
+        <citeStructure unit="article" match="//body/div" use="@xml:id">
+          <citeData property="http://purl.org/dc/terms/title" use="head[1]"/>
+          <citeData property="#function" use='split'/>
+        </citeStructure>
+      </refsDecl>
+    </encodingDesc>
+    <profileDesc>
+      <langUsage>
+        <language ident="ar">Arabic</language>
+        <language ident="en">English</language>
+        <language ident="ar-Latn-x-ala-LC">Arabic transcribed according to ALA-LC</language>
+        <language ident="ota">Ottoman</language>
+      </langUsage>
+      
+    </profileDesc>
+    <revisionDesc status="cleared">
+      <listChange>
+        <change resp="#eAM" when="2023-06-16" status="cleared"/>
+      </listChange>
+    </revisionDesc>
+  </teiHeader>
+  
+  <text xml:lang="ar">
+      <body>
+         <div xml:id="WA1259062401" resp="#eNK #eSG">
+        <head><date when-custom="1259-04-22">٢٢ ربيع الثاني <choice>
+              <sic>١٢٥٨</sic>
+              <corr>١٢٥٩</corr>
+            </choice></date>
+          <date when="1843-05-21">٢١ مايو ١٨٤٣</date>
+          <bibl><biblScope unit="issue">نمرة ٦٢٤</biblScope>
+            <biblScope unit="page">صفحة ٦</biblScope></bibl></head>
+        <head>فوايد مختلفة</head>
+        <p>قد تولى <persName role="شيخ طائفة الصعائدة">العلامة السيد احمد القيصاوى الصعيدى شيخا على
+            طائفة الصعائدة</persName> عوضا عن المرحوم <persName type=" شيخ-على-طائفة-الصعائدة">الشيخ
+            عبد الله القاضى</persName> فى هذا الخصوص بداعى ان الشيخ المذكور صعيدى وشيخ المالكية
+          المتولى الان بحيرى وقد جرت العادة انه بعد اتحاف شيخ المذهب <sic>بفرو سمور</sic> من الخديوى
+          وبفرو من حضرة شيخ الجامع قبل ذلك ينزل حالا الى <placeName xml:id="place-WA1259062401_01" type="بيت" ref="بيت-حضرة-نقيب-الاشراف">بيت حضرة نقيب الاشراف</placeName> وحضرة شيخ السادات الوفائية
+          فيتحف عند كل منهما بفرو سمور وقد حصل ذلك <persName>للشيخ الحبيشى</persName> ثم بعد ذلك
+          يطوف ببيوت الاعيان الذين لهم عادة الاتحاف المذكور فيكسوه كل على حسب مقامه وكذلك مشايخ
+          الاروقة الكبيرة فلبس شيخ المالكية المذكور زيادة على ذلك صوفا من عند حضرة قاضى الاسلام
+          وفروا من حضرة بركة وقته <persName>الشيخ الجوهرى</persName> وفروا من حفيد العلامة القويسنى
+          وفرجية جوخ من <persName role="مفتى السادة الحنفية">حضرة الشيخ التميمى مفتى السادة
+            الحنفية</persName> وشالا كشميريا من <persName>حضرة مصطفى باشا العروسى</persName> وفرجية
+          من عند <persName>الشيخ عبد الفتاح العنانى</persName> وكذلك لبس من عند <persName>السيد حنفى
+            مكرم</persName> وغيره من اصحاب العادات وكل من هؤلاء المذكورين اتحف <persName role="شيخ رواق الصعائدة">السيد القيصاوى شيخ رواق الصعائدة</persName>
+          <sic>بفرحية</sic> ومن جملتهم <persName>الشيخ محمد الحبيشى</persName> نفسه فقد كساه كما
+          كساه غيره واجاز من مدحه من الشعراء.</p>
+      </div>
+         <div xml:id="WA1259062402" resp="#eNK #eSG" n="RIZQA">
+        <head><date when-custom="1259-04-22">٢٢ ربيع الثاني <choice>
+              <sic>١٢٥٨</sic>
+              <corr>١٢٥٩</corr>
+            </choice></date>
+          <date when="1843-05-21">٢١ مايو ١٨٤٣</date>
+          <bibl><biblScope unit="issue">نمرة ٦٢٤</biblScope>
+            <biblScope unit="page">صفحة ٦</biblScope></bibl></head>
+        <head>اعلانات</head>
+        <p>بيان ما فى الدلالة من العقارات وغيرها</p>
+        <p>احد عشردكانا مسكونة فى <placeName xml:id="place-WA1259062402_01" ref="التربيعة">التربيعة</placeName> بلغت فى الدلالة من
+          القروش ١١٨٠٠</p>
+        <p>تسع دكاكين ب<placeName xml:id="place-WA1259062402_02" ref="العقادين">العقادين البلدى</placeName> بلغت من القروش
+          ٥٣٧٠٠</p>
+        <p><placeName xml:id="place-WA1259062402_03" type="وكالة" ref="وكالة-فى العقادين-البلدى">وكالة فى العقادين
+            البلدى</placeName> فى داخلها دكاكين وحواصل واوض وبيوت وبظهرها خربة بلغت من القروش
+          ٢٠٠٠</p>
+        <p>دكاكين خمسة ب<placeName xml:id="place-WA1259062402_04" type="خط" ref="خط-الوراقين">خط الوراقين</placeName> بلغت من
+          القروش ٧٠٠٠</p>
+        <p>اطيان رزقة بلا مال تعلق <persName>عبد الرحمن بيك</persName> ب<placeName xml:id="place-WA1259062402_05" type="ناحية" ref="ناحيه-سيله-فيوم">ناحية سيله فيوم</placeName> جميعها سواد قدرها مائة فدان وبها من
+          المهمات ثلاثة اقواس ومحراث واحد ومن المواشى ثور واحد بلغت من القروش ٢٠٠٠</p>
+        <p>خمسمائة فدان رزقة بلا مال تعلق البيك المذكور ب<placeName xml:id="place-WA1259062402_06" ref="الفيوم">الفيوم</placeName>
+          بها من المهمات محراثان واربعة عشر قوسا ونورج واحد ومن المواشى اربعة اثوار وحمار واحد بلغت
+          من القروش ١٠٠٠٠٠</p>
+        <p>ثلاثة مساكن تعلق المرحوم <persName>خليل افندى</persName> ووصيه <persName>عارف
+            بيك</persName> ب<placeName xml:id="place-WA1259062402_07" type="درب" ref="الدرب-الاحمر">الدرب الاحمر</placeName> فى
+            <placeName xml:id="place-WA1259062402_08" ref="التبانه">التبانه</placeName> بلغت فى الدلالة من القروش ٤٠٠٠</p>
+        <p>طيان تعلق<persName role="مديرالقليوبية">حسن بيك مدير<placeName xml:id="place-WA1259062402_09" ref="القليوبية">القليوبية</placeName> سابقا</persName> ب<placeName xml:id="place-WA1259062402_10" type="ناحية" ref="ناحية-ميت-العايد">ناحية ميت <choice>
+              <sic>العايد</sic>
+              <corr>القايد</corr>
+            </choice></placeName> ب<placeName xml:id="place-WA1259062402_11" type="اقليم" ref="اقليم-الجيزة">اقليم
+            الجيزة</placeName> رزقة بلا مال قطعة واحدة قدرها مائتان واربعة وعشرون فدانا بلغت فى
+          الدلالة من القروش ٥٠٠٠٠</p>
+        <p>مسكن تعلق المذكور ب<placeName xml:id="place-WA1259062402_12" type="ناحية" ref="ناحية-الجيزة">ناحية الجيزة</placeName>
+          بلغ من القروش ٢١٠٠٠ </p>
+        <p>اطيان تعلق المذكور ب<placeName xml:id="place-WA1259062402_13" type="ناحية" ref="ناحية-الدقى">ناحية الدقى</placeName> من
+            <placeName xml:id="place-WA1259062402_14" type="جهة" ref="جهة-الجيزة">جهة الجيزة</placeName> رزقة بلا مال قدرها <choice>
+            <sic>ابعة</sic>
+            <corr>اربعة</corr>
+          </choice> وعشرون فدانا بلغت من القروش ٣٢٥٠٠ </p>
+        <p>منزل ب<placeName xml:id="place-WA1259062402_15" ref="الجيزة">الجيزة</placeName> تعلق المذكور بلغ فى الدلالة ثمانين الف
+          قرش</p>
+        <p>تسعة دكاكين ب<placeName xml:id="place-WA1259062402_16" type="سوق" ref="سوق الجيزة">سوق الجيزة</placeName> و<placeName xml:id="place-WA1259062402_17" type="طاحونة">طاحونة</placeName> و<placeName xml:id="place-WA1259062402_18" type="فرن">فرن</placeName> و<placeName xml:id="place-WA1259062402_19" type="اصطبل">اصطبل</placeName> كبير بلغت اثنى عشر الف قرش</p>
+        <p>الف وستمائة فدان تعلق المذكور رزقة بلا مال ب<placeName xml:id="place-WA1259062402_20" type="ناحية" ref="ناحية-بوش">ناحية
+            بوش</placeName> بلغت ثلثمائة الف قرش وخمسة وثلاثين الفا</p>
+        <p>منزل ب<placeName xml:id="place-WA1259062402_21" ref="الدرب الاحمر">الدرب الاحمر</placeName> تعلق <persName role="باش جاويش بالديوان الخديوى">اسماعيل اغا باش جاويش ب<orgName type="ديوان" ref="الديوان-الخديوى">الديوان الخديوى</orgName></persName> بلغ فى الدلالة أحدا وثلاثين
+          الف قرش وخمسمائة قرش</p>
+        <p>منزل ب<placeName xml:id="place-WA1259062402_22" ref="الباطلية">الباطلية</placeName> ب<placeName xml:id="place-WA1259062402_23" type="ناحية" ref="ناحية الازهر">ناحية الازهر</placeName> تعلق <persName>الحاج على الاسكندرانى</persName>
+          بلغ من القروش ٦٢٥٠ </p>
+      </div>
+      </body>
+   </text>
+</TEI>