aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/User_documentation
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2014-11-04 08:33:05 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2014-11-04 08:33:05 +0100
commita0c57b35a338f95a7426f49461cbfa203ec49a24 (patch)
tree9a0e27df765e1671420dd8b6992285066caa9fd6 /docs/en/User_documentation
parent893b8e4cefae8b7b7600ab8322250cdb5d10cedd (diff)
downloadwallabag-a0c57b35a338f95a7426f49461cbfa203ec49a24.tar.gz
wallabag-a0c57b35a338f95a7426f49461cbfa203ec49a24.tar.zst
wallabag-a0c57b35a338f95a7426f49461cbfa203ec49a24.zip
add HTML documentation
Diffstat (limited to 'docs/en/User_documentation')
-rw-r--r--docs/en/User_documentation/Download_and_install.html120
-rw-r--r--docs/en/User_documentation/Hidden_options.html90
-rw-r--r--docs/en/User_documentation/Save_your_first_article.html115
3 files changed, 325 insertions, 0 deletions
diff --git a/docs/en/User_documentation/Download_and_install.html b/docs/en/User_documentation/Download_and_install.html
new file mode 100644
index 00000000..5ed5ce36
--- /dev/null
+++ b/docs/en/User_documentation/Download_and_install.html
@@ -0,0 +1,120 @@
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 http-equiv="content-type" content="text/html; 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 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'>
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/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">
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 </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 6:13 AM </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> ou <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> </article>
92 </div>
93 </div>
94 </div>
95 </div>
96
97
98
99 <!-- jQuery -->
100 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
101 <script>
102 if (typeof jQuery == 'undefined')
103 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
104 </script>
105
106 <!-- hightlight.js -->
107 <script src="../../js/highlight.min.js"></script>
108 <script>hljs.initHighlightingOnLoad();</script>
109
110 <!-- JS -->
111
112 <!-- Front end file editor -->
113 <script src="../../js/custom.js"></script>
114 <!--[if lt IE 9]>
115 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
116 <![endif]-->
117
118</body>
119</html>
120
diff --git a/docs/en/User_documentation/Hidden_options.html b/docs/en/User_documentation/Hidden_options.html
new file mode 100644
index 00000000..65420813
--- /dev/null
+++ b/docs/en/User_documentation/Hidden_options.html
@@ -0,0 +1,90 @@
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 http-equiv="content-type" content="text/html; 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 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'>
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/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">
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 </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Monday, November 3, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 1:28 PM </span>
59 </div>
60
61 <p>TODO</p> </article>
62 </div>
63 </div>
64 </div>
65 </div>
66
67
68
69 <!-- jQuery -->
70 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
71 <script>
72 if (typeof jQuery == 'undefined')
73 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
74 </script>
75
76 <!-- hightlight.js -->
77 <script src="../../js/highlight.min.js"></script>
78 <script>hljs.initHighlightingOnLoad();</script>
79
80 <!-- JS -->
81
82 <!-- Front end file editor -->
83 <script src="../../js/custom.js"></script>
84 <!--[if lt IE 9]>
85 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
86 <![endif]-->
87
88</body>
89</html>
90
diff --git a/docs/en/User_documentation/Save_your_first_article.html b/docs/en/User_documentation/Save_your_first_article.html
new file mode 100644
index 00000000..a3a89efa
--- /dev/null
+++ b/docs/en/User_documentation/Save_your_first_article.html
@@ -0,0 +1,115 @@
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 http-equiv="content-type" content="text/html; 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 <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'>
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/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">
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 </h1>
55 <span style="float: left; font-size: 10px; color: gray;">
56 Sunday, October 26, 2014 </span>
57 <span style="float: right; font-size: 10px; color: gray;">
58 9:34 PM </span>
59 </div>
60
61 <p>Once connected, you have many ways to save an article.</p>
62<h2>From the web application</h2>
63<h2>Thanks to the bookmarklet</h2>
64<p><a href="http://en.wikipedia.org/wiki/Bookmarklet">From Wikipedia</a></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<h2>From your smartphone</h2>
67<h3>Android</h3>
68<h4>Installation and configuration</h4>
69<p>TODO</p>
70<h4>Saving an article</h4>
71<p>TODO</p>
72<h4>Reading</h4>
73<p>TODO</p>
74<h3>iOS</h3>
75<h4>Installation and configuration</h4>
76<p>TODO</p>
77<h4>Use</h4>
78<p>TODO</p>
79<h3>Windows Phone</h3>
80<h4>Installation and configuration</h4>
81<p>TODO</p>
82<h2>From your browser</h2>
83<h3>Firefox</h3>
84<p>TODO</p>
85<h3>Chrome</h3>
86<p>TODO</p> </article>
87 </div>
88 </div>
89 </div>
90 </div>
91
92
93
94 <!-- jQuery -->
95 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
96 <script>
97 if (typeof jQuery == 'undefined')
98 document.write(unescape("%3Cscript src='../../js/jquery-1.11.0.min.js' type='text/javascript'%3E%3C/script%3E"));
99 </script>
100
101 <!-- hightlight.js -->
102 <script src="../../js/highlight.min.js"></script>
103 <script>hljs.initHighlightingOnLoad();</script>
104
105 <!-- JS -->
106
107 <!-- Front end file editor -->
108 <script src="../../js/custom.js"></script>
109 <!--[if lt IE 9]>
110 <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
111 <![endif]-->
112
113</body>
114</html>
115
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 08:56:07 +0000