.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" 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 "Padre::Plugin::SpellCheck 3pm"
.TH Padre::Plugin::SpellCheck 3pm "2012-06-19" "perl v5.14.2" "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"
Padre::Plugin::SpellCheck \- Check spelling in Padre, The Perl IDE.
.SH "VERSION"
.IX Header "VERSION"
version 1.29
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plug-in allows one to check there spelling within Padre using
\&\f(CW\*(C`F7\*(C'\fR (standard spelling short-cut across text processors).
.PP
One can change the dictionary language used (based upon install languages) in the preferences window via Plug-in Manager.
Note that preferences can \fBonly\fR be setup while the plugin is \fBdisabled\fR.
Preferences are persistent. You need to Save your preferred language.
.PP
This plug-in is using \f(CW\*(C`Text::Aspell\*(C'\fR default (legacy). You can also use \f(CW\*(C`Text::Hunspell\*(C'\fR, so check these module's
pod for more information and install the one for you.
.PP
Of course, you need to have the relevant Dictionary binary, dev and dictionary installed.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& Check your file or selected text for spelling errors in your preferred language.
\& F7
.Ve
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.SS "Standard Padre::Plugin \s-1API\s0"
.IX Subsection "Standard Padre::Plugin API"
\&\f(CW\*(C`Padre::Plugin::SpellCheck\*(C'\fR defines a plug-in which follows
\&\f(CW\*(C`Padre::Plugin\*(C'\fR \s-1API\s0. Refer to this module's documentation for more
information.
.PP
The following methods are implemented:
.IP "\fIclean_dialog()\fR" 7
.IX Item "clean_dialog()"
.PD 0
.IP "\fImenu_plugins()\fR" 7
.IX Item "menu_plugins()"
.IP "\fIpadre_interfaces()\fR" 7
.IX Item "padre_interfaces()"
.IP "\fIplugin_disable()\fR" 7
.IX Item "plugin_disable()"
.IP "\fIplugin_enable()\fR" 7
.IX Item "plugin_enable()"
.PD
Return the plug-in's configuration, or a suitable default one if none exist previously.
.IP "\fIplugin_name()\fR" 7
.IX Item "plugin_name()"
.PD 0
.IP "\fIplugin_preferences()\fR" 7
.IX Item "plugin_preferences()"
.PD
Open the check spelling preferences window.
.SS "Spell checking methods"
.IX Subsection "Spell checking methods"
.IP "\(bu" 1
\&\fIspell_check()\fR
.Sp
Spell checks the current selection (or the whole document).
.SH "BUGS and LIMITATIONS"
.IX Header "BUGS and LIMITATIONS"
If you upgrade your os, and run Perl from a local/lib,
you may find Hunspell stops showing local dictionary s in preferences,
you will need to un-install Text::Hunspell and re-install in cpan.
.PP
Spell-checking non-ascii files has bugs: the selection does not
match the word boundaries, and as the spell checks moves further in
the document, offsets are totally irrelevant. This is a bug in
\&\f(CW\*(C`Wx::StyledTextCtrl\*(C'\fR that has some Unicode problems... So
unfortunately, there's nothing that I can do in this plug-in to
tackle this bug.
.PP
Please report any bugs or feature requests to \f(CW\*(C`padre\-plugin\-spellcheck
at rt.cpan.org\*(C'\fR, or through the web interface at \*(L"/rt.cpan.org/NoAuth/ReportBug.html?Queue=Padre\-Plugin\-
SpellCheck\*(R" in http:. I will be notified, and then you'll automatically be
notified of progress on your bug as I make changes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Plug-in icon courtesy of Mark James, at
.
.IP "\(bu" 2
Padre-Plugin-SpellCheck web page
.Sp
.IP "\(bu" 2
Our svn repository
.Sp
http://svn.perlide.org/padre/trunk/Padre\-Plugin\-SpellCheck ,
and can be browsed at
http://padre.perlide.org/browser/trunk/Padre\-Plugin\-SpellCheck .
.PP
You can also look for information on this module at:
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
http://annocpan.org/dist/Padre\-Plugin\-SpellCheck
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
http://cpanratings.perl.org/d/Padre\-Plugin\-SpellCheck
.IP "\(bu" 4
Open bugs
.Sp
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Padre\-Plugin\-SpellCheck
.PP
Everything Aspell related: .
.PP
Everything Hunspell related: .
.SH "AUTHORS"
.IX Header "AUTHORS"
Kevin Dawson
.PP
Ahmad M. Zawawi
.PP
Fayland Lam
.PP
Jerome Quelin
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This software is copyright (c) 2010 by Fayland Lam, Jerome Quelin.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl 5 itself.