aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2014-11-24 13:46:39 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2014-11-24 13:46:39 +0100
commitc4457fba85d4b564bebde844d3176964d4f252b3 (patch)
tree8c05b16e7a882435eeea983732298217a57d4ee3 /docs/en
parentd4b42995f7aada85a16188b376955f9f4b3b67db (diff)
downloadwallabag-c4457fba85d4b564bebde844d3176964d4f252b3.tar.gz
wallabag-c4457fba85d4b564bebde844d3176964d4f252b3.tar.zst
wallabag-c4457fba85d4b564bebde844d3176964d4f252b3.zip
upgrade documentation
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/Getting_started.html15
-rw-r--r--docs/en/Help_wallabag.html32
-rw-r--r--docs/en/User_documentation/Configure_wallabag.html106
-rw-r--r--docs/en/User_documentation/Download_and_install.html17
-rw-r--r--docs/en/User_documentation/Hidden_options.html40
-rw-r--r--docs/en/User_documentation/Save_your_first_article.html61
6 files changed, 223 insertions, 48 deletions
diff --git a/docs/en/Getting_started.html b/docs/en/Getting_started.html
index 011959bf..269bbcd9 100644
--- a/docs/en/Getting_started.html
+++ b/docs/en/Getting_started.html
@@ -5,7 +5,7 @@
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--> 5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head> 6<head>
7 <title>Getting started</title> 7 <title>Getting started</title>
8 <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" /> 9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas Lœuillet"> 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"> 11 <link rel="icon" href="../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
14 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15 15
16 <!-- Font --> 16 <!-- Font -->
17 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'> 17
18 <!-- CSS --> 18 <!-- CSS -->
19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'> 19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head> 20</head>
@@ -39,7 +39,7 @@
39 </div> 39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse"> 40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation --> 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/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul> <div class="well well-sidebar"> 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 43
44 <!-- Links --> 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> 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>
@@ -51,11 +51,11 @@
51 <div class="content-page"> 51 <div class="content-page">
52 <article> 52 <article>
53 <div class="page-header sub-header clearfix"> 53 <div class="page-header sub-header clearfix">
54 <h1>Getting started </h1> 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;"> 55 <span style="float: left; font-size: 10px; color: gray;">
56 Monday, November 3, 2014 </span> 56 Friday, October 31, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;"> 57 <span style="float: right; font-size: 10px; color: gray;">
58 1:28 PM </span> 58 8:34 PM </span>
59 </div> 59 </div>
60 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> 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>
@@ -73,7 +73,8 @@
73<h2>Demonstration</h2> 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> 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> 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> </article> 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>
77 </div> 78 </div>
78 </div> 79 </div>
79 </div> 80 </div>
diff --git a/docs/en/Help_wallabag.html b/docs/en/Help_wallabag.html
index 5d4c307f..5ec6f458 100644
--- a/docs/en/Help_wallabag.html
+++ b/docs/en/Help_wallabag.html
@@ -5,7 +5,7 @@
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--> 5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head> 6<head>
7 <title>Help wallabag</title> 7 <title>Help wallabag</title>
8 <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" /> 9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas Lœuillet"> 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"> 11 <link rel="icon" href="../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
14 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15 15
16 <!-- Font --> 16 <!-- Font -->
17 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'> 17
18 <!-- CSS --> 18 <!-- CSS -->
19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'> 19 <link href='../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head> 20</head>
@@ -39,7 +39,7 @@
39 </div> 39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse"> 40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation --> 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/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul> <div class="well well-sidebar"> 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 43
44 <!-- Links --> 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> 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>
@@ -51,14 +51,32 @@
51 <div class="content-page"> 51 <div class="content-page">
52 <article> 52 <article>
53 <div class="page-header sub-header clearfix"> 53 <div class="page-header sub-header clearfix">
54 <h1>Help wallabag </h1> 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;"> 55 <span style="float: left; font-size: 10px; color: gray;">
56 Monday, November 3, 2014 </span> 56 Tuesday, November 4, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;"> 57 <span style="float: right; font-size: 10px; color: gray;">
58 1:28 PM </span> 58 8:52 PM </span>
59 </div> 59 </div>
60 60
61 <p>TODO</p> </article> 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>
62 </div> 80 </div>
63 </div> 81 </div>
64 </div> 82 </div>
diff --git a/docs/en/User_documentation/Configure_wallabag.html b/docs/en/User_documentation/Configure_wallabag.html
new file mode 100644
index 00000000..af73636d
--- /dev/null
+++ b/docs/en/User_documentation/Configure_wallabag.html
@@ -0,0 +1,106 @@
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
index 5ed5ce36..5ee9221f 100644
--- a/docs/en/User_documentation/Download_and_install.html
+++ b/docs/en/User_documentation/Download_and_install.html
@@ -5,7 +5,7 @@
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--> 5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head> 6<head>
7 <title>Download and install</title> 7 <title>Download and install</title>
8 <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" /> 9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas Lœuillet"> 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"> 11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
14 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15 15
16 <!-- Font --> 16 <!-- Font -->
17 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'> 17
18 <!-- CSS --> 18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'> 19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head> 20</head>
@@ -39,7 +39,7 @@
39 </div> 39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse"> 40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation --> 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/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul> <div class="well well-sidebar"> 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 43
44 <!-- Links --> 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> 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>
@@ -51,11 +51,11 @@
51 <div class="content-page"> 51 <div class="content-page">
52 <article> 52 <article>
53 <div class="page-header sub-header clearfix"> 53 <div class="page-header sub-header clearfix">
54 <h1>Download and install </h1> 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;"> 55 <span style="float: left; font-size: 10px; color: gray;">
56 Friday, October 31, 2014 </span> 56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;"> 57 <span style="float: right; font-size: 10px; color: gray;">
58 6:13 AM </span> 58 9:22 PM </span>
59 </div> 59 </div>
60 60
61 <h2>I don't want to install wallabag</h2> 61 <h2>I don't want to install wallabag</h2>
@@ -84,11 +84,12 @@ php composer.phar install</code></pre>
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> 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> 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> 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> ou <code>postgresql</code>) and finally the information for your user account.</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> 88<p>wallabag is now installed. </p>
89<h2>Login</h2> 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> 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> </article> 91<p>Enjoy!</p>
92 </article>
92 </div> 93 </div>
93 </div> 94 </div>
94 </div> 95 </div>
diff --git a/docs/en/User_documentation/Hidden_options.html b/docs/en/User_documentation/Hidden_options.html
index 65420813..83c9668b 100644
--- a/docs/en/User_documentation/Hidden_options.html
+++ b/docs/en/User_documentation/Hidden_options.html
@@ -5,7 +5,7 @@
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--> 5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head> 6<head>
7 <title>Hidden options</title> 7 <title>Hidden options</title>
8 <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" /> 9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas Lœuillet"> 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"> 11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
14 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15 15
16 <!-- Font --> 16 <!-- Font -->
17 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'> 17
18 <!-- CSS --> 18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'> 19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head> 20</head>
@@ -39,7 +39,7 @@
39 </div> 39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse"> 40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation --> 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/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul> <div class="well well-sidebar"> 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 43
44 <!-- Links --> 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> 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>
@@ -51,14 +51,40 @@
51 <div class="content-page"> 51 <div class="content-page">
52 <article> 52 <article>
53 <div class="page-header sub-header clearfix"> 53 <div class="page-header sub-header clearfix">
54 <h1>Hidden options </h1> 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;"> 55 <span style="float: left; font-size: 10px; color: gray;">
56 Monday, November 3, 2014 </span> 56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;"> 57 <span style="float: right; font-size: 10px; color: gray;">
58 1:28 PM </span> 58 9:22 PM </span>
59 </div> 59 </div>
60 60
61 <p>TODO</p> </article> 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>
62 </div> 88 </div>
63 </div> 89 </div>
64 </div> 90 </div>
diff --git a/docs/en/User_documentation/Save_your_first_article.html b/docs/en/User_documentation/Save_your_first_article.html
index a3a89efa..180691c5 100644
--- a/docs/en/User_documentation/Save_your_first_article.html
+++ b/docs/en/User_documentation/Save_your_first_article.html
@@ -5,7 +5,7 @@
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--> 5<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
6<head> 6<head>
7 <title>Save your first article</title> 7 <title>Save your first article</title>
8 <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 8 <meta charset="utf-8">
9 <meta name="description" content="Documentation for wallabag" /> 9 <meta name="description" content="Documentation for wallabag" />
10 <meta name="author" content="Nicolas Lœuillet"> 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"> 11 <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
14 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 14 <meta name="viewport" content="width=device-width, initial-scale=1.0">
15 15
16 <!-- Font --> 16 <!-- Font -->
17 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'> 17
18 <!-- CSS --> 18 <!-- CSS -->
19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'> 19 <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
20</head> 20</head>
@@ -39,7 +39,7 @@
39 </div> 39 </div>
40 <div id="sub-nav-collapse" class="sub-nav-collapse"> 40 <div id="sub-nav-collapse" class="sub-nav-collapse">
41 <!-- Navigation --> 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/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul> <div class="well well-sidebar"> 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 43
44 <!-- Links --> 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> 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>
@@ -51,39 +51,62 @@
51 <div class="content-page"> 51 <div class="content-page">
52 <article> 52 <article>
53 <div class="page-header sub-header clearfix"> 53 <div class="page-header sub-header clearfix">
54 <h1>Save your first article </h1> 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;"> 55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, October 26, 2014 </span> 56 Sunday, November 16, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;"> 57 <span style="float: right; font-size: 10px; color: gray;">
58 9:34 PM </span> 58 9:22 PM </span>
59 </div> 59 </div>
60 60
61 <p>Once connected, you have many ways to save an article.</p> 61 <h1>Save your first article</h1>
62<p>Once connected on wallabag, you have many ways to save an article.</p>
62<h2>From the web application</h2> 63<h2>From the web application</h2>
63<h2>Thanks to the bookmarklet</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>
64<p><a href="http://en.wikipedia.org/wiki/Bookmarklet">From Wikipedia</a></p> 65<p>Confirm to store the content of the article.</p>
65<pre><code>A bookmarklet is a bookmark stored in a web browser that contains JavaScript commands to extend the browser's functionality.</code></pre> 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>
66<h2>From your smartphone</h2> 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>
67<h3>Android</h3> 79<h3>Android</h3>
68<h4>Installation and configuration</h4> 80<h4>Installation and configuration</h4>
69<p>TODO</p> 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>
70<h4>Saving an article</h4> 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>
71<p>TODO</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>
72<h4>Reading</h4> 85<h4>Reading</h4>
73<p>TODO</p> 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>
74<h3>iOS</h3> 90<h3>iOS</h3>
75<h4>Installation and configuration</h4> 91<h4>Installation and configuration</h4>
76<p>TODO</p> 92<p>TODO</p>
77<h4>Use</h4> 93<h4>Utilization</h4>
78<p>TODO</p> 94<p>TODO</p>
79<h3>Windows Phone</h3> 95<h3>Windows Phone</h3>
80<h4>Installation and configuration</h4> 96<h4>Installation and configuration</h4>
81<p>TODO</p> 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>
82<h2>From your browser</h2> 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>
83<h3>Firefox</h3> 101<h3>Firefox</h3>
84<p>TODO</p> 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>
85<h3>Chrome</h3> 105<h3>Chrome</h3>
86<p>TODO</p> </article> 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>
87 </div> 110 </div>
88 </div> 111 </div>
89 </div> 112 </div>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-30 19:13:45 +0000