Home Explore Help
Sign In
kotnik
/
shaarli
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 5ebc1d504b
Branches Tags
shaarli
/
doc
/
Plugin-System.html

Plugin-System.html 28 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8">
    5. 

  5.   <meta name="generator" content="pandoc">
    6. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
    7. 

  7.   <title>Shaarli – Plugin System</title>
    8. 

  8.   <style type="text/css">code{white-space: pre;}</style>
    9. 

  9.   <style type="text/css">
    10. 

  10. div.sourceCode { overflow-x: auto; }
    11. 

  11. table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
    12. 

  12.   margin: 0; padding: 0; vertical-align: baseline; border: none; }
    13. 

  13. table.sourceCode { width: 100%; line-height: 100%; }
    14. 

  14. td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
    15. 

  15. td.sourceCode { padding-left: 5px; }
    16. 

  16. code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
    17. 

  17. code > span.dt { color: #902000; } /* DataType */
    18. 

  18. code > span.dv { color: #40a070; } /* DecVal */
    19. 

  19. code > span.bn { color: #40a070; } /* BaseN */
    20. 

  20. code > span.fl { color: #40a070; } /* Float */
    21. 

  21. code > span.ch { color: #4070a0; } /* Char */
    22. 

  22. code > span.st { color: #4070a0; } /* String */
    23. 

  23. code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
    24. 

  24. code > span.ot { color: #007020; } /* Other */
    25. 

  25. code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
    26. 

  26. code > span.fu { color: #06287e; } /* Function */
    27. 

  27. code > span.er { color: #ff0000; font-weight: bold; } /* Error */
    28. 

  28. code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
    29. 

  29. code > span.cn { color: #880000; } /* Constant */
    30. 

  30. code > span.sc { color: #4070a0; } /* SpecialChar */
    31. 

  31. code > span.vs { color: #4070a0; } /* VerbatimString */
    32. 

  32. code > span.ss { color: #bb6688; } /* SpecialString */
    33. 

  33. code > span.im { } /* Import */
    34. 

  34. code > span.va { color: #19177c; } /* Variable */
    35. 

  35. code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
    36. 

  36. code > span.op { color: #666666; } /* Operator */
    37. 

  37. code > span.bu { } /* BuiltIn */
    38. 

  38. code > span.ex { } /* Extension */
    39. 

  39. code > span.pp { color: #bc7a00; } /* Preprocessor */
    40. 

  40. code > span.at { color: #7d9029; } /* Attribute */
    41. 

  41. code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
    42. 

  42. code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
    43. 

  43. code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
    44. 

  44. code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
    45. 

  45.   </style>
    46. 

  46.   <link rel="stylesheet" href="github-markdown.css">
    47. 

  47.   <!--[if lt IE 9]>
    48. 

  48.     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
    49. 

  49.   <![endif]-->
    50. 

  50. </head>
    51. 

  51. <body>
    52. 

  52. <div id="local-sidebar">
    53. 

  53. <ul>
    54. 

  54. <li><a href="Home.html">Home</a></li>
    55. 

  55. <li>Setup
    56. 

  56. <ul>
    57. 

  57. <li><a href="Download-and-Installation.html">Download and Installation</a></li>
    58. 

  58. <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
    59. 

  59. <li><a href="Server-requirements.html">Server requirements</a></li>
    60. 

  60. <li><a href="Server-configuration.html">Server configuration</a></li>
    61. 

  61. <li><a href="Server-security.html">Server security</a></li>
    62. 

  62. <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
    63. 

  63. <li><a href="Plugins.html">Plugins</a></li>
    64. 

  64. </ul></li>
    65. 

  65. <li><a href="Docker.html">Docker</a></li>
    66. 

  66. <li><a href="Usage.html">Usage</a>
    67. 

  67. <ul>
    68. 

  68. <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
    69. 

  69. <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
    70. 

  70. <li><a href="Firefox-share.html">Firefox share</a></li>
    71. 

  71. <li><a href="RSS-feeds.html">RSS feeds</a></li>
    72. 

  72. </ul></li>
    73. 

  73. <li>How To
    74. 

  74. <ul>
    75. 

  75. <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
    76. 

  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. 

  77. <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
    78. 

  78. <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
    79. 

  79. <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
    80. 

  80. </ul></li>
    81. 

  81. <li><a href="Troubleshooting.html">Troubleshooting</a></li>
    82. 

  82. <li><a href="Development.html">Development</a>
    83. 

  83. <ul>
    84. 

  84. <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
    85. 

  85. <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
    86. 

  86. <li><a href="Directory-structure.html">Directory structure</a></li>
    87. 

  87. <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
    88. 

  88. <li><a href="Plugin-System.html">Plugin System</a></li>
    89. 

  89. <li><a href="Release-Shaarli.html">Release Shaarli</a></li>
    90. 

  90. <li><a href="Security.html">Security</a></li>
    91. 

  91. <li><a href="Static-analysis.html">Static analysis</a></li>
    92. 

  92. <li><a href="Theming.html">Theming</a></li>
    93. 

  93. <li><a href="Unit-tests.html">Unit tests</a></li>
    94. 

  94. </ul></li>
    95. 

  95. <li>About
    96. 

  96. <ul>
    97. 

  97. <li><a href="FAQ.html">FAQ</a></li>
    98. 

  98. <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
    99. 

  99. </ul></li>
    100. 

  100. </ul>
    101. 

  101. </div>
    102. 

  102. <h1 id="plugin-system">Plugin System</h1>
    103. 

  103. <blockquote>
    104. 

  104. <p>Note: Plugin current status - in development (not merged into master).</p>
    105. 

  105. </blockquote>
    106. 

  106. <p><a href="#developer-api"><strong>I am a developer.</strong> Developer API.</a><a href=".html"></a></p>
    107. 

  107. <p><a href="#guide-for-template-designer"><strong>I am a template designer.</strong> Guide for template designer.</a><a href=".html"></a></p>
    108. 

  108. <h2 id="developer-api">Developer API</h2>
    109. 

  109. <h3 id="what-can-i-do-with-plugins">What can I do with plugins?</h3>
    110. 

  110. <p>The plugin system let you:</p>
    111. 

  111. <ul>
    112. 

  112. <li>insert content into specific places across templates.</li>
    113. 

  113. <li>alter data before templates rendering.</li>
    114. 

  114. <li>alter data before saving new links.</li>
    115. 

  115. </ul>
    116. 

  116. <h3 id="how-can-i-create-a-plugin-for-shaarli">How can I create a plugin for Shaarli?</h3>
    117. 

  117. <p>First, chose a plugin name, such as <code>demo_plugin</code>.</p>
    118. 

  118. <p>Under <code>plugin</code> folder, create a folder named with your plugin name. Then create a <plugin_name>.php file in that folder.</p>
    119. 

  119. <p>You should have the following tree view:</p>
    120. 

  120. <pre><code>| index.php
    121. 

  121. | plugins/
    122. 

  122. |---| demo_plugin/
    123. 

  123. |   |---| demo_plugin.php</code></pre>
    124. 

  124. <h3 id="understanding-hooks">Understanding hooks</h3>
    125. 

  125. <p>A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.</p>
    126. 

  126. <p>These functions need to be named with this pattern:</p>
    127. 

  127. <pre><code>hook_&lt;plugin_name&gt;_&lt;hook_name&gt;</code></pre>
    128. 

  128. <p>For exemple, if my plugin want to add data to the header, this function is needed:</p>
    129. 

  129. <pre><code>hook_demo_plugin_render_header()</code></pre>
    130. 

  130. <p>If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.</p>
    131. 

  131. <h3 id="plugins-data">Plugin's data</h3>
    132. 

  132. <h4 id="parameters">Parameters</h4>
    133. 

  133. <p>Every hook function has a <code>$data</code> parameter. Its content differs for each hooks.</p>
    134. 

  134. <p><strong>This parameter needs to be returned every time</strong>, otherwise data is lost.</p>
    135. 

  135. <pre><code>return $data;</code></pre>
    136. 

  136. <h4 id="filling-templates-placeholder">Filling templates placeholder</h4>
    137. 

  137. <p>Template placeholders are displayed in template in specific places.</p>
    138. 

  138. <p>RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.</p>
    139. 

  139. <p>For example, let's add a value in the placeholder <code>top_placeholder</code> which is displayed at the top of my page:</p>
    140. 

  140. <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">[]</span> = <span class="st">&#39;My content&#39;</span><span class="ot">;](]</span>-=-<span class="st">&#39;My-content&#39;</span><span class="ot">;</span>.html<span class="ot">)</span>
    141. 

  141. <span class="co"># OR</span>
    142. 

  142. <span class="fu">array_push</span><span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;top_placeholder&#39;</span><span class="ot">],</span> <span class="st">&#39;My&#39;</span><span class="ot">,</span> <span class="st">&#39;content&#39;</span><span class="ot">);[](</span>.html<span class="ot">)</span>
    143. 

  143. 

  144. <span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div>
    145. 

  145. <h4 id="data-manipulation">Data manipulation</h4>
    146. 

  146. <p>When a page is displayed, every variable send to the template engine is passed to plugins before that in <code>$data</code>.</p>
    147. 

  147. <p>The data contained by this array can be altered before template rendering.</p>
    148. 

  148. <p>For exemple, in linklist, it is possible to alter every title:</p>
    149. 

  149. <div class="sourceCode"><pre class="sourceCode php"><code class="sourceCode php"><span class="co">// mind the reference if you want $data to be altered</span>
    150. 

  150. <span class="kw">foreach</span> <span class="ot">(</span><span class="kw">$data</span><span class="ot">[</span><span class="st">&#39;links&#39;</span><span class="ot">]</span> <span class="kw">as</span> &amp;<span class="kw">$value</span><span class="ot">)</span> {<span class="ot">[](</span>.html<span class="ot">)</span>
    151. 

  151.     <span class="co">// String reverse every title.</span>
    152. 

  152.     <span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]</span> = <span class="fu">strrev</span><span class="ot">(</span><span class="kw">$value</span><span class="ot">[</span><span class="st">&#39;title&#39;</span><span class="ot">]);[](</span>.html<span class="ot">)</span>
    153. 

  153. }
    154. 

  154. 

  155. <span class="kw">return</span> <span class="kw">$data</span><span class="ot">;</span></code></pre></div>
    156. 

  156. <h3 id="metadata">Metadata</h3>
    157. 

  157. <p>Every plugin needs a <code>&lt;plugin_name&gt;.meta</code> file, which is in fact an <code>.ini</code> file (<code>KEY=&quot;VALUE&quot;</code>), to be listed in plugin administration.</p>
    158. 

  158. <p>Each file contain two keys:</p>
    159. 

  159. <ul>
    160. 

  160. <li><code>description</code>: plugin description</li>
    161. 

  161. <li><code>parameters</code>: user parameter names, separated by a <code>;</code>.</li>
    162. 

  162. </ul>
    163. 

  163. <blockquote>
    164. 

  164. <p>Note: In PHP, <code>parse_ini_file()</code> seems to want strings to be between by quotes <code>&quot;</code> in the ini file.</p>
    165. 

  165. </blockquote>
    166. 

  166. <h3 id="its-not-working">It's not working!</h3>
    167. 

  167. <p>Use <code>demo_plugin</code> as a functional example. It covers most of the plugin system features.</p>
    168. 

  168. <p>If it's still not working, please <a href="https://github.com/shaarli/Shaarli/issues/new">open an issue</a>.<a href=".html"></a></p>
    169. 

  169. <h3 id="hooks">Hooks</h3>
    170. 

  170. <table style="width:42%;">
    171. 

  171. <colgroup>
    172. 

  172. <col style="width: 19%" />
    173. 

  173. <col style="width: 22%" />
    174. 

  174. </colgroup>
    175. 

  175. <thead>
    176. 

  176. <tr class="header">
    177. 

  177. <th>Hooks</th>
    178. 

  178. <th style="text-align: center;">Description</th>
    179. 

  179. </tr>
    180. 

  180. </thead>
    181. 

  181. <tbody>
    182. 

  182. <tr class="odd">
    183. 

  183. <td><a href="#render_header">render_header</a></td>
    184. 

  184. <td style="text-align: center;">Allow plugin to add content in page headers.</td>
    185. 

  185. </tr>
    186. 

  186. <tr class="even">
    187. 

  187. <td><a href="#render_includes">render_includes</a></td>
    188. 

  188. <td style="text-align: center;">Allow plugin to include their own CSS files.</td>
    189. 

  189. </tr>
    190. 

  190. <tr class="odd">
    191. 

  191. <td><a href="#render_footer">render_footer</a></td>
    192. 

  192. <td style="text-align: center;">Allow plugin to add content in page footer and include their own JS files.</td>
    193. 

  193. </tr>
    194. 

  194. <tr class="even">
    195. 

  195. <td><a href="#render_linklist">render_linklist</a></td>
    196. 

  196. <td style="text-align: center;">It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</td>
    197. 

  197. </tr>
    198. 

  198. <tr class="odd">
    199. 

  199. <td><a href="#render_editlink">render_editlink</a></td>
    200. 

  200. <td style="text-align: center;">Allow to add fields in the form, or display elements.</td>
    201. 

  201. </tr>
    202. 

  202. <tr class="even">
    203. 

  203. <td><a href="#render_tools">render_tools</a></td>
    204. 

  204. <td style="text-align: center;">Allow to add content at the end of the page.</td>
    205. 

  205. </tr>
    206. 

  206. <tr class="odd">
    207. 

  207. <td><a href="#render_picwall">render_picwall</a></td>
    208. 

  208. <td style="text-align: center;">Allow to add content at the top and bottom of the page.</td>
    209. 

  209. </tr>
    210. 

  210. <tr class="even">
    211. 

  211. <td><a href="#render_tagcloud">render_tagcloud</a></td>
    212. 

  212. <td style="text-align: center;">Allow to add content at the top and bottom of the page.</td>
    213. 

  213. </tr>
    214. 

  214. <tr class="odd">
    215. 

  215. <td><a href="#render_daily">render_daily</a></td>
    216. 

  216. <td style="text-align: center;">Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</td>
    217. 

  217. </tr>
    218. 

  218. <tr class="even">
    219. 

  219. <td><a href="#savelink">savelink</a></td>
    220. 

  220. <td style="text-align: center;">Allow to alter the link being saved in the datastore.</td>
    221. 

  221. </tr>
    222. 

  222. </tbody>
    223. 

  223. </table>
    224. 

  224. <h4 id="render_header">render_header</h4>
    225. 

  225. <p>Triggered on every page.</p>
    226. 

  226. <p>Allow plugin to add content in page headers.</p>
    227. 

  227. <h5 id="data">Data</h5>
    228. 

  228. <p><code>$data</code> is an array containing:</p>
    229. 

  229. <ul>
    230. 

  230. <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li>
    231. 

  231. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    232. 

  232. </ul>
    233. 

  233. <h5 id="template-placeholders">Template placeholders</h5>
    234. 

  234. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    235. 

  235. <p>List of placeholders:</p>
    236. 

  236. <ul>
    237. 

  237. <li><code>buttons_toolbar</code>: after the list of buttons in the header.</li>
    238. 

  238. </ul>
    239. 

  239. <p><img src="http://i.imgur.com/ssJUOrt.png" alt="buttons_toolbar_example" /><a href=".html"></a></p>
    240. 

  240. <ul>
    241. 

  241. <li><code>fields_toolbar</code>: after search fields in the header.</li>
    242. 

  242. </ul>
    243. 

  243. <blockquote>
    244. 

  244. <p>Note: This will only be called in linklist.</p>
    245. 

  245. </blockquote>
    246. 

  246. <p><img src="http://i.imgur.com/3GMifI2.png" alt="fields_toolbar_example" /><a href=".html"></a></p>
    247. 

  247. <h4 id="render_includes">render_includes</h4>
    248. 

  248. <p>Triggered on every page.</p>
    249. 

  249. <p>Allow plugin to include their own CSS files.</p>
    250. 

  250. <h5 id="data-1">Data</h5>
    251. 

  251. <p><code>$data</code> is an array containing:</p>
    252. 

  252. <ul>
    253. 

  253. <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li>
    254. 

  254. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    255. 

  255. </ul>
    256. 

  256. <h5 id="template-placeholders-1">Template placeholders</h5>
    257. 

  257. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    258. 

  258. <p>List of placeholders:</p>
    259. 

  259. <ul>
    260. 

  260. <li><code>css_files</code>: called after loading default CSS.</li>
    261. 

  261. </ul>
    262. 

  262. <blockquote>
    263. 

  263. <p>Note: only add the path of the CSS file. E.g: <code>plugins/demo_plugin/custom_demo.css</code>.</p>
    264. 

  264. </blockquote>
    265. 

  265. <h4 id="render_footer">render_footer</h4>
    266. 

  266. <p>Triggered on every page.</p>
    267. 

  267. <p>Allow plugin to add content in page footer and include their own JS files.</p>
    268. 

  268. <h5 id="data-2">Data</h5>
    269. 

  269. <p><code>$data</code> is an array containing:</p>
    270. 

  270. <ul>
    271. 

  271. <li><code>_PAGE_</code>: current target page (eg: <code>linklist</code>, <code>picwall</code>, etc.).</li>
    272. 

  272. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    273. 

  273. </ul>
    274. 

  274. <h5 id="template-placeholders-2">Template placeholders</h5>
    275. 

  275. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    276. 

  276. <p>List of placeholders:</p>
    277. 

  277. <ul>
    278. 

  278. <li><code>text</code>: called after the end of the footer text.</li>
    279. 

  279. <li><code>endofpage</code>: called at the end of the page.</li>
    280. 

  280. </ul>
    281. 

  281. <p><img src="http://i.imgur.com/L5S2YEH.png" alt="text_example" /><a href=".html"></a></p>
    282. 

  282. <ul>
    283. 

  283. <li><code>js_files</code>: called at the end of the page, to include custom JS scripts.</li>
    284. 

  284. </ul>
    285. 

  285. <blockquote>
    286. 

  286. <p>Note: only add the path of the JS file. E.g: <code>plugins/demo_plugin/custom_demo.js</code>.</p>
    287. 

  287. </blockquote>
    288. 

  288. <h4 id="render_linklist">render_linklist</h4>
    289. 

  289. <p>Triggered when <code>linklist</code> is displayed (list of links, permalink, search, tag filtered, etc.).</p>
    290. 

  290. <p>It allows to add content at the begining and end of the page, after every link displayed and to alter link data.</p>
    291. 

  291. <h5 id="data-3">Data</h5>
    292. 

  292. <p><code>$data</code> is an array containing:</p>
    293. 

  293. <ul>
    294. 

  294. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    295. 

  295. <li>All templates data, including links.</li>
    296. 

  296. </ul>
    297. 

  297. <h5 id="template-placeholders-3">Template placeholders</h5>
    298. 

  298. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    299. 

  299. <p>List of placeholders:</p>
    300. 

  300. <ul>
    301. 

  301. <li><code>action_plugin</code>: next to the button &quot;private only&quot; at the top and bottom of the page.</li>
    302. 

  302. </ul>
    303. 

  303. <p><img src="http://i.imgur.com/Q12PWg0.png" alt="action_plugin_example" /><a href=".html"></a></p>
    304. 

  304. <ul>
    305. 

  305. <li><code>link_plugin</code>: for every link, between permalink and link URL.</li>
    306. 

  306. </ul>
    307. 

  307. <p><img src="http://i.imgur.com/3oDPhWx.png" alt="link_plugin_example" /><a href=".html"></a></p>
    308. 

  308. <ul>
    309. 

  309. <li><code>plugin_start_zone</code>: before displaying the template content.</li>
    310. 

  310. </ul>
    311. 

  311. <p><img src="http://i.imgur.com/OVBkGy3.png" alt="plugin_start_zone_example" /><a href=".html"></a></p>
    312. 

  312. <ul>
    313. 

  313. <li><code>plugin_end_zone</code>: after displaying the template content.</li>
    314. 

  314. </ul>
    315. 

  315. <p><img src="http://i.imgur.com/6IoRuop.png" alt="plugin_end_zone_example" /><a href=".html"></a></p>
    316. 

  316. <h4 id="render_editlink">render_editlink</h4>
    317. 

  317. <p>Triggered when the link edition form is displayed.</p>
    318. 

  318. <p>Allow to add fields in the form, or display elements.</p>
    319. 

  319. <h5 id="data-4">Data</h5>
    320. 

  320. <p><code>$data</code> is an array containing:</p>
    321. 

  321. <ul>
    322. 

  322. <li>All templates data.</li>
    323. 

  323. </ul>
    324. 

  324. <h5 id="template-placeholders-4">Template placeholders</h5>
    325. 

  325. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    326. 

  326. <p>List of placeholders:</p>
    327. 

  327. <ul>
    328. 

  328. <li><code>edit_link_plugin</code>: after tags field.</li>
    329. 

  329. </ul>
    330. 

  330. <p><img src="http://i.imgur.com/5u17Ens.png" alt="edit_link_plugin_example" /><a href=".html"></a></p>
    331. 

  331. <h4 id="render_tools">render_tools</h4>
    332. 

  332. <p>Triggered when the &quot;tools&quot; page is displayed.</p>
    333. 

  333. <p>Allow to add content at the end of the page.</p>
    334. 

  334. <h5 id="data-5">Data</h5>
    335. 

  335. <p><code>$data</code> is an array containing:</p>
    336. 

  336. <ul>
    337. 

  337. <li>All templates data.</li>
    338. 

  338. </ul>
    339. 

  339. <h5 id="template-placeholders-5">Template placeholders</h5>
    340. 

  340. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    341. 

  341. <p>List of placeholders:</p>
    342. 

  342. <ul>
    343. 

  343. <li><code>tools_plugin</code>: at the end of the page.</li>
    344. 

  344. </ul>
    345. 

  345. <p><img src="http://i.imgur.com/Bqhu9oQ.png" alt="tools_plugin_example" /><a href=".html"></a></p>
    346. 

  346. <h4 id="render_picwall">render_picwall</h4>
    347. 

  347. <p>Triggered when picwall is displayed.</p>
    348. 

  348. <p>Allow to add content at the top and bottom of the page.</p>
    349. 

  349. <h5 id="data-6">Data</h5>
    350. 

  350. <p><code>$data</code> is an array containing:</p>
    351. 

  351. <ul>
    352. 

  352. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    353. 

  353. <li>All templates data.</li>
    354. 

  354. </ul>
    355. 

  355. <h5 id="template-placeholders-6">Template placeholders</h5>
    356. 

  356. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    357. 

  357. <p>List of placeholders:</p>
    358. 

  358. <ul>
    359. 

  359. <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li>
    360. 

  360. <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li>
    361. 

  361. </ul>
    362. 

  362. <p><img src="http://i.imgur.com/tVTQFER.png" alt="plugin_start_end_zone_example" /><a href=".html"></a></p>
    363. 

  363. <h4 id="render_tagcloud">render_tagcloud</h4>
    364. 

  364. <p>Triggered when tagcloud is displayed.</p>
    365. 

  365. <p>Allow to add content at the top and bottom of the page.</p>
    366. 

  366. <h5 id="data-7">Data</h5>
    367. 

  367. <p><code>$data</code> is an array containing:</p>
    368. 

  368. <ul>
    369. 

  369. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    370. 

  370. <li>All templates data.</li>
    371. 

  371. </ul>
    372. 

  372. <h5 id="template-placeholders-7">Template placeholders</h5>
    373. 

  373. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    374. 

  374. <p>List of placeholders:</p>
    375. 

  375. <ul>
    376. 

  376. <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li>
    377. 

  377. <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li>
    378. 

  378. </ul>
    379. 

  379. <p><img src="http://i.imgur.com/vHmyT3a.png" alt="plugin_start_end_zone_example" /><a href=".html"></a></p>
    380. 

  380. <h4 id="render_daily">render_daily</h4>
    381. 

  381. <p>Triggered when tagcloud is displayed.</p>
    382. 

  382. <p>Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.</p>
    383. 

  383. <h5 id="data-8">Data</h5>
    384. 

  384. <p><code>$data</code> is an array containing:</p>
    385. 

  385. <ul>
    386. 

  386. <li><code>_LOGGEDIN_</code>: true if user is logged in, false otherwise.</li>
    387. 

  387. <li>All templates data, including links.</li>
    388. 

  388. </ul>
    389. 

  389. <h5 id="template-placeholders-8">Template placeholders</h5>
    390. 

  390. <p>Items can be displayed in templates by adding an entry in <code>$data['&lt;placeholder&gt;']</code> array.<a href=".html"></a></p>
    391. 

  391. <p>List of placeholders:</p>
    392. 

  392. <ul>
    393. 

  393. <li><code>link_plugin</code>: used at bottom of each link.</li>
    394. 

  394. </ul>
    395. 

  395. <p><img src="http://i.imgur.com/hzhMfSZ.png" alt="link_plugin_example" /><a href=".html"></a></p>
    396. 

  396. <ul>
    397. 

  397. <li><p><code>plugin_start_zone</code>: before displaying the template content.</p></li>
    398. 

  398. <li><p><code>plugin_end_zone</code>: after displaying the template content.</p></li>
    399. 

  399. </ul>
    400. 

  400. <h4 id="savelink">savelink</h4>
    401. 

  401. <p>Triggered when a link is save (new link or edit).</p>
    402. 

  402. <p>Allow to alter the link being saved in the datastore.</p>
    403. 

  403. <h5 id="data-9">Data</h5>
    404. 

  404. <p><code>$data</code> is an array containing the link being saved:</p>
    405. 

  405. <ul>
    406. 

  406. <li>title</li>
    407. 

  407. <li>url</li>
    408. 

  408. <li>description</li>
    409. 

  409. <li>linkdate</li>
    410. 

  410. <li>private</li>
    411. 

  411. <li>tags</li>
    412. 

  412. </ul>
    413. 

  413. <h2 id="guide-for-template-designer">Guide for template designer</h2>
    414. 

  414. <h3 id="plugin-administration">Plugin administration</h3>
    415. 

  415. <p>Your theme must include a plugin administration page: <code>pluginsadmin.html</code>.</p>
    416. 

  416. <blockquote>
    417. 

  417. <p>Note: repo's template link needs to be added when the PR is merged.</p>
    418. 

  418. </blockquote>
    419. 

  419. <p>Use the default one as an example.</p>
    420. 

  420. <p>Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include <code>plugin_admin.js</code>, only if:</p>
    421. 

  421. <ul>
    422. 

  422. <li>you're using a table.</li>
    423. 

  423. <li>you call orderUp() and orderUp() onclick on arrows.</li>
    424. 

  424. <li>you add data-line and data-order to your rows.</li>
    425. 

  425. </ul>
    426. 

  426. <p>Otherwise, you can use your own JS as long as this field is send by the form:</p>
    427. 

  427. <p><input type="hidden" name="order_{$key}" value="{$counter}"></p>
    428. 

  428. <h3 id="placeholder-system">Placeholder system</h3>
    429. 

  429. <p>In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.</p>
    430. 

  430. <p>It's a RainTPL loop like this:</p>
    431. 

  431. <pre><code>{loop=&quot;$plugin_variable&quot;}
    432. 

  432.     {$value}
    433. 

  433. {/loop}</code></pre>
    434. 

  434. <p>You should enable <code>demo_plugin</code> for testing purpose, since it uses every placeholder available.</p>
    435. 

  435. <h3 id="list-of-placeholders">List of placeholders</h3>
    436. 

  436. <p><strong>page.header.html</strong></p>
    437. 

  437. <p>At the end of the menu:</p>
    438. 

  438. <pre><code>{loop=&quot;$plugins_header.buttons_toolbar&quot;}
    439. 

  439.     {$value}
    440. 

  440. {/loop}</code></pre>
    441. 

  441. <p>At the end of file, before clearing floating blocks:</p>
    442. 

  442. <pre><code>{if=&quot;!empty($plugin_errors) &amp;&amp; isLoggedIn()&quot;}
    443. 

  443.     &lt;ul class=&quot;errors&quot;&gt;
    444. 

  444.         {loop=&quot;plugin_errors&quot;}
    445. 

  445.             &lt;li&gt;{$value}&lt;/li&gt;
    446. 

  446.         {/loop}
    447. 

  447.     &lt;/ul&gt;
    448. 

  448. {/if}</code></pre>
    449. 

  449. <p><strong>includes.html</strong></p>
    450. 

  450. <p>At the end of the file:</p>
    451. 

  451. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_includes.css_files&quot;}
    452. 

  452. <span class="kw">&lt;link</span><span class="ot"> type=</span><span class="st">&quot;text/css&quot;</span><span class="ot"> rel=</span><span class="st">&quot;stylesheet&quot;</span><span class="ot"> href=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">/&gt;</span>
    453. 

  453. {/loop}</code></pre></div>
    454. 

  454. <p><strong>page.footer.html</strong></p>
    455. 

  455. <p>At the end of your footer notes:</p>
    456. 

  456. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.text&quot;}
    457. 

  457.      {$value}
    458. 

  458. {/loop}</code></pre></div>
    459. 

  459. <p>At the end of file:</p>
    460. 

  460. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_footer.js_files&quot;}
    461. 

  461.      <span class="kw">&lt;script</span><span class="ot"> src=</span><span class="st">&quot;{$value}#&quot;</span><span class="kw">&gt;&lt;/script&gt;</span>
    462. 

  462. {/loop}</code></pre></div>
    463. 

  463. <p><strong>linklist.html</strong></p>
    464. 

  464. <p>After search fields:</p>
    465. 

  465. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugins_header.fields_toolbar&quot;}
    466. 

  466.      {$value}
    467. 

  467. {/loop}</code></pre></div>
    468. 

  468. <p>Before displaying the link list (after paging):</p>
    469. 

  469. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_start_zone&quot;}
    470. 

  470.      {$value}
    471. 

  471. {/loop}</code></pre></div>
    472. 

  472. <p>For every links (icons):</p>
    473. 

  473. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$value.link_plugin&quot;}
    474. 

  474.     <span class="kw">&lt;span&gt;</span>{$value}<span class="kw">&lt;/span&gt;</span>
    475. 

  475. {/loop}</code></pre></div>
    476. 

  476. <p>Before end paging:</p>
    477. 

  477. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$plugin_end_zone&quot;}
    478. 

  478.      {$value}
    479. 

  479. {/loop}</code></pre></div>
    480. 

  480. <p><strong>linklist.paging.html</strong></p>
    481. 

  481. <p>After the &quot;private only&quot; icon:</p>
    482. 

  482. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$action_plugin&quot;}
    483. 

  483.      {$value}
    484. 

  484. {/loop}</code></pre></div>
    485. 

  485. <p><strong>editlink.html</strong></p>
    486. 

  486. <p>After tags field:</p>
    487. 

  487. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$edit_link_plugin&quot;}
    488. 

  488.      {$value}
    489. 

  489. {/loop}</code></pre></div>
    490. 

  490. <p><strong>tools.html</strong></p>
    491. 

  491. <p>After the last tool:</p>
    492. 

  492. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">{loop=&quot;$tools_plugin&quot;}
    493. 

  493.      {$value}
    494. 

  494. {/loop}</code></pre></div>
    495. 

  495. <p><strong>picwall.html</strong></p>
    496. 

  496. <p>Top:</p>
    497. 

  497. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    498. 

  498.     {loop=&quot;$plugin_start_zone&quot;}
    499. 

  499.         {$value}
    500. 

  500.     {/loop}
    501. 

  501. <span class="kw">&lt;/div&gt;</span></code></pre></div>
    502. 

  502. <p>Bottom:</p>
    503. 

  503. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    504. 

  504.     {loop=&quot;$plugin_end_zone&quot;}
    505. 

  505.         {$value}
    506. 

  506.     {/loop}
    507. 

  507. <span class="kw">&lt;/div&gt;</span></code></pre></div>
    508. 

  508. <p><strong>tagcloud.html</strong></p>
    509. 

  509. <p>Top:</p>
    510. 

  510. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">   <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    511. 

  511.         {loop=&quot;$plugin_start_zone&quot;}
    512. 

  512.             {$value}
    513. 

  513.         {/loop}
    514. 

  514.     <span class="kw">&lt;/div&gt;</span></code></pre></div>
    515. 

  515. <p>Bottom:</p>
    516. 

  516. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html">    <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_tagcloud&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    517. 

  517.         {loop=&quot;$plugin_end_zone&quot;}
    518. 

  518.             {$value}
    519. 

  519.         {/loop}
    520. 

  520.     <span class="kw">&lt;/div&gt;</span></code></pre></div>
    521. 

  521. <p><strong>daily.html</strong></p>
    522. 

  522. <p>Top:</p>
    523. 

  523. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_start_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    524. 

  524.      {loop=&quot;$plugin_start_zone&quot;}
    525. 

  525.          {$value}
    526. 

  526.      {/loop}
    527. 

  527. <span class="kw">&lt;/div&gt;</span></code></pre></div>
    528. 

  528. <p>After every link:</p>
    529. 

  529. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;dailyEntryFooter&quot;</span><span class="kw">&gt;</span>
    530. 

  530.      {loop=&quot;$link.link_plugin&quot;}
    531. 

  531.           {$value}
    532. 

  532.      {/loop}
    533. 

  533. <span class="kw">&lt;/div&gt;</span></code></pre></div>
    534. 

  534. <p>Bottom:</p>
    535. 

  535. <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;plugin_zone_end_picwall&quot;</span><span class="ot"> class=</span><span class="st">&quot;plugin_zone&quot;</span><span class="kw">&gt;</span>
    536. 

  536.     {loop=&quot;$plugin_end_zone&quot;}
    537. 

  537.         {$value}
    538. 

  538.     {/loop}
    539. 

  539. <span class="kw">&lt;/div&gt;</span></code></pre></div>
    540. 

  540. </body>
    541. 

  541. </html>
    542.