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 @@

Download
GitHub Repo
Help
Documentation contributors
@@ -51,11 +51,11 @@

Getting started

Getting started Fix this page

- Monday, November 3, 2014 + Friday, October 31, 2014 - 1:28 PM + 8:34 PM

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

@@ -73,7 +73,8 @@

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 index 5d4c307f..5ec6f458 100644 --- a/docs/en/Help_wallabag.html +++ b/docs/en/Help_wallabag.html @@ -5,7 +5,7 @@ Help wallabag - + @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@

Download
GitHub Repo
Help
Documentation contributors
@@ -51,14 +51,32 @@

Help wallabag

Help wallabag Fix this page

- Monday, November 3, 2014 + Tuesday, November 4, 2014 - 1:28 PM + 8:52 PM

TODO

Report bugs

Contact wallabag support

TODO

Create a new issue

TODO

Write and fix documentation

TODO

Fix bugs

TODO

Spread the word

It's not so complicated: just talk about wallabag! Use #wallabag hashtag on all your social networks: twitter, Facebook, Diaspora*, Google+, etc.

Here are our accounts on social networks:

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 @@ + + + + + + + Configure wallabag + + + + + + + + + + + + + + + +

+ +

+ + +

Configure wallabag

From the configuration menu, you can change some wallabag's options.

Some parts won't be presented here as they have a complete chapter in the documentation (RSS +feeds, import from a third party service, export your data, Epub conversion and multi-user mode).

Theme

Of tastes and colors, we do not discuss. That's why wallabag offers you to change its skin to please everyone.

Select the theme of your choice from the drop down list and confirm by clicking on Update.

Language

Select the language of your choice in the drop down list and confirm by clicking on Update +.

Password

Fill in your new password in the two dedicated fields and confirm by clicking on Update.

You will be disconnected and need to enter your new password to access your wallabag.

Clear the cache

The cache allows wallabag perform certain functions faster.

After updating wallabag, it is advised to clear the cache. You only have to click to do so.

+ + + + + + + + + + + + + + + + + + + + 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 @@ Download and install - + @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@

Download
GitHub Repo
Help
Documentation contributors
@@ -51,11 +51,11 @@

Download and install

Download and install Fix this page

- Friday, October 31, 2014 + Sunday, November 16, 2014 - 6:13 AM + 9:22 PM

I don't want to install wallabag

@@ -84,11 +84,12 @@ php composer.phar install

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.

Fill your database type (sqlite, mysql or 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 index 65420813..83c9668b 100644 --- a/docs/en/User_documentation/Hidden_options.html +++ b/docs/en/User_documentation/Hidden_options.html @@ -5,7 +5,7 @@ Hidden options - + @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@

Download
GitHub Repo
Help
Documentation contributors
@@ -51,14 +51,40 @@

Hidden options

Hidden options Fix this page

- Monday, November 3, 2014 + Sunday, November 16, 2014 - 1:28 PM + 9:22 PM

TODO

Be careful

Attention, this part is for advanced users only. We'll edit an important file of wallabag, inc/poche/config.inc.php, please make a backup of this file before changes.
+If you make a mistake while editing a wallabag file, your application may be broken.

This file is created when wallabag is installed.
+Please first install wallabag, make a backup of this file and open it with ~~Sublime Text~~ your favorite editor.

In this file are defined some parameters that you can't change on the wallabag configuration page.

Advanced options

Each parameter is defined like this:

@define ('PARAMETER_NAME', 'Parameter value');

For each line, you can only change Parameter value part.

TODO explain all the following parameters

Here are all the parameters you can change:

HTTP_PORT (default value is 80): Expected value: a digit.
SSL_PORT (default value is 443): Expected value: a digit.
DEBUG_POCHE (default value is FALSE): Expected values: TRUE or FALSE.
DOWNLOAD_PICTURES (default value is FALSE): Expected values: TRUE or FALSE.
SHARE_TWITTER (default value is TRUE): Expected values: TRUE or FALSE.
SHARE_MAIL (par défaut, TRUE): Expected values: TRUE or FALSE.
SHARE_SHAARLI (default value is FALSE): Expected values: TRUE or FALSE.
SHAARLI_URL (default value is 'http://myshaarliurl.com'): Expected value: your Shaarli URL.
FLATTR (default value is TRUE): Expected values: TRUE or FALSE.
SHOW_PRINTLINK (default value is '1'): Expected values: '0' to disable, '1' to enable.
SHOW_READPERCENT (default value is '1'): '0' to disable, '1' to enable.
PAGINATION (default value is '12'): Expected value: a digit.

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 @@ Save your first article - + @@ -14,7 +14,7 @@ - + @@ -39,7 +39,7 @@

Download
GitHub Repo
Help
Documentation contributors
@@ -51,39 +51,62 @@

Save your first article

Save your first article Fix this page

- Sunday, October 26, 2014 + Sunday, November 16, 2014 - 9:34 PM + 9:22 PM

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

Save your first article

Once connected on wallabag, 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.

Let's see first how to do from the web application. In the menu, you have a link save a link. Clicking on it, a form shows up : you simply have to type the web adress of the article you want to save.

Confirm to store the content of the article.

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 DOWNLOAD_PICTURES. Read the chapter on hidden options for more information.

From the bookmarklet

From Wikipedia's definition

+
A bookmarklet is a bookmark stored in a web browser that contains JavaScriptcommands to extend the browser's functionality.
+
Bookmarklets are unobtrusive scripts stored as the URL of a bookmark in a web browser or as a hyperlink on a web page.
+
When clicked, a bookmarklet performs some function, one of a wide variety such as a search query or data extraction. Bookmarklets are usually JavaScript programs.
+

From the wallabag's menu, click on settings. 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. +From 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.

From your smartphone

Above all else

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.

Android

Installation and configuration

TODO

Saving an article

TODO

You can download the android application from the Google Play Store and from F-droid. It's the exact same application on those two stores.

Once installed, start the application, go to the settings part et fill in the URL (complete address of your wallabag installation or your Framabag account) and User ID (in most cases, you'll have to put 1) 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 Token (enter properly all the token's letters as seen in the settings part of wallabag).

Saving of an article

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 Share menu : you'll find a Bag it ! entry which will add your article in wallabag.

Reading

TODO

When you open the application, click on Synchronize : your recently saved articles will be downloaded on your smartphone.

You don't need an internet connection anymore : click on List articles to start your reading.

At the end of each article, a Mark as read button allows you to archive the article.

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.

iOS

Installation and configuration

TODO

Use

Utilization

TODO

Windows Phone

Installation and configuration

TODO

From your browser

You can download the Windows Phone application from the Windows Store or directly from your smartphone's Store.

Once installed, the application will show you a notification on the first launch, asking the configuration of your wallabag server. Go to the Settings part of the application by pressing the three dots menu at the bottom of the screen, then fill in the URL (complete address of your wallabag installation or your Framabag account) and User ID (in most cases, you'll have to put 1) 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 Token (enter properly all the token's letters as seen in the setting part of wallabag).

From your web browser

Firefox

TODO

Download the Firefox add-on on addons.mozilla.org and install it like any other Firefox add-on.

In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.

Personalize the Firefox toolbar to add wallabag (W 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.

Chrome

TODO

Download the Chrome add-on on the dedicated website and install it like any other Chrome add-on.

In the add-on's settings, fill the complete URL of your installation of wallabag or your Framabag account.

During the addon's installation, a new icon appear in Chrome toolbar (a W 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.

-- cgit v1.2.3

Getting started

Getting started Fix this page

Demonstration

Create an account

Help wallabag

Help wallabag Fix this page

Report bugs

Contact wallabag support

Create a new issue

Write and fix documentation

Fix bugs

Spread the word

Configure wallabag Fix this page

Configure wallabag

Theme

Language

Password

Clear the cache

Download and install

Download and install Fix this page

I don't want to install wallabag

Installation of wallabag. At last.

Login

Hidden options

Hidden options Fix this page

Be careful

Advanced options

Save your first article

Save your first article Fix this page

Save your first article

From the web application

Thanks to the bookmarklet

From the bookmarklet

From your smartphone

Above all else

Android

Installation and configuration

Saving an article

Saving of an article

Reading

iOS

Installation and configuration

Use

Utilization

Windows Phone

Installation and configuration

From your browser

From your web browser

Firefox

Chrome