Text::TEI::Collate::Word is an object that describes a word in a collated text. This may be a useful way for editors of other things to plug in their own logic.
Creates a new word object. Should not be called directly.
If called with an argument, sets the stripped form of the word that should be used for comparison. Returns the word's stripped form.
Return either the word or the 'special', as applicable
If called with an argument, sets the form of the word, punctuation and all, that was originally passed. Returns the word's original form.
If called with an argument, sets the accented form of the word (minus punctuation). Returns the word's accented form.
If called with an argument, sets the canonical form of the word (minus punctuation). Returns the word's canonical form.
If called with an argument, sets the comparison form of the word (using a set standard for orthographic equivalence.) Returns the word's comparison form.
If called with an argument, sets the punctuation marks that were passed with the word. Returns the word's puncutation.
If called with an argument, sets the canonizer subroutine that the word object should use. Returns the subroutine.
If called with an argument, sets the comparator subroutine that the word object should use. Returns the subroutine.
Returns a word's special value. Used for meta-words like BEGIN and END.
Returns whether this is an empty word. Useful to distinguish from a special word.
Returns a hash of all the values that might be changed by a re-comparison. Useful to 'back up' a word before attempting a rematch. Currently does not expect any of the 'mutable' keys to contain data structure refs.
Returns true if the word has been matched together with its following word. If passed with an argument, sets this value.
Returns true if the word has been matched together with its following word. If passed with an argument, sets this value.
Returns the sectional markers, if any, that go before the word.
Adds a sectional marker that should precede the word in question.
Returns the sigil of the manuscript wherein this word appears.
Returns the list of links, or an empty list.
Adds to the list of 'like' words in this word's column.
Returns the list of variants, or an empty list.
Adds to the list of 'different' words in this word's column.
Many things. I shall enumerate them later.
Tara L Andrews <aurum@cpan.org>
