diff --git a/doc/Home.html b/doc/Home.html
index e4d117f1..2cb54c86 100644
--- a/doc/Home.html
+++ b/doc/Home.html
@@ -14,8 +14,7 @@
Shaarli wiki
Welcome to the Shaarli wiki! Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. For general info, read the README.
-If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion or read the current issues. If you've found a bug, please create a new issue.
-If you'd like a feature added, see if it fits in the list of Ideas for Plugins and update the corresponding bug report.
+If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion or read the current issues. If you've found a bug, please create a new issue. If you would like a feature added to Shaarli, check the issues labeled feature, enhancement, and plugin.
Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/ directory of your Shaarli installation.
@@ -25,7 +24,9 @@ Shaarli wiki
Basic Usage
Other usage examples
-Related software
+Related software
+
Other links
FAQ
This bookmarklet button in 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.
+Add Shaarli as a sharing service to Firefox
+
+- Open your Shaarli and
Login
+- Click the
Tools button in the top bar
+- Click the
βAdd to Firefox social button and accept the activation.
+
Share links using the bookmarklet
- When you are visiting a webpage you would like to share with Shaarli, click the bookmarklet you just added.
@@ -98,6 +113,12 @@ Share links using the bookmarklet
- You can also check the βPrivateβ box so that the link is saved but only visible to you.
- Click
Save.Voila! Your link is now shared.
+Sharing links using Firefox share
+
+- Add the sharing service as described above
+- When you are visiting a webpage you would like to share with Shaarli, click the Firefox Share button [[images/firefoxshare.png]]
+- You can edit your link before and after saving, just like the bookmarklet above.
+
Other usage examples
Shaarli can be used:
@@ -134,7 +155,7 @@ - The same method also works for a full-text search (Search box) and for the Picture Wall (want to only see pictures about
nature?)
- You can also build the URL manually:
https://my.shaarli.domain/?do=rss&searchtags=nature, https://my.shaarli.domain/links/?do=picwall&searchterm=poney
-
+
Configuration
Main data/options.php file
To change the configuration, create the file data/options.php, example:
@@ -153,10 +174,10 @@ Main data/options.php file
BAN_AFTER (4) : An IP address will be banned after this many failed login attempts.
BAN_DURATION (1800) : Duration of ban (in seconds). (1800 seconds = 30 minutes)
OPEN_SHAARLI (false) : If you set this option to true, anyone will be able to add/modify/delete/import/exports links without having to login.
-HIDE_TIMESTAMPS (false) : If you set this option to true, the date/time of each link will not be displayed (including in RSS Feed).
+HIDE_TIMESTAMPS (false) : If you set this option to true, the date/time of each link will not be displayed (including in RSS Feed).#related-software
ENABLE_THUMBNAILS (true) : Enable/disable thumbnails.
RAINTPL_TMP (tmp/) : Raintpl cache directory (keep the trailing slash!)
-`RAINTPL_TPL (tpl/) : Raintpl template directory (keep the trailing slash!). Edit this option if you want to change the rendering template (page structure) used by Shaarli. See Changing template
+RAINTPL_TPL (tpl/) : Raintpl template directory (keep the trailing slash!). Edit this option if you want to change the rendering template (page structure) used by Shaarli. See Changing template
CACHEDIR ('cache') : Directory where the thumbnails are stored.
ENABLE_LOCALCACHE (true) : If you have a limited quota on your webspace, you can set this option to false: Shaarli will not generate thumbnails which need to be cached locally (vimeo, flickr, etc.). Thumbnails will still be visible for the services which do not use the local cache (youtube.com, imgur.com, dailymotion.com, imageshack.us)
UPDATECHECK_FILENAME ($GLOBALS['config']['DATADIR'].'/lastupdatecheck.txt') : name of the file used to store available shaarli version.
@@ -164,7 +185,8 @@ Main data/options.php file
ENABLE_UPDATECHECK: Determines whether Shaarli check for new releases at https://github.com/shaarli/Shaarli
SHOW_ATOM (false) : Show an ATOM Feed button next to the Subscribe (RSS) button. ATOM feeds are available at the address ?do=atom regardless of this option.
ARCHIVE_ORG (false) : For each link, display a link to an archived version on archive.org
-ENABLE_RSS_PERMALINKS (true): choose whether the RSS item title link points directly to the link, or to the entry on Shaarli (permalink). true is the original Shaarli bahevior (point directly to the link)
+ENABLE_RSS_PERMALINKS (true): choose whether the RSS item title link points directly to the link, or to the entry on Shaarli (permalink). true is the original Shaarli bahevior (point directly to the link)
+HIDE_PUBLIC_LINKS (false): setting this to true hides all links, even public ones, for non-logged in users.
Changing theme
Changing template
-| π₯ | This feature is currently being worked on and will be improved in the next releases. Experimental. |
|---------|---------|
+| WARNING | This feature is currently being worked on and will be improved in the next releases. Experimental. |
|---------|---------|
- Find the template you'd like to install. See the list of available templates (TODO). Find it's git clone URL or download the zip archive for the template.
- In your Shaarli
tpl/ directory, run git clone https://url/of/my-template/ or unpack the zip archive. There should now be a my-template/ directory under the tpl/ dir, containing directly all the template files.
- Edit
data/options.php to have Shaarli use this template. Eg.
$GLOBALS['config']['RAINTPL_TPL'] = 'tpl/my-template/' ;
-You can find a list of compatible templates in Related Software
+You can find a list of compatible templates in Related Software
Backup
You have two ways of backing up your database:
@@ -248,7 +270,14 @@ Various hacks
- Example patch: add a new "via" field for links
- Copy a Shaarli installation over SSH SCP, serve it locally with php cli
-- To display the array representing the data saved in datastore.php, use the following snippet (TODO where is it gone?)
+To display the array representing the data saved in datastore.php, use the following snippet
+$data = "tZNdb9MwFIb... <Commented content inside datastore.php>";
+$out = unserialize(gzinflate(base64_decode($data)));
+echo "<pre>"; // Pretty printing is love, pretty printing is life
+print_r($out);
+echo "</pre>";
+exit;
+This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation)
Changing timestamp for a link
@@ -256,33 +285,39 @@ Changing timestamp for a link
- Remove
type="hidden" from this line
- A new date/time field becomes available in the edit/new link dialog. You can set the timestamp manually by entering it in the format
YYYMMDD_HHMMS.
-
$data = "tZNdb9MwFIb... <Commented content inside datastore.php>";
-$out = unserialize(gzinflate(base64_decode($data)));
-echo "<pre>"; // Pretty printing is love, pretty printing is life
-print_r($out);
-echo "</pre>";
-exit;
-This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation)
Unofficial but relatedd work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork. TODO contact repos owners to see if they'd like to standardize their work for the community fork.
+Server apps
+Android apps
+
+Themes & templates
+
+
+
+Alternative to Shaarli
+
- Bookie - Another self-hostable, Free bookmark sharing software, written in Python
- Unmark - An open source to do app for bookmarks (Homepage)
@@ -333,36 +368,48 @@ Technical details
Directory structure
Here is the directory structure of Shaarli and the purpose of the different files:
index.php : Main program.
+ application/ : Shaarli classes
+ βββ LinkDB.php
+ βββ Utils.php
+ tests/ : Shaarli unitary & functional tests
+ βββ LinkDBTest.php
+ βββ utils # utilities to ease testing
+ β βββ ReferenceLinkDB.php
+ βββ UtilsTest.php
COPYING : Shaarli license.
inc/ : Includes (libraries, CSSβ¦)
- shaarli.css : Shaarli stylesheet.
- jquery.min.js : jQuery javascript library.
- jquery-ui.min.js : jQuery-UI javascript library.
- jquery-MIT-LICENSE.txt: jQuery license.
- jquery.lazyload.min.js: LazyLoad javascript library.
- rain.tpl.class.php : RainTPL templating library.
+ βββ awesomplete.*: tags autocompletion library
+ βββ blazy.*: picture wall lazy image loading library
+ βββ shaarli.css, reset.css : Shaarli stylesheet.
+ βββ qr.* : qr code generation library
+ βββrain.tpl.class.php : RainTPL templating library.
tpl/ : RainTPL templates for Shaarli. They are used to build the pages.
images/ : Images and icons used in Shaarli.
data/ : Directory where data is stored (bookmark database, configuration, logs, banlistβ¦)
- config.php : Shaarli configuration (login, password, timezone, titleβ¦)
- datastore.php : Your link database (compressed).
- ipban.php : IP address ban system data.
- lastupdatecheck.txt : Update check timestamp file (used to check every 24 hours if a new version of Shaarli is available).
- log.txt : login/IPban log.
+ βββ config.php : Shaarli configuration (login, password, timezone, titleβ¦)
+ βββ datastore.php : Your link database (compressed).
+ βββ ipban.php : IP address ban system data.
+ βββ lastupdatecheck.txt : Update check timestamp file (used to check every 24 hours if a new version of Shaarli is available).
+ βββlog.txt : login/IPban log.
cache/ : Directory containing the thumbnails cache. This directory is automatically created. You can erase it anytime you want.
tmp/ : Temporary directory for compiled RainTPL templates. This directory is automatically created. You can erase it anytime you want.
+Development
+
Why not use a real database ? Files are slow !
Does browsing this page feel slow ? Try browsing older pages, too.
It's not slow at all, is it ? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why ?
The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.
Wiki - TODO
-- Translate (new page can be called Home.fr, Home.es ...) and linked from Home
+- translate (new page can be called Home.fr, Home.es ... and linked from Home)
- add more screenshots
-- add developer documentation (storage architecture, classes and functions, security handling, ...)
-- Contact related projects
-- Add a Table of Contents to the wiki (can be added to the sidebar)
+- add developer documentation (storage architecture, classes and functions, security handling, ...)
-...