Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first draft for a TEI with RDFa exemplar #2431

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

first draft for a TEI with RDFa exemplar #2431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13ebecb
first draft for a TEI with RDFa exemplar
peterstadler Jul 1, 2020
3fc6e8b
completed the rdfa exemplar with @martinascholger
HelenaSabel Oct 18, 2024
d9b67fe
created a small sample file for rdfa
HelenaSabel Oct 18, 2024
97ad373
add relaxng file for testing purposes
HelenaSabel Oct 18, 2024
b000c35
change example of @content
HelenaSabel Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 227 additions & 0 deletions P5/Exemplars/tei_rdfa.odd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
<?xml version="1.0" encoding="UTF-8"?>
<TEI xmlns="http://www.tei-c.org/ns/1.0">
<teiHeader>
<fileDesc>
<titleStmt>
<title>TEI with RDFa</title>
<author>Martina Scholger</author>
<author>Peter Stadler</author>
</titleStmt>
<publicationStmt>
<publisher>TEI Consortium</publisher>
<availability status="free">
<licence target="http://creativecommons.org/licenses/by-sa/3.0/"> Distributed under a
Creative Commons Attribution-ShareAlike 3.0 Unported License </licence>
<licence target="http://www.opensource.org/licenses/BSD-2-Clause">
<p>Copyright 2020 TEI Consortium.</p>
<p>All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:</p>
<list>
<item>Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.</item>
<item>Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.</item>
</list>
<p>This software is provided by the copyright holders and contributors "as is" and any
express or implied warranties, including, but not limited to, the implied warranties
of merchantability and fitness for a particular purpose are disclaimed. In no event
shall the copyright holder or contributors be liable for any direct, indirect,
incidental, special, exemplary, or consequential damages (including, but not limited
to, procurement of substitute goods or services; loss of use, data, or profits; or
business interruption) however caused and on any theory of liability, whether in
contract, strict liability, or tort (including negligence or otherwise) arising in any
way out of the use of this software, even if advised of the possibility of such
damage.</p>
</licence>
<p>TEI material can be licensed differently depending on the use you intend to make of it.
Hence it is made available under both the CC+BY and BSD-2 licences. The CC+BY licence is
generally appropriate for usages which treat TEI content as data or documentation. The
BSD-2 licence is generally appropriate for usage of TEI content in a software
environment. For further information or clarification, please contact the <ref
target="mailto:info@tei-c.org">TEI Consortium</ref>. </p>
</availability>
</publicationStmt>
<sourceDesc>
<p>born digital</p>
</sourceDesc>
</fileDesc>
</teiHeader>
<text>
<body>
<schemaSpec ident="tei_rdfa" start="TEI">
<moduleRef key="tei"/> <!-- required -->
<moduleRef key="header"/> <!-- required -->
<moduleRef key="core"/> <!-- required -->
<moduleRef key="textstructure"/> <!-- required -->
<moduleRef key="gaiji"/>
<moduleRef key="verse"/>
<moduleRef key="drama"/>
<moduleRef key="spoken"/>
<moduleRef key="cmc"/>
<moduleRef key="dictionaries"/>
<moduleRef key="msdescription"/>
<moduleRef key="transcr"/>
<moduleRef key="textcrit"/>
<moduleRef key="namesdates"/>
<moduleRef key="figures"/>
<moduleRef key="corpus"/>
<moduleRef key="linking"/>
<moduleRef key="analysis"/>
<moduleRef key="iso-fs"/>
<moduleRef key="nets"/>
<moduleRef key="certainty"/>
<moduleRef key="tagdocs" except="elementSpec moduleRef schemaSpec" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My instinct is that this should be

<moduleRef key="tagdocs" include="att code eg egXML gi ident tag val"/>

<!--
From the tagdocs module we exclude the three elements that have
a `@prefix` attribute which is both defined locally on
elementSpec, moduleRef, and schemaSpec, as well as by our new
class `att.global.analytic.rdfa`. We argue that these tagdocs elements
are not going to be used in the context where RDFa support is relevant
-->

<classSpec type="atts" ident="att.global.analytic.rdfa" mode="add">
<desc xml:lang="en" versionDate="2020-07-01">provides additional global attributes for
embedding RDF following the RDFa Core 1.1 specification</desc>
<attList>
<attDef mode="add" ident="about">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-about</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a SafeCURIEorCURIEorIRI, used for stating
what the data is about (a 'subject' in RDF terminology)</desc>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should “'subject'” be <term>subject</term>?

<datatype>
<dataRef key="teidata.enumerated"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh?
We expect an enumerated list of possible values?

</datatype>
</attDef>
<attDef mode="add" ident="content">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-content</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a CDATA string, for supplying
machine-readable content for a literal (a 'literal object', in RDF
terminology)</desc>
<datatype>
<dataRef key="teidata.text"/>
</datatype>
</attDef>
<attDef mode="add" ident="datatype">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-datatype</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a TERMorCURIEorAbsIRI representing a
datatype, to express the datatype of a literal</desc>
<datatype>
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="href">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@href and @src below are the HTML attributes on <a> and <img>, for example. We shouldn't add them. The RDFa spec is explaining how these built in HTML attributes interact with RDF—namely they can act in the same way as @resource. The corresponding TEI attributes are @target and @url, though there are many, many more attributes in TEI that could potentially interact with RDFa. See https://tei-c.org/release/doc/tei-p5-doc/en/html/ref-teidata.pointer.html for a rather dizzying list.

<gloss xml:lang="en" versionDate="2020-07-01">rdfa-href</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a traditionally navigable IRI for
expressing the partner resource of a relationship (a 'resource object', in RDF
terminology)</desc>
<datatype>
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="inlist">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-inlist</gloss>
<desc xml:lang="en" versionDate="2020-07-01">An attribute used to indicate that the
object associated with a rel or property attribute on the same element is to be
added to the list for that predicate. The value of this attribute MUST be ignored.
Presence of this attribute causes a list to be created if it does not already
exist.</desc>
<datatype>
<dataRef key="teidata.nullOrName"/>
</datatype>
</attDef>
<attDef mode="add" ident="prefix">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prefix probably isn't needed in a TEI context since we can use @xmlns to declare prefixes. Non-XHTML HTML can't, hence the need for the attribute.

<gloss xml:lang="en" versionDate="2020-07-01">rdfa-prefix</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a white space separated list of
prefix-name IRI pairs of the form NCName ':' ' '+ xsd:anyURI </desc>
<datatype maxOccurs="unbounded">
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="property">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-property</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a white space separated list of
TERMorCURIEorAbsIRIs, used for expressing relationships between a subject and either
a resource object if given or some literal text (also a 'predicate')</desc>
<datatype maxOccurs="unbounded">
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="rel">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-rel</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a white space separated list of
TERMorCURIEorAbsIRIs, used for expressing relationships between two resources
('predicates' in RDF terminology)</desc>
<datatype maxOccurs="unbounded">
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="resource">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-resource</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a SafeCURIEorCURIEorIRI for expressing
the partner resource of a relationship that is not intended to be navigable (e.g., a
'clickable' link) (also an 'object')</desc>
<datatype>
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="rev">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-rev</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a white space separated list of
TERMorCURIEorAbsIRIs, used for expressing reverse relationships between two
resources (also 'predicates')</desc>
<datatype maxOccurs="unbounded">
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="src">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment on @href above. We shouldn't add this.

<gloss xml:lang="en" versionDate="2020-07-01">rdfa-src</gloss>
<desc xml:lang="en" versionDate="2020-07-01">an IRI for expressing the partner
resource of a relationship when the resource is embedded (also a 'resource
object')</desc>
<datatype>
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="typeof">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-typeof</gloss>
<desc xml:lang="en" versionDate="2020-07-01">a white space separated list of
TERMorCURIEorAbsIRIs that indicate the RDF type(s) to associate with a
subject</desc>
<datatype maxOccurs="unbounded">
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
<attDef mode="add" ident="vocab">
<gloss xml:lang="en" versionDate="2020-07-01">rdfa-vocab</gloss>
<desc xml:lang="en" versionDate="2020-07-01">an IRI that defines the mapping to use
when a TERM is referenced in an attribute value. See General Use of Terms in
Attributes and the section on Vocabulary Expansion.</desc>
<datatype>
<dataRef key="teidata.enumerated"/>
</datatype>
</attDef>
</attList>
</classSpec>

<!--
Hook the new class `att.global.analytic.rdfa` into the existing
class `att.global.analytic`
-->
<classSpec type="atts" ident="att.global.analytic" mode="change">
<classes mode="change">
<memberOf key="att.global.analytic.rdfa" mode="add"/>
</classes>
</classSpec>

<elementSpec ident="citeData" mode="change">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleting @property from <citeData> isn't a viable solution going forward. The attribute on citeData is (almost) precisely the same thing, except that it doesn't play a role in defining a proper triple (it specifies how to use the document to construct triples). Do these attributes have to be absolutely global? Can we simply override the definition in this case, as we do in various places with @type, for example. I feel like some thinking about the scope of RDFa in TEI might be worthwhile.

<desc>We delete the attribute @property from this element (A URI indicating a property definition) so as avoid
a double definition with the same attribute in our new class att.global.analytic.rdfa</desc>
<attList>
<attDef ident="property" mode="delete"/>
</attList>
</elementSpec>
</schemaSpec>
</body>
</text>
</TEI>
Loading