Changes between Version 22 and Version 23 of PadrePluginCookbookRecipie05


Ignore:
Timestamp:
Aug 9, 2011, 6:19:38 PM (3 years ago)
Author:
bowtie
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PadrePluginCookbookRecipie05

    v22 v23  
    77Padre::Plugin::Cookbook Recipe-05 DRAFT 
    88 
    9 This page compleats {{{Padre::Plugin::Cookbook}}} series, It is just meant to be an aid, with a suggested layout and some ideas to speed you along, enjoy. 
    10 * Unlike the previous recipes which have covered, Plug-ins with dialogs, this is more concerned, with conformance, playing nice with Padre.  {{{Padre::Plugin::CookBook}}} see trunk 
    11  * You may find this helpful, see: [wiki:DownloadRepository Download Padre from Repository] 
    12 ---- 
    13  
    14 The following is as a result of analysing Plugins for this page. 
    15  
    16 The examples here, where relevant will build upon Cookbook, some relate to other Plug-ins as it is more pertinent to use them, 
    17  
    18 ---- 
    19 == Outline 
    20 * Plug-in Compliance, Things to do to make your Plug-in Load 
     9This page compleats {{{Padre::Plugin::Cookbook}}} series, It is just meant to be an aid, with a suggested layout and some ideas to speed you along your way, enjoy. 
     10 
     11* Unlike the previous recipes which have covered, Plug-ins with dialogs, this is more concerned, with conformance, playing nice with Padre.  
     12 
     13* The following is as a result of analysing Plug-ins for this page. 
     14 
     15* The examples here, where relevant will build upon Cookbook, some relate to other Plug-ins as it is more pertinent to use them, 
     16 
     17---- 
     18== Deceleration 
     19 
    2120Initial thoughts, of what a {{{Padre::Plugin}}} should provide, critiques welcome. 
    22 Plug-in Compliance 
    23 Things to do to make your Plug-in Load 
    24 * Plugin Manager can load plugin 
    25  
    26 ---- 
     21 
     22Things to do to enable Plugin Manager to load your Plug-in 
     23 
     24 
    2725=== Plugin must have a Version 
    2826 * For compliance you will need to have a version in your Padre::Plugin::Name.pm. 
     
    3230 
    3331---- 
     32 
     33== Methods 
    3434 
    3535=== plugin_name 
     
    4848---- 
    4949=== padre_interfaces 
    50 * Plugin must declare it's **Interfaces**, all Padre Modules should be included 
     50* Plugin must declare it's **Interfaces**, all Padre Modules should be included, just look at some other Plug-ins to see the pattern.  
    5151 * Don't forget to include the following sub. 
    5252 * Use the version number of Padre you are developing against, as shown below. 
     
    185185 
    186186=== plugin_disable 
    187 * Plugin_disable so that we can load and unloaded our Plug-in repeatedly, using Tools -> Reload All Plugins. 
     187* Plugin_disable is a must so that we can load and unloaded our Plug-in repeatedly, using Tools -> Reload All Plug-ins. 
    188188Don't forget to include all the relevant sections. 
    189189 1. Wx::Dialogs, as shown 
     
    333333all_from 'lib/Padre/Plugin/Cookbook.pm'; 
    334334 
    335 # Optional if it has a "use Foo 1.23" that another module doesn't have 
     335# Recommended, Alias+ 
    336336requires_from 'lib/Padre/Plugin/Cookbook/Recipe01/Main.pm'; 
    337337requires_from 'lib/Padre/Plugin/Cookbook/Recipe02/Main.pm'; 
     
    353353}}} 
    354354 
     355* **NB** {{{Module::Install::API experimental}}} 
     356 
     357**requires_from** command takes a module file path, and looks for //use// statements with explicit module version (like {{{use Foo::Bar 0.01 }}}), and from which it sets //requires// attributes. 
     358 
    355359---- 
    356360