doc: merge all sharing methods under a single "Sharing content" page
* formatting, wording, reordering, general improvements * move blog/pastebin/notepad item from index.md to this page * add TODOs * add the new page to mkdocs TOC Part of https://github.com/shaarli/Shaarli/issues/598
This commit is contained in:
parent
14dd77ad7e
commit
80786e150d
5 changed files with 89 additions and 58 deletions
|
@ -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
|
|
|
@ -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._
|
|
88
doc/md/Sharing-content.md
Normal file
88
doc/md/Sharing-content.md
Normal file
|
@ -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)
|
||||||
|
|
||||||
|
|
||||||
|
### +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`.
|
||||||
|
|
||||||
|
<!-- TODO Add screenshot of add/edit link dialog -->
|
||||||
|
|
||||||
|
### 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 ![](https://raw.githubusercontent.com/shaarli/Shaarli/master/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.
|
||||||
|
|
|
@ -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/).
|
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
|
## About
|
||||||
### Shaarli community fork
|
### Shaarli community fork
|
||||||
This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
|
This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
|
||||||
|
|
|
@ -22,9 +22,8 @@ pages:
|
||||||
- Reverse proxy configuration: docker/reverse-proxy-configuration.md
|
- Reverse proxy configuration: docker/reverse-proxy-configuration.md
|
||||||
- Docker resources: docker/resources.md
|
- Docker resources: docker/resources.md
|
||||||
- Usage:
|
- Usage:
|
||||||
- Bookmarklet: Bookmarklet.md
|
|
||||||
- Browsing and searching: Browsing-and-searching.md
|
- Browsing and searching: Browsing-and-searching.md
|
||||||
- Firefox share: Firefox-share.md
|
- Sharing content: Sharing-content.md
|
||||||
- RSS feeds: RSS-feeds.md
|
- RSS feeds: RSS-feeds.md
|
||||||
- REST API: REST-API.md
|
- REST API: REST-API.md
|
||||||
- Community & Related software: Community-&-Related-software.md
|
- Community & Related software: Community-&-Related-software.md
|
||||||
|
|
Loading…
Reference in a new issue