From a8fb97a0c37b5008765fa73d30a678418011adc1 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 13 Jul 2019 11:02:05 +0200 Subject: [PATCH] Default colors plugin - Documentation --- doc/md/Plugin-System.md | 17 +++++++++++++++++ doc/md/Plugins.md | 4 ++++ 2 files changed, 21 insertions(+) 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 | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | +| [save_plugin_parameters](#save_plugin_parameters) | Allow to manipulate plugin parameters before they're saved. | @@ -471,6 +472,22 @@ Allow to execute any action before the link is actually removed from the datasto - created - updated + +#### save_plugin_parameters + +Triggered when the plugin parameters are saved from the plugin administration page. + +Plugins can perform an action every times their settings are updated. +For example it is used to update the CSS file of the `default_colors` plugins. + +##### Data + +`$data` input contains the `$_POST` array. + +So if the plugin has a parameter called `MYPLUGIN_PARAMETER`, +the array will contain an entry with `MYPLUGIN_PARAMETER` as a key. + + ## Guide for template designer ### 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: * `addlink-toolbar`: Adds the addlink input on the linklist page * `archiveorg`: For each link, add an Archive.org icon + * `default_colors`: Override default theme colors. + * `isso`: Let visitor comment your shaares on permalinks with Isso. * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. + * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. + * `pubsubhubbub`: Enable PubSubHubbub feed publishing * `qrcode`: For each link, add a QRCode icon. * [`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.