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

#Plugins
## Plugin installation

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

If you want to install a third party plugin:

  * Download it.
  * Put it in the `plugins` directory in Shaarli's installation folder.
  * Make sure you put it correctly:

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

```

  * 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`.

Here you can enable and disable all plugins available, and configure them.

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

## Plugin 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.

This is important in case plugins are depending on each other. Read plugins README details 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.

## File mode

Enabled plugin are stored in your `config.php` parameters file, under the `array`:

```php
$GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html)
```

You can edit them manually here.
Example:

```php
$GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html)
    'qrcode', 
    'archiveorg',
    'wallabag',
    'markdown',
);
```

### Plugin usage

#### Official plugins

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
 * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax.[](.html)
 * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.[](.html)
 * `qrcode`: For each link, add a QRCode icon.
 * `readityourself`: For each link, add a ReadItYourself icon to save the shaared URL
 * [`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.[](.html)


#### Third party plugins

See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins)[](.html)
Commit	Line	Data
08dcd8ea	1	#Plugins
5409ade2 A	2	## Plugin installation
	3
	4	There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.
	5
	6	If you want to install a third party plugin:
	7
	8	* Download it.
	9	* Put it in the `plugins` directory in Shaarli's installation folder.
	10	* Make sure you put it correctly:
	11
	12	```
	13	\| index.php
	14	\| plugins/
	15	\|---\| custom_plugin/
	16	\| \|---\| custom_plugin.php
	17	\| \|---\| ...
	18
	19	```
	20
	21	* Make sure your webserver can read and write the files in your plugin folder.
	22
	23	## Plugin configuration
	24
	25	In Shaarli's administration page (`Tools` link), go to `Plugin administration`.
	26
	27	Here you can enable and disable all plugins available, and configure them.
	28
	29	![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67)[](.html)
	30
	31	## Plugin order
	32
	33	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.
	34
	35	This is important in case plugins are depending on each other. Read plugins README details for more information.
	36
	37	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.
	38
	39	## File mode
	40
	41	Enabled plugin are stored in your `config.php` parameters file, under the `array`:
	42
	43	```php
	44	$GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html)
	45	```
	46
	47	You can edit them manually here.
	48	Example:
	49
	50	```php
	51	$GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html)
	52	'qrcode',
	53	'archiveorg',
	54	'wallabag',
	55	'markdown',
	56	);
	57	```
	58
	59	### Plugin usage
	60
08dcd8ea A	61	#### Official plugins
08dcd8ea A	62
5409ade2 A	63	Usage of each plugin is documented in it's README file:
	64
	65	* `addlink-toolbar`: Adds the addlink input on the linklist page
	66	* `archiveorg`: For each link, add an Archive.org icon
	67	* [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax.[](.html)
	68	* [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.[](.html)
	69	* `qrcode`: For each link, add a QRCode icon.
	70	* `readityourself`: For each link, add a ReadItYourself icon to save the shaared URL
	71	* [`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.[](.html)
08dcd8ea A	72
	73
	74
	75	#### Third party plugins
	76
	77	See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins)[](.html)