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