index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  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. <link rel="shortcut icon" href="../img/favicon.ico">
  9. <title>Bookmarklet - Shaarli Documentation</title>
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  11. <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  12. <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  13. <link rel="stylesheet" href="../css/highlight.css">
  14. <link href="../github-markdown.css" rel="stylesheet">
  15. <script>
  16. // Current page data
  17. var mkdocs_page_name = "Bookmarklet";
  18. var mkdocs_page_input_path = "Bookmarklet.md";
  19. var mkdocs_page_url = "/Bookmarklet/";
  20. </script>
  21. <script src="../js/jquery-2.1.1.min.js"></script>
  22. <script src="../js/modernizr-2.8.3.min.js"></script>
  23. <script type="text/javascript" src="../js/highlight.pack.js"></script>
  24. </head>
  25. <body class="wy-body-for-nav" role="document">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  28. <div class="wy-side-nav-search">
  29. <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  30. <div role="search">
  31. <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. </form>
  34. </div>
  35. </div>
  36. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  37. <ul class="current">
  38. <li class="toctree-l1">
  39. <a class="" href="..">Home</a>
  40. </li>
  41. <li class="toctree-l1">
  42. <span class="caption-text">Setup</span>
  43. <ul class="subnav">
  44. <li class="">
  45. <a class="" href="../Download-and-Installation/">Download and Installation</a>
  46. </li>
  47. <li class="">
  48. <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  49. </li>
  50. <li class="">
  51. <a class="" href="../Server-requirements/">Server requirements</a>
  52. </li>
  53. <li class="">
  54. <a class="" href="../Server-configuration/">Server configuration</a>
  55. </li>
  56. <li class="">
  57. <a class="" href="../Server-security/">Server security</a>
  58. </li>
  59. <li class="">
  60. <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  61. </li>
  62. <li class="">
  63. <a class="" href="../Plugins/">Plugins</a>
  64. </li>
  65. </ul>
  66. </li>
  67. <li class="toctree-l1">
  68. <span class="caption-text">Docker</span>
  69. <ul class="subnav">
  70. <li class="">
  71. <a class="" href="../docker/docker-101/">Docker 101</a>
  72. </li>
  73. <li class="">
  74. <a class="" href="../docker/shaarli-images/">Shaarli images</a>
  75. </li>
  76. <li class="">
  77. <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
  78. </li>
  79. <li class="">
  80. <a class="" href="../docker/resources/">Docker resources</a>
  81. </li>
  82. </ul>
  83. </li>
  84. <li class="toctree-l1">
  85. <span class="caption-text">Usage</span>
  86. <ul class="subnav">
  87. <li class="">
  88. <a class="" href="../Features/">Features</a>
  89. </li>
  90. <li class=" current">
  91. <a class="current" href="./">Bookmarklet</a>
  92. <ul class="subnav">
  93. <li class="toctree-l3"><a href="#add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (bookmarklet) to your browser</a></li>
  94. <li class="toctree-l3"><a href="#share-links-using-the-bookmarklet">Share links using the bookmarklet</a></li>
  95. <li class="toctree-l3"><a href="#troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</a></li>
  96. </ul>
  97. </li>
  98. <li class="">
  99. <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
  100. </li>
  101. <li class="">
  102. <a class="" href="../Firefox-share/">Firefox share</a>
  103. </li>
  104. <li class="">
  105. <a class="" href="../RSS-feeds/">RSS feeds</a>
  106. </li>
  107. <li class="">
  108. <a class="" href="../REST-API/">REST API</a>
  109. </li>
  110. </ul>
  111. </li>
  112. <li class="toctree-l1">
  113. <span class="caption-text">How To</span>
  114. <ul class="subnav">
  115. <li class="">
  116. <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
  117. </li>
  118. <li class="">
  119. <a class="" href="../Various-hacks/">Various hacks</a>
  120. </li>
  121. </ul>
  122. </li>
  123. <li class="toctree-l1">
  124. <a class="" href="../Troubleshooting/">Troubleshooting</a>
  125. </li>
  126. <li class="toctree-l1">
  127. <span class="caption-text">Development</span>
  128. <ul class="subnav">
  129. <li class="">
  130. <a class="" href="../Development-guidelines/">Development guidelines</a>
  131. </li>
  132. <li class="">
  133. <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
  134. </li>
  135. <li class="">
  136. <a class="" href="../GnuPG-signature/">GnuPG signature</a>
  137. </li>
  138. <li class="">
  139. <a class="" href="../Coding-guidelines/">Coding guidelines</a>
  140. </li>
  141. <li class="">
  142. <a class="" href="../Directory-structure/">Directory structure</a>
  143. </li>
  144. <li class="">
  145. <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
  146. </li>
  147. <li class="">
  148. <a class="" href="../Plugin-System/">Plugin System</a>
  149. </li>
  150. <li class="">
  151. <a class="" href="../Release-Shaarli/">Release Shaarli</a>
  152. </li>
  153. <li class="">
  154. <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
  155. </li>
  156. <li class="">
  157. <a class="" href="../Security/">Security</a>
  158. </li>
  159. <li class="">
  160. <a class="" href="../Static-analysis/">Static analysis</a>
  161. </li>
  162. <li class="">
  163. <a class="" href="../Theming/">Theming</a>
  164. </li>
  165. <li class="">
  166. <a class="" href="../Unit-tests/">Unit tests</a>
  167. </li>
  168. </ul>
  169. </li>
  170. <li class="toctree-l1">
  171. <span class="caption-text">About</span>
  172. <ul class="subnav">
  173. <li class="">
  174. <a class="" href="../FAQ/">FAQ</a>
  175. </li>
  176. <li class="">
  177. <a class="" href="../Community-&-Related-software/">Community & Related software</a>
  178. </li>
  179. </ul>
  180. </li>
  181. </ul>
  182. </div>
  183. &nbsp;
  184. </nav>
  185. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  186. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  187. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  188. <a href="..">Shaarli Documentation</a>
  189. </nav>
  190. <div class="wy-nav-content">
  191. <div class="rst-content">
  192. <div role="navigation" aria-label="breadcrumbs navigation">
  193. <ul class="wy-breadcrumbs">
  194. <li><a href="..">Docs</a> &raquo;</li>
  195. <li>Usage &raquo;</li>
  196. <li>Bookmarklet</li>
  197. <li class="wy-breadcrumbs-aside">
  198. <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Bookmarklet.md"
  199. class="icon icon-github"> Edit on GitHub</a>
  200. </li>
  201. </ul>
  202. <hr/>
  203. </div>
  204. <div role="main">
  205. <div class="section">
  206. <h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3>
  207. <ul>
  208. <li>Open your Shaarli and <code>Login</code></li>
  209. <li>Click the <code>Tools</code> button in the top bar</li>
  210. <li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li>
  211. </ul>
  212. <p><em>This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.</em></p>
  213. <p><img alt="" src="../images/bookmarklet.png" /></p>
  214. <h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3>
  215. <ul>
  216. <li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li>
  217. <li>A window opens.</li>
  218. <li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li>
  219. <li>You will be able to edit this link later using the <img alt="" src="https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png" /> edit button.</li>
  220. <li>You can also check the “Private” box so that the link is saved but only visible to you. </li>
  221. <li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li>
  222. </ul>
  223. <h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3>
  224. <p>Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.</p>
  225. <p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.</p>
  226. <p>There is an open bug for both Firefox and Chromium:</p>
  227. <ul>
  228. <li>https://bugzilla.mozilla.org/show_bug.cgi?id=866522</li>
  229. <li>https://code.google.com/p/chromium/issues/detail?id=233903</li>
  230. </ul>
  231. </div>
  232. </div>
  233. <footer>
  234. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  235. <a href="../Browsing-and-searching/" class="btn btn-neutral float-right" title="Browsing and searching">Next <span class="icon icon-circle-arrow-right"></span></a>
  236. <a href="../Features/" class="btn btn-neutral" title="Features"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  237. </div>
  238. <hr/>
  239. <div role="contentinfo">
  240. <!-- Copyright etc -->
  241. </div>
  242. 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>.
  243. </footer>
  244. </div>
  245. </div>
  246. </section>
  247. </div>
  248. <div class="rst-versions" role="note" style="cursor: pointer">
  249. <span class="rst-current-version" data-toggle="rst-current-version">
  250. <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  251. <span><a href="../Features/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  252. <span style="margin-left: 15px"><a href="../Browsing-and-searching/" style="color: #fcfcfc">Next &raquo;</a></span>
  253. </span>
  254. </div>
  255. <script src="../js/theme.js"></script>
  256. </body>
  257. </html>