diff options
author | Mark Schmitz <kramred@gmail.com> | 2018-06-07 14:23:53 +0100 |
---|---|---|
committer | Mark Schmitz <kramred@gmail.com> | 2018-06-07 14:23:53 +0100 |
commit | 0deaedeeaef088040fb015f5be3e270e3bae508e (patch) | |
tree | bbdab87adf45592a6a881f808e667ba5c21312a9 /doc | |
parent | f6b3295d28352cbeb46dff04799cf8f4d39087bb (diff) | |
parent | 17e45b2e9c33c736751e059276fadb480f98e621 (diff) | |
download | Shaarli-0deaedeeaef088040fb015f5be3e270e3bae508e.tar.gz Shaarli-0deaedeeaef088040fb015f5be3e270e3bae508e.tar.zst Shaarli-0deaedeeaef088040fb015f5be3e270e3bae508e.zip |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r-- | doc/md/Bookmarklet.md | 29 | ||||
-rw-r--r-- | doc/md/Community-&-Related-software.md | 4 | ||||
-rw-r--r-- | doc/md/Firefox-share.md | 20 | ||||
-rw-r--r-- | doc/md/Sharing-content.md | 88 | ||||
-rw-r--r-- | doc/md/images/doc-logo.png | bin | 19543 -> 19520 bytes | |||
-rw-r--r-- | doc/md/images/firefoxshare.png | bin | 757 -> 715 bytes | |||
-rw-r--r-- | doc/md/images/install-shaarli.png | bin | 44376 -> 33827 bytes | |||
-rw-r--r-- | doc/md/images/rss-filter-1.png | bin | 18682 -> 18534 bytes | |||
-rw-r--r-- | doc/md/images/rss-filter-2.png | bin | 15604 -> 15440 bytes | |||
-rw-r--r-- | doc/md/index.md | 7 |
10 files changed, 91 insertions, 57 deletions
diff --git a/doc/md/Bookmarklet.md b/doc/md/Bookmarklet.md deleted file mode 100644 index 6c7f1c6a..00000000 --- a/doc/md/Bookmarklet.md +++ /dev/null | |||
@@ -1,29 +0,0 @@ | |||
1 | ## Add the sharing button (_bookmarklet_) to your browser | ||
2 | |||
3 | - Open your Shaarli and `Login` | ||
4 | - Click the `Tools` button in the top bar | ||
5 | - Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. | ||
6 | |||
7 | _This bookmarklet button is 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._ | ||
8 | |||
9 | ![](images/bookmarklet.png) | ||
10 | |||
11 | ## Share links using the _bookmarklet_ | ||
12 | |||
13 | - When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. | ||
14 | - A window opens. | ||
15 | - You can freely edit title, description, tags... to find it later using the text search or tag filtering. | ||
16 | - You will be able to edit this link later using the ![](images/edit_icon.png) edit button. | ||
17 | - You can also check the “Private” box so that the link is saved but only visible to you. | ||
18 | - Click `Save`.**Voilà! Your link is now shared.** | ||
19 | |||
20 | ## Troubleshooting: The bookmarklet doesn't work with a few websites (e.g. Github.com) | ||
21 | |||
22 | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. | ||
23 | |||
24 | See [#196](https://github.com/shaarli/Shaarli/issues/196). | ||
25 | |||
26 | There is an open bug for both Firefox and Chromium: | ||
27 | |||
28 | - https://bugzilla.mozilla.org/show_bug.cgi?id=866522 | ||
29 | - https://code.google.com/p/chromium/issues/detail?id=233903 | ||
diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 207153b6..7c570acf 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md | |||
@@ -38,9 +38,11 @@ See [Theming](Theming) for a list of community-contributed themes, and an instal | |||
38 | - [ShaarliOS](https://github.com/mro/ShaarliOS) - Apple iOS share extension. | 38 | - [ShaarliOS](https://github.com/mro/ShaarliOS) - Apple iOS share extension. |
39 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider | 39 | - [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider |
40 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli | 40 | - [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli |
41 | - [Stakali for Android](https://stakali.toneiv.eu) - Stakali is a personal bookmark manager which synchronizes with Shaarli | ||
41 | 42 | ||
42 | ### Browser addons | 43 | ### Browser addons |
43 | * [Shaarli Web Extension](https://github.com/ikipatang/shaarli-web-extension) - toolbar button to share your current tab with Shaarli. | 44 | - [Shaarli Firefox Extension](https://github.com/ikipatang/shaarli-web-extension) - toolbar button to share your current tab with Shaarli. |
45 | - [Shaarli Chrome Extension](https://github.com/octplane/Shiny-Shaarli) - toolbar button to share your current tab with Shaarli. | ||
44 | 46 | ||
45 | ### Server apps | 47 | ### Server apps |
46 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content | 48 | - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content |
diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md deleted file mode 100644 index 9a46b185..00000000 --- a/doc/md/Firefox-share.md +++ /dev/null | |||
@@ -1,20 +0,0 @@ | |||
1 | | Note | Firefox Share is no longer available for Firefox 57 and later versions. | | ||
2 | |---------|---------| | ||
3 | |||
4 | ### Add Shaarli as a sharing service to Firefox | ||
5 | |||
6 | - Open your Shaarli and `Login` | ||
7 | - Click the `Tools` button in the top bar | ||
8 | - Click the `✚Add to Firefox social` button and accept the activation. | ||
9 | |||
10 | |||
11 | ### Sharing links using Firefox share | ||
12 | |||
13 | - Add the sharing service as described above | ||
14 | - When you are visiting a webpage you would like to share with Shaarli, | ||
15 | click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) | ||
16 | - You can edit your link before and after saving, just like the bookmarklet above. | ||
17 | |||
18 | _Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) | ||
19 | enabled server for Firefox Share to work. Firefox Share will not work over | ||
20 | plain HTTP connections._ | ||
diff --git a/doc/md/Sharing-content.md b/doc/md/Sharing-content.md new file mode 100644 index 00000000..faacc1f9 --- /dev/null +++ b/doc/md/Sharing-content.md | |||
@@ -0,0 +1,88 @@ | |||
1 | Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, | ||
2 | you can customize the following aspects: | ||
3 | |||
4 | * URL to link to | ||
5 | * Title | ||
6 | * Free-text description | ||
7 | * Tags | ||
8 | * Public/private status | ||
9 | |||
10 | -------------------------------------------------------------------------------- | ||
11 | |||
12 | ## Adding new Shaares | ||
13 | |||
14 | While logged in to your Shaarli, you can add new Shaares in several ways: | ||
15 | |||
16 | * [+Shaare button] | ||
17 | * [Bookmarklet] | ||
18 | * [Firefox Share](#firefox-share) | ||
19 | * Third-party [apps and browser addons](Community-\&-Related-software.md#mobile-apps) | ||
20 | * [REST API](https://shaarli.github.io/api-documentation/) | ||
21 | |||
22 | ### +Shaare button | ||
23 | |||
24 | * While logged in to your Shaarli, click the **`+Shaare`** button located in the toolbar. | ||
25 | * Enter the URL of a link you want to share. | ||
26 | * Click `Add link` | ||
27 | * The `New Shaare` dialog appears, allowing you to fill in the details of your Shaare. | ||
28 | * The Description, Title, and Tags will help you find your Shaare later using tags or full-text search. | ||
29 | * You can also check the “Private” box so that the link is saved but only visible to you (the logged-in user). | ||
30 | * Click `Save`. | ||
31 | |||
32 | <!-- TODO Add screenshot of add/edit link dialog --> | ||
33 | |||
34 | ### Bookmarklet | ||
35 | |||
36 | The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special | ||
37 | browser bookmark you can use to add new content to your Shaarli. This bookmarklet is | ||
38 | compatible with Firefox, Opera, Chrome and Safari. To set it up: | ||
39 | |||
40 | * Access the `Tools` page from the button in the toolbar. | ||
41 | * Drag the **`✚Shaare link` button** to your browser's bookmarks bar. | ||
42 | |||
43 | Once this is done, you can shaare any URL you are visiting simply by clicking the | ||
44 | bookmarklet in your browser! The same `New Shaare` dialog as above is displayed. | ||
45 | |||
46 | | Note | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunately, there is nothing Shaarli can do about it. \[[1](https://github.com/shaarli/Shaarli/issues/196)]\ \[[2](https://bugzilla.mozilla.org/show_bug.cgi?id=866522)]\ \[[3](https://code.google.com/p/chromium/issues/detail?id=233903)]\ | | ||
47 | |---------|---------| | ||
48 | |||
49 | | Note | 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. | | ||
50 | |---------|---------| | ||
51 | |||
52 | ![](images/bookmarklet.png) | ||
53 | |||
54 | |||
55 | ### Firefox Share | ||
56 | |||
57 | Before using Firefox Share, you must first add Shaarli as a sharing provider: | ||
58 | |||
59 | - Click the `Tools` button in the top bar | ||
60 | - Click the `✚Add to Firefox social` button and accept the activation. | ||
61 | |||
62 | Once this is done, you can share any URL you are visiting by clicking the Firefox | ||
63 | _Share_ button [images/firefoxshare.png](images/firefoxshare.png) | ||
64 | |||
65 | | Note | Firefox Share is no longer available for Firefox 57 and later versions. | | ||
66 | |---------|---------| | ||
67 | |||
68 | | Note | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plaintext HTTP connections. | | ||
69 | |---------|---------| | ||
70 | |||
71 | -------------------------------------------------------------------------------- | ||
72 | |||
73 | ## Editing Shaares | ||
74 | |||
75 | Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. | ||
76 | |||
77 | Editing a Shaare will not change it's permalink, each permalink always points to the | ||
78 | latest revision of a Shaare. | ||
79 | |||
80 | -------------------------------------------------------------------------------- | ||
81 | |||
82 | ## Using shaarli as a blog, notepad, pastebin... | ||
83 | |||
84 | While adding or editing a link, leave the URL field blank to create a text-only | ||
85 | ("note") post. This allows you to post any kind of text content, such as blog | ||
86 | articles, private or public notes, snippets... There is no character limit! You can | ||
87 | access your Shaare from its permalink. | ||
88 | |||
diff --git a/doc/md/images/doc-logo.png b/doc/md/images/doc-logo.png index 3d8d1787..3da7ba57 100644 --- a/doc/md/images/doc-logo.png +++ b/doc/md/images/doc-logo.png | |||
Binary files differ | |||
diff --git a/doc/md/images/firefoxshare.png b/doc/md/images/firefoxshare.png index 98c2fdd3..8f8fdba4 100644 --- a/doc/md/images/firefoxshare.png +++ b/doc/md/images/firefoxshare.png | |||
Binary files differ | |||
diff --git a/doc/md/images/install-shaarli.png b/doc/md/images/install-shaarli.png index 7ae33816..d5d5baa7 100644 --- a/doc/md/images/install-shaarli.png +++ b/doc/md/images/install-shaarli.png | |||
Binary files differ | |||
diff --git a/doc/md/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png index d2a03f67..0cf1591c 100644 --- a/doc/md/images/rss-filter-1.png +++ b/doc/md/images/rss-filter-1.png | |||
Binary files differ | |||
diff --git a/doc/md/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png index 538b126e..5a40755a 100644 --- a/doc/md/images/rss-filter-2.png +++ b/doc/md/images/rss-filter-2.png | |||
Binary files differ | |||
diff --git a/doc/md/index.md b/doc/md/index.md index e77b4d3a..224070cb 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
@@ -94,13 +94,6 @@ Easily extensible by any client using the REST API exposed by Shaarli. | |||
94 | 94 | ||
95 | See the [API documentation](http://shaarli.github.io/api-documentation/). | 95 | See the [API documentation](http://shaarli.github.io/api-documentation/). |
96 | 96 | ||
97 | ### Using Shaarli as a blog, notepad, pastebin... | ||
98 | - Go to your Shaarli setup and log in | ||
99 | - Click the `Add Link` button | ||
100 | - To share text only, do not enter any URL in the corresponding input field and click `Add Link` | ||
101 | - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` | ||
102 | - Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. | ||
103 | |||
104 | ## About | 97 | ## About |
105 | ### Shaarli community fork | 98 | ### Shaarli community fork |
106 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli | 99 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli |