2016-04-14 14:20:23 +02:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "generator" content = "pandoc" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0, user-scalable=yes" >
2016-05-14 11:37:28 +02:00
< title > Shaarli – < / title >
2016-04-14 14:20:23 +02:00
< style type = "text/css" > code { white-space : pre ; } < / style >
< style type = "text/css" >
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
< / style >
< link rel = "stylesheet" href = "github-markdown.css" >
<!-- [if lt IE 9]>
< script src = "//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js" > < / script >
<![endif]-->
< / head >
< body >
< div id = "local-sidebar" >
< ul >
< li > < a href = "Home.html" > Home< / a > < / li >
2016-10-12 12:36:59 +02:00
< li > Setup
2016-04-14 14:20:23 +02:00
< ul >
2016-10-12 12:36:59 +02:00
< li > < a href = "Download-and-Installation.html" > Download and Installation< / a > < / li >
< li > < a href = "Upgrade-and-migration.html" > Upgrade and migration< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Server-requirements.html" > Server requirements< / a > < / li >
< li > < a href = "Server-configuration.html" > Server configuration< / a > < / li >
< li > < a href = "Server-security.html" > Server security< / a > < / li >
< li > < a href = "Shaarli-configuration.html" > Shaarli configuration< / a > < / li >
2016-05-14 11:37:28 +02:00
< li > < a href = "Plugins.html" > Plugins< / a > < / li >
2016-04-14 14:20:23 +02:00
< / ul > < / li >
< li > < a href = "Docker.html" > Docker< / a > < / li >
< li > < a href = "Usage.html" > Usage< / a >
< ul >
< li > < a href = "Sharing-button.html" > Sharing button< / a > (bookmarklet)< / li >
< li > < a href = "Browsing-and-Searching.html" > Browsing and Searching< / a > < / li >
< li > < a href = "Firefox-share.html" > Firefox share< / a > < / li >
< li > < a href = "RSS-feeds.html" > RSS feeds< / a > < / li >
2017-05-07 18:44:05 +02:00
< li > < a href = "REST-API.html" > REST API< / a > < / li >
2016-04-14 14:20:23 +02:00
< / ul > < / li >
< li > How To
< ul >
< li > < a href = "Backup,-restore,-import-and-export.html" > Backup, restore, import and export< / a > < / li >
< 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 >
< li > < a href = "Create-and-serve-multiple-Shaarlis-(farm).html" > Create and serve multiple Shaarlis (farm)< / a > < / li >
< li > < a href = "Download-CSS-styles-from-an-OPML-list.html" > Download CSS styles from an OPML list< / a > < / li >
< li > < a href = "Datastore-hacks.html" > Datastore hacks< / a > < / li >
< / ul > < / li >
< li > < a href = "Troubleshooting.html" > Troubleshooting< / a > < / li >
< li > < a href = "Development.html" > Development< / a >
< ul >
< li > < a href = "GnuPG-signature.html" > GnuPG signature< / a > < / li >
< li > < a href = "Coding-guidelines.html" > Coding guidelines< / a > < / li >
< li > < a href = "Directory-structure.html" > Directory structure< / a > < / li >
< li > < a href = "3rd-party-libraries.html" > 3rd party libraries< / a > < / li >
< li > < a href = "Plugin-System.html" > Plugin System< / a > < / li >
< li > < a href = "Release-Shaarli.html" > Release Shaarli< / a > < / li >
2017-05-07 18:44:05 +02:00
< li > < a href = "Versioning-and-Branches.html" > Versioning and Branches< / a > < / li >
2016-04-14 14:20:23 +02:00
< li > < a href = "Security.html" > Security< / a > < / li >
< li > < a href = "Static-analysis.html" > Static analysis< / a > < / li >
< li > < a href = "Theming.html" > Theming< / a > < / li >
< li > < a href = "Unit-tests.html" > Unit tests< / a > < / li >
< / ul > < / li >
< li > About
< ul >
< li > < a href = "FAQ.html" > FAQ< / a > < / li >
< li > < a href = "Community-&-Related-software.html" > Community & Related software< / a > < / li >
< / ul > < / li >
< / ul >
< / div >
2016-05-14 11:37:28 +02:00
< h1 id = "plugins" > Plugins< / h1 >
2016-04-14 14:20:23 +02:00
< h2 id = "plugin-installation" > Plugin installation< / h2 >
< p > There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.< / p >
< p > If you want to install a third party plugin:< / p >
< ul >
< li > Download it.< / li >
< li > Put it in the < code > plugins< / code > directory in Shaarli's installation folder.< / li >
< li > Make sure you put it correctly:< / li >
< / ul >
< pre > < code > | index.php
| plugins/
|---| custom_plugin/
| |---| custom_plugin.php
| |---| ...
< / code > < / pre >
< ul >
< li > Make sure your webserver can read and write the files in your plugin folder.< / li >
< / ul >
< h2 id = "plugin-configuration" > Plugin configuration< / h2 >
< p > In Shaarli's administration page (< code > Tools< / code > link), go to < code > Plugin administration< / code > .< / p >
< p > Here you can enable and disable all plugins available, and configure them.< / p >
< p > < img src = "https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" alt = "administration screenshot" / > < a href = ".html" > < / a > < / p >
< h2 id = "plugin-order" > Plugin order< / h2 >
< 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 >
< p > This is important in case plugins are depending on each other. Read plugins README details for more information.< / p >
< 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 >
< h2 id = "file-mode" > File mode< / h2 >
< p > Enabled plugin are stored in your < code > config.php< / code > parameters file, under the < code > array< / code > :< / p >
< 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 >
< p > You can edit them manually here.< br / >
Example:< / p >
< 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 >
< span class = "st" > ' qrcode' < / span > < span class = "ot" > ,< / span >
< span class = "st" > ' archiveorg' < / span > < span class = "ot" > ,< / span >
< span class = "st" > ' wallabag' < / span > < span class = "ot" > ,< / span >
< span class = "st" > ' markdown' < / span > < span class = "ot" > ,< / span >
< span class = "ot" > );< / span > < / code > < / pre > < / div >
< h3 id = "plugin-usage" > Plugin usage< / h3 >
2016-05-14 11:37:28 +02:00
< h4 id = "official-plugins" > Official plugins< / h4 >
2016-04-14 14:20:23 +02:00
< p > Usage of each plugin is documented in it's README file:< / p >
< ul >
< li > < code > addlink-toolbar< / code > : Adds the addlink input on the linklist page< / li >
< li > < code > archiveorg< / code > : For each link, add an Archive.org icon< / li >
< 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 >
< 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 >
< li > < code > qrcode< / code > : For each link, add a QRCode icon.< / li >
< 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 >
< / ul >
2016-05-14 11:37:28 +02:00
< h4 id = "third-party-plugins" > Third party plugins< / h4 >
< 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 >
2016-04-14 14:20:23 +02:00
< / body >
< / html >
