diff options
author | ArthurHoaro <arthur@hoa.ro> | 2019-07-13 11:02:05 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2019-07-20 09:32:56 +0200 |
commit | a8fb97a0c37b5008765fa73d30a678418011adc1 (patch) | |
tree | 4f37fb76f2fe50c6f4c9a5efb8321d811a357ad2 /doc/md | |
parent | e503d26f0bf87e8354291e09380f289f52cd67ab (diff) | |
download | Shaarli-a8fb97a0c37b5008765fa73d30a678418011adc1.tar.gz Shaarli-a8fb97a0c37b5008765fa73d30a678418011adc1.tar.zst Shaarli-a8fb97a0c37b5008765fa73d30a678418011adc1.zip |
Default colors plugin - Documentation
Diffstat (limited to 'doc/md')
-rw-r--r-- | doc/md/Plugin-System.md | 17 | ||||
-rw-r--r-- | doc/md/Plugins.md | 4 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md index cbec04c0..9b0d3a7d 100644 --- a/doc/md/Plugin-System.md +++ b/doc/md/Plugin-System.md | |||
@@ -137,6 +137,7 @@ If it's still not working, please [open an issue](https://github.com/shaarli/Sha | |||
137 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | | 137 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | |
138 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | | 138 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | |
139 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | | 139 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | |
140 | | [save_plugin_parameters](#save_plugin_parameters) | Allow to manipulate plugin parameters before they're saved. | | ||
140 | 141 | ||
141 | 142 | ||
142 | 143 | ||
@@ -471,6 +472,22 @@ Allow to execute any action before the link is actually removed from the datasto | |||
471 | - created | 472 | - created |
472 | - updated | 473 | - updated |
473 | 474 | ||
475 | |||
476 | #### save_plugin_parameters | ||
477 | |||
478 | Triggered when the plugin parameters are saved from the plugin administration page. | ||
479 | |||
480 | Plugins can perform an action every times their settings are updated. | ||
481 | For example it is used to update the CSS file of the `default_colors` plugins. | ||
482 | |||
483 | ##### Data | ||
484 | |||
485 | `$data` input contains the `$_POST` array. | ||
486 | |||
487 | So if the plugin has a parameter called `MYPLUGIN_PARAMETER`, | ||
488 | the array will contain an entry with `MYPLUGIN_PARAMETER` as a key. | ||
489 | |||
490 | |||
474 | ## Guide for template designer | 491 | ## Guide for template designer |
475 | 492 | ||
476 | ### Plugin administration | 493 | ### Plugin administration |
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md index 954442e2..3e261815 100644 --- a/doc/md/Plugins.md +++ b/doc/md/Plugins.md | |||
@@ -63,8 +63,12 @@ Usage of each plugin is documented in it's README file: | |||
63 | 63 | ||
64 | * `addlink-toolbar`: Adds the addlink input on the linklist page | 64 | * `addlink-toolbar`: Adds the addlink input on the linklist page |
65 | * `archiveorg`: For each link, add an Archive.org icon | 65 | * `archiveorg`: For each link, add an Archive.org icon |
66 | * `default_colors`: Override default theme colors. | ||
67 | * `isso`: Let visitor comment your shaares on permalinks with Isso. | ||
66 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. | 68 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. |
69 | * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. | ||
67 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. | 70 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. |
71 | * `pubsubhubbub`: Enable PubSubHubbub feed publishing | ||
68 | * `qrcode`: For each link, add a QRCode icon. | 72 | * `qrcode`: For each link, add a QRCode icon. |
69 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. | 73 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. |
70 | 74 | ||