aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/User_documentation
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/User_documentation')
-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
4 files changed, 0 insertions, 481 deletions
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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-25 08:50:31 +0000