Browse Source

Review updates

pull/4288/head
Adam Magness 4 years ago
parent
commit
ac374f7773
  1. 2
      INSTALL.txt
  2. 4
      doc/Addons.md
  3. 2
      doc/database/db_addon.md

2
INSTALL.txt

@ -141,7 +141,7 @@ installation, it will look like
$a->config['system']['addon'] = 'js_upload';
This indicates the "js_upload" addon module is enabled. You may add additional
addons/addons using this same line in the configuration file. Change it to
addons using this same line in the configuration file. Change it to
read
$a->config['system']['addon'] = 'js_upload,poormancron';

4
doc/Plugins.md → doc/Addons.md

@ -9,7 +9,7 @@ Modules work by intercepting specific page requests (by URL path).
Addon names cannot contain spaces or other punctuation and are used as filenames and function names.
You may supply a "friendly" name within the comment block.
Each addon must contain both an install and an uninstall function based on the addon/addon name.
Each addon must contain both an install and an uninstall function based on the addon name.
For instance "addon1name_install()".
These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
The install and uninstall functions will also be called (i.e. re-installed) if the addon changes after installation.
@ -69,7 +69,7 @@ Remember to declare it with '&' if you wish to alter it.
Modules
---
Addons/addons may also act as "modules" and intercept all page requests for a given URL path.
Addons may also act as "modules" and intercept all page requests for a given URL path.
In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.

2
doc/database/db_addon.md

@ -12,6 +12,6 @@ Table addon
| plugin_admin | 1 = has admin config, 0 = has no admin config | tinyint(1) | NO | | 0 | |
Notes:
These are addons which have been enabled by the site administrator on the admin/addon page
These are addons which have been enabled by the site administrator on the addon page
Return to [database documentation](help/database)
Loading…
Cancel
Save