From a0c57b35a338f95a7426f49461cbfa203ec49a24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 4 Nov 2014 08:33:05 +0100 Subject: add HTML documentation --- docs/en/Getting_started.html | 105 ++++++++++++++++++ docs/en/Help_wallabag.html | 90 ++++++++++++++++ .../User_documentation/Download_and_install.html | 120 +++++++++++++++++++++ docs/en/User_documentation/Hidden_options.html | 90 ++++++++++++++++ .../Save_your_first_article.html | 115 ++++++++++++++++++++ 5 files changed, 520 insertions(+) create mode 100644 docs/en/Getting_started.html create mode 100644 docs/en/Help_wallabag.html create mode 100644 docs/en/User_documentation/Download_and_install.html create mode 100644 docs/en/User_documentation/Hidden_options.html create mode 100644 docs/en/User_documentation/Save_your_first_article.html (limited to 'docs/en') diff --git a/docs/en/Getting_started.html b/docs/en/Getting_started.html new file mode 100644 index 00000000..011959bf --- /dev/null +++ b/docs/en/Getting_started.html @@ -0,0 +1,105 @@ + + + + + + + Getting started + + + + + + + + + + + + + + + +
+
+
+ wallabag +

Generated by Daux.io

+
+
+
+
+ +
+ +
+ +
+
+
+
+
+

Getting started

+ + Monday, November 3, 2014 + + 1:28 PM +
+ +

wallabag is a read-it-later application: it saves a web page by keeping content only. Elements like navigation or ads are deleted.

+

Features

+
    +
  • content of the web page is saved: text and pictures.
    • +
  • the web application is responsive
    • +
  • you can export articles into ePub
    • +
  • you can read your articles offline thanks to smartphones applications
    • +
  • you can easily save a new link thanks to browser addons
    • +
  • many templates are available to change your wallabag as you wish
    • +
  • and many others great features !
    • +
+

This user documentation is here to learn to you what you can do with wallabag.

+

Demonstration

+

If you want to try all wallabag features, there is a demonstration website: http://demo.wallabag.org

+

Create an account

+

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 Framabag.org. Just your email is needed.

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + diff --git a/docs/en/Help_wallabag.html b/docs/en/Help_wallabag.html new file mode 100644 index 00000000..5d4c307f --- /dev/null +++ b/docs/en/Help_wallabag.html @@ -0,0 +1,90 @@ + + + + + + + Help wallabag + + + + + + + + + + + + + + + +
+
+
+ wallabag +

Generated by Daux.io

+
+
+
+
+ +
+ +
+ +
+
+
+
+
+

Help wallabag

+ + Monday, November 3, 2014 + + 1:28 PM +
+ +

TODO

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + 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 @@ + + + + + + + Download and install + + + + + + + + + + + + + + + +
+
+
+ wallabag +

Generated by Daux.io

+
+
+
+
+ +
+ +
+ +
+
+
+
+
+

Download and install

+ + Friday, October 31, 2014 + + 6:13 AM +
+ +

I don't want to install wallabag

+

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).

+

I want to install wallabag

+

Download the latest wallabag version and unpack it. Copy the files on your web server.

+

Prerequisites for your web server

+ +

To ensure that your server has all the prerequisites, you can run the file wallabag_compatibility_test.php that is located in the install directory of wallabag.

+

Installation of the dependencies

+

In order to work properly, wallabag needs some dependencies. To install them, you have to use composer. In your wallabag folder, run the following commands:

+
curl -s http://getcomposer.org/installer | php
+php composer.phar install
+

If you can't install composer (In order to work properly, Wallabag needs some dependencies), we provide you a vendor.zip file to unpack in your wallabag directory.

+

Permissions

+

Your web server needs a writing access in assets, cache and db directory. Otherwise, a message will report that the installation is impossible.

+

Installation of wallabag. At last.

+

Access to wallabag from your web browser. If your server is correctly configured, you reach the setup screen.

+

Fill your database type (sqlite, mysql ou postgresql) and finally the information for your user account.

+

wallabag is now installed.

+

Login

+

From your web browser, you reach the login screen : fill your username and your password to connect to your account.

+

Enjoy!

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + 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 @@ + + + + + + + Hidden options + + + + + + + + + + + + + + + +
+
+
+ wallabag +

Generated by Daux.io

+
+
+
+
+ +
+ +
+ +
+
+
+
+
+

Hidden options

+ + Monday, November 3, 2014 + + 1:28 PM +
+ +

TODO

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + 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 @@ + + + + + + + Save your first article + + + + + + + + + + + + + + + +
+
+
+ wallabag +

Generated by Daux.io

+
+
+
+
+ +
+ +
+ +
+
+
+
+
+

Save your first article

+ + Sunday, October 26, 2014 + + 9:34 PM +
+ +

Once connected, you have many ways to save an article.

+

From the web application

+

Thanks to the bookmarklet

+

From Wikipedia

+
A bookmarklet is a bookmark stored in a web browser that contains JavaScript commands to extend the browser's functionality.
+

From your smartphone

+

Android

+

Installation and configuration

+

TODO

+

Saving an article

+

TODO

+

Reading

+

TODO

+

iOS

+

Installation and configuration

+

TODO

+

Use

+

TODO

+

Windows Phone

+

Installation and configuration

+

TODO

+

From your browser

+

Firefox

+

TODO

+

Chrome

+

TODO

+
+
+
+
+ + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3 From c4457fba85d4b564bebde844d3176964d4f252b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 24 Nov 2014 13:46:39 +0100 Subject: upgrade documentation --- docs/en/Getting_started.html | 15 +-- docs/en/Help_wallabag.html | 32 +++++-- docs/en/User_documentation/Configure_wallabag.html | 106 +++++++++++++++++++++ .../User_documentation/Download_and_install.html | 17 ++-- docs/en/User_documentation/Hidden_options.html | 40 ++++++-- .../Save_your_first_article.html | 61 ++++++++---- 6 files changed, 223 insertions(+), 48 deletions(-) create mode 100644 docs/en/User_documentation/Configure_wallabag.html (limited to 'docs/en') 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 @@ Getting started - + @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@