NAME

       Padre - Perl Application Development and Refactoring Environment

SYNOPSIS

       Padre is a text editor aimed to be an IDE for Perl.

       After installation you should be able to just type in

         padre

       and get the editor working.

       Padre development started in June 2008 and made a lot of progress but there are still lots
       of missing features and the development is still very fast.

Getting Started

       After installing Padre you can start it by typing padre on the command line.  On Windows
       that would be Start/Run padre.bat

       You can start new files File/New ("Ctrl+N") or open existing files File/Open ("Ctrl+O").

       You can edit the file and save it using File/Save ("Ctrl+S").

       You can run the script by pressing Run/Run Script ("F5")

       By default Padre uses the same Perl interpreter for executing code that it uses for itself
       but this will be configurable later.

FEATURES

       Instead of duplicating all the text here, let us point you to the web site of Padre
       <http://padre.perlide.org/> where we keep a list of existing and planned features. We are
       creating detailed explanation about every feature in our wiki:
       <http://padre.perlide.org/trac/wiki/Features/>

DESCRIPTION

   Configuration
       The application maintains its configuration information in a directory called .padre.

   Other
       On Strawberry Perl you can associate .pl file extension with C:\strawberry\perl\bin\wxperl
       and then you can start double clicking on the application. It should work...

       Run This ("F5") - run the current buffer with the current Perl this currently only works
       with files with .pl extensions.

       Run Any ("Ctrl+F5") - run any external application

       First time it will prompt you to a command line that you have to type in such as

         perl /full/path/to/my/script.pl

       ...then it will execute this every time you press "Ctrl+F5" or the menu option. Currently
       "Ctrl+F5" does not save any file.  (This will be added later.)

       You can edit the command line using the Run/Setup menu item.

       Please Note that you can use $ENV{PADRE_VERSION} to detect whether the script is running
       inside Padre or not.

   Navigation
         Ctrl+2          Quick Fix
         Ctrl+.          Next Problem

         Ctrl+H opens a help window where you can see the documentation of
         any Perl module. Just use open (in the help window) and type in the name
         of a module.

         Ctrl+Shift+H Highlight the name of a module in the editor and then
         press Ctrl+Shift+H. It will open the help window for the module
         whose name was highlighted.

         In the help window you can also start typing the name of a module. When the
         list of the matching possible modules is small enough you'll be able
         to open the drop-down list and select the name.
         The "small enough" is controlled by two configuration options in the
         Edit/Setup menu:

         Max Number of modules
         Min Number of modules

         This feature only works after you have indexed all the modules
         on your computer. Indexing is currently done by running the following command:

         padre --index

SQLite

       Padre is using an SQLite database (~/.padre/config.db) for two things.  Part of the
       preferences/configuration information is kept there and it is used for the POD reader.

Documentation POD reader

       Padre currently can index (the names of) all the modules on your system and it was planned
       to have a search capability for modules/functions/etc.

Plug-ins

       There is a highly experimental but quite simple plug-in system.

       A plug-in is a module in the "Padre::Plugin::*" namespace.

       At start-up time Padre looks for all such modules in @INC and in its own private directory
       and loads them.

       Every plug-in must be a subclass of Padre::Plugin and follow the rules defined in the
       Padre::Plugin API documentation.

       See also Padre::PluginManager and Padre::PluginBuilder

       While Padre is running there is a menu option to show the plug-in configuration window
       that shows the list of all the plug-ins.

       TO DO: What to do if a newer version of the same plug-in was installed?

       TO DO: What to do if a module was removed ? Shall we keep its data in the configuration
       file or remove it?

       TO DO: Padre should offer an easy but simple way for plug-in authors to declare
       configuration variables and automatically generate both configuration file and
       configuration dialog. Padre should also allow for full customization of both for those
       more advanced in Wx.

   Tab and space conversion
       Tab to Space and Space to Tab conversions ask the number of spaces each tab should
       substitute. It currently works everywhere.  We probably should add a mode to operate only
       at the beginning of the lines or better yet only at the indentation levels.

       Delete All Ending space does just what it says.

       Delete Leading Space will ask How many leading spaces and act accordingly.

ARCHITECTURE

       Padre.pm
           is the main module.

       Padre::Autosave
           describes some of our plans for an auto-save mechanism.  It is not implemented yet.
           (There is also some description elsewhere in this document).

       Padre::Config
           reads/writes the configuration files.

           There is an SQLite database and a YAML file to keep various pieces of information.
           The database holds host related configuration values while the YAML file holds
           personal configuration options.

           The SQLite database holds the list of modules available on the system.  It will also
           contain indexing of the documentation Looking at the "" entries of modules List of
           functions

       Padre::DB
           The SQLite database abstraction for storing Padre's internal data.

       Padre::Document
           is an abstraction class to deal with a single document.

           Padre::Document::PASM
           Padre::Document::PIR
           Padre::Document::Perl
       Padre::PluginBuilder
       Padre::PluginManager
           locates and loads the plug-ins.

       Padre::Plugin
           Should be the base class of all plug-ins.

       Padre::Pod2HTML
       Padre::PPI
       Padre::Project
           Abstract class understanding what a project is.

       Padre::Project::Perl
           Is a Perl specific project. These are work in process.  Not yet used.

       Padre::TaskManager
           Managing background tasks.

       Padre::Task
           Background tasks.

       Padre::Util
           Various utility functions.

   Wx GUI
       The "Padre::Wx::*" namespace is supposed to deal with all the Wx related code.

       Padre::Wx
       Padre::Wx::App
           is the Wx::App subclass. Does not really do much.

       Padre::Wx::Dialog::Bookmarks
       Padre::Wx::Dialog::Find
           This is the main Find dialog

       Padre::Wx::Panel::FindFast
           This is the newer Firefox like inline search box.

       Padre::Wx::Dialog::PluginManager
       Padre::Wx::Dialog::Preferences
       Padre::Wx::Dialog::Snippets
       Padre::Wx::FileDropTarget
           The code for drag and drop

       Padre::Wx::Editor
           holds an editor text control instance (one for each buffer/file).  This is a subclass
           of Wx::Scintilla::TextCtrl also known as Scintilla.

       Padre::Wx::ComboBox::History
       Padre::Wx::TextEntryDialog::History
       Padre::Wx::Main
           This is the main window, most of the code is currently there.

       Padre::Wx::Menu
           handles everything the menu should know and do.

       Padre::Wx::Output
           the output window at the bottom of the editor displaying the output of running code
           using "F5".

       Padre::Wx::HtmlWindow
       Padre::Wx::Frame::POD
       Padre::Wx::Popup
           not in use.

       Padre::Wx::Printout
           Implementing the printing capability of Padre.

       Padre::Wx::SyntaxCheck
           Implementing the continuous syntax check of Perl code.

       Padre::Wx::ToolBar
           handles everything the toolbar should know and do.

METHODS

       The "Padre" class itself provides a number of convenience methods.

   "ide"
         my $ide = Padre->ide;

       The static "ide" method returns the Padre singleton object if the IDE has been created, or
       throws an exception if the IDE has not been created.

   "new"
         my $ide = Padre->new(%options);

       The "new" constructor creates the new singleton Padre object, or throws an exception if
       the IDE has already been created.

       It takes a set of parsed command line options as a parameter, storing them until they are
       needed at startup.

   "wx"
         my $app = Padre->wx;

       The static "wx" method is a convenience wrapper around the underlying global variable
       $Wx::TheApp provided by the Wx module.

       For convenience reasons, it can also be used as an instance method.

       Returns a Wx::App object, or "undef" if the application object has not yet been created.

   "run"
         $padre->run;

       The "run" method starts the Padre IDE and enters the Wx main loop.

BUGS

       Before submitting a bug please talk to the Padre developers on IRC: #padre on
       irc.perl.org. You can use this web based IRC client:
       <http://padre.perlide.org/irc.html?channel=padre>

       Please submit your bugs at <http://padre.perlide.org/trac/>

SUPPORT

       See also <http://padre.perlide.org/contact.html>

COPYRIGHT

       Copyright 2008-2013 The Padre development team as listed in Padre.pm.
       <http://padre.perlide.org/>

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same
       terms as Perl 5 itself.

DISCLAIMER OF WARRANTY

       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE,
       TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
       COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF
       ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
       THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE
       DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT
       HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY
       THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
       INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
       LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY
       OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
       SUCH DAMAGES.

ACKNOWLEDGEMENTS

   The Padre development team
       The developers of Padre in alphabetical order:

       Aaron Trevena (TEEJAY)

       Ahmad Zawawi XXXX XXXX XXXXX (AZAWAWI)

       Adam Kennedy (ADAMK) <adamk@cpan.org>

       Alexandr Ciornii (CHORNY)

       Blake Willmarth (BLAKEW)

       Breno G. de Oliveira (GARU)

       Brian Cassidy (BRICAS)

       Burak Guersoy (BURAK) <burak@cpan.org>

       Cezary Morga (THEREK) <cm@therek.net>

       Chris Dolan (CHRISDOLAN)

       Claudio Ramirez (NXADM) <nxadm@cpan.org>

       Fayland Lam (FAYLAND) <fayland@gmail.com>

       Gabriel Vieira (GABRIELMAD)

       Gabor Szabo - XXXXX XXX (SZABGAB) <szabgab@gmail.com>

       Heiko Jansen (HJANSEN) <heiko_jansen@web.de>

       Jerome Quelin (JQUELIN) <jquelin@cpan.org>

       Kaare Rasmussen (KAARE) <kaare@cpan.org>

       Keedi Kim - XXX (KEEDI)

       Kenichi Ishigaki - XXXX (ISHIGAKI) <ishigaki@cpan.org>

       Kevin Dawson (BOWTIE) <bowtie@cpan.org>

       Mark Grimes <mgrimes@cpan.org>

       Max Maischein (CORION)

       Olivier Mengue (DOLMEN)

       Patrick Donelan (PDONELAN) <pat@patspam.com>

       PaweX Murias (PMURIAS)

       Petar Shangov (PSHANGOV)

       Peter Lavender (PLAVEN)

       Ryan Niebur (RSN) <rsn@cpan.org>

       Sebastian Willing (SEWI)

       Steffen Mueller (TSEE) <smueller@cpan.org>

       Zeno Gantner (ZENOG)

   Translators
       Arabic

       Ahmad M. Zawawi - XXXX XXXX XXXXX (AZAWAWI)

       Chinese (Simplified)

       Fayland Lam (FAYLAND)

       Chinese (Traditional)

       BlueT - Matthew Lien - XXX (BLUET) <bluet@cpan.org>

       Chuanren Wu

       Dutch

       Dirk De Nijs (ddn123456)

       English

       Everyone on the team

       French

       Jerome Quelin (JQUELIN)

       Olivier Mengue (DOLMEN)

       German

       Heiko Jansen (HJANSEN)

       Sebastian Willing (SEWI)

       Zeno Gantner (ZENOG)

       Hebrew

       Omer Zak  - XXXX XX

       Shlomi Fish  - XXXXX XXX (SHLOMIF)

       Amir E. Aharoni - XXXX X. XXXXXX

       Hungarian

       Gyoergy Pasztor (GYU)

       Italian

       Simone Blandino (SBLANDIN)

       Japanese

       Kenichi Ishigaki - XXXX (ISHIGAKI)

       Korean

       Keedi Kim - XXX (KEEDI)

       Russian

       Andrew Shitov

       Polish

       Cezary Morga (THEREK)

       Marek Roszkowski (EviL) <evil@evil.devil.is-my.name>

       Portuguese (Brazilian)

       Breno G. de Oliveira (GARU)

       Spanish

       Paco Alguacil (PacoLinux)

       Enrique Nell (ENELL)

       Czech

       Marcela MaXlaXova (mmaslano)

       Marek Roszkowski (EviL) <evil@evil.devil.is-my.name>

       Norwegian

       Kjetil Skotheim (KJETIL)

       Turkish

       Burak Guersoy (BURAK) <burak@cpan.org>

   Thanks
       Mattia Barbon for providing wxPerl.  Part of the code was copied from his Wx::Demo
       application.

       Herbert Breunung for letting me work on Kephra.

       Octavian Rasnita for early testing and bug reports.

       Tatsuhiko Miyagawa for consulting on our I18N and L10N support.