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

Jump to bottom

NVH serialization #33

Merged
merged 1 commit into from
Aug 7, 2023
Merged

NVH serialization #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion dmlex-v1.0/specification/dmlex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@
<listitem>
<para>An RDF serialization of DMLex</para>
</listitem>
<listitem>
<para>An NVH serialization of DMLex</para>
</listitem>
</itemizedlist>
</para>
</abstract>
Expand Down Expand Up @@ -283,7 +286,7 @@
<section id="Introduction">
<title>Introduction</title>
<para>DMLex is a data model for modelling dictionaries (here called <emphasis>lexicographic resources</emphasis>) in computer applications such as dictionary writing systems.</para>
<para>DMLex is a data model, not an encoding format. DMLex is abstract, independent of any markup language or formalism. At the same time, DMLex has been designed to be easily and straightforwardly implementable in XML, JSON, as a relational database, and as a Semantic Web triplestore.</para>
<para>DMLex is a data model, not an encoding format. DMLex is abstract, independent of any markup language or formalism. At the same time, DMLex has been designed to be easily and straightforwardly implementable in XML, JSON, NVH, as a relational database, and as a Semantic Web triplestore.</para>
<section>
<title>Modular structure of DMLex</title>
<para>The DMLex specification is divided into a core with several optional modules.</para>
Expand Down Expand Up @@ -323,6 +326,7 @@
<member><olink targetptr="XML_implementation">XML</olink>,</member>
<member><olink targetptr="JSON_implementation">JSON</olink>,</member>
<member><olink targetptr="RDF_implementation">RDF</olink>,</member>
<member><olink targetptr="NVH_implementation">NVH</olink>,</member>
<member>and <olink targetptr="RDB_implementation">relational databases</olink>.</member>
</simplelist> We also provide an informative serialization as NVH [to link appendix when
available]. </para>
Expand All @@ -337,6 +341,13 @@
Examples of what the two serializations look like with real-world data are given in <xref linkend="examples"/>.
</para>
</listitem>
<listitem>
<para>
The NVH implementation is intended for <emphasis>human and machine viewing and editing</emphasis>:
it makes it easy for humans to understand or change the content as well as quickly develop programs that read or modify it.
Examples of what the serialization looks like with real-world data are given in <xref linkend="examples"/>.
</para>
</listitem>
<listitem>
<para>
The relational database implementation is intended as a representation for lexicographic data
Expand Down Expand Up @@ -370,6 +381,7 @@
<xi:include href="serializations/JSON/specification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="serializations/RDF/specification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="serializations/RDB/specification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="serializations/NVH/specification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>
<appendix role="informative">
<!-- examples -->
Expand Down
34 changes: 34 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/collocateMarker.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_collocateMarker">
<title>Node: <literal>collocateMarker</literal></title>
<para>Implements the <olink targetptr="annotation_collocateMarker">collocateMarker</olink> object type from the Annotation module.
Contains the text which it marks up and optional child nodes.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><glossterm>Required</glossterm>, implements the <literal>text</literal> property.</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>id</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
<listitem>
<para><literal>lemma</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_label">label</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>


</section>
35 changes: 35 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/definition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_definition">
<title>Node: <literal>definition</literal></title>
<para>Implements the <olink targetptr="core_definition">definition</olink> object type.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><glossterm>Required</glossterm>, implements the <literal>text</literal> property.</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>definitionType</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes if implementing the Annotation Module</title>
<listitem>
<para><literal><olink targetptr="nvh_headwordMarker">headwordMarker</olink></literal> node <glossterm>optional</glossterm> (zero or more)</para>
<para><literal><olink targetptr="nvh_collocateMarker">collocateMarker</olink></literal> node <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>


</section>
29 changes: 29 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/definitionTypeTag.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_definitionTypeTag">
<title>Node: <literal>definitionTypeTag</literal></title>
<para>Implements the <olink targetptr="values_definitionTypeTag">definitionTypeTag</olink> object type from the Controlled Values Module.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>tag</literal> <glossterm>required</glossterm></para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>description</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_sameAs">sameAs</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>

</section>
58 changes: 58 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/entry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_entry">
<title>Node: <literal>entry</literal></title>
<para>Implements the <olink targetptr="core_entry">entry</olink> object type.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>headword</literal> <glossterm>required</glossterm> </para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>id</literal> <glossterm>required</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal>homographNumber</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_partOfSpeech">partOfSpeech</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_label">label</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_pronunciation">pronunciation</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_inflectedForm">inflectedForm</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_sense">sense</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes if implementing the Annotation Module</title>
<listitem>
<para><literal><olink targetptr="nvh_placeholderMarker">placeholderMarker</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes if implementing the Etymology Module</title>
<listitem>
<para><literal><olink targetptr="nvh_etymology">etymology</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>

</section>
27 changes: 27 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/etymology.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_etymology">
<title>Node: <literal>etymology</literal></title>
<para>Implements the <olink targetptr="etymology_etymology">etymology</olink> object type from the Etymology Module.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>description</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal><olink targetptr="nvh_etymon">etymon</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
</itemizedlist>


</section>
32 changes: 32 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/etymon.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_etymon">
<title>Node: <literal>etymon</literal></title>
<para>Implements the <olink targetptr="etymology_etymon">etymon</olink> object type from the Etymology Module.</para>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>when</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal>type</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal>note</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="nvh_etymonUnit">etymonUnit</olink></literal> <glossterm>required</glossterm> (one or more)</para>
</listitem>
<listitem>
<para><literal>translation</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
</itemizedlist>


</section>
27 changes: 27 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/etymonLanguage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_etymonLanguage">
<title>Node: <literal>etymonLanguage</literal></title>
<para>Implements the <olink targetptr="etymology_etymonLanguage">etymonLanguage</olink> object type from the Etymology Module.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>langCode</literal> <glossterm>required</glossterm></para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>displayName</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
</itemizedlist>


</section>
27 changes: 27 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/etymonType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_etymonType">
<title>Node: <literal>etymonType</literal></title>
<para>Implements the <olink targetptr="etymology_etymonType">etymonType</olink> object type from the Etymology Module.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>type</literal> <glossterm>required</glossterm></para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>description</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
</itemizedlist>


</section>
36 changes: 36 additions & 0 deletions dmlex-v1.0/specification/serializations/NVH/nodes/etymonUnit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.docbook.org/xml/4.5/docbookx.dtd" [
<!ENTITY % xinclude SYSTEM "../../../docbook/xinclude.mod" >
%xinclude;
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED" >
]>
<section id="nvh_etymonUnit">
<title>Node: <literal>etymonUnit</literal></title>
<para>Implements the <olink targetptr="etymology_etymonUnit">etymonUnit</olink> object type from the Etymology Module.</para>

<itemizedlist>
<title>Value</title>
<listitem>
<para><literal>text</literal> <glossterm>required</glossterm> </para>
</listitem>
</itemizedlist>

<itemizedlist>
<title>Child nodes</title>
<listitem>
<para><literal>language</literal> <glossterm>required</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal>reconstructed</literal> <glossterm>optional</glossterm> (exactly one)</para>
</listitem>
<listitem>
<para><literal><olink targetptr="etymology_partOfSpeech">partOfSpeech</olink></literal> <glossterm>optional</glossterm> (zero or more)</para>
</listitem>
<listitem>
<para><literal>translation</literal> <glossterm>optional</glossterm> (zero or one)</para>
</listitem>
</itemizedlist>


</section>
Loading
Loading