doc/Usage.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <title>Shaarli – Usage</title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <link rel="stylesheet" href="github-markdown.css">
  10   <!--[if lt IE 9]>
  11     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  12   <![endif]-->
  13 </head>
  14 <body>
  15 <div id="local-sidebar">
  16 <ul>
  17 <li><a href="Home.html">Home</a></li>
  18 <li>Setup
  19 <ul>
  20 <li><a href="Download-and-Installation.html">Download and Installation</a></li>
  21 <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
  22 <li><a href="Server-requirements.html">Server requirements</a></li>
  23 <li><a href="Server-configuration.html">Server configuration</a></li>
  24 <li><a href="Server-security.html">Server security</a></li>
  25 <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
  26 <li><a href="Plugins.html">Plugins</a></li>
  27 </ul></li>
  28 <li><a href="Docker.html">Docker</a></li>
  29 <li><a href="Usage.html">Usage</a>
  30 <ul>
  31 <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
  32 <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
  33 <li><a href="Firefox-share.html">Firefox share</a></li>
  34 <li><a href="RSS-feeds.html">RSS feeds</a></li>
  35 </ul></li>
  36 <li>How To
  37 <ul>
  38 <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
  39 <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>
  40 <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
  41 <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
  42 <li><a href="Datastore-hacks.html">Datastore hacks</a></li>
  43 </ul></li>
  44 <li><a href="Troubleshooting.html">Troubleshooting</a></li>
  45 <li><a href="Development.html">Development</a>
  46 <ul>
  47 <li><a href="GnuPG-signature.html">GnuPG signature</a></li>
  48 <li><a href="Coding-guidelines.html">Coding guidelines</a></li>
  49 <li><a href="Directory-structure.html">Directory structure</a></li>
  50 <li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
  51 <li><a href="Plugin-System.html">Plugin System</a></li>
  52 <li><a href="Release-Shaarli.html">Release Shaarli</a></li>
  53 <li><a href="Security.html">Security</a></li>
  54 <li><a href="Static-analysis.html">Static analysis</a></li>
  55 <li><a href="Theming.html">Theming</a></li>
  56 <li><a href="Unit-tests.html">Unit tests</a></li>
  57 </ul></li>
  58 <li>About
  59 <ul>
  60 <li><a href="FAQ.html">FAQ</a></li>
  61 <li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
  62 </ul></li>
  63 </ul>
  64 </div>
  65 <h1 id="usage">Usage</h1>
  66 <h3 id="main-features">Main features</h3>
  67 <p>Shaarli is intended:</p>
  68 <ul>
  69 <li>to share, comment and save interesting links and news</li>
  70 <li>to bookmark useful/frequent personal links (as private links) and share them between computers</li>
  71 <li>as a minimal blog/microblog/writing platform (no character limit)</li>
  72 <li>as a read-it-later list (for example items tagged <code>readlater</code>)</li>
  73 <li>to draft and save articles/ideas</li>
  74 <li>to keep code snippets</li>
  75 <li>to keep notes and documentation</li>
  76 <li>as a shared clipboard between machines</li>
  77 <li>as a todo list</li>
  78 <li>to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)</li>
  79 <li>to keep extracts/comments from webpages that may disappear</li>
  80 <li>to keep track of ongoing discussions (for example items tagged <code>discussion</code>)</li>
  81 <li><a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags<a href=".html"></a></li>
  82 <li>to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</li>
  83 </ul>
  84 <h3 id="using-shaarli-as-a-blog-notepad-pastebin...">Using Shaarli as a blog, notepad, pastebin...</h3>
  85 <ul>
  86 <li>Go to your Shaarli setup and log in</li>
  87 <li>Click the <code>Add Link</code> button</li>
  88 <li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li>
  89 <li>Pick a title and enter your article, or note, in the description field; add a few tags; optionally check <code>Private</code> then click <code>Save</code></li>
  90 <li>Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.</li>
  91 </ul>
  92 </body>
  93 </html>