**General rewording, proof-reading, deduplication, shortening, reordering, simplifica...

[github/shaarli/Shaarli.git] / doc / md / Plugins.md

diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md
index 3e261815252ac38473dace088a6c40fa7574d573..49a51f51ec83733653bfa3414f61fa3dd7ff6a4e 100644 (file)
--- a/doc/md/Plugins.md
+++ b/doc/md/Plugins.md
@@ -1,14 +1,13 @@
-## Plugin installation
+# Plugins

 
 

-There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.
+## Installation

 
 

-If you want to install a third party plugin:
+For plugins shipped with Shaarli, no installation is required.

 
 

-- Download it.
-- Put it in the `plugins` directory in Shaarli's installation folder.
-- Make sure you put it correctly:
+If you want to install a third party plugin, download it to the `plugins` directory in Shaarli's installation folder:

 
 

-```
+```bash
+# example directory structure

 | index.php
 | plugins/
 |---| custom_plugin/
 | index.php
 | plugins/
 |---| custom_plugin/


@@ -17,34 +16,34 @@ If you want to install a third party plugin:
 
 ```
 
 
 ```
 

-  * Make sure your webserver can read and write the files in your plugin folder.
+Make sure your webserver can read and write the files in your plugin folder.

 
 

-## Plugin configuration

 
 

-In Shaarli's administration page (`Tools` link), go to `Plugin administration`.
+## Configuration

 
 

-Here you can enable and disable all plugins available, and configure them.
+From Shaarli's administration page (`Tools` link), go to `Plugin administration`. Here you can enable and disable all plugins available, and configure them.

 
 ![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67)
 
 
 ![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67)
 

-## Plugin order
+
+## Order

 
 In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.
 
 
 In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.
 

-This is important in case plugins are depending on each other. Read plugins README details for more information.
+This is important in case plugins depend on each other. Read plugins READMEs for more information.

 
 **Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.
 
 
 **Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.
 

-## File mode

 
 

-Enabled plugin are stored in your `config.json.php` parameters file, under the `array`:
+## Configuration file
+
+Enabled plugins are stored in your [Configuration file](Shaarli-configuration), under the array:

 
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS']
 ```
 
 
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS']
 ```
 

-You can edit them manually here.
-Example:
+You can edit them manually here. For example:

 
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS'] = array(
 
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS'] = array(


@@ -55,25 +54,25 @@ $GLOBALS['config']['ENABLED_PLUGINS'] = array(
 );
 ```
 
 );
 ```
 

-### Plugin usage

 
 

-#### Official plugins
+## Usage
+
+### Official plugins

 
 Usage of each plugin is documented in it's README file:
 
 
 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
+ * `addlink-toolbar`: Adds the addlink input on the Shaares list page
+ * `archiveorg`: For each Shaare, add a link to the archived page on Archive.org

  * `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
  * `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.
-
+ * `qrcode`: For each Shaare, add a QRCode icon.
+ * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md):  For each Shaare, add a Wallabag icon to save it in your instance.

 
 
 
 

-#### Third party plugins
+### Third party plugins

 
 

-See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/)
+See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-and-Related-software/)