aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2015-08-03 13:21:11 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2015-08-03 13:21:11 +0200
commitc766284d522206578e7ec154961e0fce456f70c8 (patch)
treea5246151bf8278a0e8053b9dd1ce9d770073c50b /docs/en
parentc0cb52c07439c974075c302a190a034a8cce4f92 (diff)
parente968ec6c2244aee600358b3c87648b2409c97945 (diff)
downloadwallabag-c766284d522206578e7ec154961e0fce456f70c8.tar.gz
wallabag-c766284d522206578e7ec154961e0fce456f70c8.tar.zst
wallabag-c766284d522206578e7ec154961e0fce456f70c8.zip
Merge pull request #1267 from wallabag/dev1.9.1
1.9.1
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/Administrator/download_and_install.html261
-rw-r--r--docs/en/Administrator/hidden_options.html231
-rw-r--r--docs/en/Administrator/multiusers.html200
-rw-r--r--docs/en/Administrator/update.html210
-rw-r--r--docs/en/Developer/create_new_theme.html200
-rw-r--r--docs/en/Developer/docker.html200
-rw-r--r--docs/en/Developer/git_repo.html210
-rw-r--r--docs/en/Developer/v2.html200
-rw-r--r--docs/en/Developer/vagrant.html218
-rw-r--r--docs/en/Developer/write_config_files.html214
-rw-r--r--docs/en/Getting_started.html106
-rw-r--r--docs/en/Help_wallabag.html108
-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
-rw-r--r--docs/en/User_documentation/Configure_wallabag.html106
-rw-r--r--docs/en/User_documentation/Download_and_install.html121
-rw-r--r--docs/en/User_documentation/Hidden_options.html116
-rw-r--r--docs/en/User_documentation/Save_your_first_article.html138
-rw-r--r--docs/en/help_wallabag.html234
-rw-r--r--docs/en/index.html211
28 files changed, 4817 insertions, 695 deletions
diff --git a/docs/en/Administrator/download_and_install.html b/docs/en/Administrator/download_and_install.html
new file mode 100644
index 00000000..127739c1
--- /dev/null
+++ b/docs/en/Administrator/download_and_install.html
@@ -0,0 +1,261 @@
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 - Download and install 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 Download and install 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 active">
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 ">
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="download-and-install-wallabag">Download and install wallabag</h1>
181<h2 id="i-dont-want-to-install-wallabag">I don't want to install wallabag</h2>
182<p>If you can't or don't want to install Wallabag on your server, we suggest you create a free account on <a href="https://framabag.org/">Framabag</a> wich uses our software: read the complete documentation here (TODO write Create a framabag account).</p>
183<h2 id="i-want-to-install-wallabag">I want to install wallabag</h2>
184<h3 id="i-want-to-download-wallabag-the-easiest-way-possible">I want to download wallabag the easiest way possible</h3>
185<p><a href="http://wllbg.org/latest">Download the latest wallabag version</a> and unpack it. Copy the files on your web server. Jump off to next section.</p>
186<h3 id="i-want-to-download-wallabag-via-composer">I want to download wallabag via composer</h3>
187<p>You need to install composer: </p>
188<pre><code>curl -s http://getcomposer.org/installer | php</code></pre>
189<p>Next, on your web server, run this command: </p>
190<pre><code>composer create-project wallabag/wallabag . dev-master</code></pre>
191<p>All is downloaded into <code>wallabag</code> folder.</p>
192<h3 id="permissions">Permissions</h3>
193<p>Your web server needs a writing access to the <code>assets</code>, <code>cache</code> and <code>db</code> directories. Otherwise, a message will report that the installation is impossible.</p>
194<h3 id="installation-of-wallabag-at-last">Installation of wallabag. At last.</h3>
195<p>Access to wallabag from your web browser. If your server is correctly configured, you directly reach the setup screen. </p>
196<h4 id="prerequisites">Prerequisites</h4>
197<p>The installer will tell you which prerequisites are missing. If there's any, jump off to the <a href="#Prerequisites">corresponding session</a> to know how to deal with that problem.</p>
198<h4 id="twig-installation">Twig installation</h4>
199<p>wallabag is build with Twig, a template library. You have to download it for wallabag to work.</p>
200<ul>
201<li>One option is to choose the automatic download of the package which will be automatically downloaded and installed.</li>
202<li>If this option fails, you can choose the second option which is to manually download <a href="http://wllbg.org/vendor">the vendor package</a>, unzip it and copy the vendor directory in your wallabag directory</li>
203<li>
204<p>Finally, you can here also use Composer to install Twig by following the commands written on screen :</p>
205<pre><code>curl -s http://getcomposer.org/installer | php
206php composer.phar install</code></pre>
207</li>
208</ul>
209<h4 id="database-connection">Database connection</h4>
210<p>You have to choose a database system between:</p>
211<ul>
212<li><strong>SQLite</strong>: The easiest system of all. No extra configuration needed.</li>
213<li><strong>MySQL</strong>: A well known database system, which is in most cases more efficient than SQLite</li>
214<li><strong>Postgresql</strong>: Some people found it better than MySQL.</li>
215</ul>
216<p><em>Note :</em> If you're using MySQL or Postgresql, you have to <strong>fill all the fields</strong>, otherwise the installation will not work and an error message will tell you what's wrong. You must create the database that you will use for wallabag manually with a tool like PHPMyAdmin or the console.</p>
217<h4 id="user-account">User Account</h4>
218<p>Finally, you need to create an user account. As always, be sure to choose a strong password.
219An email field is present but it is not at all required.</p>
220<p>If you get a green success message, it means wallabag is now installed.</p>
221<h3><a name="Prerequisites"></a>Prerequisites</h3>
222<h4 id="list-of-prerequisites-for-your-web-server">List of prerequisites for your web server</h4>
223<ul>
224<li><a href="http://php.net/manual/en/install.php">PHP 5.3.3 or more</a> <strong>with <a href="http://php.net/manual/en/book.pdo.php">PDO</a> support</strong></li>
225<li><a href="http://php.net/manual/en/book.sqlite.php">SQLite</a> <strong>or</strong> <a href="http://php.net/manual/en/book.mysql.php">MySQL</a> <strong>or</strong> <a href="http://php.net/manual/en/book.pgsql.php">PostgreSQL</a></li>
226<li><a href="http://php.net/en/xml">XML for PHP</a></li>
227<li><a href="http://php.net/en/pcre">PCRE</a></li>
228<li><a href="http://php.net/en/zlib">ZLib</a></li>
229<li><a href="http://php.net/en/mbstring">mbstring</a> and/or <a href="http://php.net/en/iconv">iconv</a></li>
230<li>The <a href="http://php.net/manual/en/book.dom.php">DOM/XML</a> extension</li>
231<li><a href="http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen">allow_url_fopen</a></li>
232<li><a href="http://php.net/manual/en/book.gettext.php">gettext</a></li>
233</ul>
234<p>Optionnal:</p>
235<ul>
236<li><a href="http://php.net/en/curl">cURL</a> (with Parallel URL fetching) or <a href="http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen">allow_url_fopen</a></li>
237<li><a href="http://php.net/manual/en/book.image.php">GD</a></li>
238<li><a href="http://php.net/manual/en/book.filter.php">Data filtering</a></li>
239</ul>
240<h2 id="login">Login</h2>
241<p>From your web browser, you reach the login screen: fill your username and your password to connect to your account.</p>
242<p>Enjoy!</p>
243 </section>
244
245 </div>
246 </main>
247
248 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
249 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
250 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
251
252 <script>
253 $(function() {
254 $("section>h1").wrap('<div class="page-header" />');
255 // Syntax highlighting
256 hljs.initHighlightingOnLoad();
257 });
258 </script>
259
260 </body>
261</html>
diff --git a/docs/en/Administrator/hidden_options.html b/docs/en/Administrator/hidden_options.html
new file mode 100644
index 00000000..f9e18332
--- /dev/null
+++ b/docs/en/Administrator/hidden_options.html
@@ -0,0 +1,231 @@
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 - Hidden options</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 Hidden options
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 active">
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 ">
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="hidden-options">Hidden options</h1>
181<h2 id="caution">Caution</h2>
182<p><strong>Be careful</strong>, this section is destined to advanced users. We are going to modify an important wallabag configuration file, <code>inc/poche/config.inc.php</code>. It is therefore advised to do a backup of this file before you proceed.
183<strong>Any error occuring during the modification of a wallabag file could lead to malfunctions</strong>.</p>
184<p>This file is created when you install wallabag.
185Install wallabag, do a backup copy of the file, then open it in your favorite text editor.</p>
186<p>In this file, there are some options that are not, as of now, available in the <strong>config</strong> page of wallabag.</p>
187<h2 id="modification-of-advanced-options">Modification of advanced options</h2>
188<p>Each option is defined this way:</p>
189<pre><code>@define ('OPTION_NAME', 'Value');</code></pre>
190<p>For each line, you can only modify the <code>Value</code> field.</p>
191<p>Here is the list of each option you can change:</p>
192<ul>
193<li><code>HTTP_PORT</code> (default: <code>80</code>) : the HTTP port of your web server. You may need to change it if your server is behind a proxy. Accepted values: number</li>
194<li><code>SSL_PORT</code> (default: <code>443</code>) : the HTTP port of your web server. You may need to change it if your server use SSLH. Accepted values: number</li>
195<li><code>MODE_DEMO</code> (default : <code>FALSE)</code>: If you ever wanted to set up a demonstration server... Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
196<li><code>DEBUG_POCHE</code> (default: <code>FALSE</code>) : if you encounter some problems with wallabag, we may ask you to active Debug mode. Accepted values: <code>TRUE</code> or <code>FALSE</code>. Check the logs in cache/log.txt after activating that.</li>
197<li><code>ERROR_REPORTING</code> (default : <code>E_ALL &amp; ~E_NOTICE</code>) : Set to <code>E_ALL</code> if needed to look for eventual PHP errors.</li>
198<li><code>DOWNLOAD_PICTURES</code> (default: <code>FALSE</code>) : Allows wallabag to fetch images from the articles you save on your server, instead of fetching only the text. We prefer to let you activate this option yourself. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
199<li><code>REGENERATE_PICTURES_QUALITY</code> (default : <code>75</code>) : In order to avoid security problems, pictures are regenerated if you activate the download of pictures. This is the percentage of quality at which they are saved. Increase that numbler if you want better quality, lower if you need better performances.</li>
200<li><code>SHARE_TWITTER</code> (default: <code>TRUE</code>) : enables Twitter sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
201<li><code>SHARE_MAIL</code> (default: <code>TRUE</code>) : enables mail sharing. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
202<li><code>SHARE_EVERNOTE</code>(default : <code>FALSE</code>) : enables sharing with your Evernote account. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
203<li><code>SHARE_DIASPORA</code> (default : <code>FALSE</code>) : enables to share an article on your Diaspora account.</li>
204<li><code>DIASPORA_URL</code> (default : <code>http://diasporapod.com</code>) : The URL of your Diaspora* pod</li>
205<li><code>CARROT</code> (default : <code>FALSE</code>) : Like Flattr, it's a service to give small amounts of money to a web page. See <a href="http://carrot.org/">http://carrot.org/</a></li>
206<li><code>SHARE_SHAARLI</code> (default: <code>FALSE</code>) : enables sharing via your Shaarli installation (Shaarli is an open-source bookmark manager). Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
207<li><code>SHAARLI_URL</code> (default: <code>'http://myshaarliurl.com'</code>) : defines your Shaarli installation URL. Accepted values: an URL.</li>
208<li><code>FLATTR</code> (default: <code>TRUE</code>) : enables the possibility to Flattr an article (<a href="http://en.wikipedia.org/wiki/Flattr">Flattr is a microdonation platform</a>). If an article is Flattr-able, an icon will be displayed, allowing you to send a microdonation to the author. Accepted values: <code>TRUE</code> or <code>FALSE</code>.</li>
209<li><code>SHOW_PRINTLINK</code> (default: <code>'1'</code>) : enables the Print button for articles. Accepted values: <code>'1'</code> to enable or <code>'0'</code> to disable.</li>
210<li><code>SHOW_READPERCENT</code> (default: <code>'1'</code>) : enables the reading progress on articles (working on the <code>default</code>, <code>dark</code>, <code>dmagenta</code>, <code>solarized</code>, <code>solarized-dark</code> themes). Accepted values: <code>'1'</code> to enable or <code>'0'</code> to disable.</li>
211<li><code>PAGINATION</code> (default: <code>'12'</code>) : defines the number of articles that are displayed on a list. Accepted values: number.</li>
212</ul>
213 </section>
214
215 </div>
216 </main>
217
218 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
219 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
220 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
221
222 <script>
223 $(function() {
224 $("section>h1").wrap('<div class="page-header" />');
225 // Syntax highlighting
226 hljs.initHighlightingOnLoad();
227 });
228 </script>
229
230 </body>
231</html>
diff --git a/docs/en/Administrator/multiusers.html b/docs/en/Administrator/multiusers.html
new file mode 100644
index 00000000..de673851
--- /dev/null
+++ b/docs/en/Administrator/multiusers.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 - Multi users</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 Multi users
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 active">
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 ">
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="multi-users">Multi users</h1>
181<p>To be translated from <a href="../../fr/Administrateur/multi-utilisateurs.html">Multi-utilisateurs</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>
diff --git a/docs/en/Administrator/update.html b/docs/en/Administrator/update.html
new file mode 100644
index 00000000..af278286
--- /dev/null
+++ b/docs/en/Administrator/update.html
@@ -0,0 +1,210 @@
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 - Update 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 Update 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 active">
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 ">
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="update-wallabag">Update wallabag</h1>
181<h2 id="update-an-existing-wallabag-installation">Update an existing wallabag installation</h2>
182<p>In order to update your installation, download and unzip the archive into your installation folder. For example on Ubuntu/Debian:</p>
183<pre><code>wget http://wllbg.org/latest
184unzip latest
185rsync -ur wallabag-version-number/* /var/www/html/wallabag/ # could be another location such as /srv/html, /usr/share/nginx/html</code></pre>
186<p>After that, just access wallabag in your browser and follow the instructions to finish the update.</p>
187<p>You can verify at the bottom of the configuration page that you're running the last version.</p>
188<p><strong>If it fails</strong>, just delete the <code>install</code> folder and clear the cache:</p>
189<pre><code>cd /var/www/html/wallabag/
190rm -r cache/* install/</code></pre>
191<p>Clearing the cache is also possible in the configuration page, clicking on the link `Delete Cache.</p>
192 </section>
193
194 </div>
195 </main>
196
197 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
198 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
199 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
200
201 <script>
202 $(function() {
203 $("section>h1").wrap('<div class="page-header" />');
204 // Syntax highlighting
205 hljs.initHighlightingOnLoad();
206 });
207 </script>
208
209 </body>
210</html>
diff --git a/docs/en/Developer/create_new_theme.html b/docs/en/Developer/create_new_theme.html
new file mode 100644
index 00000000..f1143b2a
--- /dev/null
+++ b/docs/en/Developer/create_new_theme.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 - Create new theme</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 Create new theme
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 ">
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 active">
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="create-new-theme">Create new theme</h1>
181<p>TODO</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>
diff --git a/docs/en/Developer/docker.html b/docs/en/Developer/docker.html
new file mode 100644
index 00000000..84b0428c
--- /dev/null
+++ b/docs/en/Developer/docker.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 - Docker</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 Docker
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 ">
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 active">
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="docker">Docker</h1>
181<p>TODO</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>
diff --git a/docs/en/Developer/git_repo.html b/docs/en/Developer/git_repo.html
new file mode 100644
index 00000000..19b6d378
--- /dev/null
+++ b/docs/en/Developer/git_repo.html
@@ -0,0 +1,210 @@
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 - git repository</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 git repository
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 ">
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 active">
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="git-repository">git repository</h1>
181<p>If you wish to contribute to the project by suggesting new features or by fixing some bugs, please follow the recommendations below regarding the git repository available at <a href="https://github.com/wallabag/wallabag"><a href="https://github.com/wallabag/wallabag">https://github.com/wallabag/wallabag</a></a>.</p>
182<h2 id="current-state">Current state</h2>
183<p>To manage the different versions of wallabag, we use Git.</p>
184<p>There are multiple branches for the source code of wallabag web app:</p>
185<ul>
186<li><code>master</code> branch : this is the stable branch, downloaded by those who wish to install wallabag for their own use.</li>
187<li><code>dev</code> branch : before being added on <code>master</code> branch, all bug fixes and new features must go on that branch. This branch is not recommended for production use.</li>
188<li><code>v2-symfony</code> branch : this is the branch for a revamp of wallabag. A whole chapter is to be focused on it.</li>
189</ul>
190<h2 id="workflow">Workflow</h2>
191<p>All the rules for contributing to the git repository are in the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">CONTRIBUTING.md file of wallabag</a>. Please read carefully this file before you make any change.</p>
192 </section>
193
194 </div>
195 </main>
196
197 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
198 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
199 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
200
201 <script>
202 $(function() {
203 $("section>h1").wrap('<div class="page-header" />');
204 // Syntax highlighting
205 hljs.initHighlightingOnLoad();
206 });
207 </script>
208
209 </body>
210</html>
diff --git a/docs/en/Developer/v2.html b/docs/en/Developer/v2.html
new file mode 100644
index 00000000..d4c9a538
--- /dev/null
+++ b/docs/en/Developer/v2.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 - wallabag v2 / symfony2</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 wallabag v2 / symfony2
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 ">
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 active">
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="wallabag-v2--symfony2">wallabag v2 / symfony2</h1>
181<p>TODO</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>
diff --git a/docs/en/Developer/vagrant.html b/docs/en/Developer/vagrant.html
new file mode 100644
index 00000000..423f332a
--- /dev/null
+++ b/docs/en/Developer/vagrant.html
@@ -0,0 +1,218 @@
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 - Vagrant</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 Vagrant
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 ">
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 active">
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="vagrant">Vagrant</h1>
181<p>In order to allow you to easily set up the required configuration for wallabag, we offer you a Vagrantfile file to be used with <a href="http://www.vagrantup.com">Vagrant</a>.</p>
182<p><a href="https://en.wikipedia.org/wiki/Vagrant_%28software%29">According to Wikipedia,</a></p>
183<pre><code>Vagrant is computer software for creating and configuring virtual development environments. It can be seen as a wrapper around virtualization software such as VirtualBox, KVM, VMware and around configuration management software such as Ansible, Chef, Salt or Puppet.</code></pre>
184<h2 id="use-vagrant-for-wallabag">Use Vagrant for wallabag</h2>
185<p>Here is the procedure to run wallabag inside a Vagrant container:</p>
186<pre><code>wget -O wallabag-dev.zip https://github.com/wallabag/wallabag/archive/dev.zip
187unzip wallabag-dev.zip
188cd wallabag-dev
189vagrant up</code></pre>
190<p>Now, go to <code>http://localhost:8003</code>, wallabag should be available there! (make sure you do not use the port 8003 of your machine for something else before)</p>
191<h2 id="what-did-the-vagrantfile-install-">What did the Vagrantfile install ?</h2>
192<p>The script install a LAMP server, i.e. :</p>
193<ul>
194<li>Ubuntu 14.04</li>
195<li>an Apache2 web server</li>
196<li>PHP5</li>
197<li>SQLite or MySQL or PostgreSQL for PHP</li>
198<li>XDebug for PHP</li>
199</ul>
200 </section>
201
202 </div>
203 </main>
204
205 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
206 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
207 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
208
209 <script>
210 $(function() {
211 $("section>h1").wrap('<div class="page-header" />');
212 // Syntax highlighting
213 hljs.initHighlightingOnLoad();
214 });
215 </script>
216
217 </body>
218</html>
diff --git a/docs/en/Developer/write_config_files.html b/docs/en/Developer/write_config_files.html
new file mode 100644
index 00000000..17eae753
--- /dev/null
+++ b/docs/en/Developer/write_config_files.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 - Write config files</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 Write config files
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 ">
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 active">
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="write-config-files">Write config files</h1>
181<p>wallabag can use specific site config files to parse website articles. These files are stored in the <a href="https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard"><code>inc/3rdparty/site_config/standard</code></a> folder.</p>
182<p>The format used for these files is <a href="http://www.w3.org/TR/xpath20/">XPath</a>. Look at some examples in the folder.</p>
183<h2 id="automatic-config-files-generation">Automatic config files generation</h2>
184<p>Fivefilters has created a <a href="http://siteconfig.fivefilters.org/">very useful tool</a> to create config files. You just type in the adress of the article to work on with, and you select the area containing the content you want.</p>
185<p><img src="https://lut.im/RNaO7gGe/l9vRnO1b" alt="siteconfig" /></p>
186<p>You should confirm this area by trying with other articles.<br />
187When you got the right area, just click on <em>Download Full-Text RSS site config</em> to download your file.</p>
188<h2 id="manual-config-file-generation">Manual config file generation</h2>
189<p>If Fivefilters tool doesn't work correctly, take a look at the source (Ctrl + U on Firefox and Chromium). Search for your content and get the <code>class</code> or the <code>id</code> attribute of the area containing what you want.</p>
190<p>Once you've got the id or class, you can write for example one or another of these lines:</p>
191<pre><code>body: //div[@class='myclass']
192body: //div[@id='myid']</code></pre>
193<p>Then, test you file. If you got the right content but you want to strip unnecessary parts, do:</p>
194<pre><code>strip: //div[@class='hidden']</code></pre>
195<p>You can look at other options for siteconfig files <a href="http://help.fivefilters.org/customer/portal/articles/223153-site-patterns">here</a>.</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/Getting_started.html b/docs/en/Getting_started.html
deleted file mode 100644
index 269bbcd9..00000000
--- a/docs/en/Getting_started.html
+++ /dev/null
@@ -1,106 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Getting started</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li class="active"><a href="../en/Getting_started.html">Getting started</a></li><li><a href="../en/Help_wallabag.html">Help wallabag</a></li><li><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Getting started <a href="https://github.com/wallabag/documentation/blob/master/en/00_Getting_started.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Friday, October 31, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 8:34 PM </span>
59 </div>
60
61 <p><strong>wallabag</strong> is a read-it-later application: it saves a web page by keeping content only. Elements like navigation or ads are deleted.</p>
62<h2>Features</h2>
63<ul>
64<li>content of the web page is saved: text and pictures. </li>
65<li>the web application is responsive</li>
66<li>you can export articles into ePub</li>
67<li>you can read your articles offline thanks to smartphones applications</li>
68<li>you can easily save a new link thanks to browser addons</li>
69<li>many templates are available to change your wallabag as you wish</li>
70<li>and many others great features ! </li>
71</ul>
72<p>This user documentation is here to learn to you what you can do with wallabag.</p>
73<h2>Demonstration</h2>
74<p>If you want to try all wallabag features, there is a demonstration website: <a href="http://demo.wallabag.org"><a href="http://demo.wallabag.org">http://demo.wallabag.org</a></a></p>
75<h2>Create an account</h2>
76<p>Maybe you don't want to install and update wallabag by yourself, or you can't do it, it's possible to create a free account on <a href="https://www.framabag.org">Framabag.org</a>. Just your email is needed.</p>
77 </article>
78 </div>
79 </div>
80 </div>
81 </div>
82
83
84
85 <!-- jQuery -->
86 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
87 <script>
88 if (typeof jQuery == 'undefined')
89 document.write(unescape("%3Cscript src='../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
90 </script>
91
92 <!-- hightlight.js -->
93 <script src="../js/highlight.min.js"></script>
94 <script>hljs.initHighlightingOnLoad();</script>
95
96 <!-- JS -->
97
98 <!-- Front end file editor -->
99 <script src="../js/custom.js"></script>
100 <!--[if lt IE 9]>
101 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
102 <![endif]-->
103
104</body>
105</html>
106
diff --git a/docs/en/Help_wallabag.html b/docs/en/Help_wallabag.html
deleted file mode 100644
index 5ec6f458..00000000
--- a/docs/en/Help_wallabag.html
+++ /dev/null
@@ -1,108 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Help wallabag</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li><a href="../en/Getting_started.html">Getting started</a></li><li class="active"><a href="../en/Help_wallabag.html">Help wallabag</a></li><li><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Help wallabag <a href="https://github.com/wallabag/documentation/blob/master/en/01_Help_wallabag.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Tuesday, November 4, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 8:52 PM </span>
59 </div>
60
61 <h2>Report bugs</h2>
62<h3>Contact wallabag support</h3>
63<p>TODO</p>
64<h3>Create a new issue</h3>
65<p>TODO</p>
66<h2>Write and fix documentation</h2>
67<p>TODO</p>
68<h2>Fix bugs</h2>
69<p>TODO</p>
70<h2>Spread the word</h2>
71<p>It's not so complicated: just talk about wallabag! Use #wallabag hashtag on all your social networks: twitter, Facebook, Diaspora*, Google+, etc. </p>
72<p>Here are our accounts on social networks: </p>
73<ul>
74<li><a href="https://framasphere.org/people/2335ff202f920132196e2a0000053625">Diaspora*</a></li>
75<li><a href="https:/twitter.com/wallabagapp">twitter</a></li>
76<li><a href="https://www.facebook.com/wallabag">Facebook</a></li>
77<li><a href="https://plus.google.com/+WallabagOrg/">Google+</a></li>
78</ul>
79 </article>
80 </div>
81 </div>
82 </div>
83 </div>
84
85
86
87 <!-- jQuery -->
88 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
89 <script>
90 if (typeof jQuery == 'undefined')
91 document.write(unescape("%3Cscript src='../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
92 </script>
93
94 <!-- hightlight.js -->
95 <script src="../js/highlight.min.js"></script>
96 <script>hljs.initHighlightingOnLoad();</script>
97
98 <!-- JS -->
99
100 <!-- Front end file editor -->
101 <script src="../js/custom.js"></script>
102 <!--[if lt IE 9]>
103 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
104 <![endif]-->
105
106</body>
107</html>
108
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>
diff --git a/docs/en/User_documentation/Configure_wallabag.html b/docs/en/User_documentation/Configure_wallabag.html
deleted file mode 100644
index af73636d..00000000
--- a/docs/en/User_documentation/Configure_wallabag.html
+++ /dev/null
@@ -1,106 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Configure wallabag</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li class="active"><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Configure wallabag <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/06_Configure_wallabag.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 9:22 PM </span>
59 </div>
60
61 <h1>Configure wallabag</h1>
62<p>From the configuration menu, you can change some wallabag's options. </p>
63<p>Some parts won't be presented here as they have a complete chapter in the documentation (RSS
64feeds, import from a third party service, export your data, Epub conversion and multi-user mode).</p>
65<h2>Theme</h2>
66<p>Of tastes and colors, we do not discuss. That's why wallabag offers you to change its skin to please everyone.</p>
67<p>Select the theme of your choice from the drop down list and confirm by clicking on <strong>Update</strong>.</p>
68<h2>Language</h2>
69<p>Select the language of your choice in the drop down list and confirm by clicking on <strong>Update</strong>
70.</p>
71<h2>Password</h2>
72<p>Fill in your new password in the two dedicated fields and confirm by clicking on <strong>Update</strong>.</p>
73<p>You will be disconnected and need to enter your new password to access your wallabag.</p>
74<h2>Clear the cache</h2>
75<p>The cache allows wallabag perform certain functions faster.</p>
76<p>After updating wallabag, it is advised to clear the cache. You only have to click to do so.</p>
77 </article>
78 </div>
79 </div>
80 </div>
81 </div>
82
83
84
85 <!-- jQuery -->
86 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
87 <script>
88 if (typeof jQuery == 'undefined')
89 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
90 </script>
91
92 <!-- hightlight.js -->
93 <script src="../../js/highlight.min.js"></script>
94 <script>hljs.initHighlightingOnLoad();</script>
95
96 <!-- JS -->
97
98 <!-- Front end file editor -->
99 <script src="../../js/custom.js"></script>
100 <!--[if lt IE 9]>
101 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
102 <![endif]-->
103
104</body>
105</html>
106
diff --git a/docs/en/User_documentation/Download_and_install.html b/docs/en/User_documentation/Download_and_install.html
deleted file mode 100644
index 5ee9221f..00000000
--- a/docs/en/User_documentation/Download_and_install.html
+++ /dev/null
@@ -1,121 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Download and install</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li class="active"><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Download and install <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/02_Download_and_install.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 9:22 PM </span>
59 </div>
60
61 <h2>I don't want to install wallabag</h2>
62<p>If you can't or don't want to install Wallabag on your server, we suggest you create a free account on Framabag wich uses our software: read the complete documentation here (TODO write Create a framabag account).</p>
63<h2>I want to install wallabag</h2>
64<p><a href="http://www.wallabag.org/download">Download the latest wallabag version</a> and unpack it. Copy the files on your web server.</p>
65<h2>Prerequisites for your web server</h2>
66<ul>
67<li><a href="http://php.net/manual/en/install.php">PHP 5.3.3 or more</a></li>
68<li><a href="http://php.net/manual/en/book.sqlite.php">SQLite</a> or <a href="http://php.net/manual/fr/book.mysql.php">MySQL</a> or <a href="http://php.net/manual/en/book.pgsql.php">PostgreSQL</a></li>
69<li><a href="http://php.net/xml">XML for PHP</a></li>
70<li><a href="http://php.net/pcre">PCRE</a></li>
71<li><a href="http://php.net/manual/book.filter.php">Data filtering</a></li>
72<li><a href="http://php.net/tidy">Tidy for PHP</a></li>
73<li><a href="http://php.net/curl">cURL</a></li>
74<li><a href="http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen">allow_url_fopen</a></li>
75<li><a href="http://php.net/manual/en/book.gettext.php">gettext</a></li>
76</ul>
77<p>To ensure that your server has all the prerequisites, you can run the file <code>wallabag_compatibility_test.php</code> that is located in the <code>install</code> directory of wallabag.</p>
78<h2>Installation of the dependencies</h2>
79<p>In order to work properly, wallabag needs some dependencies. To install them, you have to use <code>composer</code>. In your wallabag folder, run the following commands:</p>
80<pre><code>curl -s http://getcomposer.org/installer | php
81php composer.phar install</code></pre>
82<p>If you can't install <code>composer</code> (In order to work properly, Wallabag needs some dependencies), we provide you a <a href="http://wllbg.org/vendor">vendor.zip</a> file to unpack in your wallabag directory. </p>
83<h2>Permissions</h2>
84<p>Your web server needs a writing access in <code>assets</code>, <code>cache</code> and <code>db</code> directory. Otherwise, a message will report that the installation is impossible.</p>
85<h2>Installation of wallabag. At last.</h2>
86<p>Access to wallabag from your web browser. If your server is correctly configured, you reach the setup screen. </p>
87<p>Fill your database type (<code>sqlite</code>, <code>mysql</code> or <code>postgresql</code>) and finally the information for your user account.</p>
88<p>wallabag is now installed. </p>
89<h2>Login</h2>
90<p>From your web browser, you reach the login screen : fill your username and your password to connect to your account.</p>
91<p>Enjoy!</p>
92 </article>
93 </div>
94 </div>
95 </div>
96 </div>
97
98
99
100 <!-- jQuery -->
101 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
102 <script>
103 if (typeof jQuery == 'undefined')
104 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
105 </script>
106
107 <!-- hightlight.js -->
108 <script src="../../js/highlight.min.js"></script>
109 <script>hljs.initHighlightingOnLoad();</script>
110
111 <!-- JS -->
112
113 <!-- Front end file editor -->
114 <script src="../../js/custom.js"></script>
115 <!--[if lt IE 9]>
116 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
117 <![endif]-->
118
119</body>
120</html>
121
diff --git a/docs/en/User_documentation/Hidden_options.html b/docs/en/User_documentation/Hidden_options.html
deleted file mode 100644
index 83c9668b..00000000
--- a/docs/en/User_documentation/Hidden_options.html
+++ /dev/null
@@ -1,116 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Hidden options</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li class="active"><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Hidden options <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/14_Hidden_options.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 9:22 PM </span>
59 </div>
60
61 <h2>Be careful</h2>
62<p><strong>Attention</strong>, this part is for advanced users only. We'll edit an important file of wallabag, <code>inc/poche/config.inc.php</code>, please make a backup of this file before changes.<br />
63<strong>If you make a mistake while editing a wallabag file, your application may be broken.</strong></p>
64<p>This file is created when wallabag is installed.<br />
65Please first install wallabag, make a backup of this file and open it with <del>Sublime Text</del> your favorite editor.</p>
66<p>In this file are defined some parameters that you can't change on the wallabag <strong>configuration</strong> page. </p>
67<h2>Advanced options</h2>
68<p>Each parameter is defined like this:</p>
69<pre><code>@define ('PARAMETER_NAME', 'Parameter value');</code></pre>
70<p>For each line, you can only change <code>Parameter value</code> part. </p>
71<p>TODO explain all the following parameters</p>
72<p>Here are all the parameters you can change: </p>
73<ul>
74<li><code>HTTP_PORT</code> (default value is <code>80</code>): Expected value: a digit.</li>
75<li><code>SSL_PORT</code> (default value is <code>443</code>): Expected value: a digit. </li>
76<li><code>DEBUG_POCHE</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
77<li><code>DOWNLOAD_PICTURES</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
78<li><code>SHARE_TWITTER</code> (default value is <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
79<li><code>SHARE_MAIL</code> (par défaut, <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
80<li><code>SHARE_SHAARLI</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
81<li><code>SHAARLI_URL</code> (default value is <code>'http://myshaarliurl.com'</code>): Expected value: your Shaarli URL. </li>
82<li><code>FLATTR</code> (default value is <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
83<li><code>SHOW_PRINTLINK</code> (default value is <code>'1'</code>): Expected values: <code>'0'</code> to disable, <code>'1'</code> to enable.</li>
84<li><code>SHOW_READPERCENT</code> (default value is <code>'1'</code>): <code>'0'</code> to disable, <code>'1'</code> to enable.</li>
85<li><code>PAGINATION</code> (default value is <code>'12'</code>): Expected value: a digit. </li>
86</ul>
87 </article>
88 </div>
89 </div>
90 </div>
91 </div>
92
93
94
95 <!-- jQuery -->
96 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
97 <script>
98 if (typeof jQuery == 'undefined')
99 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
100 </script>
101
102 <!-- hightlight.js -->
103 <script src="../../js/highlight.min.js"></script>
104 <script>hljs.initHighlightingOnLoad();</script>
105
106 <!-- JS -->
107
108 <!-- Front end file editor -->
109 <script src="../../js/custom.js"></script>
110 <!--[if lt IE 9]>
111 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
112 <![endif]-->
113
114</body>
115</html>
116
diff --git a/docs/en/User_documentation/Save_your_first_article.html b/docs/en/User_documentation/Save_your_first_article.html
deleted file mode 100644
index 180691c5..00000000
--- a/docs/en/User_documentation/Save_your_first_article.html
+++ /dev/null
@@ -1,138 +0,0 @@
1<!DOCTYPE html>
2<!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
3<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
4<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head>
7 <title>Save your first article</title>
8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas LÅ“uillet">
11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
12 <!-- Mobile -->
13 <meta name="apple-mobile-web-app-capable" content="yes" />
14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
16 <!-- Font -->
17
18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head>
21<body>
22 <!-- Docs -->
23 <div class="container-fluid fluid-height wrapper">
24 <div class="navbar navbar-fixed-top hidden-print">
25 <div class="container-fluid">
26 <a class="brand navbar-brand pull-left" href="../../index.html">wallabag</a>
27 <p class="navbar-text pull-right">Generated by <a href="http://daux.io">Daux.io</a></p>
28 </div>
29 </div>
30 <div class="row columns content">
31 <div class="left-column article-tree col-sm-3 hidden-print">
32 <!-- For Mobile -->
33 <div class="responsive-collapse">
34 <button type="button" class="btn btn-sidebar" id="menu-spinner-button">
35 <span class="icon-bar"></span>
36 <span class="icon-bar"></span>
37 <span class="icon-bar"></span>
38 </button>
39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation -->
42 <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li class="active"><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul> <div class="well well-sidebar">
43
44 <!-- Links -->
45 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>
46 <!-- Twitter -->
47 </div>
48 </div>
49 </div>
50 <div class="right-column content-area col-sm-9">
51 <div class="content-page">
52 <article>
53 <div class="page-header sub-header clearfix">
54 <h1>Save your first article <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/03_Save_your_first_article.md" class="btn">Fix this page</a> </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 9:22 PM </span>
59 </div>
60
61 <h1>Save your first article</h1>
62<p>Once connected on wallabag, you have many ways to save an article.</p>
63<h2>From the web application</h2>
64<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>
65<p>Confirm to store the content of the article.</p>
66<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>
67<h2>From the bookmarklet</h2>
68<p>From <a href="http://fr.wikipedia.org/wiki/Bookmarklet">Wikipedia's definition</a></p>
69<blockquote>
70<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>
71<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>
72<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>
73</blockquote>
74<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 Bag it ! link) to drag and drop in the bookmarks bar of your web browser.
75From 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>
76<h2>From your smartphone</h2>
77<h3>Above all else</h3>
78<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>
79<h3>Android</h3>
80<h4>Installation and configuration</h4>
81<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>
82<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>
83<h4>Saving of an article</h4>
84<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>
85<h4>Reading</h4>
86<p>When you open the application, click on Synchronize : your recently saved articles will be downloaded on your smartphone.</p>
87<p>You don't need an internet connection anymore : click on <strong>List articles</strong> to start your reading.</p>
88<p>At the end of each article, a <strong>Mark as read</strong> button allows you to archive the article.</p>
89<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>
90<h3>iOS</h3>
91<h4>Installation and configuration</h4>
92<p>TODO</p>
93<h4>Utilization</h4>
94<p>TODO</p>
95<h3>Windows Phone</h3>
96<h4>Installation and configuration</h4>
97<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>
98<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>
99<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>
100<h2>From your web browser</h2>
101<h3>Firefox</h3>
102<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>
103<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
104<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>
105<h3>Chrome</h3>
106<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>
107<p>In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.</p>
108<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>
109 </article>
110 </div>
111 </div>
112 </div>
113 </div>
114
115
116
117 <!-- jQuery -->
118 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
119 <script>
120 if (typeof jQuery == 'undefined')
121 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
122 </script>
123
124 <!-- hightlight.js -->
125 <script src="../../js/highlight.min.js"></script>
126 <script>hljs.initHighlightingOnLoad();</script>
127
128 <!-- JS -->
129
130 <!-- Front end file editor -->
131 <script src="../../js/custom.js"></script>
132 <!--[if lt IE 9]>
133 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
134 <![endif]-->
135
136</body>
137</html>
138
diff --git a/docs/en/help_wallabag.html b/docs/en/help_wallabag.html
new file mode 100644
index 00000000..1f9566a4
--- /dev/null
+++ b/docs/en/help_wallabag.html
@@ -0,0 +1,234 @@
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 - Help 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 Help 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 active">
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 ">
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="help-wallabag">Help wallabag</h1>
181<h2 id="report-bugs">Report bugs</h2>
182<h3 id="contact-wallabag-support">Contact wallabag support</h3>
183<p>If you have a problem while installation or using wallabag (either with the web application or the smartphone applications), use the support site <a href="http://support.wallabag.org"><a href="http://support.wallabag.org">http://support.wallabag.org</a></a>.</p>
184<p>We will look if we can do to help you promptly, or if it is an new bug that we will need to correct.</p>
185<p>It is better to use the support site than sending us an email: the followup is easier for us and the solution to your problem may help another user.</p>
186<h3 id="create-a-new-issue">Create a new issue</h3>
187<p>If you find a bug during wallabag use, thanks for opening a new issue on Github (an account is required).</p>
188<p><strong>First of all</strong>, read the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">advices about the submission of a new issue</a>. The better you report the issue, the more we will be able to help you.</p>
189<ul>
190<li>for a bug in the web application, <a href="https://github.com/wallabag/wallabag/issues/new">open a new issue here</a></li>
191<li>for a bug in the Android application, <a href="https://github.com/wallabag/android-app/issues/new">open a new issue here</a></li>
192<li>for a bug in the Windows Phone application, <a href="https://github.com/wallabag/windowsphone-app">open a new issue here</a></li>
193<li>for a bug in the iOS application , <a href="https://github.com/wallabag/ios-app/issues/new">open a new issue here</a></li>
194<li>for a bug in the Firefox extension, <a href="https://github.com/wallabag/firefox-ext/issues/new">open a new issue here</a></li>
195<li>for a bug in the Chrome extension, <a href="https://github.com/wallabag/chrome-ext/issues/new">open a new issue here</a></li>
196</ul>
197<h2 id="write-and-fix-documentation">Write and fix documentation</h2>
198<p>The documentation you are reading is likely to miss some points, to be out-of-date, to require a translation in your language. Hence, we invite you to take part in its writing.</p>
199<p>The Github repository is here: <a href="https://github.com/wallabag/documentation"><a href="https://github.com/wallabag/documentation">https://github.com/wallabag/documentation</a></a>.</p>
200<h2 id="fix-bugs">Fix bugs</h2>
201<p>Two options:</p>
202<ul>
203<li>when a wallabag user asks a new question <a href="http://support.wallabag.org">on the support site</a>, you could answer him directly if you are a more advanced wallabag user.</li>
204<li>on Github, some issues are likely to match your skills. <a href="https://github.com/wallabag/wallabag/issues">Go through the issue list</a> and help yourself.</li>
205</ul>
206<p>You are welcome to suggest changes to the wallabag code. Look at the <a href="https://github.com/wallabag/wallabag/blob/master/contributing.html">advices about the submission of a new issue</a>.</p>
207<h2 id="spread-the-word">Spread the word</h2>
208<p>It's not so complicated: just talk about wallabag! Use #wallabag hashtag on all your social networks: twitter, Facebook, Diaspora*, Google+, etc.</p>
209<p>Here are our accounts on social networks:</p>
210<ul>
211<li><a href="https://framasphere.org/people/2335ff202f920132196e2a0000053625">Diaspora*</a></li>
212<li><a href="https:/twitter.com/wallabagapp">twitter</a></li>
213<li><a href="https://www.facebook.com/wallabag">Facebook</a></li>
214<li><a href="https://plus.google.com/+WallabagOrg/">Google+</a></li>
215</ul>
216 </section>
217
218 </div>
219 </main>
220
221 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
222 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
223 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
224
225 <script>
226 $(function() {
227 $("section>h1").wrap('<div class="page-header" />');
228 // Syntax highlighting
229 hljs.initHighlightingOnLoad();
230 });
231 </script>
232
233 </body>
234</html>
diff --git a/docs/en/index.html b/docs/en/index.html
new file mode 100644
index 00000000..f9c73418
--- /dev/null
+++ b/docs/en/index.html
@@ -0,0 +1,211 @@
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 - English documentation</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 English documentation
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 active">
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 ">
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="english-documentation">English documentation</h1>
181<p><strong>wallabag</strong> is a read-it-later application: it saves a web page by keeping content only. Elements like navigation or ads are deleted.</p>
182<h2 id="features">Features</h2>
183<ul>
184<li>content of the web page is saved: text and pictures.</li>
185<li>the web application is responsive</li>
186<li>you can export articles into ePub</li>
187<li>you can read your articles offline thanks to smartphones applications</li>
188<li>you can easily save a new link thanks to browser addons</li>
189<li>many templates are available to change your wallabag as you wish</li>
190<li>and many others great features!</li>
191</ul>
192<p>This user documentation is here to learn to you what you can do with wallabag.</p>
193 </section>
194
195 </div>
196 </main>
197
198 <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
199 <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
200 <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
201
202 <script>
203 $(function() {
204 $("section>h1").wrap('<div class="page-header" />');
205 // Syntax highlighting
206 hljs.initHighlightingOnLoad();
207 });
208 </script>
209
210 </body>
211</html>