diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2015-10-22 17:02:06 +0200 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2015-10-22 17:02:06 +0200 |
commit | e686b5e6fe37b476d70eeadce34616d65572245b (patch) | |
tree | 850a783f53671a3ad71892c5d6bd41d1c4595043 /docs/en/user/first_article.rst | |
parent | 71200c4155490cb47b64172c3c2159f44cb80eca (diff) | |
parent | 59e91bc8931a386974a3817e9849aad1ca7fc186 (diff) | |
download | wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.gz wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.zst wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.zip |
Merge pull request #1495 from wallabag/v2-docs
add docs
Diffstat (limited to 'docs/en/user/first_article.rst')
-rw-r--r-- | docs/en/user/first_article.rst | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst new file mode 100644 index 00000000..4e6735c6 --- /dev/null +++ b/docs/en/user/first_article.rst | |||
@@ -0,0 +1,79 @@ | |||
1 | Save your first article | ||
2 | ======================= | ||
3 | |||
4 | The main purpose of wallabag is to save web articles. You have many ways to do it. | ||
5 | |||
6 | By using a bookmarklet | ||
7 | ---------------------- | ||
8 | |||
9 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. | ||
10 | |||
11 | Now, each time you're reading an article on the web and you want to save it, click on the ``bag it!`` link in your bookmarks bar. The article is saved. | ||
12 | |||
13 | By using the classic form | ||
14 | ------------------------- | ||
15 | |||
16 | In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. | ||
17 | |||
18 | .. image:: ../../img/user/topbar.png | ||
19 | :alt: Top bar | ||
20 | :align: center | ||
21 | |||
22 | Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. | ||
23 | |||
24 | By using a browser add-on | ||
25 | ------------------------- | ||
26 | |||
27 | Firefox | ||
28 | ~~~~~~~ | ||
29 | |||
30 | Firefox Classic Add-on | ||
31 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
32 | |||
33 | Download the Firefox add-on at `addons.mozilla.org`_ and install it like | ||
34 | any other Firefox add-on. | ||
35 | |||
36 | In the add-on’s settings, fill the complete URL of your installation of | ||
37 | wallabag or your Framabag account. | ||
38 | |||
39 | Personalize the Firefox toolbar to add wallabag (**W** icon). When you | ||
40 | find an article you want to save, click on this icon: a new window will | ||
41 | open to add the article and will close itself automatically. | ||
42 | |||
43 | Firefox Social API Service | ||
44 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
45 | |||
46 | *Available from wallabag v1.9.1 only* | ||
47 | |||
48 | You will need an https connection to use this. It’s a Firefox | ||
49 | `requirement`_, sorry. | ||
50 | |||
51 | With Firefox 29+ versions, your browser comes with an integrated | ||
52 | interface to share things to multiple social services directly from your | ||
53 | browser. In the Firefox interface, it is shown a paper plane-like icon | ||
54 | that you will use to share a page, which means here, save an article. | ||
55 | You can add the service by going into the Config page of wallabag, then | ||
56 | click on Mozilla Services Social API Extension. You must also accept to | ||
57 | use Firefox Services. | ||
58 | |||
59 | Chrome | ||
60 | ~~~~~~ | ||
61 | |||
62 | By using your smarphone application | ||
63 | ----------------------------------- | ||
64 | |||
65 | Android | ||
66 | ~~~~~~~ | ||
67 | |||
68 | Firefox OS | ||
69 | ~~~~~~~~~~ | ||
70 | |||
71 | Windows Phone | ||
72 | ~~~~~~~~~~~~~ | ||
73 | |||
74 | iOS | ||
75 | ~~~ | ||
76 | |||
77 | |||
78 | .. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ | ||
79 | .. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents | ||