aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/User
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/User')
-rw-r--r--docs/en/User/configure_wallabag.html212
-rw-r--r--docs/en/User/epub_conversion.html213
-rw-r--r--docs/en/User/framabag_account_creation.html214
-rw-r--r--docs/en/User/import_export.html244
-rw-r--r--docs/en/User/issue_with_article.html216
-rw-r--r--docs/en/User/organize_articles.html232
-rw-r--r--docs/en/User/read_an_article.html226
-rw-r--r--docs/en/User/rss_feed.html221
-rw-r--r--docs/en/User/save_your_first_article.html250
-rw-r--r--docs/en/User/search.html200
10 files changed, 2228 insertions, 0 deletions
diff --git a/docs/en/User/configure_wallabag.html b/docs/en/User/configure_wallabag.html
new file mode 100644
index 00000000..b7bf879a
--- /dev/null
+++ b/docs/en/User/configure_wallabag.html
@@ -0,0 +1,212 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Configure wallabag</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Configure wallabag
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test active">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="configure-wallabag">Configure wallabag</h1>
181<p>From the configuration menu, you can change some wallabag's options.</p>
182<p>Some parts won't be presented here as they have a complete chapter in the documentation (RSS feeds, import from a third party service, export your data, Epub conversion and multi-user mode).</p>
183<h2 id="theme">Theme</h2>
184<p>Of tastes and colors, we do not discuss. That's why wallabag offers you to change its skin to please everyone.</p>
185<p>Select the theme of your choice from the drop down list and confirm by clicking on <strong>Update</strong>.</p>
186<h2 id="language">Language</h2>
187<p>Select the language of your choice in the drop down list and confirm by clicking on <strong>Update</strong>.</p>
188<h2 id="password">Password</h2>
189<p>Fill in your new password in the two dedicated fields and confirm by clicking on <strong>Update</strong>.</p>
190<p>You will be disconnected and need to enter your new password to access your wallabag.</p>
191<h2 id="clear-the-cache">Clear the cache</h2>
192<p>The cache allows wallabag perform certain functions faster.</p>
193<p>After updating wallabag, it is advised to clear the cache. You only have to click to do so.</p>
194 </section>
195
196 </div>
197 </main>
198
199 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
200 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
201 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
202
203 <script>
204 $(function() {
205 $("section>h1").wrap('<div class="page-header" />');
206 // Syntax highlighting
207 hljs.initHighlightingOnLoad();
208 });
209 </script>
210
211 </body>
212</html>
diff --git a/docs/en/User/epub_conversion.html b/docs/en/User/epub_conversion.html
new file mode 100644
index 00000000..97b095e4
--- /dev/null
+++ b/docs/en/User/epub_conversion.html
@@ -0,0 +1,213 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - ePub conversion</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 ePub conversion
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test active">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="epub-conversion">ePub conversion</h1>
181<p>To enable you to read your articles on a e-reader, wallabag can convert them to the ePub format, and hence create an eBook for your long winter evenings.</p>
182<h2 id="a-word-of-caution">A word of caution</h2>
183<p>Be careful, the creation of ePub files can be very resource demanding for the server on which wallabag is installed.
184It depends on the number of articles and on their length.
185Do not create a really big eBook if this is not necessary.</p>
186<h2 id="where-to-convert-the-articles">Where to convert the articles</h2>
187<p>You can convert your articles at various places in wallabag:</p>
188<ul>
189<li>on the reading page of an article: the ePub link will convert this article only</li>
190<li>from the list of articles (unread, favorite or archived articles, articles with a tag): a link at the bottom of the page allows you to convert all the article of this category</li>
191<li>from a search: the link is at the bottom of the page</li>
192<li>from the configuration page: you can convert all your articles, whatever the category to which they belong</li>
193</ul>
194<p>TODO talk about calibre</p>
195 </section>
196
197 </div>
198 </main>
199
200 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
201 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
202 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
203
204 <script>
205 $(function() {
206 $("section>h1").wrap('<div class="page-header" />');
207 // Syntax highlighting
208 hljs.initHighlightingOnLoad();
209 });
210 </script>
211
212 </body>
213</html>
diff --git a/docs/en/User/framabag_account_creation.html b/docs/en/User/framabag_account_creation.html
new file mode 100644
index 00000000..f60022ae
--- /dev/null
+++ b/docs/en/User/framabag_account_creation.html
@@ -0,0 +1,214 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Framabag account creation</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Framabag account creation
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test active">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="framabag-account-creation">Framabag account creation</h1>
181<p>If you do not want to install and update wallabag, or if you do not have the know-how to install it, it is possible to create an account for free at <a href="https://www.framabag.org">Framabag.org</a>.</p>
182<h2 id="account-creation">Account creation</h2>
183<p>Click on the button <strong>Créez votre compte / Create your account</strong>.</p>
184<p>You have to input some information: your username, your password and your email address. Your address is used only to validate your account, except if you check the box to subscribe the newsletter (3 to 4 messages per year).</p>
185<p>Once this form validated, you will receive an email with the confirmation link. Click on it to create your account.</p>
186<p>You will receive a last email with the address of your Framabag account, which will look like
187<code>https://www.framabag.org/u/Your-username</code>.</p>
188<h2 id="information-storage">Information storage</h2>
189<p>Framabag use one database per user. We do not and will not use your stored data.</p>
190<h2 id="you-have-forgotten-your-password">You have forgotten your password</h2>
191<p>If you have forgotten your password to get connected to Framabag, a form is available <a href="https://www.framabag.org">on the main page of the service</a>.<br />
192Fill it, and a confirmation will be sent to you and will allow you to input a new password.</p>
193<h2 id="account-deletion">Account deletion</h2>
194<p>If you wish to delete your account, contact us by email: <a href="mailto:hello@wallabag.org">hello@wallabag.org</a> using the address your created your account with, and state your username. </p>
195<p>We will answer you after your account has been deleted: then, no information about you will be stored by Framabag.</p>
196 </section>
197
198 </div>
199 </main>
200
201 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
202 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
203 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
204
205 <script>
206 $(function() {
207 $("section>h1").wrap('<div class="page-header" />');
208 // Syntax highlighting
209 hljs.initHighlightingOnLoad();
210 });
211 </script>
212
213 </body>
214</html>
diff --git a/docs/en/User/import_export.html b/docs/en/User/import_export.html
new file mode 100644
index 00000000..e3705147
--- /dev/null
+++ b/docs/en/User/import_export.html
@@ -0,0 +1,244 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Import and export data</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Import and export data
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test active">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="import-and-export-data">Import and export data</h1>
181<h2 id="import">Import</h2>
182<p>To import data in wallabag, go to the page <strong>Configuration</strong>.</p>
183<h3 id="caution">Caution</h3>
184<p>Data import can be a <strong>demanding process</strong> for your server. Hence, it is done in two steps:</p>
185<ul>
186<li>Insertion of the URL in the wallabag database</li>
187<li>in the second step, the retrieval, for each article, of its full content.</li>
188</ul>
189<p>These two steps cannot be done concurrently, because it let us the possibility to import thousands of links, but today, wallabag does not have sufficient technical capabilities to do this task automatically.</p>
190<h3 id="from-pocket">From Pocket</h3>
191<h4 id="export-your-data-from-pocket">Export your data from Pocket</h4>
192<p>From your Pocket account, go to the options.
193TODO</p>
194<h4 id="import-your-pocket-data">Import your Pocket data</h4>
195<p>From the configuration page of wallabag, section <strong>Import</strong>, select the file <code>ril_export.html</code> generated by Pocket, then click on <strong>Import</strong>.
196Wallabag only insert these links in the database. Now, you have to get the content of each article.</p>
197<p>For this, click on <code>Click to finish import</code>: wallabag will fetch the content of 10 articles at a time.</p>
198<p>TODO</p>
199<p>TODO new ticket: why when a click is done, this does not load in a loop? I believe this was doing this ping @mariroz</p>
200<h3 id="from-instapaper">From Instapaper</h3>
201<h4 id="export-your-data-from-instapaper">Export your data from Instapaper</h4>
202<p>TODO</p>
203<h4 id="import-your-instapaper-data">Import your Instapaper data</h4>
204<p>TODO</p>
205<h3 id="from-readability">From Readability</h3>
206<h4 id="export-your-data-from-readability">Export your data from Readability</h4>
207<p>TODO</p>
208<h4 id="import-your-readability-data">Import your Readability data</h4>
209<p>TODO</p>
210<h3 id="from-wallabag">From wallabag</h3>
211<p>Since you can export your data from wallabag (see below), it is of course possible to re-import them.</p>
212<p>In the import form, select your wallabag-exported file (format JSON). Start the import, et voilà.</p>
213<p>Unlike the above imports, this process is shorter because all the data (title and content of the articles) are already included in the file. Hence wallabag does not have to access each URL. However, the import file is necessarily bigger.</p>
214<h3 id="from-a-html-or-json-file">From a HTML or JSON file</h3>
215<p>TODO</p>
216<h2 id="export">Export</h2>
217<p>It is possible to export your data from the page <strong>Configuration</strong> of wallabag. Several reasons to do this:</p>
218<ul>
219<li>re-install of wallabag</li>
220<li>leave the Framabag service to install your own wallabag</li>
221<li>a user with an account on a multi-user wallabag want to have his/her own wallabag installation</li>
222<li>...</li>
223</ul>
224<p>This will lead you to download a file <a href="http://en.wikipedia.org/wiki/JavaScript_Object_Notation">at the JSON format</a>.<br />
225As detailed above, you can import this file in wallabag.</p>
226 </section>
227
228 </div>
229 </main>
230
231 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
232 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
233 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
234
235 <script>
236 $(function() {
237 $("section>h1").wrap('<div class="page-header" />');
238 // Syntax highlighting
239 hljs.initHighlightingOnLoad();
240 });
241 </script>
242
243 </body>
244</html>
diff --git a/docs/en/User/issue_with_article.html b/docs/en/User/issue_with_article.html
new file mode 100644
index 00000000..1c1c8e6e
--- /dev/null
+++ b/docs/en/User/issue_with_article.html
@@ -0,0 +1,216 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Issue with article</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Issue with article
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test active">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="my-article-is-not-displayed-properly-in-wallabag">My article is not displayed properly in wallabag</h1>
181<p>If you think wallabag do not copy well the content of an article (empty or incomplete text), here are some suggestions.</p>
182<h2 id="ask-for-help">Ask for help</h2>
183<p>Via an email or a ticket, do not forget to give some information that are important for us to better solve the problem:</p>
184<ul>
185<li>The URL of the article</li>
186<li>What wallabag displays</li>
187<li>What you were expecting</li>
188<li>The wallabag version of if you use Framabag</li>
189</ul>
190<h3 id="open-a-ticket-on-github">Open a ticket on github</h3>
191<p>To open a new ticket, you should <a href="https://github.com/wallabag/wallabag/issues/new">go to github</a>. An account is required.
192Do not forget to send us the information listed above.</p>
193<h3 id="send-us-an-email">Send us an email</h3>
194<p>Send us the link in a email to the address <a href="mailto:hello@wallabag.org?subject=Wrong%20display%20in%20wallabag">hello@wallabag.org</a>.<br />
195Do not forget to send us the information listed above.</p>
196<h2 id="solve-this-display-problem">Solve this display problem</h2>
197<p>TODO</p>
198 </section>
199
200 </div>
201 </main>
202
203 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
204 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
205 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
206
207 <script>
208 $(function() {
209 $("section>h1").wrap('<div class="page-header" />');
210 // Syntax highlighting
211 hljs.initHighlightingOnLoad();
212 });
213 </script>
214
215 </body>
216</html>
diff --git a/docs/en/User/organize_articles.html b/docs/en/User/organize_articles.html
new file mode 100644
index 00000000..45c21826
--- /dev/null
+++ b/docs/en/User/organize_articles.html
@@ -0,0 +1,232 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Organize articles</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Organize articles
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test active">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="organize-articles">Organize articles</h1>
181<p>To be able to find more easily your articles, several methods are available. </p>
182<h2 id="tags">Tags</h2>
183<h3 id="assign-a-tag">Assign a tag</h3>
184<h4 id="when-saving-an-article">When saving an article</h4>
185<p>To tag an article when saving it, just click on the tag icon next to the URL field before hitting the Save button. At the moment, it is possible only to do this from the web interface, but it could come to some apps or extensions.</p>
186<h4 id="from-the-article">From the article</h4>
187<p>To tag an already-saved article, go to the reading page of the article. There is a part <code>tags</code> followed with a pencil. Click on the pencil.</p>
188<p>Input in the box the tags you want to assign. Add as many tags as you want. They need to be separated by commas and not spaces. Auto-completion is available here: when you type the first letters of an existing tag, it is not necessary to type the whole word. Select it in the drop-down list. Once all your tags are inputted, click on the button <strong>Tag</strong>.</p>
189<p>Then, you can go back to your article and read it.</p>
190<h4 id="from-the-search">From the search</h4>
191<p>A full chapter on search is available. Here, we will describe only how to assign a tag from your search.</p>
192<p>When your search displays results, there is a link <code>Apply the tag ABCD to this search</code> at the bottom of the page. Click on it: a tad depending on your search (here <code>ABCD</code>) will be assigned to all the articles found.</p>
193<h3 id="find-all-the-articles-with-a-given-tag">Find all the articles with a given tag</h3>
194<p>In the wallabag menu, click on <strong>Tags</strong>. Then, all the tags you have created are displayed, sorted by the number of articles for each tag. Click on one of these tags to find all the articles with this tag.</p>
195<h2 id="preferred-articles">Preferred articles</h2>
196<p>When you wish to set aside an article, you can mark it as preferred.</p>
197<h3 id="set-an-article-as-favorite">Set an article as favorite</h3>
198<p>From the reading page of an article, or from a list of articles (such as the list of unread articles), you can set an article as favorite simply by a click on the star which is displayed.
199Click again on the star will remove the <strong>favorite</strong> status of this article.</p>
200<h3 id="find-all-the-favorite-articles">Find all the favorite articles</h3>
201<p>In the wallabag menu, click on <strong>Favorites</strong> to display the list of all the articles that you have set as favorite.</p>
202<h2 id="archived-articles">Archived articles</h2>
203<p>When you have read an article, you can archive it: hence it will not be displayed in your list of unread articles.</p>
204<p>Archiving an article does not remove it from wallabag.</p>
205<h3 id="archive-an-article">Archive an article</h3>
206<p>From the reading page of an article, or from a list of articles (such as the list of unread articles), you can archive an article simply by clicking on the icon ✓.<br />
207Click again on this icon will set back the <strong>unread</strong> status of the article.</p>
208<h3 id="find-all-the-archived-articles">Find all the archived articles</h3>
209<p>In the wallabag menu, click on <strong>Archive</strong> to find all the articles that you have archived.</p>
210<h2 id="delete-an-article">Delete an article</h2>
211<p>Be cautious: the deletion of an article is <strong>definitive</strong>. It is deleted from the wallabag database.</p>
212<p>To delete an article, a trash icon is displayed on the page of an article or of a list of articles (unread articles, favorites or archived, for example).</p>
213<p>We trust you: that is why there is no confirmation message during the deletion.</p>
214 </section>
215
216 </div>
217 </main>
218
219 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
220 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
221 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
222
223 <script>
224 $(function() {
225 $("section>h1").wrap('<div class="page-header" />');
226 // Syntax highlighting
227 hljs.initHighlightingOnLoad();
228 });
229 </script>
230
231 </body>
232</html>
diff --git a/docs/en/User/read_an_article.html b/docs/en/User/read_an_article.html
new file mode 100644
index 00000000..ed06c785
--- /dev/null
+++ b/docs/en/User/read_an_article.html
@@ -0,0 +1,226 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Read an article</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Read an article
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test active">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="read-an-article">Read an article</h1>
181<p>To read an article is not the most complex thing in wallabag: you only have to click on the title of the article for it to be displayed.</p>
182<h2 id="back-to-where-you-quit-reading-your-article">Back to where you quit reading your article</h2>
183<p>If you quit reading an article while you are only at half of it (for example), when you will open it again, wallabag will display it at the place you left the article.</p>
184<p>This feature works only with web applications and not with smartphone applications.</p>
185<h2 id="possible-actions-in-an-article">Possible actions in an article</h2>
186<p>These actions are possible through the icons displayed at the top of the page. We suppose that you are using the theme Baggy (<a href="configure_wallabag.html">read the documentation about how to change theme</a>). Icons in other themes are very similar. </p>
187<p>Here are the actions, in the order of appearance of the icons.</p>
188<h3 id="read-the-original-article">Read the original article</h3>
189<p>Move to the original article.</p>
190<h3 id="mark-the-article-as-read">Mark the article as read</h3>
191<p>Archive the article, that will be put in the category <strong>Archive</strong> of the wallabag menu.
192Clicking again on this button will move the article back to the <strong>unread</strong> category.</p>
193<h3 id="mark-the-article-as-favorite">Mark the article as favorite</h3>
194<p>Mark the article as favorite, and it will be put to the category <strong>Favorites</strong> of the wallabag menu
195Clicking again on this button will remove the favorite status.</p>
196<h3 id="delete-the-article">Delete the article</h3>
197<p>Delete completely the article from wallabag. It cannot be restored. Be careful: no confirmation message is displayed.</p>
198<h3 id="share-through-twitter">Share through twitter</h3>
199<p>Share the title and the original link of the article through twitter.</p>
200<h3 id="share-via-email">Share via email</h3>
201<p>Share the title and the original link of the article via email.</p>
202<h3 id="print-the-article">Print the article</h3>
203<p>Open the print window of the browser.</p>
204<h3 id="convert-into-epub">Convert into ePub</h3>
205<p>Convert the article into ePub format. <a href="convert_into_epub.html">A full chapter about this here</a>.</p>
206<h3 id="notify-us-that-the-article-appears-wrong">Notify us that the article appears wrong</h3>
207<p>Allow to notify us that an article is not displayed as expected. <a href="issue_with_article.html">A full chapter about this here</a>.</p>
208 </section>
209
210 </div>
211 </main>
212
213 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
214 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
215 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
216
217 <script>
218 $(function() {
219 $("section>h1").wrap('<div class="page-header" />');
220 // Syntax highlighting
221 hljs.initHighlightingOnLoad();
222 });
223 </script>
224
225 </body>
226</html>
diff --git a/docs/en/User/rss_feed.html b/docs/en/User/rss_feed.html
new file mode 100644
index 00000000..6edd3d10
--- /dev/null
+++ b/docs/en/User/rss_feed.html
@@ -0,0 +1,221 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - RSS feed</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 RSS feed
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test active">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="rss-feed">RSS feed</h1>
181<p>The RSS feeds allow you to:</p>
182<ul>
183<li>read your articles from your favorite RSS feed reader.</li>
184<li>to activate the reading features for smartphone softwares</li>
185</ul>
186<p>First, you must activate the RSS feature by generating a feed token.<br />
187Go to <strong>config</strong> in wallabag and generate a token in the section <strong>Feeds</strong>.
188You can generate a new token at any time.</p>
189<h2 id="read-articles">Read articles</h2>
190<p>Once the token created, you have access to three RSS feeds:</p>
191<ul>
192<li>the one of the unread articles</li>
193<li>the one of the favorites articles</li>
194<li>the one of the archived articles</li>
195</ul>
196<p>Add the feed you want to your RSS feed reader.
197Be careful: when you will be reading an article from your feed reader, this will not set it as read in wallabag.</p>
198<h3 id="share-your-readings">Share your readings</h3>
199<p>If you wish to share your readings with somebody, send him for example the RSS feed of your favorite articles.
200Hence, as soon as an article will be set as favorite in wallabag, this person will be able to read it too.</p>
201<h2 id="activate-the-features-for-smartphones">Activate the features for smartphones</h2>
202<p>You ave created an RSS feed token. It will also be useful to you to configure your smartphone software. For more information about smartphone sofwares, you can read <a href="save_your_first_article.html">Save your first article</a>.</p>
203 </section>
204
205 </div>
206 </main>
207
208 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
209 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
210 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
211
212 <script>
213 $(function() {
214 $("section>h1").wrap('<div class="page-header" />');
215 // Syntax highlighting
216 hljs.initHighlightingOnLoad();
217 });
218 </script>
219
220 </body>
221</html>
diff --git a/docs/en/User/save_your_first_article.html b/docs/en/User/save_your_first_article.html
new file mode 100644
index 00000000..37b4ce7c
--- /dev/null
+++ b/docs/en/User/save_your_first_article.html
@@ -0,0 +1,250 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Save your first article</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Save your first article
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test active">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test ">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="save-your-first-article">Save your first article</h1>
181<p>Once connected on wallabag, you have many ways to save an article.</p>
182<h2 id="from-the-web-application">From the web application</h2>
183<p>Let's see first how to do from the web application. In the menu, you have a link <strong>save a link</strong>. Clicking on it, a form shows up: you simply have to type the web adress of the article you want to save.</p>
184<p>Confirm to store the content of the article.</p>
185<p>By default, only the text is saved. If you want to store a copy of the images on your server, you have to enable the setting <em>DOWNLOAD_PICTURES</em>. Read the chapter on hidden options for more information.</p>
186<h2 id="from-the-bookmarklet">From the bookmarklet</h2>
187<p>From <a href="http://fr.wikipedia.org/wiki/Bookmarklet">Wikipedia's definition</a></p>
188<blockquote>
189<p>A bookmarklet is a <a href="http://en.wikipedia.org/wiki/Internet_bookmark">bookmark</a> stored in a <a href="http://en.wikipedia.org/wiki/Web_browser">web browser</a> that contains <a href="http://en.wikipedia.org/wiki/JavaScript">JavaScript</a>commands to extend the browser's functionality.</p>
190<p>Bookmarklets are unobtrusive scripts stored as the URL of a bookmark in a web browser or as a hyperlink on a web page.</p>
191<p>When clicked, a bookmarklet performs some function, one of a wide variety such as a search query or data extraction. Bookmarklets are usually <a href="http://en.wikipedia.org/wiki/Computer_program">JavaScript programs</a>.</p>
192</blockquote>
193<p>From the wallabag's menu, click on <strong>settings</strong>. On the first part of this page, we have listed all the ways to save an article. You'll find the bookmarklet (it's the <code>Bag it!</code> link) to drag and drop in the bookmarks bar of your web browser.
194From now on, when you want to save the article you are browsing, you just have to click on this bookmarklet and the article will be automatically saved.</p>
195<h2 id="from-your-smartphone">From your smartphone</h2>
196<h3 id="above-all-else">Above all else</h3>
197<p>To use a smartphone application, you have to enable RSS feeds from the settings panel of wallabag. Then some information will be displayed, like your security tokken. Read the chapter on RSS feeds for more information.</p>
198<h3 id="android">Android</h3>
199<h4 id="installation-and-configuration">Installation and configuration</h4>
200<p>You can download the android application from the <a href="https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche">Google Play Store</a> and from <a href="https://f-droid.org/app/fr.gaulupeau.apps.InThePoche">F-droid</a>. It's the exact same application on those two stores.</p>
201<p>Once installed, start the application, go to the <strong>settings</strong> part et fill in the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> fields. If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the settings part of wallabag).</p>
202<h4 id="saving-of-an-article">Saving of an article</h4>
203<p>Now that everything is correctly set up, as soon as you browse on your smartphone's web browser, you can share an article in wallabag at any time from the <strong>Share</strong> menu: you'll find a <strong>Bag it!</strong> entry which will add your article in wallabag.</p>
204<h4 id="reading">Reading</h4>
205<p>When you open the application, click on Synchronize: your recently saved articles will be downloaded on your smartphone.</p>
206<p>You don't need an internet connection anymore: click on <strong>List articles</strong> to start your reading.</p>
207<p>At the end of each article, a <strong>Mark as read</strong> button allows you to archive the article.</p>
208<p>To date, the synchronisation occurs in one direction (from wallabag to the application), thus preventing mark as read an article on wallabag from your smartphone.</p>
209<h3 id="ios">iOS</h3>
210<h4 id="installation-and-configuration-1">Installation and configuration</h4>
211<p>You can download the iOS application from the <a href="https://itunes.apple.com/app/id828331015">AppStore</a>.</p>
212<p>Once installed, configure the app by filling following fields inside the settings: the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> field. If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the settings part of wallabag).</p>
213<h4 id="usage">Usage</h4>
214<p>If the app is configured correctly, the app will automatically download the articles from your wallabag (use <strong>pull-to-refresh</strong> to trigger this update manually). Once an article is downloaded, it'll be available offline from your app.</p>
215<p>Unfortunately you can only locally mark an article as read (it will not synchronise to your online wallabag).</p>
216<h3 id="saving-articles">Saving articles</h3>
217<p>If you're browsing a website and want to add the current article to your wallabag, simply tap the <strong>Share</strong>-button and select <strong>Bag it!</strong> (if you don't find the wallabag icon, have a look in the <strong>more</strong>-menu). If everything is set up correctly, your article will be saved (you may have to login from time to time).</p>
218<h3 id="windows-phone">Windows Phone</h3>
219<h4 id="installation-and-configuration-2">Installation and configuration</h4>
220<p>You can download the Windows Phone application from the <a href="http://www.windowsphone.com/fr-fr/store/app/wallabag/ff890514-348c-4d0b-9b43-153fff3f7450">Windows Store</a> or directly from your smartphone's Store.</p>
221<p>Once installed, the application will show you a notification on the first launch, asking the configuration of your wallabag server. Go to the <strong>Settings</strong> part of the application by pressing the three dots menu at the bottom of the screen, then fill in the <strong>URL (complete address of your wallabag installation or your Framabag account)</strong> and <strong>User ID (in most cases, you'll have to put 1)</strong> fields.</p>
222<p>If you have created multiple accounts from wallabag, you will have to to fill the user account you want to connect to your application and your security <strong>Token</strong> (enter properly all the token's letters as seen in the setting part of wallabag).</p>
223<h2 id="from-your-web-browser">From your web browser</h2>
224<h3 id="firefox">Firefox</h3>
225<p>Download the Firefox add-on on <a href="https://addons.mozilla.org/firefox/addon/wallabag/">addons.mozilla.org</a> and install it like any other Firefox add-on.</p>
226<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
227<p>Personalize the Firefox toolbar to add wallabag (<strong>W</strong> icon). When you find an article you want to save, click on this icon: a new window will open to add the article and will close itself automatically.</p>
228<h3 id="chrome">Chrome</h3>
229<p>Download the Chrome add-on <a href="https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj">on the dedicated website</a> and install it like any other Chrome add-on.</p>
230<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
231<p>During the addon's installation, a new icon appear in Chrome toolbar (a <strong>W</strong> icon). When you find an article you want to save, click on this icon: a popup will appear to confirm that your article has been saved.</p>
232 </section>
233
234 </div>
235 </main>
236
237 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
238 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
239 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
240
241 <script>
242 $(function() {
243 $("section>h1").wrap('<div class="page-header" />');
244 // Syntax highlighting
245 hljs.initHighlightingOnLoad();
246 });
247 </script>
248
249 </body>
250</html>
diff --git a/docs/en/User/search.html b/docs/en/User/search.html
new file mode 100644
index 00000000..f385960c
--- /dev/null
+++ b/docs/en/User/search.html
@@ -0,0 +1,200 @@
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1">
6
7 <title>wallabag - Search content</title>
8
9 <link rel="stylesheet" href="http://doc.wallabag.org/css/bootstrap.min.css">
10 <link rel="stylesheet" href="http://doc.wallabag.org/css/font-awesome.min.css">
11 <link rel="stylesheet" href="http://doc.wallabag.org/css/highlight.tomorrow-night.css">
12 <link rel="stylesheet" href="http://doc.wallabag.org/css/main.css">
13 </head>
14 <body>
15
16 <header class="navbar navbar-default navbar-fixed-top">
17
18 <a class="navbar-brand" href="http://doc.wallabag.org/">
19 wallabag
20 <small class="hidden-xs hidden-sm">
21 Search content
22 </small>
23 </a>
24 <a href="http://doc.wallabag.org/en">EN</a> - <a href="http://doc.wallabag.org/fr">FR</a> - <a href="http://doc.wallabag.org/de">DE</a> - <a href="http://doc.wallabag.org/ru">RU</a>
25
26
27 </header>
28
29 <main class="container-fluid">
30 <div class="row">
31
32
33 <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
34
35 <ul class="nav nav-pills nav-stacked">
36
37 <h4 class="text-muted">
38
39 </h4>
40
41 <ul class="nav nav-pills nav-stacked">
42 <li class="test ">
43 <a href="http://doc.wallabag.org/en/index.html">
44 Getting started
45 </a>
46 </li>
47 <li class="test ">
48 <a href="http://doc.wallabag.org/en/help_wallabag.html">
49 Help us
50 </a>
51 </li>
52 </ul>
53
54 <h4 class="text-muted">
55 Administrator
56 </h4>
57
58 <ul class="nav nav-pills nav-stacked">
59 <li class="test ">
60 <a href="http://doc.wallabag.org/en/Administrator/download_and_install.html">
61 Download and installation
62 </a>
63 </li>
64 <li class="test ">
65 <a href="http://doc.wallabag.org/en/Administrator/update.html">
66 Update wallabag
67 </a>
68 </li>
69 <li class="test ">
70 <a href="http://doc.wallabag.org/en/Administrator/hidden_options.html">
71 Hidden options
72 </a>
73 </li>
74 <li class="test ">
75 <a href="http://doc.wallabag.org/en/Administrator/multiusers.html">
76 Multi users
77 </a>
78 </li>
79 </ul>
80
81 <h4 class="text-muted">
82 User
83 </h4>
84
85 <ul class="nav nav-pills nav-stacked">
86 <li class="test ">
87 <a href="http://doc.wallabag.org/en/User/save_your_first_article.html">
88 Save your first article
89 </a>
90 </li>
91 <li class="test ">
92 <a href="http://doc.wallabag.org/en/User/read_an_article.html">
93 Read an article
94 </a>
95 </li>
96 <li class="test ">
97 <a href="http://doc.wallabag.org/en/User/organize_articles.html">
98 Organize articles
99 </a>
100 </li>
101 <li class="test ">
102 <a href="http://doc.wallabag.org/en/User/configure_wallabag.html">
103 Configure wallabag
104 </a>
105 </li>
106 <li class="test active">
107 <a href="http://doc.wallabag.org/en/User/search.html">
108 Search
109 </a>
110 </li>
111 <li class="test ">
112 <a href="http://doc.wallabag.org/en/User/epub_conversion.html">
113 ePub conversion
114 </a>
115 </li>
116 <li class="test ">
117 <a href="http://doc.wallabag.org/en/User/issue_with_article.html">
118 Issue with article
119 </a>
120 </li>
121 <li class="test ">
122 <a href="http://doc.wallabag.org/en/User/rss_feed.html">
123 RSS feed
124 </a>
125 </li>
126 <li class="test ">
127 <a href="http://doc.wallabag.org/en/User/import_export.html">
128 Import export
129 </a>
130 </li>
131 <li class="test ">
132 <a href="http://doc.wallabag.org/en/User/framabag_account_creation.html">
133 Framabag account creation
134 </a>
135 </li>
136 </ul>
137
138 <h4 class="text-muted">
139 Developer
140 </h4>
141
142 <ul class="nav nav-pills nav-stacked">
143 <li class="test ">
144 <a href="http://doc.wallabag.org/en/Developer/write_config_files.html">
145 Write config files
146 </a>
147 </li>
148 <li class="test ">
149 <a href="http://doc.wallabag.org/en/Developer/create_new_theme.html">
150 Create a new theme
151 </a>
152 </li>
153 <li class="test ">
154 <a href="http://doc.wallabag.org/en/Developer/git_repo.html">
155 Git repository
156 </a>
157 </li>
158 <li class="test ">
159 <a href="http://doc.wallabag.org/en/Developer/docker.html">
160 Docker
161 </a>
162 </li>
163 <li class="test ">
164 <a href="http://doc.wallabag.org/en/Developer/vagrant.html">
165 Vagrant
166 </a>
167 </li>
168 <li class="test ">
169 <a href="http://doc.wallabag.org/en/Developer/v2.html">
170 wallabag v2 / symfony2
171 </a>
172 </li>
173 </ul>
174 </ul>
175
176 </nav>
177
178
179 <section class="col-lg-10">
180 <h1 id="search-content">Search content</h1>
181<p>To be translated from <a href="../../fr/Utilisateur/rechercher.html">Rechercher du contenu dans wallabag</a>.</p>
182 </section>
183
184 </div>
185 </main>
186
187 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
188 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
189 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
190
191 <script>
192 $(function() {
193 $("section>h1").wrap('<div class="page-header" />');
194 // Syntax highlighting
195 hljs.initHighlightingOnLoad();
196 });
197 </script>
198
199 </body>
200</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 09:56:19 +0000