diff options
Diffstat (limited to 'doc/Usage.html')
| -rw-r--r-- | doc/Usage.html | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/Usage.html b/doc/Usage.html new file mode 100644 index 00000000..cffdc4d6 --- /dev/null +++ b/doc/Usage.html | |||
| @@ -0,0 +1,85 @@ | |||
| 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 | <!--[if lt IE 9]> | ||
| 10 | <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | ||
| 11 | <![endif]--> | ||
| 12 | <link rel="stylesheet" href="github-markdown.css"> | ||
| 13 | </head> | ||
| 14 | <body> | ||
| 15 | <div id="local-sidebar"> | ||
| 16 | <ul> | ||
| 17 | <li><a href="Home.html">Home</a></li> | ||
| 18 | <li>Installation | ||
| 19 | <ul> | ||
| 20 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
| 21 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
| 22 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
| 23 | </ul></li> | ||
| 24 | <li><a href="Usage.html">Usage</a> | ||
| 25 | <ul> | ||
| 26 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
| 27 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
| 28 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
| 29 | </ul></li> | ||
| 30 | <li>How To | ||
| 31 | <ul> | ||
| 32 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
| 33 | <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> | ||
| 34 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
| 35 | </ul></li> | ||
| 36 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
| 37 | <li><a href="Development.html">Development</a> | ||
| 38 | <ul> | ||
| 39 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
| 40 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
| 41 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
| 42 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
| 43 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
| 44 | <li><a href="Security.html">Security</a></li> | ||
| 45 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
| 46 | <li><a href="Theming.html">Theming</a></li> | ||
| 47 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
| 48 | </ul></li> | ||
| 49 | <li>About | ||
| 50 | <ul> | ||
| 51 | <li><a href="FAQ.html">FAQ</a></li> | ||
| 52 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
| 53 | <li><a href="TODO.html">TODO</a></li> | ||
| 54 | </ul></li> | ||
| 55 | </ul> | ||
| 56 | </div> | ||
| 57 | <h1 id="usage">Usage</h1> | ||
| 58 | <h3 id="main-features">Main features</h3> | ||
| 59 | <p>Shaarli is intended:</p> | ||
| 60 | <ul> | ||
| 61 | <li>to share, comment and save interesting links and news</li> | ||
| 62 | <li>to bookmark useful/frequent personal links (as private links) and share them between computers</li> | ||
| 63 | <li>as a minimal blog/microblog/writing platform (no character limit)</li> | ||
| 64 | <li>as a read-it-later list (for example items tagged <code>readlater</code>)</li> | ||
| 65 | <li>to draft and save articles/ideas</li> | ||
| 66 | <li>to keep code snippets</li> | ||
| 67 | <li>to keep notes and documentation</li> | ||
| 68 | <li>as a shared clipboard between machines</li> | ||
| 69 | <li>as a todo list</li> | ||
| 70 | <li>to store playlists (e.g. with the <code>music</code> or <code>video</code> tags)</li> | ||
| 71 | <li>to keep extracts/comments from webpages that may disappear</li> | ||
| 72 | <li>to keep track of ongoing discussions (for example items tagged <code>discussion</code>)</li> | ||
| 73 | <li><a href="http://shaarli.chassegnouf.net/?9Efeiw">to feed RSS aggregators</a> (planets) with specific tags<a href=".html"></a></li> | ||
| 74 | <li>to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)</li> | ||
| 75 | </ul> | ||
| 76 | <h3 id="using-shaarli-as-a-blog-notepad-pastebin...">Using Shaarli as a blog, notepad, pastebin...</h3> | ||
| 77 | <ul> | ||
| 78 | <li>Go to your Shaarli setup and log in</li> | ||
| 79 | <li>Click the <code>Add Link</code> button</li> | ||
| 80 | <li>To share text only, do not enter any URL in the corresponding input field and click <code>Add Link</code></li> | ||
| 81 | <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> | ||
| 82 | <li>Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.</li> | ||
| 83 | </ul> | ||
| 84 | </body> | ||
| 85 | </html> | ||