search

proycon / folia

FoLiA: Format for Linguistic Annotation - FoLiA is a rich XML-based annotation format for the representation of language resources (including corpora) with linguistic annotations. A wide variety of linguistic annotations are supported, making FoLiA a useful format for NLP tasks and data interchange. Note that the actual Python library for processing FoLiA is implemented as part of PyNLPl, this contains higher-level tools that use the library as well as the full documentation, validation schemas, and set definitions
http://proycon.github.io/folia/
GNU General Public License v3.0
60 stars 10 forks source link

Rename alignment annotation to relation annotation? #59

Closed proycon closed 5 years ago

proycon commented 5 years ago

I'm contemplating renaming alignment annotation (see https://folia.readthedocs.io/en/folia2.0/alignment_annotation.html, a form of higher-order annotation) to relation annotation, which sounds more generic and far more to the point.

It would require some extra hacks for backward compatibility with the old name.

kosloot commented 5 years ago

So what is the difference between this annotation and the Reference annotation? They smell a bit the same.

proycon commented 5 years ago

Reference is a a structure annotation element that is an explicit reference in the text, think of things like footnotes and hyperlinks. This is higher-order annotation that can set a relationship between anything.

proycon commented 5 years ago

But yes, the terminology might be confusing. This could just as well have been called reference in another parallel universe.

kosloot commented 5 years ago

and the one off the reference examples seems (almost) to do what relation does. 

      <note xml:id="example.note.1" class="footnote">
        <part>
            <t>See our website.</t>
        </part>
        <ref xml:id="example.ref.2" xlink:href="https://github.io/folia" xlink:type="simple" format="text/html" />
      </note>

So this has to be explained carefully. And I fear that users also will loose track.

proycon commented 5 years ago

Yes, the documentation has been reworked so it should be clear hopefully. Feel free to judge for yourself: https://folia.readthedocs.io/en/folia2.0/reference_annotation.html

kosloot commented 5 years ago

is surely much clearer