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

Revise FoLiA documentation, turn into more formal specification #43

Closed proycon closed 5 years ago

proycon commented 6 years ago

The FoLiA documentation is currently a LaTeX document containing 157 pages that has grown over the years. Though it has been revised to keep up with the latest FoLiA standard, at certain places discrepancies may have arisen with the yaml specification (folia.yml) that acts as the source for the libraries (pynlpl.formats.folia and libfolia). A more integrative revision of the documentation might be desirable. By this I mean that parts of the documentation are generated from the specification, giving the documentation a more formal character and ensuring everything is in sync.

This also allows for documentation to be publishable in various forms, rather than just the PDF which it is now.

proycon commented 6 years ago

Development of this is currently in progress: