[github/shaarli/Shaarli.git] / doc / Usage.html

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