doc/html/Plugins/index.html

   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/docker-101/">Docker 101</a>
 119                 </li>
 120                 <li class="">
 121
 122     <a class="" href="../docker/shaarli-images/">Shaarli images</a>
 123                 </li>
 124                 <li class="">
 125
 126     <a class="" href="../docker/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="../Various-hacks/">Various hacks</a>
 177                 </li>
 178     </ul>
 179             </li>
 180
 181             <li class="toctree-l1">
 182
 183     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 184             </li>
 185
 186             <li class="toctree-l1">
 187
 188     <span class="caption-text">Development</span>
 189     <ul class="subnav">
 190                 <li class="">
 191
 192     <a class="" href="../Development-guidelines/">Development guidelines</a>
 193                 </li>
 194                 <li class="">
 195
 196     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 197                 </li>
 198                 <li class="">
 199
 200     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 201                 </li>
 202                 <li class="">
 203
 204     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 205                 </li>
 206                 <li class="">
 207
 208     <a class="" href="../Directory-structure/">Directory structure</a>
 209                 </li>
 210                 <li class="">
 211
 212     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 213                 </li>
 214                 <li class="">
 215
 216     <a class="" href="../Plugin-System/">Plugin System</a>
 217                 </li>
 218                 <li class="">
 219
 220     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 221                 </li>
 222                 <li class="">
 223
 224     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 225                 </li>
 226                 <li class="">
 227
 228     <a class="" href="../Security/">Security</a>
 229                 </li>
 230                 <li class="">
 231
 232     <a class="" href="../Static-analysis/">Static analysis</a>
 233                 </li>
 234                 <li class="">
 235
 236     <a class="" href="../Theming/">Theming</a>
 237                 </li>
 238                 <li class="">
 239
 240     <a class="" href="../Unit-tests/">Unit tests</a>
 241                 </li>
 242     </ul>
 243             </li>
 244
 245             <li class="toctree-l1">
 246
 247     <span class="caption-text">About</span>
 248     <ul class="subnav">
 249                 <li class="">
 250
 251     <a class="" href="../FAQ/">FAQ</a>
 252                 </li>
 253                 <li class="">
 254
 255     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 256                 </li>
 257     </ul>
 258             </li>
 259
 260         </ul>
 261       </div>
 262       &nbsp;
 263     </nav>
 264
 265     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 266
 267
 268       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 269         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 270         <a href="..">Shaarli Documentation</a>
 271       </nav>
 272
 273
 274       <div class="wy-nav-content">
 275         <div class="rst-content">
 276           <div role="navigation" aria-label="breadcrumbs navigation">
 277   <ul class="wy-breadcrumbs">
 278     <li><a href="..">Docs</a> &raquo;</li>
 279
 280
 281
 282           <li>Setup &raquo;</li>
 283
 284
 285
 286     <li>Plugins</li>
 287     <li class="wy-breadcrumbs-aside">
 288
 289         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Plugins.md"
 290           class="icon icon-github"> Edit on GitHub</a>
 291
 292     </li>
 293   </ul>
 294   <hr/>
 295 </div>
 296           <div role="main">
 297             <div class="section">
 298
 299                 <h2 id="plugin-installation">Plugin installation</h2>
 300 <p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.</p>
 301 <p>If you want to install a third party plugin:</p>
 302 <ul>
 303 <li>Download it.</li>
 304 <li>Put it in the <code>plugins</code> directory in Shaarli's installation folder.</li>
 305 <li>Make sure you put it correctly:</li>
 306 </ul>
 307 <pre><code>| index.php
 308 | plugins/
 309 |---| custom_plugin/
 310 |   |---| custom_plugin.php
 311 |   |---| ...
 312
 313 </code></pre>
 314
 315 <ul>
 316 <li>Make sure your webserver can read and write the files in your plugin folder.</li>
 317 </ul>
 318 <h2 id="plugin-configuration">Plugin configuration</h2>
 319 <p>In Shaarli's administration page (<code>Tools</code> link), go to <code>Plugin administration</code>.</p>
 320 <p>Here you can enable and disable all plugins available, and configure them.</p>
 321 <p><img alt="administration screenshot" src="https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" /></p>
 322 <h2 id="plugin-order">Plugin order</h2>
 323 <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>
 324 <p>This is important in case plugins are depending on each other. Read plugins README details for more information.</p>
 325 <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>
 326 <h2 id="file-mode">File mode</h2>
 327 <p>Enabled plugin are stored in your <code>config.php</code> parameters file, under the <code>array</code>:</p>
 328 <pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS']
 329 </code></pre>
 330
 331 <p>You can edit them manually here.
 332 Example:</p>
 333 <pre><code class="php">$GLOBALS['config']['ENABLED_PLUGINS'] = array(
 334     'qrcode',
 335     'archiveorg',
 336     'wallabag',
 337     'markdown',
 338 );
 339 </code></pre>
 340
 341 <h3 id="plugin-usage">Plugin usage</h3>
 342 <h4 id="official-plugins">Official plugins</h4>
 343 <p>Usage of each plugin is documented in it's README file:</p>
 344 <ul>
 345 <li><code>addlink-toolbar</code>: Adds the addlink input on the linklist page</li>
 346 <li><code>archiveorg</code>: For each link, add an Archive.org icon</li>
 347 <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>
 348 <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>
 349 <li><code>qrcode</code>: For each link, add a QRCode icon.</li>
 350 <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>
 351 </ul>
 352 <h4 id="third-party-plugins">Third party plugins</h4>
 353 <p>See <a href="https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community &amp; related software</a></p>
 354
 355             </div>
 356           </div>
 357           <footer>
 358
 359     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 360
 361         <a href="../docker/docker-101/" class="btn btn-neutral float-right" title="Docker 101">Next <span class="icon icon-circle-arrow-right"></span></a>
 362
 363
 364         <a href="../Shaarli-configuration/" class="btn btn-neutral" title="Shaarli configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 365
 366     </div>
 367
 368
 369   <hr/>
 370
 371   <div role="contentinfo">
 372     <!-- Copyright etc -->
 373
 374   </div>
 375
 376   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>.
 377 </footer>
 378
 379         </div>
 380       </div>
 381
 382     </section>
 383
 384   </div>
 385
 386   <div class="rst-versions" role="note" style="cursor: pointer">
 387     <span class="rst-current-version" data-toggle="rst-current-version">
 388
 389           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 390
 391
 392         <span><a href="../Shaarli-configuration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 393
 394
 395         <span style="margin-left: 15px"><a href="../docker/docker-101/" style="color: #fcfcfc">Next &raquo;</a></span>
 396
 397     </span>
 398 </div>
 399     <script src="../js/theme.js"></script>
 400
 401 </body>
 402 </html>