]>
Commit | Line | Data |
---|---|---|
5409ade2 A |
1 | <!DOCTYPE html> |
2 | <html> | |
3 | <head> | |
4 | <meta charset="utf-8"> | |
5 | <meta name="generator" content="pandoc"> | |
6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | |
08dcd8ea | 7 | <title>Shaarli – Plugins</title> |
5409ade2 A |
8 | <style type="text/css">code{white-space: pre;}</style> |
9 | <style type="text/css"> | |
10 | div.sourceCode { overflow-x: auto; } | |
11 | table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { | |
12 | margin: 0; padding: 0; vertical-align: baseline; border: none; } | |
13 | table.sourceCode { width: 100%; line-height: 100%; } | |
14 | td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } | |
15 | td.sourceCode { padding-left: 5px; } | |
16 | code > span.kw { color: #007020; font-weight: bold; } /* Keyword */ | |
17 | code > span.dt { color: #902000; } /* DataType */ | |
18 | code > span.dv { color: #40a070; } /* DecVal */ | |
19 | code > span.bn { color: #40a070; } /* BaseN */ | |
20 | code > span.fl { color: #40a070; } /* Float */ | |
21 | code > span.ch { color: #4070a0; } /* Char */ | |
22 | code > span.st { color: #4070a0; } /* String */ | |
23 | code > span.co { color: #60a0b0; font-style: italic; } /* Comment */ | |
24 | code > span.ot { color: #007020; } /* Other */ | |
25 | code > span.al { color: #ff0000; font-weight: bold; } /* Alert */ | |
26 | code > span.fu { color: #06287e; } /* Function */ | |
27 | code > span.er { color: #ff0000; font-weight: bold; } /* Error */ | |
28 | code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */ | |
29 | code > span.cn { color: #880000; } /* Constant */ | |
30 | code > span.sc { color: #4070a0; } /* SpecialChar */ | |
31 | code > span.vs { color: #4070a0; } /* VerbatimString */ | |
32 | code > span.ss { color: #bb6688; } /* SpecialString */ | |
33 | code > span.im { } /* Import */ | |
34 | code > span.va { color: #19177c; } /* Variable */ | |
35 | code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */ | |
36 | code > span.op { color: #666666; } /* Operator */ | |
37 | code > span.bu { } /* BuiltIn */ | |
38 | code > span.ex { } /* Extension */ | |
39 | code > span.pp { color: #bc7a00; } /* Preprocessor */ | |
40 | code > span.at { color: #7d9029; } /* Attribute */ | |
41 | code > span.do { color: #ba2121; font-style: italic; } /* Documentation */ | |
42 | code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */ | |
43 | code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */ | |
44 | code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */ | |
45 | </style> | |
46 | <link rel="stylesheet" href="github-markdown.css"> | |
47 | <!--[if lt IE 9]> | |
48 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | |
49 | <![endif]--> | |
50 | </head> | |
51 | <body> | |
52 | <div id="local-sidebar"> | |
53 | <ul> | |
54 | <li><a href="Home.html">Home</a></li> | |
fdf88d19 | 55 | <li>Setup |
5409ade2 | 56 | <ul> |
fdf88d19 A |
57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> |
58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | |
5409ade2 A |
59 | <li><a href="Server-requirements.html">Server requirements</a></li> |
60 | <li><a href="Server-configuration.html">Server configuration</a></li> | |
61 | <li><a href="Server-security.html">Server security</a></li> | |
5409ade2 | 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> |
08dcd8ea | 63 | <li><a href="Plugins.html">Plugins</a></li> |
5409ade2 A |
64 | </ul></li> |
65 | <li><a href="Docker.html">Docker</a></li> | |
5409ade2 A |
66 | <li><a href="Usage.html">Usage</a> |
67 | <ul> | |
68 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | |
69 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | |
70 | <li><a href="Firefox-share.html">Firefox share</a></li> | |
71 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | |
72 | </ul></li> | |
73 | <li>How To | |
74 | <ul> | |
75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | |
5409ade2 A |
76 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> |
77 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | |
78 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | |
79 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | |
80 | </ul></li> | |
81 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | |
82 | <li><a href="Development.html">Development</a> | |
83 | <ul> | |
84 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | |
85 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | |
86 | <li><a href="Directory-structure.html">Directory structure</a></li> | |
87 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | |
88 | <li><a href="Plugin-System.html">Plugin System</a></li> | |
89 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | |
90 | <li><a href="Security.html">Security</a></li> | |
91 | <li><a href="Static-analysis.html">Static analysis</a></li> | |
92 | <li><a href="Theming.html">Theming</a></li> | |
93 | <li><a href="Unit-tests.html">Unit tests</a></li> | |
94 | </ul></li> | |
95 | <li>About | |
96 | <ul> | |
97 | <li><a href="FAQ.html">FAQ</a></li> | |
98 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | |
5409ade2 A |
99 | </ul></li> |
100 | </ul> | |
101 | </div> | |
08dcd8ea | 102 | <h1 id="plugins">Plugins</h1> |
5409ade2 A |
103 | <h2 id="plugin-installation">Plugin installation</h2> |
104 | <p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p> | |
105 | <p>If you want to install a third party plugin:</p> | |
106 | <ul> | |
107 | <li>Download it.</li> | |
108 | <li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li> | |
109 | <li>Make sure you put it correctly:</li> | |
110 | </ul> | |
111 | <pre><code>| index.php | |
112 | | plugins/ | |
113 | |---| custom_plugin/ | |
114 | | |---| custom_plugin.php | |
115 | | |---| ... | |
116 | </code></pre> | |
117 | <ul> | |
118 | <li>Make sure your webserver can read and write the files in your plugin folder.</li> | |
119 | </ul> | |
120 | <h2 id="plugin-configuration">Plugin configuration</h2> | |
121 | <p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p> | |
122 | <p>Here you can enable and disable all plugins available, and configure them.</p> | |
123 | <p><img src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" alt="administration screenshot" /><a href=".html"></a></p> | |
124 | <h2 id="plugin-order">Plugin order</h2> | |
125 | <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> | |
126 | <p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p> | |
127 | <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> | |
128 | <h2 id="file-mode">File mode</h2> | |
129 | <p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p> | |
130 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]](</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span>.html<span class="ot">)</span></code></pre></div> | |
131 | <p>You can edit them manually here.<br /> | |
132 | Example:</p> | |
133 | <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$GLOBALS</span><span class="ot">[</span><span class="st">'config'</span><span class="ot">[</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span> = <span class="fu">array</span><span class="ot">(](</span><span class="st">'ENABLED_PLUGINS'</span><span class="ot">]</span>-=-<span class="fu">array</span><span class="ot">(</span>.html<span class="ot">)</span> | |
134 | <span class="st">'qrcode'</span><span class="ot">,</span> | |
135 | <span class="st">'archiveorg'</span><span class="ot">,</span> | |
136 | <span class="st">'wallabag'</span><span class="ot">,</span> | |
137 | <span class="st">'markdown'</span><span class="ot">,</span> | |
138 | <span class="ot">);</span></code></pre></div> | |
139 | <h3 id="plugin-usage">Plugin usage</h3> | |
08dcd8ea | 140 | <h4 id="official-plugins">Official plugins</h4> |
5409ade2 A |
141 | <p>Usage of each plugin is documented in it's README file:</p> |
142 | <ul> | |
143 | <li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li> | |
144 | <li><code>archiveorg</code>: For each link, add an Archive.org icon</li> | |
145 | <li><a href="https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md"><code>markdown</code></a>: Render shaare description with Markdown syntax.<a href=".html"></a></li> | |
146 | <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.<a href=".html"></a></li> | |
147 | <li><code>qrcode</code>: For each link, add a QRCode icon.</li> | |
148 | <li><code>readityourself</code>: For each link, add a ReadItYourself icon to save the shaared URL</li> | |
149 | <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.<a href=".html"></a></li> | |
150 | </ul> | |
08dcd8ea A |
151 | <h4 id="third-party-plugins">Third party plugins</h4> |
152 | <p>See <a href="https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community & related software</a><a href=".html"></a></p> | |
5409ade2 A |
153 | </body> |
154 | </html> |