.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "MediaWiki::Bot::Constants 3pm"
.TH MediaWiki::Bot::Constants 3pm "2016-07-21" "perl v5.22.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"
MediaWiki::Bot::Constants \- constants for MediaWiki::Bot
.SH "VERSION"
.IX Header "VERSION"
version 5.006003
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use MediaWiki::Bot;
\&    use MediaWiki::Bot::Constants qw(:file);
\&
\&    my $bot = MediaWiki::Bot\->new();
\&    my $file_existence = $bot\->test_image_exists("File:...");
\&
\&    # Make sense of MediaWiki::Bot\*(Aqs random numbers
\&    if ($file_existence == FILE_LOCAL) {
\&        # Get from local media repository
\&    }
\&    elsif ($file_existence == FILE_SHARED) {
\&        # Get from shared (remote) media repository
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Exportable constants used by MediaWiki::Bot. Use these constants
in your code to avoid the use of magical numbers, and to ensure
compatibility with future changes in \f(CW\*(C`MediaWiki::Bot\*(C'\fR.
.PP
You can also import \f(CW\*(C`:constants\*(C'\fR or any constant name(s) from
MediaWiki::Bot:
.PP
.Vb 2
\&    use MediaWiki::Bot qw(:constants);
\&    use MediaWiki::Bot qw(PAGE_NONEXISTENT);
.Ve
.SH "CONSTANTS"
.IX Header "CONSTANTS"
The available constants are divided into 5 tags, which can be imported
individually:
.IP "\(bu" 4
err \- the error constants, inherited from MediaWiki::API
.IP "\(bu" 4
bool \- boolean constants
.IP "\(bu" 4
page \- page existence
.IP "\(bu" 4
file \- file (image/media) existence status (which is not boolean)
.IP "\(bu" 4
ns \- some namespace numbers. \fBAchtung!\fR Incomplete! Use MediaWiki::Bot's
functions for getting namespace information for your wiki.
.SH "EXPORTS"
.IX Header "EXPORTS"
No symbols are exported by default. The available tags are err, bool, page, file, ns, and all.
.SH "AVAILABILITY"
.IX Header "AVAILABILITY"
The project homepage is <https://metacpan.org/module/MediaWiki::Bot>.
.PP
The latest version of this module is available from the Comprehensive Perl
Archive Network (\s-1CPAN\s0). Visit <http://www.perl.com/CPAN/> to find a \s-1CPAN\s0
site near you, or see <https://metacpan.org/module/MediaWiki::Bot/>.
.SH "SOURCE"
.IX Header "SOURCE"
The development version is on github at <http://github.com/MediaWiki\-Bot/MediaWiki\-Bot>
and may be cloned from <git://github.com/MediaWiki\-Bot/MediaWiki\-Bot.git>
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
You can make new bug reports, and view existing ones, through the
web interface at <https://github.com/MediaWiki\-Bot/MediaWiki\-Bot/issues>.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Dan Collins <dcollins@cpan.org>
.IP "\(bu" 4
Mike.lifeguard <lifeguard@cpan.org>
.IP "\(bu" 4
Alex Rowe <alex.d.rowe@gmail.com>
.IP "\(bu" 4
Oleg Alexandrov <oleg.alexandrov@gmail.com>
.IP "\(bu" 4
jmax.code <jmax.code@gmail.com>
.IP "\(bu" 4
Stefan Petrea <stefan.petrea@gmail.com>
.IP "\(bu" 4
kc2aei <kc2aei@gmail.com>
.IP "\(bu" 4
bosborne@alum.mit.edu
.IP "\(bu" 4
Brian Obio <brianobio@gmail.com>
.IP "\(bu" 4
patch and bug report contributors
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2016 by the MediaWiki::Bot team <perlwikibot@googlegroups.com>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve