From: nodiscc Date: Wed, 18 Apr 2018 17:57:36 +0000 (+0200) Subject: Merge pull request #1081 from nodiscc/doc-merge-sharing X-Git-Tag: v0.10.0~29 X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=3c0e27eec72f7bb00aea81540f978c4b4a1ac87f;hp=7ca124079e6bd414b096fcec9789cef1216dff8f;p=github%2Fshaarli%2FShaarli.git Merge pull request #1081 from nodiscc/doc-merge-sharing doc: merge all sharing methods under a single "Sharing content" page --- 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 @@ -## Add the sharing button (_bookmarklet_) to your browser - -- Open your Shaarli and `Login` -- Click the `Tools` button in the top bar -- Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. - -_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._ - -![](images/bookmarklet.png) - -## Share links using the _bookmarklet_ - -- When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. -- A window opens. - - You can freely edit title, description, tags... to find it later using the text search or tag filtering. - - You will be able to edit this link later using the ![](images/edit_icon.png) edit button. - - You can also check the “Private” box so that the link is saved but only visible to you. -- Click `Save`.**Voilà! Your link is now shared.** - -## Troubleshooting: The bookmarklet doesn't work with a few websites (e.g. Github.com) - -Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. - -See [#196](https://github.com/shaarli/Shaarli/issues/196). - -There is an open bug for both Firefox and Chromium: - -- https://bugzilla.mozilla.org/show_bug.cgi?id=866522 -- https://code.google.com/p/chromium/issues/detail?id=233903 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 @@ -| Note | Firefox Share is no longer available for Firefox 57 and later versions. | -|---------|---------| - -### 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. - - -### 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](images/firefoxshare.png) -- You can edit your link before and after saving, just like the bookmarklet above. - -_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 -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 @@ +Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, +you can customize the following aspects: + + * URL to link to + * Title + * Free-text description + * Tags + * Public/private status + +-------------------------------------------------------------------------------- + +## Adding new Shaares + +While logged in to your Shaarli, you can add new Shaares in several ways: + + * [+Shaare button] + * [Bookmarklet] + * [Firefox Share](#firefox-share) + * Third-party [apps and browser addons](Community-\&-Related-software.md#mobile-apps) + * [REST API](https://shaarli.github.io/api-documentation/) + +### +Shaare button + + * While logged in to your Shaarli, click the **`+Shaare`** button located in the toolbar. + * Enter the URL of a link you want to share. + * Click `Add link` + * The `New Shaare` dialog appears, allowing you to fill in the details of your Shaare. + * The Description, Title, and Tags will help you find your Shaare later using tags or full-text search. + * You can also check the “Private” box so that the link is saved but only visible to you (the logged-in user). + * Click `Save`. + + + +### Bookmarklet + +The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special +browser bookmark you can use to add new content to your Shaarli. This bookmarklet is +compatible with Firefox, Opera, Chrome and Safari. To set it up: + + * Access the `Tools` page from the button in the toolbar. + * Drag the **`✚Shaare link` button** to your browser's bookmarks bar. + +Once this is done, you can shaare any URL you are visiting simply by clicking the +bookmarklet in your browser! The same `New Shaare` dialog as above is displayed. + +| 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)]\ | +|---------|---------| + +| 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. | +|---------|---------| + +![](images/bookmarklet.png) + + +### Firefox Share + +Before using Firefox Share, you must first add Shaarli as a sharing provider: + +- Click the `Tools` button in the top bar +- Click the `✚Add to Firefox social` button and accept the activation. + +Once this is done, you can share any URL you are visiting by clicking the Firefox +_Share_ button [images/firefoxshare.png](images/firefoxshare.png) + +| Note | Firefox Share is no longer available for Firefox 57 and later versions. | +|---------|---------| + +| 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. | +|---------|---------| + +-------------------------------------------------------------------------------- + +## Editing Shaares + +Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. + +Editing a Shaare will not change it's permalink, each permalink always points to the +latest revision of a Shaare. + +-------------------------------------------------------------------------------- + +## Using shaarli as a blog, notepad, pastebin... + +While adding or editing a link, leave the URL field blank to create a text-only +("note") post. This allows you to post any kind of text content, such as blog +articles, private or public notes, snippets... There is no character limit! You can +access your Shaare from its permalink. + diff --git a/doc/md/images/doc-logo.png b/doc/md/images/doc-logo.png index 3d8d1787..3da7ba57 100644 Binary files a/doc/md/images/doc-logo.png and b/doc/md/images/doc-logo.png differ diff --git a/doc/md/images/firefoxshare.png b/doc/md/images/firefoxshare.png index 98c2fdd3..8f8fdba4 100644 Binary files a/doc/md/images/firefoxshare.png and b/doc/md/images/firefoxshare.png differ diff --git a/doc/md/images/install-shaarli.png b/doc/md/images/install-shaarli.png index 7ae33816..d5d5baa7 100644 Binary files a/doc/md/images/install-shaarli.png and b/doc/md/images/install-shaarli.png differ diff --git a/doc/md/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png index d2a03f67..0cf1591c 100644 Binary files a/doc/md/images/rss-filter-1.png and b/doc/md/images/rss-filter-1.png differ diff --git a/doc/md/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png index 538b126e..5a40755a 100644 Binary files a/doc/md/images/rss-filter-2.png and b/doc/md/images/rss-filter-2.png 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. See the [API documentation](http://shaarli.github.io/api-documentation/). -### Using Shaarli as a blog, notepad, pastebin... -- Go to your Shaarli setup and log in -- Click the `Add Link` button -- To share text only, do not enter any URL in the corresponding input field and click `Add Link` -- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` -- Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. - ## About ### Shaarli community fork This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli diff --git a/inc/languages/fr/LC_MESSAGES/shaarli.po b/inc/languages/fr/LC_MESSAGES/shaarli.po index fd47217e..2ebeccbc 100644 --- a/inc/languages/fr/LC_MESSAGES/shaarli.po +++ b/inc/languages/fr/LC_MESSAGES/shaarli.po @@ -1,9 +1,8 @@ msgid "" msgstr "" "Project-Id-Version: Shaarli\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2018-02-24 12:39+0100\n" -"PO-Revision-Date: 2018-02-24 12:43+0100\n" +"POT-Creation-Date: 2018-01-24 18:43+0100\n" +"PO-Revision-Date: 2018-03-06 18:44+0100\n" "Last-Translator: \n" "Language-Team: Shaarli\n" "Language: fr_FR\n" @@ -764,6 +763,12 @@ msgstr "Tous les liens d'un jour sur une page." msgid "Next day" msgstr "Jour suivant" +#: tpl/editlink.html +msgid "Edit Shaare" +msgstr "Modifier le Shaare" +msgid "New Shaare" +msgstr "Nouveau Shaare" + #: tmp/editlink.b91ef64efc3688266305ea9b42e5017e.rtpl.php:25 msgid "Created:" msgstr "Création :" diff --git a/mkdocs.yml b/mkdocs.yml index 443c3a08..8ba25540 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,9 +22,8 @@ pages: - Reverse proxy configuration: docker/reverse-proxy-configuration.md - Docker resources: docker/resources.md - Usage: - - Bookmarklet: Bookmarklet.md - Browsing and searching: Browsing-and-searching.md - - Firefox share: Firefox-share.md + - Sharing content: Sharing-content.md - RSS feeds: RSS-feeds.md - REST API: REST-API.md - Community & Related software: Community-&-Related-software.md diff --git a/tpl/default/editlink.html b/tpl/default/editlink.html index d03fd72f..f8e968f1 100644 --- a/tpl/default/editlink.html +++ b/tpl/default/editlink.html @@ -9,8 +9,7 @@

- {if="!$link_is_new"}{'Edit'|t}{/if} - {'Shaare'|t} + {if="!$link_is_new"}{'Edit Shaare'|t}{else}{'New Shaare'|t}{/if}

{if="isset($link.id)"}