.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Lingua::GA::Gramadoir 3pm"
.TH Lingua::GA::Gramadoir 3pm "2013-10-14" "perl v5.18.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Lingua::GA::Gramadoir \- Check the grammar of Irish language text
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Lingua::GA::Gramadoir;
\&
\& my $gr = new Lingua::GA::Gramadoir;
\&
\& my $errors = $gr\->grammatical_errors( $text );
\& foreach my $error (@$errors) {
\& # process $error appropriately
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module contains the code for segmentation, spell checking,
part-of-speech tagging, and grammar checking used by \*(L"An Gramado\*'ir\*(R",
an open-source grammar and style checker that can be used
with vim, emacs, OpenOffice, or through a command-line interface.
An Gramado\*'ir is intended as a platform for the development of
sophisticated natural language processing tools for languages with
limited computational resources.
.PP
The Perl code contained in this module is generated automatically
from a higher-level representation of the grammatical rules
and should not be edited directly. Anyone interested in helping
improve the lexicon or the rule sets should download the
developers' pack from the An Gramado\*'ir web site:
.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .IP "new %PARAMS" 4
.el .IP "new \f(CW%PARAMS\fR" 4
.IX Item "new %PARAMS"
Constructs an instance of the grammar checker and loads the lexicon
into memory. It should only be called once. Options may be specified
by passing a hash containing any of the following keys:
.Sp
fix_spelling => 0
.Sp
Suggest replacements for misspelled or unknown words.
.Sp
use_ignore_file => 0
.Sp
Read a file containing words to be ignored when checking spelling and grammar.
.Sp
unigram_tagging => 1
.Sp
Resolve ambiguous part of speech according to frequency. This should
be set to false only for debugging purposes because the pattern matching
for grammatical errors relies on complete disambiguation.
.Sp
interface_language => ""
.Sp
Specify the language of output messages
(\fBnot\fR necessarily the language of the text to be checked).
With the default value, Locale::Maketext attempts to determine
the correct language to use based on things like your
environment variables.
.Sp
input_encoding => '\s-1ISO\-8859\-1\s0'
.Sp
Specify the encoding for all texts passed to one of the module's exported
functions. There is no currently no way to change the encoding of
the data returned by the exported functions (always encoded as perl strings).
.SH "METHODS"
.IX Header "METHODS"
.IP "get_sentences \s-1TEXT\s0" 4
.IX Item "get_sentences TEXT"
Splits the input \s-1TEXT\s0 up into sentences and returns a reference to an
array containing the sentences.
.IP "tokenize \s-1TEXT\s0" 4
.IX Item "tokenize TEXT"
Splits the input \s-1TEXT\s0 up into orthographic words and returns a reference to an
array containing the words.
.IP "spell_check \s-1TEXT\s0" 4
.IX Item "spell_check TEXT"
Returns a reference to an array containing the misspelled words appearing
in the input text.
.IP "all_possible_tags \s-1WORD\s0" 4
.IX Item "all_possible_tags WORD"
Takes the input \s-1WORD\s0 and returns it with (XML-style) markup
indicating all of its possible parts of speech.
.IP "add_tags \s-1TEXT\s0" 4
.IX Item "add_tags TEXT"
Takes the input \s-1TEXT\s0 and returns a reference to an array of sentences
with (XML-style) *disambiguated* part-of-speech tags. Does not do
any grammatical rule checking.
.IP "xml_stream \s-1TEXT\s0" 4
.IX Item "xml_stream TEXT"
Takes the input \s-1TEXT\s0 and returns it as well-formed \s-1XML \s0(encoded as perl
strings, not utf\-8) with full grammatical markup. Error messages are not
localized. This function should only be exported for debugging/development
purposes. Use \*(L"grammatical_errors\*(R" (which is basically \*(L"xml_stream\*(R" plus
some whittling down) as an interface with other programs.
.IP "grammatical_errors \s-1TEXT\s0" 4
.IX Item "grammatical_errors TEXT"
Returns the grammatical errors in the input \s-1TEXT\s0 as a reference to an array,
one error per element of the array, with each error given in a simple
\&\s-1XML\s0 format usable by other applications. Error messages are localized
according to locale settings as determined by Locale::Maketext.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
.IP "\(bu" 4
Locale::Maketext
.IP "\(bu" 4
\&\fIperl\fR\|(1)
.SH "BUGS"
.IX Header "BUGS"
The grammar checker does not attempt a full parse of the input
sentences nor does it attempt to exploit any semantic information.
There are, therefore, certain constructs that cannot be dealt with
correctly. See for a
detailed discussion and specific examples.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kevin P. Scannell, .
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2004, 2005, 2007 Kevin P. Scannell
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.2 or,
at your option, any later version of Perl 5 you may have available.