doc/html/Bookmarklet/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>Bookmarklet - 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 = "Bookmarklet";
  22     var mkdocs_page_input_path = "Bookmarklet.md";
  23     var mkdocs_page_url = "/Bookmarklet/";
  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="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../docker/docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../docker/shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../docker/resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class="">
 119
 120     <a class="" href="../Features/">Features</a>
 121                 </li>
 122                 <li class=" current">
 123
 124     <a class="current" href="./">Bookmarklet</a>
 125     <ul class="subnav">
 126
 127     <li class="toctree-l3"><a href="#add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (bookmarklet) to your browser</a></li>
 128
 129
 130     <li class="toctree-l3"><a href="#share-links-using-the-bookmarklet">Share links using the bookmarklet</a></li>
 131
 132
 133     <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>
 134
 135
 136     </ul>
 137                 </li>
 138                 <li class="">
 139
 140     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 141                 </li>
 142                 <li class="">
 143
 144     <a class="" href="../Firefox-share/">Firefox share</a>
 145                 </li>
 146                 <li class="">
 147
 148     <a class="" href="../RSS-feeds/">RSS feeds</a>
 149                 </li>
 150                 <li class="">
 151
 152     <a class="" href="../REST-API/">REST API</a>
 153                 </li>
 154     </ul>
 155             </li>
 156
 157             <li class="toctree-l1">
 158
 159     <span class="caption-text">How To</span>
 160     <ul class="subnav">
 161                 <li class="">
 162
 163     <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 164                 </li>
 165                 <li class="">
 166
 167     <a class="" href="../Various-hacks/">Various hacks</a>
 168                 </li>
 169     </ul>
 170             </li>
 171
 172             <li class="toctree-l1">
 173
 174     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 175             </li>
 176
 177             <li class="toctree-l1">
 178
 179     <span class="caption-text">Development</span>
 180     <ul class="subnav">
 181                 <li class="">
 182
 183     <a class="" href="../Development-guidelines/">Development guidelines</a>
 184                 </li>
 185                 <li class="">
 186
 187     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 188                 </li>
 189                 <li class="">
 190
 191     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 192                 </li>
 193                 <li class="">
 194
 195     <a class="" href="../Coding-guidelines/">Coding guidelines</a>
 196                 </li>
 197                 <li class="">
 198
 199     <a class="" href="../Directory-structure/">Directory structure</a>
 200                 </li>
 201                 <li class="">
 202
 203     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 204                 </li>
 205                 <li class="">
 206
 207     <a class="" href="../Plugin-System/">Plugin System</a>
 208                 </li>
 209                 <li class="">
 210
 211     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 212                 </li>
 213                 <li class="">
 214
 215     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 216                 </li>
 217                 <li class="">
 218
 219     <a class="" href="../Security/">Security</a>
 220                 </li>
 221                 <li class="">
 222
 223     <a class="" href="../Static-analysis/">Static analysis</a>
 224                 </li>
 225                 <li class="">
 226
 227     <a class="" href="../Theming/">Theming</a>
 228                 </li>
 229                 <li class="">
 230
 231     <a class="" href="../Unit-tests/">Unit tests</a>
 232                 </li>
 233     </ul>
 234             </li>
 235
 236             <li class="toctree-l1">
 237
 238     <span class="caption-text">About</span>
 239     <ul class="subnav">
 240                 <li class="">
 241
 242     <a class="" href="../FAQ/">FAQ</a>
 243                 </li>
 244                 <li class="">
 245
 246     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 247                 </li>
 248     </ul>
 249             </li>
 250
 251         </ul>
 252       </div>
 253       &nbsp;
 254     </nav>
 255
 256     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 257
 258
 259       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 260         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 261         <a href="..">Shaarli Documentation</a>
 262       </nav>
 263
 264
 265       <div class="wy-nav-content">
 266         <div class="rst-content">
 267           <div role="navigation" aria-label="breadcrumbs navigation">
 268   <ul class="wy-breadcrumbs">
 269     <li><a href="..">Docs</a> &raquo;</li>
 270
 271
 272
 273           <li>Usage &raquo;</li>
 274
 275
 276
 277     <li>Bookmarklet</li>
 278     <li class="wy-breadcrumbs-aside">
 279
 280         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Bookmarklet.md"
 281           class="icon icon-github"> Edit on GitHub</a>
 282
 283     </li>
 284   </ul>
 285   <hr/>
 286 </div>
 287           <div role="main">
 288             <div class="section">
 289
 290                 <h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3>
 291 <ul>
 292 <li>Open your Shaarli and <code>Login</code></li>
 293 <li>Click the <code>Tools</code> button in the top bar</li>
 294 <li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li>
 295 </ul>
 296 <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>
 297 <p><img alt="" src="../images/bookmarklet.png" /></p>
 298 <h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3>
 299 <ul>
 300 <li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li>
 301 <li>A window opens.</li>
 302 <li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li>
 303 <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>
 304 <li>You can also check the “Private” box so that the link is saved but only visible to you. </li>
 305 <li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li>
 306 </ul>
 307 <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>
 308 <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>
 309 <p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.</p>
 310 <p>There is an open bug for both Firefox and Chromium:</p>
 311 <ul>
 312 <li>https://bugzilla.mozilla.org/show_bug.cgi?id=866522</li>
 313 <li>https://code.google.com/p/chromium/issues/detail?id=233903</li>
 314 </ul>
 315
 316             </div>
 317           </div>
 318           <footer>
 319
 320     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 321
 322         <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>
 323
 324
 325         <a href="../Features/" class="btn btn-neutral" title="Features"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 326
 327     </div>
 328
 329
 330   <hr/>
 331
 332   <div role="contentinfo">
 333     <!-- Copyright etc -->
 334
 335   </div>
 336
 337   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>.
 338 </footer>
 339
 340         </div>
 341       </div>
 342
 343     </section>
 344
 345   </div>
 346
 347   <div class="rst-versions" role="note" style="cursor: pointer">
 348     <span class="rst-current-version" data-toggle="rst-current-version">
 349
 350           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 351
 352
 353         <span><a href="../Features/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 354
 355
 356         <span style="margin-left: 15px"><a href="../Browsing-and-searching/" style="color: #fcfcfc">Next &raquo;</a></span>
 357
 358     </span>
 359 </div>
 360     <script src="../js/theme.js"></script>
 361
 362 </body>
 363 </html>