From 7f8f8271e49a2834a87012ea838099c8b46cf63f Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Sat, 14 Mar 2015 00:22:11 +0100 Subject: redo the whole lot of commits I've deleted while trying Gitlab/Framasoft mirroring --- docs/en/Administrator/download_and_install.html | 261 +++++++++++++++++++++ docs/en/Administrator/hidden_options.html | 231 ++++++++++++++++++ docs/en/Administrator/multiusers.html | 200 ++++++++++++++++ docs/en/Administrator/update.html | 210 +++++++++++++++++ docs/en/Developer/create_new_theme.html | 200 ++++++++++++++++ docs/en/Developer/docker.html | 200 ++++++++++++++++ docs/en/Developer/git_repo.html | 210 +++++++++++++++++ docs/en/Developer/v2.html | 200 ++++++++++++++++ docs/en/Developer/vagrant.html | 218 +++++++++++++++++ docs/en/Developer/write_config_files.html | 214 +++++++++++++++++ docs/en/Getting_started.html | 106 --------- docs/en/Help_wallabag.html | 108 --------- docs/en/User/configure_wallabag.html | 212 +++++++++++++++++ docs/en/User/epub_conversion.html | 213 +++++++++++++++++ docs/en/User/framabag_account_creation.html | 214 +++++++++++++++++ docs/en/User/import_export.html | 244 +++++++++++++++++++ docs/en/User/issue_with_article.html | 216 +++++++++++++++++ docs/en/User/organize_articles.html | 232 ++++++++++++++++++ docs/en/User/read_an_article.html | 226 ++++++++++++++++++ docs/en/User/rss_feed.html | 221 +++++++++++++++++ docs/en/User/save_your_first_article.html | 250 ++++++++++++++++++++ docs/en/User/search.html | 200 ++++++++++++++++ docs/en/User_documentation/Configure_wallabag.html | 106 --------- .../User_documentation/Download_and_install.html | 121 ---------- docs/en/User_documentation/Hidden_options.html | 116 --------- .../Save_your_first_article.html | 138 ----------- docs/en/help_wallabag.html | 234 ++++++++++++++++++ docs/en/index.html | 211 +++++++++++++++++ 28 files changed, 4817 insertions(+), 695 deletions(-) create mode 100644 docs/en/Administrator/download_and_install.html create mode 100644 docs/en/Administrator/hidden_options.html create mode 100644 docs/en/Administrator/multiusers.html create mode 100644 docs/en/Administrator/update.html create mode 100644 docs/en/Developer/create_new_theme.html create mode 100644 docs/en/Developer/docker.html create mode 100644 docs/en/Developer/git_repo.html create mode 100644 docs/en/Developer/v2.html create mode 100644 docs/en/Developer/vagrant.html create mode 100644 docs/en/Developer/write_config_files.html delete mode 100644 docs/en/Getting_started.html delete mode 100644 docs/en/Help_wallabag.html create mode 100644 docs/en/User/configure_wallabag.html create mode 100644 docs/en/User/epub_conversion.html create mode 100644 docs/en/User/framabag_account_creation.html create mode 100644 docs/en/User/import_export.html create mode 100644 docs/en/User/issue_with_article.html create mode 100644 docs/en/User/organize_articles.html create mode 100644 docs/en/User/read_an_article.html create mode 100644 docs/en/User/rss_feed.html create mode 100644 docs/en/User/save_your_first_article.html create mode 100644 docs/en/User/search.html delete mode 100644 docs/en/User_documentation/Configure_wallabag.html delete mode 100644 docs/en/User_documentation/Download_and_install.html delete mode 100644 docs/en/User_documentation/Hidden_options.html delete mode 100644 docs/en/User_documentation/Save_your_first_article.html create mode 100644 docs/en/help_wallabag.html create mode 100644 docs/en/index.html (limited to 'docs/en') diff --git a/docs/en/Administrator/download_and_install.html b/docs/en/Administrator/download_and_install.html new file mode 100644 index 00000000..127739c1 --- /dev/null +++ b/docs/en/Administrator/download_and_install.html @@ -0,0 +1,261 @@ + + + + + + + wallabag - Download and install wallabag + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Download and install wallabag

+

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

+

I want to download wallabag the easiest way possible

+

Download the latest wallabag version and unpack it. Copy the files on your web server. Jump off to next section.

+

I want to download wallabag via composer

+

You need to install composer:

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

Next, on your web server, run this command:

+
composer create-project wallabag/wallabag . dev-master
+

All is downloaded into wallabag folder.

+

Permissions

+

Your web server needs a writing access to the assets, cache and db directories. 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 directly reach the setup screen.

+

Prerequisites

+

The installer will tell you which prerequisites are missing. If there's any, jump off to the corresponding session to know how to deal with that problem.

+

Twig installation

+

wallabag is build with Twig, a template library. You have to download it for wallabag to work.

+
    +
  • One option is to choose the automatic download of the package which will be automatically downloaded and installed.
    • +
  • If this option fails, you can choose the second option which is to manually download the vendor package, unzip it and copy the vendor directory in your wallabag directory
    • +
  • +

    Finally, you can here also use Composer to install Twig by following the commands written on screen :

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

Database connection

+

You have to choose a database system between:

+
    +
  • SQLite: The easiest system of all. No extra configuration needed.
    • +
  • MySQL: A well known database system, which is in most cases more efficient than SQLite
    • +
  • Postgresql: Some people found it better than MySQL.
    • +
+

Note : If you're using MySQL or Postgresql, you have to fill all the fields, otherwise the installation will not work and an error message will tell you what's wrong. You must create the database that you will use for wallabag manually with a tool like PHPMyAdmin or the console.

+

User Account

+

Finally, you need to create an user account. As always, be sure to choose a strong password. +An email field is present but it is not at all required.

+

If you get a green success message, it means wallabag is now installed.

+

Prerequisites

+

List of prerequisites for your web server

+ +

Optionnal:

+ +

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/Administrator/hidden_options.html b/docs/en/Administrator/hidden_options.html new file mode 100644 index 00000000..f9e18332 --- /dev/null +++ b/docs/en/Administrator/hidden_options.html @@ -0,0 +1,231 @@ + + + + + + + wallabag - Hidden options + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Hidden options

+

Caution

+

Be careful, this section is destined to advanced users. We are going to modify an important wallabag configuration file, inc/poche/config.inc.php. It is therefore advised to do a backup of this file before you proceed. +Any error occuring during the modification of a wallabag file could lead to malfunctions.

+

This file is created when you install wallabag. +Install wallabag, do a backup copy of the file, then open it in your favorite text editor.

+

In this file, there are some options that are not, as of now, available in the config page of wallabag.

+

Modification of advanced options

+

Each option is defined this way:

+
@define ('OPTION_NAME', 'Value');
+

For each line, you can only modify the Value field.

+

Here is the list of each option you can change:

+
    +
  • HTTP_PORT (default: 80) : the HTTP port of your web server. You may need to change it if your server is behind a proxy. Accepted values: number
    • +
  • SSL_PORT (default: 443) : the HTTP port of your web server. You may need to change it if your server use SSLH. Accepted values: number
    • +
  • MODE_DEMO (default : FALSE): If you ever wanted to set up a demonstration server... Accepted values: TRUE or FALSE.
    • +
  • DEBUG_POCHE (default: FALSE) : if you encounter some problems with wallabag, we may ask you to active Debug mode. Accepted values: TRUE or FALSE. Check the logs in cache/log.txt after activating that.
    • +
  • ERROR_REPORTING (default : E_ALL & ~E_NOTICE) : Set to E_ALL if needed to look for eventual PHP errors.
    • +
  • DOWNLOAD_PICTURES (default: FALSE) : Allows wallabag to fetch images from the articles you save on your server, instead of fetching only the text. We prefer to let you activate this option yourself. Accepted values: TRUE or FALSE.
    • +
  • REGENERATE_PICTURES_QUALITY (default : 75) : In order to avoid security problems, pictures are regenerated if you activate the download of pictures. This is the percentage of quality at which they are saved. Increase that numbler if you want better quality, lower if you need better performances.
    • +
  • SHARE_TWITTER (default: TRUE) : enables Twitter sharing. Accepted values: TRUE or FALSE.
    • +
  • SHARE_MAIL (default: TRUE) : enables mail sharing. Accepted values: TRUE or FALSE.
    • +
  • SHARE_EVERNOTE(default : FALSE) : enables sharing with your Evernote account. Accepted values: TRUE or FALSE.
    • +
  • SHARE_DIASPORA (default : FALSE) : enables to share an article on your Diaspora account.
    • +
  • DIASPORA_URL (default : http://diasporapod.com) : The URL of your Diaspora* pod
    • +
  • CARROT (default : FALSE) : Like Flattr, it's a service to give small amounts of money to a web page. See http://carrot.org/
    • +
  • SHARE_SHAARLI (default: FALSE) : enables sharing via your Shaarli installation (Shaarli is an open-source bookmark manager). Accepted values: TRUE or FALSE.
    • +
  • SHAARLI_URL (default: 'http://myshaarliurl.com') : defines your Shaarli installation URL. Accepted values: an URL.
    • +
  • FLATTR (default: TRUE) : enables the possibility to Flattr an article (Flattr is a microdonation platform). If an article is Flattr-able, an icon will be displayed, allowing you to send a microdonation to the author. Accepted values: TRUE or FALSE.
    • +
  • SHOW_PRINTLINK (default: '1') : enables the Print button for articles. Accepted values: '1' to enable or '0' to disable.
    • +
  • SHOW_READPERCENT (default: '1') : enables the reading progress on articles (working on the default, dark, dmagenta, solarized, solarized-dark themes). Accepted values: '1' to enable or '0' to disable.
    • +
  • PAGINATION (default: '12') : defines the number of articles that are displayed on a list. Accepted values: number.
    • +
+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Administrator/multiusers.html b/docs/en/Administrator/multiusers.html new file mode 100644 index 00000000..de673851 --- /dev/null +++ b/docs/en/Administrator/multiusers.html @@ -0,0 +1,200 @@ + + + + + + + wallabag - Multi users + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Multi users

+

To be translated from Multi-utilisateurs.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Administrator/update.html b/docs/en/Administrator/update.html new file mode 100644 index 00000000..af278286 --- /dev/null +++ b/docs/en/Administrator/update.html @@ -0,0 +1,210 @@ + + + + + + + wallabag - Update wallabag + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Update wallabag

+

Update an existing wallabag installation

+

In order to update your installation, download and unzip the archive into your installation folder. For example on Ubuntu/Debian:

+
wget http://wllbg.org/latest
+unzip latest
+rsync -ur wallabag-version-number/* /var/www/html/wallabag/ # could be another location such as /srv/html, /usr/share/nginx/html
+

After that, just access wallabag in your browser and follow the instructions to finish the update.

+

You can verify at the bottom of the configuration page that you're running the last version.

+

If it fails, just delete the install folder and clear the cache:

+
cd /var/www/html/wallabag/
+rm -r cache/* install/
+

Clearing the cache is also possible in the configuration page, clicking on the link `Delete Cache.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/create_new_theme.html b/docs/en/Developer/create_new_theme.html new file mode 100644 index 00000000..f1143b2a --- /dev/null +++ b/docs/en/Developer/create_new_theme.html @@ -0,0 +1,200 @@ + + + + + + + wallabag - Create new theme + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Create new theme

+

TODO

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/docker.html b/docs/en/Developer/docker.html new file mode 100644 index 00000000..84b0428c --- /dev/null +++ b/docs/en/Developer/docker.html @@ -0,0 +1,200 @@ + + + + + + + wallabag - Docker + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Docker

+

TODO

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/git_repo.html b/docs/en/Developer/git_repo.html new file mode 100644 index 00000000..19b6d378 --- /dev/null +++ b/docs/en/Developer/git_repo.html @@ -0,0 +1,210 @@ + + + + + + + wallabag - git repository + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

git repository

+

If you wish to contribute to the project by suggesting new features or by fixing some bugs, please follow the recommendations below regarding the git repository available at https://github.com/wallabag/wallabag.

+

Current state

+

To manage the different versions of wallabag, we use Git.

+

There are multiple branches for the source code of wallabag web app:

+
    +
  • master branch : this is the stable branch, downloaded by those who wish to install wallabag for their own use.
    • +
  • dev branch : before being added on master branch, all bug fixes and new features must go on that branch. This branch is not recommended for production use.
    • +
  • v2-symfony branch : this is the branch for a revamp of wallabag. A whole chapter is to be focused on it.
    • +
+

Workflow

+

All the rules for contributing to the git repository are in the CONTRIBUTING.md file of wallabag. Please read carefully this file before you make any change.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/v2.html b/docs/en/Developer/v2.html new file mode 100644 index 00000000..d4c9a538 --- /dev/null +++ b/docs/en/Developer/v2.html @@ -0,0 +1,200 @@ + + + + + + + wallabag - wallabag v2 / symfony2 + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

wallabag v2 / symfony2

+

TODO

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/vagrant.html b/docs/en/Developer/vagrant.html new file mode 100644 index 00000000..423f332a --- /dev/null +++ b/docs/en/Developer/vagrant.html @@ -0,0 +1,218 @@ + + + + + + + wallabag - Vagrant + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Vagrant

+

In order to allow you to easily set up the required configuration for wallabag, we offer you a Vagrantfile file to be used with Vagrant.

+

According to Wikipedia,

+
Vagrant is computer software for creating and configuring virtual development environments. It can be seen as a wrapper around virtualization software such as VirtualBox, KVM, VMware and around configuration management software such as Ansible, Chef, Salt or Puppet.
+

Use Vagrant for wallabag

+

Here is the procedure to run wallabag inside a Vagrant container:

+
wget -O wallabag-dev.zip https://github.com/wallabag/wallabag/archive/dev.zip
+unzip wallabag-dev.zip
+cd wallabag-dev
+vagrant up
+

Now, go to http://localhost:8003, wallabag should be available there! (make sure you do not use the port 8003 of your machine for something else before)

+

What did the Vagrantfile install ?

+

The script install a LAMP server, i.e. :

+
    +
  • Ubuntu 14.04
    • +
  • an Apache2 web server
    • +
  • PHP5
    • +
  • SQLite or MySQL or PostgreSQL for PHP
    • +
  • XDebug for PHP
    • +
+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Developer/write_config_files.html b/docs/en/Developer/write_config_files.html new file mode 100644 index 00000000..17eae753 --- /dev/null +++ b/docs/en/Developer/write_config_files.html @@ -0,0 +1,214 @@ + + + + + + + wallabag - Write config files + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Write config files

+

wallabag can use specific site config files to parse website articles. These files are stored in the inc/3rdparty/site_config/standard folder.

+

The format used for these files is XPath. Look at some examples in the folder.

+

Automatic config files generation

+

Fivefilters has created a very useful tool to create config files. You just type in the adress of the article to work on with, and you select the area containing the content you want.

+

siteconfig

+

You should confirm this area by trying with other articles.
+When you got the right area, just click on Download Full-Text RSS site config to download your file.

+

Manual config file generation

+

If Fivefilters tool doesn't work correctly, take a look at the source (Ctrl + U on Firefox and Chromium). Search for your content and get the class or the id attribute of the area containing what you want.

+

Once you've got the id or class, you can write for example one or another of these lines:

+
body: //div[@class='myclass']
+body: //div[@id='myid']
+

Then, test you file. If you got the right content but you want to strip unnecessary parts, do:

+
strip: //div[@class='hidden']
+

You can look at other options for siteconfig files here.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/Getting_started.html b/docs/en/Getting_started.html deleted file mode 100644 index 269bbcd9..00000000 --- a/docs/en/Getting_started.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Getting started - - - - - - - - - - - - - - - -
-
-
- wallabag -

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Getting started Fix this page

- - Friday, October 31, 2014 - - 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.

-

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 deleted file mode 100644 index 5ec6f458..00000000 --- a/docs/en/Help_wallabag.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Help wallabag - - - - - - - - - - - - - - - -
-
-
- wallabag -

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Help wallabag Fix this page

- - Tuesday, November 4, 2014 - - 8:52 PM -
- -

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/configure_wallabag.html b/docs/en/User/configure_wallabag.html new file mode 100644 index 00000000..b7bf879a --- /dev/null +++ b/docs/en/User/configure_wallabag.html @@ -0,0 +1,212 @@ + + + + + + + wallabag - Configure wallabag + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

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/epub_conversion.html b/docs/en/User/epub_conversion.html new file mode 100644 index 00000000..97b095e4 --- /dev/null +++ b/docs/en/User/epub_conversion.html @@ -0,0 +1,213 @@ + + + + + + + wallabag - ePub conversion + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

ePub conversion

+

To enable you to read your articles on a e-reader, wallabag can convert them to the ePub format, and hence create an eBook for your long winter evenings.

+

A word of caution

+

Be careful, the creation of ePub files can be very resource demanding for the server on which wallabag is installed. +It depends on the number of articles and on their length. +Do not create a really big eBook if this is not necessary.

+

Where to convert the articles

+

You can convert your articles at various places in wallabag:

+
    +
  • on the reading page of an article: the ePub link will convert this article only
    • +
  • from the list of articles (unread, favorite or archived articles, articles with a tag): a link at the bottom of the page allows you to convert all the article of this category
    • +
  • from a search: the link is at the bottom of the page
    • +
  • from the configuration page: you can convert all your articles, whatever the category to which they belong
    • +
+

TODO talk about calibre

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/framabag_account_creation.html b/docs/en/User/framabag_account_creation.html new file mode 100644 index 00000000..f60022ae --- /dev/null +++ b/docs/en/User/framabag_account_creation.html @@ -0,0 +1,214 @@ + + + + + + + wallabag - Framabag account creation + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Framabag account creation

+

If you do not want to install and update wallabag, or if you do not have the know-how to install it, it is possible to create an account for free at Framabag.org.

+

Account creation

+

Click on the button Créez votre compte / Create your account.

+

You have to input some information: your username, your password and your email address. Your address is used only to validate your account, except if you check the box to subscribe the newsletter (3 to 4 messages per year).

+

Once this form validated, you will receive an email with the confirmation link. Click on it to create your account.

+

You will receive a last email with the address of your Framabag account, which will look like +https://www.framabag.org/u/Your-username.

+

Information storage

+

Framabag use one database per user. We do not and will not use your stored data.

+

You have forgotten your password

+

If you have forgotten your password to get connected to Framabag, a form is available on the main page of the service.
+Fill it, and a confirmation will be sent to you and will allow you to input a new password.

+

Account deletion

+

If you wish to delete your account, contact us by email: hello@wallabag.org using the address your created your account with, and state your username.

+

We will answer you after your account has been deleted: then, no information about you will be stored by Framabag.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/import_export.html b/docs/en/User/import_export.html new file mode 100644 index 00000000..e3705147 --- /dev/null +++ b/docs/en/User/import_export.html @@ -0,0 +1,244 @@ + + + + + + + wallabag - Import and export data + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Import and export data

+

Import

+

To import data in wallabag, go to the page Configuration.

+

Caution

+

Data import can be a demanding process for your server. Hence, it is done in two steps:

+
    +
  • Insertion of the URL in the wallabag database
    • +
  • in the second step, the retrieval, for each article, of its full content.
    • +
+

These two steps cannot be done concurrently, because it let us the possibility to import thousands of links, but today, wallabag does not have sufficient technical capabilities to do this task automatically.

+

From Pocket

+

Export your data from Pocket

+

From your Pocket account, go to the options. +TODO

+

Import your Pocket data

+

From the configuration page of wallabag, section Import, select the file ril_export.html generated by Pocket, then click on Import. +Wallabag only insert these links in the database. Now, you have to get the content of each article.

+

For this, click on Click to finish import: wallabag will fetch the content of 10 articles at a time.

+

TODO

+

TODO new ticket: why when a click is done, this does not load in a loop? I believe this was doing this ping @mariroz

+

From Instapaper

+

Export your data from Instapaper

+

TODO

+

Import your Instapaper data

+

TODO

+

From Readability

+

Export your data from Readability

+

TODO

+

Import your Readability data

+

TODO

+

From wallabag

+

Since you can export your data from wallabag (see below), it is of course possible to re-import them.

+

In the import form, select your wallabag-exported file (format JSON). Start the import, et voilà.

+

Unlike the above imports, this process is shorter because all the data (title and content of the articles) are already included in the file. Hence wallabag does not have to access each URL. However, the import file is necessarily bigger.

+

From a HTML or JSON file

+

TODO

+

Export

+

It is possible to export your data from the page Configuration of wallabag. Several reasons to do this:

+
    +
  • re-install of wallabag
    • +
  • leave the Framabag service to install your own wallabag
    • +
  • a user with an account on a multi-user wallabag want to have his/her own wallabag installation
    • +
  • ...
    • +
+

This will lead you to download a file at the JSON format.
+As detailed above, you can import this file in wallabag.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/issue_with_article.html b/docs/en/User/issue_with_article.html new file mode 100644 index 00000000..1c1c8e6e --- /dev/null +++ b/docs/en/User/issue_with_article.html @@ -0,0 +1,216 @@ + + + + + + + wallabag - Issue with article + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

My article is not displayed properly in wallabag

+

If you think wallabag do not copy well the content of an article (empty or incomplete text), here are some suggestions.

+

Ask for help

+

Via an email or a ticket, do not forget to give some information that are important for us to better solve the problem:

+
    +
  • The URL of the article
    • +
  • What wallabag displays
    • +
  • What you were expecting
    • +
  • The wallabag version of if you use Framabag
    • +
+

Open a ticket on github

+

To open a new ticket, you should go to github. An account is required. +Do not forget to send us the information listed above.

+

Send us an email

+

Send us the link in a email to the address hello@wallabag.org.
+Do not forget to send us the information listed above.

+

Solve this display problem

+

TODO

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/organize_articles.html b/docs/en/User/organize_articles.html new file mode 100644 index 00000000..45c21826 --- /dev/null +++ b/docs/en/User/organize_articles.html @@ -0,0 +1,232 @@ + + + + + + + wallabag - Organize articles + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Organize articles

+

To be able to find more easily your articles, several methods are available.

+

Tags

+

Assign a tag

+

When saving an article

+

To tag an article when saving it, just click on the tag icon next to the URL field before hitting the Save button. At the moment, it is possible only to do this from the web interface, but it could come to some apps or extensions.

+

From the article

+

To tag an already-saved article, go to the reading page of the article. There is a part tags followed with a pencil. Click on the pencil.

+

Input in the box the tags you want to assign. Add as many tags as you want. They need to be separated by commas and not spaces. Auto-completion is available here: when you type the first letters of an existing tag, it is not necessary to type the whole word. Select it in the drop-down list. Once all your tags are inputted, click on the button Tag.

+

Then, you can go back to your article and read it.

+ +

A full chapter on search is available. Here, we will describe only how to assign a tag from your search.

+

When your search displays results, there is a link Apply the tag ABCD to this search at the bottom of the page. Click on it: a tad depending on your search (here ABCD) will be assigned to all the articles found.

+

Find all the articles with a given tag

+

In the wallabag menu, click on Tags. Then, all the tags you have created are displayed, sorted by the number of articles for each tag. Click on one of these tags to find all the articles with this tag.

+

Preferred articles

+

When you wish to set aside an article, you can mark it as preferred.

+

Set an article as favorite

+

From the reading page of an article, or from a list of articles (such as the list of unread articles), you can set an article as favorite simply by a click on the star which is displayed. +Click again on the star will remove the favorite status of this article.

+

Find all the favorite articles

+

In the wallabag menu, click on Favorites to display the list of all the articles that you have set as favorite.

+

Archived articles

+

When you have read an article, you can archive it: hence it will not be displayed in your list of unread articles.

+

Archiving an article does not remove it from wallabag.

+

Archive an article

+

From the reading page of an article, or from a list of articles (such as the list of unread articles), you can archive an article simply by clicking on the icon ✓.
+Click again on this icon will set back the unread status of the article.

+

Find all the archived articles

+

In the wallabag menu, click on Archive to find all the articles that you have archived.

+

Delete an article

+

Be cautious: the deletion of an article is definitive. It is deleted from the wallabag database.

+

To delete an article, a trash icon is displayed on the page of an article or of a list of articles (unread articles, favorites or archived, for example).

+

We trust you: that is why there is no confirmation message during the deletion.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/read_an_article.html b/docs/en/User/read_an_article.html new file mode 100644 index 00000000..ed06c785 --- /dev/null +++ b/docs/en/User/read_an_article.html @@ -0,0 +1,226 @@ + + + + + + + wallabag - Read an article + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Read an article

+

To read an article is not the most complex thing in wallabag: you only have to click on the title of the article for it to be displayed.

+

Back to where you quit reading your article

+

If you quit reading an article while you are only at half of it (for example), when you will open it again, wallabag will display it at the place you left the article.

+

This feature works only with web applications and not with smartphone applications.

+

Possible actions in an article

+

These actions are possible through the icons displayed at the top of the page. We suppose that you are using the theme Baggy (read the documentation about how to change theme). Icons in other themes are very similar.

+

Here are the actions, in the order of appearance of the icons.

+

Read the original article

+

Move to the original article.

+

Mark the article as read

+

Archive the article, that will be put in the category Archive of the wallabag menu. +Clicking again on this button will move the article back to the unread category.

+

Mark the article as favorite

+

Mark the article as favorite, and it will be put to the category Favorites of the wallabag menu +Clicking again on this button will remove the favorite status.

+

Delete the article

+

Delete completely the article from wallabag. It cannot be restored. Be careful: no confirmation message is displayed.

+

Share through twitter

+

Share the title and the original link of the article through twitter.

+

Share via email

+

Share the title and the original link of the article via email.

+

Print the article

+

Open the print window of the browser.

+

Convert into ePub

+

Convert the article into ePub format. A full chapter about this here.

+

Notify us that the article appears wrong

+

Allow to notify us that an article is not displayed as expected. A full chapter about this here.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/rss_feed.html b/docs/en/User/rss_feed.html new file mode 100644 index 00000000..6edd3d10 --- /dev/null +++ b/docs/en/User/rss_feed.html @@ -0,0 +1,221 @@ + + + + + + + wallabag - RSS feed + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

RSS feed

+

The RSS feeds allow you to:

+
    +
  • read your articles from your favorite RSS feed reader.
    • +
  • to activate the reading features for smartphone softwares
    • +
+

First, you must activate the RSS feature by generating a feed token.
+Go to config in wallabag and generate a token in the section Feeds. +You can generate a new token at any time.

+

Read articles

+

Once the token created, you have access to three RSS feeds:

+
    +
  • the one of the unread articles
    • +
  • the one of the favorites articles
    • +
  • the one of the archived articles
    • +
+

Add the feed you want to your RSS feed reader. +Be careful: when you will be reading an article from your feed reader, this will not set it as read in wallabag.

+

Share your readings

+

If you wish to share your readings with somebody, send him for example the RSS feed of your favorite articles. +Hence, as soon as an article will be set as favorite in wallabag, this person will be able to read it too.

+

Activate the features for smartphones

+

You ave created an RSS feed token. It will also be useful to you to configure your smartphone software. For more information about smartphone sofwares, you can read Save your first article.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/save_your_first_article.html b/docs/en/User/save_your_first_article.html new file mode 100644 index 00000000..37b4ce7c --- /dev/null +++ b/docs/en/User/save_your_first_article.html @@ -0,0 +1,250 @@ + + + + + + + wallabag - Save your first article + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Save your first article

+

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

+

From the web application

+

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

+

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

+

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

+

You can download the iOS application from the AppStore.

+

Once installed, configure the app by filling following fields inside the settings: the URL (complete address of your wallabag installation or your Framabag account) and User ID (in most cases, you'll have to put 1) field. 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).

+

Usage

+

If the app is configured correctly, the app will automatically download the articles from your wallabag (use pull-to-refresh to trigger this update manually). Once an article is downloaded, it'll be available offline from your app.

+

Unfortunately you can only locally mark an article as read (it will not synchronise to your online wallabag).

+

Saving articles

+

If you're browsing a website and want to add the current article to your wallabag, simply tap the Share-button and select Bag it! (if you don't find the wallabag icon, have a look in the more-menu). If everything is set up correctly, your article will be saved (you may have to login from time to time).

+

Windows Phone

+

Installation and configuration

+

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

+

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

+

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.

+
+ +
+
+ + + + + + + + + diff --git a/docs/en/User/search.html b/docs/en/User/search.html new file mode 100644 index 00000000..f385960c --- /dev/null +++ b/docs/en/User/search.html @@ -0,0 +1,200 @@ + + + + + + + wallabag - Search content + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Search content

+

To be translated from Rechercher du contenu dans wallabag.

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

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Configure wallabag Fix this page

- - Sunday, November 16, 2014 - - 9:22 PM -
- -

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 deleted file mode 100644 index 5ee9221f..00000000 --- a/docs/en/User_documentation/Download_and_install.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Download and install - - - - - - - - - - - - - - - -
-
-
- wallabag -

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Download and install Fix this page

- - Sunday, November 16, 2014 - - 9:22 PM -
- -

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 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 deleted file mode 100644 index 83c9668b..00000000 --- a/docs/en/User_documentation/Hidden_options.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - Hidden options - - - - - - - - - - - - - - - -
-
-
- wallabag -

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Hidden options Fix this page

- - Sunday, November 16, 2014 - - 9:22 PM -
- -

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 deleted file mode 100644 index 180691c5..00000000 --- a/docs/en/User_documentation/Save_your_first_article.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - Save your first article - - - - - - - - - - - - - - - -
-
-
- wallabag -

Generated by Daux.io

-
-
-
-
- -
- -
- -
-
-
-
-
-

Save your first article Fix this page

- - Sunday, November 16, 2014 - - 9:22 PM -
- -

Save your first article

-

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

-

From the web application

-

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

-

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

-

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

-

Utilization

-

TODO

-

Windows Phone

-

Installation and configuration

-

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

-

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

-

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.

-
-
-
-
-
- - - - - - - - - - - - - - - - - - - - diff --git a/docs/en/help_wallabag.html b/docs/en/help_wallabag.html new file mode 100644 index 00000000..1f9566a4 --- /dev/null +++ b/docs/en/help_wallabag.html @@ -0,0 +1,234 @@ + + + + + + + wallabag - Help wallabag + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

Help wallabag

+

Report bugs

+

Contact wallabag support

+

If you have a problem while installation or using wallabag (either with the web application or the smartphone applications), use the support site http://support.wallabag.org.

+

We will look if we can do to help you promptly, or if it is an new bug that we will need to correct.

+

It is better to use the support site than sending us an email: the followup is easier for us and the solution to your problem may help another user.

+

Create a new issue

+

If you find a bug during wallabag use, thanks for opening a new issue on Github (an account is required).

+

First of all, read the advices about the submission of a new issue. The better you report the issue, the more we will be able to help you.

+ +

Write and fix documentation

+

The documentation you are reading is likely to miss some points, to be out-of-date, to require a translation in your language. Hence, we invite you to take part in its writing.

+

The Github repository is here: https://github.com/wallabag/documentation.

+

Fix bugs

+

Two options:

+
    +
  • when a wallabag user asks a new question on the support site, you could answer him directly if you are a more advanced wallabag user.
    • +
  • on Github, some issues are likely to match your skills. Go through the issue list and help yourself.
    • +
+

You are welcome to suggest changes to the wallabag code. Look at the advices about the submission of a new issue.

+

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/index.html b/docs/en/index.html new file mode 100644 index 00000000..f9c73418 --- /dev/null +++ b/docs/en/index.html @@ -0,0 +1,211 @@ + + + + + + + wallabag - English documentation + + + + + + + + +
+ + + wallabag + + + EN - FR - DE - RU + + +
+ +
+
+ + + + + +
+

English documentation

+

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.

+
+ +
+
+ + + + + + + + + -- cgit v1.2.3