]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - doc/Usage.html
Doc: sync from Wiki, generate HTML
[github/shaarli/Shaarli.git] / doc / Usage.html
diff --git a/doc/Usage.html b/doc/Usage.html
new file mode 100644 (file)
index 0000000..cffdc4d
--- /dev/null
@@ -0,0 +1,85 @@
+<!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">
+  <title>Shaarli - Usage</title>
+  <style type="text/css">code{white-space: pre;}</style>
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link rel="stylesheet" href="github-markdown.css">
+</head>
+<body>
+<div id="local-sidebar">
+<ul>
+<li><a href="Home.html">Home</a></li>
+<li>Installation
+<ul>
+<li><a href="Server-requirements.html">Server requirements</a></li>
+<li><a href="Server-configuration.html">Server configuration</a></li>
+<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
+</ul></li>
+<li><a href="Usage.html">Usage</a>
+<ul>
+<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
+<li><a href="Firefox-share.html">Firefox share</a></li>
+<li><a href="RSS-feeds.html">RSS feeds</a></li>
+</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="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</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="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-&amp;-Related-software.html">Community &amp; Related software</a></li>
+<li><a href="TODO.html">TODO</a></li>
+</ul></li>
+</ul>
+</div>
+<h1 id="usage">Usage</h1>
+<h3 id="main-features">Main features</h3>
+<p>Shaarli is intended:</p>
+<ul>
+<li>to share, comment and save interesting links and news</li>
+<li>to bookmark useful/frequent personal links (as private links) and share them between computers</li>
+<li>as a minimal blog/microblog/writing platform (no character limit)</li>
+<li>as a read-it-later list (for example items tagged <code>readlater</code>)</li>
+<li>to draft and save articles/ideas</li>
+<li>to keep code snippets</li>
+<li>to keep notes and documentation</li>
+<li>as a shared clipboard between machines</li>
+<li>as a todo list</li>
+<li>to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)</li>
+<li>to keep extracts/comments from webpages that may disappear</li>
+<li>to keep track of ongoing discussions (for example items tagged <code>discussion</code>)</li>
+<li><a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags<a href=".html"></a></li>
+<li>to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</li>
+</ul>
+<h3 id="using-shaarli-as-a-blog-notepad-pastebin...">Using Shaarli as a blog, notepad, pastebin...</h3>
+<ul>
+<li>Go to your Shaarli setup and log in</li>
+<li>Click the <code>Add Link</code> button</li>
+<li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li>
+<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>
+<li>VoilĂ ! Your article is now published (privately if you selected that option) and accessible using its permalink.</li>
+</ul>
+</body>
+</html>