Wiki source for InstallableActionTemplate


Show raw source

=====InstallableActions Template=====

>>**See also:**
~-PluginDirectory - A home for your installable actions/plugins
>>::c::

The main title will be used in the summary column of the ""InstallableActions"" list, so make sure it's descriptive.

====The Read Me (Optional)====

You should put any important notes here. The user will see them before anything has happened to their system.

%%(readme)
This code may BlowYourHouseUp. SoBeCareful.

The license is GNU.
%%

====The Data Model (Optional)====

If your action requires some MySQL modifications, put them here.

%%(mysql)
# INSTALL STEP
CREATE TABLE prefix_testing123 (
page_tag varchar(75) NOT NULL default '',
PRIMARY KEY (page_tag)
) TYPE=MyISAM;
# INSTALL STEP
CREATE TABLE prefix_testingtesting123 (
page_tag varchar(75) NOT NULL default '',
PRIMARY KEY (page_tag)
) TYPE=MyISAM;
# INSTALL STEP

# REMOVAL STEP
DROP TABLE IF EXISTS prefix_testing123;
# REMOVAL STEP
DROP TABLE IF EXISTS prefix_testingtesting123;
# REMOVAL STEP
%%

====The CSS Definitions (Optional)====

If your action requires CSS styles, put them here. They will automatically be stored in a file and loaded in the header when the action is run.

%%(css)
.easier {font-family:verdana;color:green}
%%

====The PHP Code (Required)====

Every action is expected to have at least one line of code and a version number set in the config section.
The format is (lowercase action name without spaces)_version => '#'.
You can specify an unlimited number of config settings (one per line).

%%(php)
installableactiontemplate_version => '1.0'
random_setting => 'this will be added to the main config array'
<?php
echo $this->config['random_setting'];
echo '<p class="easier">Other typical wiki stuff goes here...</p>';
?>
%%

====Informing the Installer (Required)====

A mention of ""InstallableAction"" is required for the Installer to include your action in the list. You can hide it in an HTML comment with the following line of code:

%%
""<!-- InstallableAction -->""
%%

----
CategoryUserContributions
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki