Added an example of negation annotation #86

Author: proycon

docs/source/modality_annotation.rst

@@ -24,7 +24,7 @@ Specification
 :API Class: ``Modality`` (`FoLiApy API Reference <https://foliapy.readthedocs.io/en/latest/_autosummary/folia.main.Modality.html>`_)
 :Layer Element: ``<modalities>``
 :Span Role Elements: ``<cue>`` (``Cue``), ``<scope>`` (``Scope``), ``<source>`` (``Source``), ``<target>`` (``Target``)
-:Required Attributes: 
+:Required Attributes:
 :Optional Attributes: * ``xml:id`` -- The ID of the element; this has to be a unique in the entire document or collection of documents (corpus). All identifiers in FoLiA are of the `XML NCName <https://www.w3.org/TR/1999/WD-xmlschema-2-19990924/#NCName>`_ datatype, which roughly means it is a unique string that has to start with a letter (not a number or symbol), may contain numbers, but may never contain colons or spaces. FoLiA does not define any naming convention for IDs.
                       * ``set`` -- The set of the element, ideally a URI linking to a set definition (see :ref:`set_definitions`) or otherwise a uniquely identifying string. The ``set`` must be referred to also in the :ref:`annotation_declarations` for this annotation type.
                       * ``class`` -- The class of the annotation, i.e. the annotation tag in the vocabulary defined by ``set``.
@@ -71,8 +71,16 @@ Besides these predefined features, FoLiA's feature mechanism can be used to asso
 Example
 -------------------------
 
+An example of sentiment analysis:
+
 .. literalinclude:: ../../examples/modality-sentiments.2.4.0.folia.xml
     :linenos:
     :language: xml
 
+An example of negation annotation:
+
+.. literalinclude:: ../../examples/modality-negation.2.4.0.folia.xml
+    :linenos:
+    :language: xml
+
 

examples/modality-negation.2.4.0.folia.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8"?>
+<FoLiA xmlns="http://ilk.uvt.nl/folia" version="2.0" xml:id="example">
+  <metadata>
+      <annotations>
+          <token-annotation set="https://raw.githubusercontent.com/LanguageMachines/uctodata/master/setdefinitions/tokconfig-eng.foliaset.ttl">
+			 <annotator processor="p1" />
+		  </token-annotation>
+          <text-annotation>
+			 <annotator processor="p1" />
+          </text-annotation>
+          <sentence-annotation>
+			 <annotator processor="p1" />
+          </sentence-annotation>
+          <modality-annotation set="modalities"> <!-- an ad-hoc set -->
+			 <annotator processor="p1" />
+		  </modality-annotation>
+      </annotations>
+      <provenance>
+         <processor xml:id="p1" name="proycon" type="manual" />
+      </provenance>
+  </metadata>
+  <text xml:id="example.text">
+    <s xml:id="s1">
+     <w xml:id="s1.w1"><t>I</t></w>
+     <w xml:id="s1.w2"><t>did</t></w>
+     <w xml:id="s1.w3"><t>not</t></w>
+     <w xml:id="s1.w4"><t>know</t></w>
+     <w xml:id="s1.w5"><t>who</t></w>
+     <w xml:id="s1.w6"><t>you</t></w>
+     <w xml:id="s1.w7"><t>were</t></w>
+     <modalities>
+      <modality class="negation">
+        <cue>
+          <wref id="s1.w3" t="not" />
+        </cue>
+        <scope>
+          <wref id="s1.w1" t="I" />
+          <wref id="s1.w2" t="did" />
+          <wref id="s1.w4" t="know" />
+          <wref id="s1.w5" t="who" />
+          <wref id="s1.w6" t="you" />
+          <wref id="s1.w7" t="were" />
+        </scope>
+      </modality>
+     </modalities>
+    </s>
+  </text>
+</FoLiA>