folia.main.Head
===============

.. currentmodule:: folia.main

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

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Head.__init__
      ~Head.accepts
      ~Head.add
      ~Head.addable
      ~Head.addidsuffix
      ~Head.addtoindex
      ~Head.alternatives
      ~Head.ancestor
      ~Head.ancestors
      ~Head.annotation
      ~Head.annotations
      ~Head.annotator2processor
      ~Head.append
      ~Head.checkdeclaration
      ~Head.context
      ~Head.copy
      ~Head.copychildren
      ~Head.correct
      ~Head.count
      ~Head.deepvalidation
      ~Head.depthfirstsearch
      ~Head.description
      ~Head.elements
      ~Head.feat
      ~Head.findcorrectionhandling
      ~Head.findreplaceables
      ~Head.generate_id
      ~Head.getindex
      ~Head.getmetadata
      ~Head.gettextdelimiter
      ~Head.hasannotation
      ~Head.hasannotationlayer
      ~Head.hasphon
      ~Head.hastag
      ~Head.hastext
      ~Head.incorrection
      ~Head.insert
      ~Head.items
      ~Head.json
      ~Head.layers
      ~Head.leftcontext
      ~Head.move
      ~Head.next
      ~Head.originaltext
      ~Head.paragraphs
      ~Head.parsecommonarguments
      ~Head.parsexml
      ~Head.phon
      ~Head.phoncontent
      ~Head.postappend
      ~Head.precedes
      ~Head.previous
      ~Head.relaxng
      ~Head.relaxng_backwards
      ~Head.remove
      ~Head.replace
      ~Head.resolveoffsets
      ~Head.resolveword
      ~Head.rightcontext
      ~Head.select
      ~Head.sentences
      ~Head.setdoc
      ~Head.setdocument
      ~Head.setparents
      ~Head.setprocessor
      ~Head.settext
      ~Head.speech_speaker
      ~Head.speech_src
      ~Head.stricttext
      ~Head.substitute
      ~Head.tag
      ~Head.text
      ~Head.textcontent
      ~Head.textvalidation
      ~Head.toktext
      ~Head.untag
      ~Head.updatetext
      ~Head.words
      ~Head.xml
      ~Head.xmlstring
    
    
    ~Head.__iter__
    
    
    
    ~Head.__len__
    
    
    
    ~Head.__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:: 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:: elements
   
   .. automethod:: feat
   
   .. automethod:: findcorrectionhandling
   
   .. automethod:: findreplaceables
   
   .. automethod:: generate_id
   
   .. 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:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: paragraphs
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: sentences
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: settext
   
   .. automethod:: speech_speaker
   
   .. automethod:: speech_src
   
   .. 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__