aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/Plugins')
-rw-r--r--doc/html/Plugins/index.html414
1 files changed, 414 insertions, 0 deletions
diff --git a/doc/html/Plugins/index.html b/doc/html/Plugins/index.html
new file mode 100644
index 00000000..3a30e93c
--- /dev/null
+++ b/doc/html/Plugins/index.html
@@ -0,0 +1,414 @@
1<!DOCTYPE html>
2<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
4<head>
5 <meta charset="utf-8">
6 <meta http-equiv="X-UA-Compatible" content="IE=edge">
7 <meta name="viewport" content="width=device-width, initial-scale=1.0">
8
9
10 <link rel="shortcut icon" href="../img/favicon.ico">
11 <title>Plugins - Shaarli Documentation</title>
12 <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
13
14 <link rel="stylesheet" href="../css/theme.css" type="text/css" />
15 <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
16 <link rel="stylesheet" href="../css/highlight.css">
17 <link href="../github-markdown.css" rel="stylesheet">
18
19 <script>
20 // Current page data
21 var mkdocs_page_name = "Plugins";
22 var mkdocs_page_input_path = "Plugins.md";
23 var mkdocs_page_url = "/Plugins/";
24 </script>
25
26 <script src="../js/jquery-2.1.1.min.js"></script>
27 <script src="../js/modernizr-2.8.3.min.js"></script>
28 <script type="text/javascript" src="../js/highlight.pack.js"></script>
29
30</head>
31
32<body class="wy-body-for-nav" role="document">
33
34 <div class="wy-grid-for-nav">
35
36
37 <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
38 <div class="wy-side-nav-search">
39 <a href=".." class="icon icon-home"> Shaarli Documentation</a>
40 <div role="search">
41 <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
42 <input type="text" name="q" placeholder="Search docs" />
43 </form>
44</div>
45 </div>
46
47 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
48 <ul class="current">
49
50
51 <li class="toctree-l1">
52
53 <a class="" href="..">Home</a>
54 </li>
55
56 <li class="toctree-l1">
57
58 <span class="caption-text">Setup</span>
59 <ul class="subnav">
60 <li class="">
61
62 <a class="" href="../Download-and-Installation/">Download and Installation</a>
63 </li>
64 <li class="">
65
66 <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
67 </li>
68 <li class="">
69
70 <a class="" href="../Server-requirements/">Server requirements</a>
71 </li>
72 <li class="">
73
74 <a class="" href="../Server-configuration/">Server configuration</a>
75 </li>
76 <li class="">
77
78 <a class="" href="../Server-security/">Server security</a>
79 </li>
80 <li class="">
81
82 <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
83 </li>
84 <li class=" current">
85
86 <a class="current" href="./">Plugins</a>
87 <ul class="subnav">
88
89 <li class="toctree-l3"><a href="#plugin-installation">Plugin installation</a></li>
90
91
92 <li class="toctree-l3"><a href="#plugin-configuration">Plugin configuration</a></li>
93
94
95 <li class="toctree-l3"><a href="#plugin-order">Plugin order</a></li>
96
97
98 <li class="toctree-l3"><a href="#file-mode">File mode</a></li>
99
100 <ul>
101
102 <li><a class="toctree-l4" href="#plugin-usage">Plugin usage</a></li>
103
104 </ul>
105
106
107 </ul>
108 </li>
109 </ul>
110 </li>
111
112 <li class="toctree-l1">
113
114 <span class="caption-text">Docker</span>
115 <ul class="subnav">
116 <li class="">
117
118 <a class="" href="../Docker-101/">Docker 101</a>
119 </li>
120 <li class="">
121
122 <a class="" href="../Shaarli-images/">Shaarli images</a>
123 </li>
124 <li class="">
125
126 <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
127 </li>
128 <li class="">
129
130 <a class="" href="../Docker-resources/">Docker resources</a>
131 </li>
132 </ul>
133 </li>
134
135 <li class="toctree-l1">
136
137 <span class="caption-text">Usage</span>
138 <ul class="subnav">
139 <li class="">
140
141 <a class="" href="../Features/">Features</a>
142 </li>
143 <li class="">
144
145 <a class="" href="../Bookmarklet/">Bookmarklet</a>
146 </li>
147 <li class="">
148
149 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
150 </li>
151 <li class="">
152
153 <a class="" href="../Firefox-share/">Firefox share</a>
154 </li>
155 <li class="">
156
157 <a class="" href="../RSS-feeds/">RSS feeds</a>
158 </li>
159 <li class="">
160
161 <a class="" href="../REST-API/">REST API</a>
162 </li>
163 </ul>
164 </li>
165
166 <li class="toctree-l1">
167
168 <span class="caption-text">How To</span>
169 <ul class="subnav">
170 <li class="">
171
172 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
173 </li>
174 <li class="">
175
176 <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
177 </li>
178 <li class="">
179
180 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
181 </li>
182 <li class="">
183
184 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
185 </li>
186 <li class="">
187
188 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
189 </li>
190 </ul>
191 </li>
192
193 <li class="toctree-l1">
194
195 <a class="" href="../Troubleshooting/">Troubleshooting</a>
196 </li>
197
198 <li class="toctree-l1">
199
200 <span class="caption-text">Development</span>
201 <ul class="subnav">
202 <li class="">
203
204 <a class="" href="../Development-guidelines/">Development guidelines</a>
205 </li>
206 <li class="">
207
208 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
209 </li>
210 <li class="">
211
212 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
213 </li>
214 <li class="">
215
216 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
217 </li>
218 <li class="">
219
220 <a class="" href="../Directory-structure/">Directory structure</a>
221 </li>
222 <li class="">
223
224 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
225 </li>
226 <li class="">
227
228 <a class="" href="../Plugin-System/">Plugin System</a>
229 </li>
230 <li class="">
231
232 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
233 </li>
234 <li class="">
235
236 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
237 </li>
238 <li class="">
239
240 <a class="" href="../Security/">Security</a>
241 </li>
242 <li class="">
243
244 <a class="" href="../Static-analysis/">Static analysis</a>
245 </li>
246 <li class="">
247
248 <a class="" href="../Theming/">Theming</a>
249 </li>
250 <li class="">
251
252 <a class="" href="../Unit-tests/">Unit tests</a>
253 </li>
254 </ul>
255 </li>
256
257 <li class="toctree-l1">
258
259 <span class="caption-text">About</span>
260 <ul class="subnav">
261 <li class="">
262
263 <a class="" href="../FAQ/">FAQ</a>
264 </li>
265 <li class="">
266
267 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
268 </li>
269 </ul>
270 </li>
271
272 </ul>
273 </div>
274 &nbsp;
275 </nav>
276
277 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
278
279
280 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
281 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
282 <a href="..">Shaarli Documentation</a>
283 </nav>
284
285
286 <div class="wy-nav-content">
287 <div class="rst-content">
288 <div role="navigation" aria-label="breadcrumbs navigation">
289 <ul class="wy-breadcrumbs">
290 <li><a href="..">Docs</a> &raquo;</li>
291
292
293
294 <li>Setup &raquo;</li>
295
296
297
298 <li>Plugins</li>
299 <li class="wy-breadcrumbs-aside">
300
301 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Plugins.md"
302 class="icon icon-github"> Edit on GitHub</a>
303
304 </li>
305 </ul>
306 <hr/>
307</div>
308 <div role="main">
309 <div class="section">
310
311 <h2 id="plugin-installation">Plugin installation</h2>
312<p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p>
313<p>If you want to install a third party plugin:</p>
314<ul>
315<li>Download it.</li>
316<li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li>
317<li>Make sure you put it correctly:</li>
318</ul>
319<pre><code>| index.php
320| plugins/
321|---| custom_plugin/
322| |---| custom_plugin.php
323| |---| ...
324
325</code></pre>
326
327<ul>
328<li>Make sure your webserver can read and write the files in your plugin folder.</li>
329</ul>
330<h2 id="plugin-configuration">Plugin configuration</h2>
331<p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p>
332<p>Here you can enable and disable all plugins available, and configure them.</p>
333<p><img alt="administration screenshot" src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" /></p>
334<h2 id="plugin-order">Plugin order</h2>
335<p>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.</p>
336<p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p>
337<p><strong>Use case</strong>: The (non existent) plugin <code>shaares_footer</code> adds a footer to every shaare in Markdown syntax. It needs to be processed <em>before</em> (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.</p>
338<h2 id="file-mode">File mode</h2>
339<p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p>
340<pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS']
341</code></pre>
342
343<p>You can edit them manually here.
344Example:</p>
345<pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS'] = array(
346 'qrcode',
347 'archiveorg',
348 'wallabag',
349 'markdown',
350);
351</code></pre>
352
353<h3 id="plugin-usage">Plugin usage</h3>
354<h4 id="official-plugins">Official plugins</h4>
355<p>Usage of each plugin is documented in it's README file:</p>
356<ul>
357<li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li>
358<li><code>archiveorg</code>: For each link, add an Archive.org icon</li>
359<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md"><code>markdown</code></a>: Render shaare description with Markdown syntax.</li>
360<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md"><code>playvideos</code></a>: Add a button in the toolbar allowing to watch all videos.</li>
361<li><code>qrcode</code>: For each link, add a QRCode icon.</li>
362<li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md"><code>wallabag</code></a>: For each link, add a Wallabag icon to save it in your instance.</li>
363</ul>
364<h4 id="third-party-plugins">Third party plugins</h4>
365<p>See <a href="https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community &amp; related software</a></p>
366
367 </div>
368 </div>
369 <footer>
370
371 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
372
373 <a href="../Docker-101/" class="btn btn-neutral float-right" title="Docker 101">Next <span class="icon icon-circle-arrow-right"></span></a>
374
375
376 <a href="../Shaarli-configuration/" class="btn btn-neutral" title="Shaarli configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
377
378 </div>
379
380
381 <hr/>
382
383 <div role="contentinfo">
384 <!-- Copyright etc -->
385
386 </div>
387
388 Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
389</footer>
390
391 </div>
392 </div>
393
394 </section>
395
396 </div>
397
398 <div class="rst-versions" role="note" style="cursor: pointer">
399 <span class="rst-current-version" data-toggle="rst-current-version">
400
401 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
402
403
404 <span><a href="../Shaarli-configuration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
405
406
407 <span style="margin-left: 15px"><a href="../Docker-101/" style="color: #fcfcfc">Next &raquo;</a></span>
408
409 </span>
410</div>
411 <script src="../js/theme.js"></script>
412
413</body>
414</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-27 02:06:01 +0000