diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html index 21fa20a..0da63f2 100644 --- a/doc/3rd-party-libraries.html +++ b/doc/3rd-party-libraries.html @@ -4,12 +4,12 @@ -
Backup the file data/datastore.php
(by FTP or SSH). Restore by putting the file back in place.
Example command:
-rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
+rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
To export links as an HTML file, under Tools > Export, choose:
Example command:
-./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
+./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)
diff --git a/doc/Browsing-and-searching.html b/doc/Browsing-and-searching.html new file mode 100644 index 0000000..a088785 --- /dev/null +++ b/doc/Browsing-and-searching.html @@ -0,0 +1,84 @@ + + + + + + +Status: DRAFT
+ +Use the Search text
field to search in any of the fields of all links (Title, URL, Description...)
Exclude text/tags: Use the -
operator before a word or tag (example -uninteresting
) to prevent entries containing (or tagged) uninteresting
from showing up in the search results.
Exact text search: Use double-quotes (example "exact search"
) to search for the exact expression.
Both exclude patterns and exact searches can be combined with normal searches (example "exact search" term otherterm -notthis "very exact" stuff -notagain
)
Use the Filter by tags
field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).
Hidden tags: Tags starting with a dot .
(example .secret
) are private. They can only be seen and searched when logged in.
Alternatively you can use the Tag cloud
to discover all tags and click on any of them to display related links.
RSS feeds can also be restricted to only return items matching a text/tag search: see RSS feeds.
+ + diff --git a/doc/Browsing-and-searching.md b/doc/Browsing-and-searching.md new file mode 100644 index 0000000..187fe44 --- /dev/null +++ b/doc/Browsing-and-searching.md @@ -0,0 +1,28 @@ +#Browsing and searching +# Browsing and Searching + +Status: DRAFT + +![(http://pix.toile-libre.org/upload/original/1455571378.png)]((http://pix.toile-libre.org/upload/original/1455571378.png).html) + +## Plain text search + +Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) + +**Exclude text/tags:** Use the `-` operator before a word or tag (example `-uninteresting`) to prevent entries containing (or tagged) `uninteresting` from showing up in the search results. + +**Exact text search:** Use double-quotes (example `"exact search"`) to search for the exact expression. + +Both exclude patterns and exact searches can be combined with normal searches (example `"exact search" term otherterm -notthis "very exact" stuff -notagain`) + +## Tags search + +Use the `Filter by tags` field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). + +**Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. + +Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links. + +## Filtering RSS feeds/Picture wall + +RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds.html). diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html index 40d1791..8dbf3bc 100644 --- a/doc/Coding-guidelines.html +++ b/doc/Coding-guidelines.html @@ -4,12 +4,12 @@ -See Theming for the list of community-contributed themes, and an installation guide.
Example bash script:
-#!/bin/bash
+#!/bin/bash
#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli
#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.
#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli
@@ -124,9 +151,9 @@ code > span.er { color: #ff0000; font-weight: bold; }
##### MAIN #################
-_main
+_main
This outputs:
-$ ./local-shaarli.sh
+$ ./local-shaarli.sh
PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014
Listening on http://localhost:7431
Document root is /home/user/local-shaarli/shaarli
@@ -134,6 +161,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html)
[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html)
-[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)
+[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html)