folia.main.Word
===============

.. currentmodule:: folia.main

.. autoclass:: Word
   :show-inheritance:
   :undoc-members:
   :special-members:

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Word.__init__
      ~Word.accepts
      ~Word.add
      ~Word.addable
      ~Word.addidsuffix
      ~Word.addtoindex
      ~Word.alternativelayers
      ~Word.alternatives
      ~Word.ancestor
      ~Word.ancestors
      ~Word.annotation
      ~Word.annotations
      ~Word.annotator2processor
      ~Word.append
      ~Word.checkdeclaration
      ~Word.context
      ~Word.copy
      ~Word.copychildren
      ~Word.correct
      ~Word.count
      ~Word.deepvalidation
      ~Word.depthfirstsearch
      ~Word.description
      ~Word.division
      ~Word.domain
      ~Word.elements
      ~Word.etymology
      ~Word.feat
      ~Word.findcorrectionhandling
      ~Word.findreplaceables
      ~Word.findspans
      ~Word.generate_id
      ~Word.getcorrection
      ~Word.getcorrections
      ~Word.getindex
      ~Word.getmetadata
      ~Word.gettextdelimiter
      ~Word.hasannotation
      ~Word.hasannotationlayer
      ~Word.hasphon
      ~Word.hastag
      ~Word.hastext
      ~Word.incorrection
      ~Word.insert
      ~Word.items
      ~Word.json
      ~Word.layers
      ~Word.leftcontext
      ~Word.lemma
      ~Word.morpheme
      ~Word.morphemes
      ~Word.move
      ~Word.next
      ~Word.originaltext
      ~Word.paragraph
      ~Word.paragraphs
      ~Word.parsecommonarguments
      ~Word.parsexml
      ~Word.phon
      ~Word.phoncontent
      ~Word.phoneme
      ~Word.phonemes
      ~Word.pos
      ~Word.postappend
      ~Word.precedes
      ~Word.previous
      ~Word.relaxng
      ~Word.relaxng_backwards
      ~Word.remove
      ~Word.replace
      ~Word.resolveoffsets
      ~Word.resolveword
      ~Word.rightcontext
      ~Word.select
      ~Word.sense
      ~Word.sentence
      ~Word.sentences
      ~Word.setdoc
      ~Word.setdocument
      ~Word.setparents
      ~Word.setprocessor
      ~Word.settext
      ~Word.speech_speaker
      ~Word.speech_src
      ~Word.split
      ~Word.stricttext
      ~Word.substitute
      ~Word.tag
      ~Word.text
      ~Word.textcontent
      ~Word.textvalidation
      ~Word.toktext
      ~Word.untag
      ~Word.updatetext
      ~Word.words
      ~Word.xml
      ~Word.xmlstring
    
    
    ~Word.__iter__
    
    
    
    ~Word.__len__
    
    
    
    ~Word.__str__
    
    
   
   

   
   
   .. rubric:: Class Attributes

   
   .. autoattribute:: ACCEPTED_DATA
   .. autoattribute:: ANNOTATIONTYPE
   .. autoattribute:: AUTH
   .. autoattribute:: AUTO_GENERATE_ID
   .. autoattribute:: HIDDEN
   .. autoattribute:: IMPLICITSPACE
   .. autoattribute:: LABEL
   .. autoattribute:: OCCURRENCES
   .. autoattribute:: OCCURRENCES_PER_SET
   .. autoattribute:: OPTIONAL_ATTRIBS
   .. autoattribute:: PHONCONTAINER
   .. autoattribute:: PRIMARYELEMENT
   .. autoattribute:: PRINTABLE
   .. autoattribute:: REQUIRED_ATTRIBS
   .. autoattribute:: REQUIRED_DATA
   .. autoattribute:: SETONLY
   .. autoattribute:: SPEAKABLE
   .. autoattribute:: SUBSET
   .. autoattribute:: TEXTCONTAINER
   .. autoattribute:: TEXTDELIMITER
   .. autoattribute:: WREFABLE
   .. autoattribute:: XLINK
   .. autoattribute:: XMLTAG
   
   

   .. rubric:: Method Details

   .. automethod::  __init__
   
   .. automethod:: __init__
   
   .. automethod:: accepts
   
   .. automethod:: add
   
   .. automethod:: addable
   
   .. automethod:: addidsuffix
   
   .. automethod:: addtoindex
   
   .. automethod:: alternativelayers
   
   .. automethod:: alternatives
   
   .. automethod:: ancestor
   
   .. automethod:: ancestors
   
   .. automethod:: annotation
   
   .. automethod:: annotations
   
   .. automethod:: annotator2processor
   
   .. automethod:: append
   
   .. automethod:: checkdeclaration
   
   .. automethod:: context
   
   .. automethod:: copy
   
   .. automethod:: copychildren
   
   .. automethod:: correct
   
   .. automethod:: count
   
   .. automethod:: deepvalidation
   
   .. automethod:: depthfirstsearch
   
   .. automethod:: description
   
   .. automethod:: division
   
   .. automethod:: domain
   
   .. automethod:: elements
   
   .. automethod:: etymology
   
   .. automethod:: feat
   
   .. automethod:: findcorrectionhandling
   
   .. automethod:: findreplaceables
   
   .. automethod:: findspans
   
   .. automethod:: generate_id
   
   .. automethod:: getcorrection
   
   .. automethod:: getcorrections
   
   .. automethod:: getindex
   
   .. automethod:: getmetadata
   
   .. automethod:: gettextdelimiter
   
   .. automethod:: hasannotation
   
   .. automethod:: hasannotationlayer
   
   .. automethod:: hasphon
   
   .. automethod:: hastag
   
   .. automethod:: hastext
   
   .. automethod:: incorrection
   
   .. automethod:: insert
   
   .. automethod:: items
   
   .. automethod:: json
   
   .. automethod:: layers
   
   .. automethod:: leftcontext
   
   .. automethod:: lemma
   
   .. automethod:: morpheme
   
   .. automethod:: morphemes
   
   .. automethod:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: paragraph
   
   .. automethod:: paragraphs
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: phoneme
   
   .. automethod:: phonemes
   
   .. automethod:: pos
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: sense
   
   .. automethod:: sentence
   
   .. automethod:: sentences
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: settext
   
   .. automethod:: speech_speaker
   
   .. automethod:: speech_src
   
   .. automethod:: split
   
   .. automethod:: stricttext
   
   .. automethod:: substitute
   
   .. automethod:: tag
   
   .. automethod:: text
   
   .. automethod:: textcontent
   
   .. automethod:: textvalidation
   
   .. automethod:: toktext
   
   .. automethod:: untag
   
   .. automethod:: updatetext
   
   .. automethod:: words
   
   .. automethod:: xml
   
   .. automethod:: xmlstring
   
   
   
   .. automethod:: __iter__
   
   
   
   .. automethod:: __len__
   
   
   
   .. automethod:: __str__