From 59e91bc8931a386974a3817e9849aad1ca7fc186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 21 Oct 2015 14:14:51 +0200 Subject: add docs --- docs/README.rst | 0 docs/en/Administrator/hidden_options.rst | 85 ++++++++ docs/en/Administrator/install.rst | 200 ++++++++++++++++++ docs/en/Administrator/multiusers.rst | 47 +++++ docs/en/Administrator/sessions.rst | 26 +++ docs/en/Administrator/update.rst | 30 +++ docs/en/Developer/create_new_theme.rst | 4 + docs/en/Developer/git_repo.rst | 29 +++ docs/en/Developer/write_config_files.rst | 52 +++++ docs/en/User/configure_wallabag.rst | 118 +++++++++++ docs/en/User/epub_conversion.rst | 32 +++ docs/en/User/framabag_account_creation.rst | 49 +++++ docs/en/User/import_export.rst | 107 ++++++++++ docs/en/User/issue_with_article.rst | 36 ++++ docs/en/User/organize_articles.rst | 109 ++++++++++ docs/en/User/read_an_article.rst | 63 ++++++ docs/en/User/rss_feed.rst | 41 ++++ docs/en/User/save_your_first_article.rst | 226 +++++++++++++++++++++ docs/en/User/search.rst | 21 ++ docs/en/conf.py | 87 ++++++++ docs/en/index.rst | 57 ++++++ docs/en/requirements.txt | 2 + docs/en/user/configuration.rst | 61 ++++++ docs/en/user/create_account.rst | 43 ++++ docs/en/user/first_article.rst | 79 +++++++ docs/en/user/login.rst | 20 ++ docs/fr/Administrateur/MAJ_wallabag.md | 22 ++ docs/fr/Administrateur/Multi-utilisateurs.md | 35 ++++ docs/fr/Administrateur/Options_cachees.md | 40 ++++ .../Telechargement_et_installation.md | 121 +++++++++++ docs/fr/Administrateur/sessions.md | 26 +++ docs/fr/Contribuer_au_projet.md | 52 +++++ docs/fr/Developpeur/Creer_un_nouveau_theme.md | 9 + docs/fr/Developpeur/Depot_git.md | 23 +++ docs/fr/Developpeur/Docker.md | 9 + .../fr/Developpeur/Ecrire_fichier_configuration.md | 39 ++++ docs/fr/Developpeur/Vagrant.md | 34 ++++ docs/fr/Developpeur/v2.md | 9 + docs/fr/Utilisateur/Classer_ses_articles.md | 68 +++++++ docs/fr/Utilisateur/Configurer_wallabag.md | 30 +++ docs/fr/Utilisateur/Convertir_en_ePub.md | 25 +++ docs/fr/Utilisateur/Flux_RSS.md | 35 ++++ docs/fr/Utilisateur/Framabag.md | 34 ++++ docs/fr/Utilisateur/Importer_exporter.md | 78 +++++++ docs/fr/Utilisateur/Lire_un_article.md | 58 ++++++ docs/fr/Utilisateur/Rechercher.md | 21 ++ .../Utilisateur/Sauvegarder_son_premier_article.md | 101 +++++++++ docs/fr/Utilisateur/Un_article_est_mal_affiche.md | 32 +++ docs/fr/conf.py | 87 ++++++++ docs/fr/index.rst | 29 +++ docs/fr/requirements.txt | 2 + docs/img/user/2FA_form.png | Bin 0 -> 11013 bytes docs/img/user/activated_account.png | Bin 0 -> 13519 bytes docs/img/user/login_form.png | Bin 0 -> 9595 bytes docs/img/user/registration_form.png | Bin 0 -> 17126 bytes docs/img/user/sent_email.png | Bin 0 -> 16441 bytes docs/img/user/topbar.png | Bin 0 -> 1475 bytes docs/img/wallabag.png | Bin 0 -> 2605 bytes 58 files changed, 2643 insertions(+) create mode 100644 docs/README.rst create mode 100644 docs/en/Administrator/hidden_options.rst create mode 100644 docs/en/Administrator/install.rst create mode 100644 docs/en/Administrator/multiusers.rst create mode 100644 docs/en/Administrator/sessions.rst create mode 100644 docs/en/Administrator/update.rst create mode 100644 docs/en/Developer/create_new_theme.rst create mode 100644 docs/en/Developer/git_repo.rst create mode 100644 docs/en/Developer/write_config_files.rst create mode 100644 docs/en/User/configure_wallabag.rst create mode 100644 docs/en/User/epub_conversion.rst create mode 100644 docs/en/User/framabag_account_creation.rst create mode 100644 docs/en/User/import_export.rst create mode 100644 docs/en/User/issue_with_article.rst create mode 100644 docs/en/User/organize_articles.rst create mode 100644 docs/en/User/read_an_article.rst create mode 100644 docs/en/User/rss_feed.rst create mode 100644 docs/en/User/save_your_first_article.rst create mode 100644 docs/en/User/search.rst create mode 100644 docs/en/conf.py create mode 100644 docs/en/index.rst create mode 100644 docs/en/requirements.txt create mode 100644 docs/en/user/configuration.rst create mode 100644 docs/en/user/create_account.rst create mode 100644 docs/en/user/first_article.rst create mode 100644 docs/en/user/login.rst create mode 100644 docs/fr/Administrateur/MAJ_wallabag.md create mode 100644 docs/fr/Administrateur/Multi-utilisateurs.md create mode 100644 docs/fr/Administrateur/Options_cachees.md create mode 100644 docs/fr/Administrateur/Telechargement_et_installation.md create mode 100644 docs/fr/Administrateur/sessions.md create mode 100644 docs/fr/Contribuer_au_projet.md create mode 100644 docs/fr/Developpeur/Creer_un_nouveau_theme.md create mode 100644 docs/fr/Developpeur/Depot_git.md create mode 100644 docs/fr/Developpeur/Docker.md create mode 100644 docs/fr/Developpeur/Ecrire_fichier_configuration.md create mode 100644 docs/fr/Developpeur/Vagrant.md create mode 100644 docs/fr/Developpeur/v2.md create mode 100644 docs/fr/Utilisateur/Classer_ses_articles.md create mode 100644 docs/fr/Utilisateur/Configurer_wallabag.md create mode 100644 docs/fr/Utilisateur/Convertir_en_ePub.md create mode 100644 docs/fr/Utilisateur/Flux_RSS.md create mode 100644 docs/fr/Utilisateur/Framabag.md create mode 100644 docs/fr/Utilisateur/Importer_exporter.md create mode 100644 docs/fr/Utilisateur/Lire_un_article.md create mode 100644 docs/fr/Utilisateur/Rechercher.md create mode 100644 docs/fr/Utilisateur/Sauvegarder_son_premier_article.md create mode 100644 docs/fr/Utilisateur/Un_article_est_mal_affiche.md create mode 100644 docs/fr/conf.py create mode 100644 docs/fr/index.rst create mode 100644 docs/fr/requirements.txt create mode 100644 docs/img/user/2FA_form.png create mode 100644 docs/img/user/activated_account.png create mode 100644 docs/img/user/login_form.png create mode 100644 docs/img/user/registration_form.png create mode 100644 docs/img/user/sent_email.png create mode 100644 docs/img/user/topbar.png create mode 100644 docs/img/wallabag.png diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/Administrator/hidden_options.rst b/docs/en/Administrator/hidden_options.rst new file mode 100644 index 00000000..5cf0b22e --- /dev/null +++ b/docs/en/Administrator/hidden_options.rst @@ -0,0 +1,85 @@ +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. + +.. _Flattr is a microdonation platform: http://en.wikipedia.org/wiki/Flattr diff --git a/docs/en/Administrator/install.rst b/docs/en/Administrator/install.rst new file mode 100644 index 00000000..006d8708 --- /dev/null +++ b/docs/en/Administrator/install.rst @@ -0,0 +1,200 @@ +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`_ which uses our +software (see :ref:`Framabag account creation`). + +I want to install wallabag +-------------------------- + +I want to download wallabag manually +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`Download the latest wallabag version`_ and unpack it: + +:: + + wget http://wllbg.org/latest + unzip latest + mv wallabag-version-number wallabag + +Copy the files on your web server. For Ubuntu/Debian, it is the +directory /var/www/html/ : + +:: + + sudo mv wallabag /var/www/html/ + +Then, 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 the current folder. + +Prerequisites for your web server +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Wallabag requires that several components to be installed on your web +server. To make sure your server has all the prerequisites, open in your +browser the page ``http://monserveur.com/wallabag/install/index.php``. + +The components are: + +- `PHP 5.3.3 or above`_ **with `PDO`_ support** +- `XML for PHP`_ +- `PCRE`_ +- `ZLib`_ (otherwise, the processing of compressed pages will be + affected) +- `mbstring`_ anb/or `iconv`_ (otherwise some pages will not be read - + even in English) +- The `DOM/XML`_ extension +- `Data filtering`_ +- `GD`_ (otherwise, pictures will not be saved) +- `Tidy for PHP`_ (otherwise, you may encounter problems with some + pages) +- `cURL`_ with ``Parallel URL fetching`` (optionnal) +- `Parse ini file`_ +- `allow\_url\_fopen`_ (optionnal if cURL is installed) +- `gettext`_ (required for multi-language support) + +Install the missing components before to proceed. For example, to +install Tidy on Ubuntu/Debian: + +:: + + sudo apt-get install php5-tidy + sudo service apache2 reload + +Note : if you’re using IIS as a webserver, you have to disable +*Anonymous Authentication* and `enable *Basic Authentication*`_ in order +to be able to login. + +Twig installation +^^^^^^^^^^^^^^^^^ + +wallabag is build with Twig, a template library. You have to download it +for wallabag to work. If you cannot install ``composer`` (for example in +the case of shared hosting), we offer you to download a file which +includes ``Twig``. This file can be downloaed from the page +``http://myservur.com/wallabag/install/index.php`` (section TWIG +INSTALLATION) or directly at http://wllbg.org/vendor. Uncompress it in +your wallabag directory. + +Otherwise, you can use Composer to install ``Twig`` by launching +``composer`` from your wallabag directory (in the case of Ubuntu/Debian +too: /var/www/html/wallabag/) by following the commands written on +screen: + +:: + + curl -s http://getcomposer.org/installer | php + php composer.phar install + +Creation of the database. +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Wallabag can be installed on different types of databases: + +- `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. + +We advice you to use MySQL because it is more efficient. In this case, +you should create a new database (for example ``wallabag``), a new user +(for example ``wallabag``) and a password (here ``YourPassWord``). To do +this, you can use ``phpMyAdmin``, or launch the following commands: + +:: + + mysql -p -u root + mysql> CREATE DATABASE wallabag; + mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse'; + mysql> exit + +*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. + +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: + +:: + + sudo chown -R www-data:www-data /var/www/html/wallabag + +Installation of wallabag. At last. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Access to wallabag from your web browser: +``http://votreserveur.com/wallabag``. If your server is correctly +configured, you directly reach the setup screen. + +Select the type of database (``sqlite``, ``mysql`` or ``postgresql``) +and fill the information about your database. In the case of the databse +MySQL created before, the standard configuration will be: + +:: + + Database engine: MySQL + Server: localhost + Database: wallabag + Username: wallabag + Password: YourPassWord + +Finally, Create your first user and his/her password (different from the +database user). + +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! + +.. _SQLite: http://php.net/manual/fr/book.sqlite.php +.. _MySQL: http://php.net/manual/fr/book.mysql.php +.. _PostgreSQL: http://php.net/manual/fr/book.pgsql.php +.. _Framabag: https://framabag.org/ +.. _Download the latest wallabag version: http://wllbg.org/latest +.. _PHP 5.3.3 or above: http://php.net/manual/fr/install.php +.. _PDO: http://php.net/manual/en/book.pdo.php +.. _XML for PHP: http://php.net/fr/xml +.. _PCRE: http://php.net/fr/pcre +.. _ZLib: http://php.net/en/zlib +.. _mbstring: http://php.net/en/mbstring +.. _iconv: http://php.net/en/iconv +.. _DOM/XML: http://php.net/manual/en/book.dom.php +.. _Data filtering: http://php.net/manual/fr/book.filter.php +.. _GD: http://php.net/manual/en/book.image.php +.. _Tidy for PHP: http://php.net/fr/tidy +.. _cURL: http://php.net/fr/curl +.. _Parse ini file: http://uk.php.net/manual/en/function.parse-ini-file.php +.. _allow\_url\_fopen: http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen +.. _gettext: http://php.net/manual/fr/book.gettext.php +.. _enable *Basic Authentication*: https://technet.microsoft.com/en-us/library/cc772009%28v=ws.10%29.aspx diff --git a/docs/en/Administrator/multiusers.rst b/docs/en/Administrator/multiusers.rst new file mode 100644 index 00000000..a4053aae --- /dev/null +++ b/docs/en/Administrator/multiusers.rst @@ -0,0 +1,47 @@ +.. _`Multi users`: + +Multi users +=========== + +Create a new account +-------------------- + +Administrator mode +------------------ + +If you want to use wallabag with several persons, you can create new +accounts from the configuration page. + +At the bottom of this page there is a form where you should input a user +name and a password. + +It is now possible to login to this account from the login page of +wallabag. + +No information are shared among the accounts. + +Open registration mode +---------------------- + +Starting from version 1.9, the administrator can let users register by +themselves. This is done by changing the following lines in the +configuration file: + +:: + + // registration + @define ('ALLOW_REGISTER', FALSE); + @define ('SEND_CONFIRMATION_EMAIL', FALSE); + +Then, a user will be able to enter his/her user name and password to +create his/her own account. Depending on the configuration, a +confimation email can be sent to users who gave an email address. + +Remove an account +----------------- + +It is possible to remove your own account from the configuration page. +You simply have to enter your password and to ask for the removal. + +Of course, when there is only one account, it is impossible to remove +it. diff --git a/docs/en/Administrator/sessions.rst b/docs/en/Administrator/sessions.rst new file mode 100644 index 00000000..7dbae257 --- /dev/null +++ b/docs/en/Administrator/sessions.rst @@ -0,0 +1,26 @@ +Session issues +============== + +If you end up disconnected even while checking the *Stay signed in +checkbox*, please run the following commands as root (or with sudo) : + +:: + + mkdir /var/lib/wallabag-sessions + chown www-data:www-data /var/lib/wallabag-sessions + +*NOTE : The www-data user and group may not exist, you may use +``chown http:http /var/lib/wallabag-sessions`` instead* + +Then, using apache add: +``php_admin_value session.save_path /var/lib/wallabag-sessions`` to your +apache vhost, for instance ``wallabag-apache.conf`` Finally, restart +apache, for instance like this : ``/etc/init.d/apache2 restart`` + +If you’re using nginx, add +``php_admin_value[session.save_path] = /var/lib/wallabag-sessions`` in +your nginx configuration file. Then, restart nginx : +``/etc/init.d/nginx restart`` + +*NOTE : If you’re using systemd, you should do +``systemctl restart apache2`` (or nginx).* diff --git a/docs/en/Administrator/update.rst b/docs/en/Administrator/update.rst new file mode 100644 index 00000000..7b799bb3 --- /dev/null +++ b/docs/en/Administrator/update.rst @@ -0,0 +1,30 @@ +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.rst b/docs/en/Developer/create_new_theme.rst new file mode 100644 index 00000000..5731eb11 --- /dev/null +++ b/docs/en/Developer/create_new_theme.rst @@ -0,0 +1,4 @@ +Create new theme +================ + +TODO diff --git a/docs/en/Developer/git_repo.rst b/docs/en/Developer/git_repo.rst new file mode 100644 index 00000000..4fa5c608 --- /dev/null +++ b/docs/en/Developer/git_repo.rst @@ -0,0 +1,29 @@ +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`` 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/write_config_files.rst b/docs/en/Developer/write_config_files.rst new file mode 100644 index 00000000..c1ea61df --- /dev/null +++ b/docs/en/Developer/write_config_files.rst @@ -0,0 +1,52 @@ +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. + +.. figure:: https://lut.im/RNaO7gGe/l9vRnO1b + :alt: siteconfig + + 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/User/configure_wallabag.rst b/docs/en/User/configure_wallabag.rst new file mode 100644 index 00000000..7a0bc95f --- /dev/null +++ b/docs/en/User/configure_wallabag.rst @@ -0,0 +1,118 @@ +.. _`Configure wallabag`: + +Configure wallabag +================== + +From the configuration menu, you can change some of wallabag's options. + +Some parts won't be detailed here, as they have a dedicated chapter in +the documentation (:ref:`RSS feeds`, :ref:`Import / Export`, :ref:`ePub conversion` and :ref:`Multi users`). + +Saving articles +--------------- + +You'll find help about the different ways to save articles to your +wallabag here. + +Save article field +~~~~~~~~~~~~~~~~~~ + +Enter a link in the field and click “bag it!” to save. + +Browser extensions +~~~~~~~~~~~~~~~~~~ + +Links to download extensions for your favourite browser, Firefox or +Chrome. + +Mobile apps +~~~~~~~~~~~ + +Links to download mobile apps, Android, iOS or Windows Phone. + +For Android, you have the choice to download either from Google's Play +Store of from the Free and Open Source market +`F-Droid `__ + +Bookmarklet +~~~~~~~~~~~ + +Lastly, you can use the bookmarklet. A bookmarklet is a simple link you +can drag to your browser's bookmarks. Once it's in your bookmarks, +simply clicking on it will save the webpage you're currently viewing to +your wallabag. + +Feeds +----- + +Plese refer to `RSS feeds `__ for more details. + +.. _`Howto change theme`: + +Theme +----- + +As they say, “all tastes and colors are found in nature”. That's why +wallabag allows you to change its appearance through the use of themes, +in order 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**. + +Import +------ + +Please refer to `Import/Export `__ for more details. + +Export +------ + +Please refer to `Import/Export `__ for more details. + +Clear the cache +--------------- + +The cache allows wallabag perform certain functions faster. + +After updating wallabag, it is advised to clear the cache. + +Click on “delete cache” to do so (no confirmation will be asked). + +Password +-------- + +Fill in your new password in the two dedicated fields and confirm by +clicking on **Update**. + +You will be disconnected and will have to enter your new password to +access your wallabag. + +User +---- + +Add a user here by entering their name, password and (optionnaly) email +in the corresponding fields. + +You may not be able to add a user if don't have the rights to do so. + +Remind newly created users to change their password the first time they +connect to wallabag! + +Delete +------ + +Delete your user account on wallabag here. + +If there is only one account, you won't be able to delete the account. + +Upgrade +------- + +Wallabag will check its curent version and if there is a new version +available and display this information here. diff --git a/docs/en/User/epub_conversion.rst b/docs/en/User/epub_conversion.rst new file mode 100644 index 00000000..7b31fe07 --- /dev/null +++ b/docs/en/User/epub_conversion.rst @@ -0,0 +1,32 @@ +.. _`ePub conversion`: + +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.rst b/docs/en/User/framabag_account_creation.rst new file mode 100644 index 00000000..bce8cdfd --- /dev/null +++ b/docs/en/User/framabag_account_creation.rst @@ -0,0 +1,49 @@ +.. _`Framabag account creation`: + +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.rst b/docs/en/User/import_export.rst new file mode 100644 index 00000000..8cd18bf2 --- /dev/null +++ b/docs/en/User/import_export.rst @@ -0,0 +1,107 @@ +.. _`Import / Export`: + +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.rst b/docs/en/User/issue_with_article.rst new file mode 100644 index 00000000..408403f2 --- /dev/null +++ b/docs/en/User/issue_with_article.rst @@ -0,0 +1,36 @@ +.. _`Article is not displayed properly`: + +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.rst b/docs/en/User/organize_articles.rst new file mode 100644 index 00000000..734e4de6 --- /dev/null +++ b/docs/en/User/organize_articles.rst @@ -0,0 +1,109 @@ +.. _`Organize articles`: + +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. + +From the search +^^^^^^^^^^^^^^^ + +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.rst b/docs/en/User/read_an_article.rst new file mode 100644 index 00000000..6eef46f8 --- /dev/null +++ b/docs/en/User/read_an_article.rst @@ -0,0 +1,63 @@ +Read an article +=============== + +Reading an article is not difficult in wallabag: you only have to click on the title of the article for it to be displayed. + +Back to where you left the article +---------------------------------- + +If you stop reading an article halfway through, the next time wallabag will open it right where you left off. + +This feature only works with web applications and not with smartphone applications. + +Possible actions in an article +------------------------------ + +The following actions can be performed through the icons displayed at the top of the page. We assume here that you are using the Baggy theme (see the section on :ref:`Howto 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 +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Open the article on its original location. + +Mark the article as read +~~~~~~~~~~~~~~~~~~~~~~~~ + +Archive the article, which will be placed into the **Archive** category 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 placed into the **Favorites** category of the wallabag menu. Clicking again on this button will remove the favorite status. + +Delete the article +~~~~~~~~~~~~~~~~~~ + +Delete the article from wallabag permanently. It cannot be restored. Be careful: no confirmation message is displayed. + +Share through twitter +~~~~~~~~~~~~~~~~~~~~~ + +Share the title and the original link of the article on twitter. + +Share via email +~~~~~~~~~~~~~~~ + +Share the title and the original link of the article via e-mail. + +Print the article +~~~~~~~~~~~~~~~~~ + +Open the print window of the browser. + +Convert into ePub +~~~~~~~~~~~~~~~~~ + +Convert the article into ePub format: see the section on :ref:`ePub conversion`. + +Notify us that the article appears wrong +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Notify the wallabag developers that an article is not displayed as expected (see the section on :ref:`Article is not displayed properly`). diff --git a/docs/en/User/rss_feed.rst b/docs/en/User/rss_feed.rst new file mode 100644 index 00000000..760c2856 --- /dev/null +++ b/docs/en/User/rss_feed.rst @@ -0,0 +1,41 @@ +.. _`RSS feeds`: + +RSS feeds +========= + +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 :ref:`Save your first article`. diff --git a/docs/en/User/save_your_first_article.rst b/docs/en/User/save_your_first_article.rst new file mode 100644 index 00000000..e6e884a3 --- /dev/null +++ b/docs/en/User/save_your_first_article.rst @@ -0,0 +1,226 @@ +.. _`Save your first article`: + +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 `JavaScript`_\ commands 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 token. 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 Classic Add-on +~~~~~~~~~~~~~~~~~~~~~~ + +Download the Firefox add-on at `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. + +Firefox Social API Service +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +*Available from wallabag v1.9.1 only* + +You will need an https connection to use this. It’s a Firefox +`requirement`_, sorry. + +With Firefox 29+ versions, your browser comes with an integrated +interface to share things to multiple social services directly from your +browser. In the Firefox interface, it is shown a paper plane-like icon +that you will use to share a page, which means here, save an article. +You can add the service by going into the Config page of wallabag, then +click on Mozilla Services Social API Extension. You must also accept to +use Firefox Services. + +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. + +Opera +~~~~~ + +The recent versions of Opera (15+) allow to install add-ons compatible +with Chrome. + +First, install the add-on named `Download Chrome Extensions`_ which will +allow you to install add-ons from the Chrome Web Store. Then, go `to to +Google site`_ and get the Chrome add-on by clicking on *Add to Opera*. A +message will invite you to confirm this action because this add-on is +not coming from a certified source. The behavior will be the same as for +Chrome (see above). + +.. _Wikipedia’s definition: http://fr.wikipedia.org/wiki/Bookmarklet +.. _bookmark: http://en.wikipedia.org/wiki/Internet_bookmark +.. _web browser: http://en.wikipedia.org/wiki/Web_browser +.. _JavaScript: http://en.wikipedia.org/wiki/JavaScript +.. _JavaScript programs: http://en.wikipedia.org/wiki/Computer_program +.. _Google Play Store: https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche +.. _F-droid: https://f-droid.org/app/fr.gaulupeau.apps.InThePoche +.. _AppStore: https://itunes.apple.com/app/id828331015 +.. _Windows Store: https://www.microsoft.com/en-us/store/apps/wallabag/9nblggh11646 +.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ +.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents +.. _on the dedicated website: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj +.. _Download Chrome Extensions: https://addons.opera.com/en/extensions/details/download-chrome-extension-9/ +.. _to to Google site: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj diff --git a/docs/en/User/search.rst b/docs/en/User/search.rst new file mode 100644 index 00000000..d2bda8bc --- /dev/null +++ b/docs/en/User/search.rst @@ -0,0 +1,21 @@ +Search content in wallabag +========================== + +To enable you to find an article quickly, we set up a full search +engine. + +Click on **Search** in the wallabag menu. Then, enter your search terms. + +Wallabag will go through all your articles, and lists the ones +containing the search terms in their title, their content or their URL. + +Convert this search into ePub format +------------------------------------ + +You can convert the listed articles to the ePub format, so that you can +read them in your e-reader, for example. Look at :ref:`ePub conversion` for more about this. + +Assign a tag to your search results +----------------------------------- + +You can create a tag based on your search criteria. Loot at :ref:`Organize articles` for more about this. diff --git a/docs/en/conf.py b/docs/en/conf.py new file mode 100644 index 00000000..ae879a61 --- /dev/null +++ b/docs/en/conf.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +# +# wallabag documentation build configuration file, created by +# sphinx-quickstart on Fri Oct 16 06:47:23 2015. + +import sys +import os + +extensions = [] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +project = u'wallabag' +copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence' +version = '2.0.0' +release = version +exclude_patterns = ['_build'] +pygments_style = 'sphinx' +html_theme = 'default' +html_static_path = ['_static'] +htmlhelp_basename = 'wallabagdoc' +latex_elements = { + +} + +latex_documents = [ + ('index', 'wallabag.tex', u'wallabag Documentation', + u'Nicolas Lœuillet', 'manual'), +] + +man_pages = [ + ('index', 'wallabag', u'wallabag Documentation', + [u'Nicolas Lœuillet'], 1) +] + +texinfo_documents = [ + ('index', 'wallabag', u'wallabag Documentation', + u'Nicolas Lœuillet', 'wallabag', 'One line description of project.', + 'Miscellaneous'), +] + +##### Guzzle sphinx theme + +import guzzle_sphinx_theme +html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' +html_theme_path = guzzle_sphinx_theme.html_theme_path() +html_theme = 'guzzle_sphinx_theme' + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { + '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] +} + +# Register the theme as an extension to generate a sitemap.xml +extensions.append("guzzle_sphinx_theme") + +# Guzzle theme options (see theme.conf for more information) +html_theme_options = { + + # Set the path to a special layout to include for the homepage + # "index_template": "homepage.html", + + # Allow a separate homepage from the master_doc + # homepage = index + + # Set the name of the project to appear in the nav menu + # "project_nav_name": "Guzzle", + + # Set your Disqus short name to enable comments + # "disqus_comments_shortname": "my_disqus_comments_short_name", + + # Set you GA account ID to enable tracking + # "google_analytics_account": "my_ga_account", + + # Path to a touch icon + # "touch_icon": "", + + # Specify a base_url used to generate sitemap.xml links. If not + # specified, then no sitemap will be built. + #"base_url": "http://guzzlephp.org" + + # Allow the "Table of Contents" page to be defined separately from "master_doc" + # tocpage = Contents + + # Allow the project link to be overriden to a custom URL. + # projectlink = http://myproject.url +} diff --git a/docs/en/index.rst b/docs/en/index.rst new file mode 100644 index 00000000..6ccfd44c --- /dev/null +++ b/docs/en/index.rst @@ -0,0 +1,57 @@ +wallabag documentation +====================== + +.. image:: ../img/wallabag.png + :alt: wallabag logo + :align: center + +**wallabag** is a read-it-later application: it saves a web page by +keeping content only. Elements like navigation or ads are deleted. + +The main documentation for the site is organized into a couple sections: + +* :ref:`user-docs` +* :ref:`admin-docs` +* :ref:`dev-docs` + +.. _user-docs: + +.. toctree:: + :maxdepth: 2 + :caption: User Documentation + + user/create_account + user/login + user/configuration + user/first_article + +user/organize +user/filters +User/read_an_article +User/search +User/epub_conversion +User/issue_with_article +User/rss_feed +User/import_export + +.. _admin-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Admin Documentation + + Administrator/install + Administrator/update + Administrator/hidden_options + Administrator/multiusers + Administrator/sessions + +.. _dev-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Developer Documentation + + Developer/write_config_files + Developer/create_new_theme + Developer/git_repo diff --git a/docs/en/requirements.txt b/docs/en/requirements.txt new file mode 100644 index 00000000..06fc8973 --- /dev/null +++ b/docs/en/requirements.txt @@ -0,0 +1,2 @@ +Sphinx>=1.3.0,<1.4.0 +guzzle_sphinx_theme>=0.7.0,<0.8.0 diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst new file mode 100644 index 00000000..60aae4e5 --- /dev/null +++ b/docs/en/user/configuration.rst @@ -0,0 +1,61 @@ +Configuration +============= + +Now you're logged in, it's time to configure your account as you want. + +Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``. + +Settings +-------- + +Theme +~~~~~ + +wallabag is customizable. You can choose your prefered theme here. You can also create a new one, a chapter is dedicated for this. The default theme is ``Material``, it's the theme used in the documentation screenshots. + +Items per page +~~~~~~~~~~~~~~ + +You can change the number of articles displayed on each page. + +Language +~~~~~~~~ + +You can change the language of wallabag interface. + +RSS +--- + +wallabag provides RSS feeds for each article status: unread, starred and archive. + +Firstly, you need to create a personal token: click on ``Create your token``. +It's possible to change your token by clicking on ``Reset your token``. + +Now you have three links, one for each status: add them into your favourite RSS reader. + +You can also define how many articles you want in each RSS feed (default value: 50). + +User information +---------------- + +You can change your name, your email address and enable ``Two factor authentication``. + +Two factor authentication +~~~~~~~~~~~~~~~~~~~~~~~~~ + + Two-factor authentication (also known as 2FA) is a technology patented in 1984 that provides identification of users by means of the combination of two different components. + +https://en.wikipedia.org/wiki/Two-factor_authentication + +If you enable 2FA, each time you want to login to wallabag, you'll receive a code by email. You have to put this code on the following form. + +.. image:: ../../img/user/2FA_form.png + :alt: Two factor authentication + :align: center + +If you don't want to receive a code each time you want to login, you can check the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. + +Password +-------- + +You can change your password here. diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst new file mode 100644 index 00000000..11fe304c --- /dev/null +++ b/docs/en/user/create_account.rst @@ -0,0 +1,43 @@ +Create an account +================= + +On the login page, click on ``Register`` button. + +.. image:: ../../img/user/registration_form.png + :alt: Registration form + :align: center + +You have to fill the form. Please sure to type a valid email address, we'll send you an activation email. + +.. image:: ../../img/user/sent_email.png + :alt: Email was sent to activate account + :align: center + +Check your inbox, you now have a new mail with a link like this ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. Click on it to activate your account. + +Your account is now activated. + +.. image:: ../../img/user/activated_account.png + :alt: Welcome on board! + :align: center + +Frequently asked questions +-------------------------- + +I can't valid the registration form +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Make sure that all fields are well filled: + +* valid email address +* same passwords in two fields + +I don't receive my activation email +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Are you sure your email address was correct? Did you check your spams folder? + +When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. +~~~~~~~~~~~~~~~ + +You already enabled your account or the URL of the activation email is wrong. diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst new file mode 100644 index 00000000..4e6735c6 --- /dev/null +++ b/docs/en/user/first_article.rst @@ -0,0 +1,79 @@ +Save your first article +======================= + +The main purpose of wallabag is to save web articles. You have many ways to do it. + +By using a bookmarklet +---------------------- + +On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. + +Now, each time you're reading an article on the web and you want to save it, click on the ``bag it!`` link in your bookmarks bar. The article is saved. + +By using the classic form +------------------------- + +In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. + +.. image:: ../../img/user/topbar.png + :alt: Top bar + :align: center + +Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. + +By using a browser add-on +------------------------- + +Firefox +~~~~~~~ + +Firefox Classic Add-on +^^^^^^^^^^^^^^^^^^^^^^ + +Download the Firefox add-on at `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. + +Firefox Social API Service +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*Available from wallabag v1.9.1 only* + +You will need an https connection to use this. It’s a Firefox +`requirement`_, sorry. + +With Firefox 29+ versions, your browser comes with an integrated +interface to share things to multiple social services directly from your +browser. In the Firefox interface, it is shown a paper plane-like icon +that you will use to share a page, which means here, save an article. +You can add the service by going into the Config page of wallabag, then +click on Mozilla Services Social API Extension. You must also accept to +use Firefox Services. + +Chrome +~~~~~~ + +By using your smarphone application +----------------------------------- + +Android +~~~~~~~ + +Firefox OS +~~~~~~~~~~ + +Windows Phone +~~~~~~~~~~~~~ + +iOS +~~~ + + +.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ +.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst new file mode 100644 index 00000000..1b6b8875 --- /dev/null +++ b/docs/en/user/login.rst @@ -0,0 +1,20 @@ +Login +===== + +Your account is now enabled, congratulations! + +To login to wallabag, fill the form on login page. + +If you are on your personal computer and you want to stay connected, you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. + +.. image:: ../../img/user/login_form.png + :alt: Login form + :align: center + +Frequently asked questions +-------------------------- + +I forgot my password +~~~~~~~~~~~~~~~~~~~~ + +You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address diff --git a/docs/fr/Administrateur/MAJ_wallabag.md b/docs/fr/Administrateur/MAJ_wallabag.md new file mode 100644 index 00000000..57929e11 --- /dev/null +++ b/docs/fr/Administrateur/MAJ_wallabag.md @@ -0,0 +1,22 @@ +--- +language: Français +currentMenu: upgrade +subTitle: Mettre à jour wallabag +--- + +# Mettre à jour wallabag + + Pour mettre à jour votre installation, téléchargez et décompressez l’archive dans votre installation (ici `/var/www/html/wallabag/`) : + + wget http://wllbg.org/latest + unzip latest + rsync -ur wallabag-version-number/* /var/www/html/wallabag/ + +Supprimez le répertoire `install` et videz le cache : + + cd /var/www/html/wallabag/ + rm -r cache/* install/ + +Pour vider le cache, il est également possible d'aller dans la page de configuration et de cliquer sur le lien pour supprimer le cache. + +Vérifiez dans le bas de la page de configuration que la dernière version est bien installée. diff --git a/docs/fr/Administrateur/Multi-utilisateurs.md b/docs/fr/Administrateur/Multi-utilisateurs.md new file mode 100644 index 00000000..77a48d5e --- /dev/null +++ b/docs/fr/Administrateur/Multi-utilisateurs.md @@ -0,0 +1,35 @@ +--- +language: Français +currentMenu: multiusers +subTitle: wallabag multi-utilisateurs +--- + +# wallabag multi-utilisateurs + +## Créer un nouveau compte + +### Mode administrateur + +Si vous souhaitez utiliser wallabag pour plusieurs personnes, il est possible de créer de nouveaux comptes depuis la page de configuration. + +En bas de cette page se trouve un formulaire où vous devez saisir un nom d'utilisateur et un mot de passe. + +Il est maintenant possible de se connecter avec ce compte depuis la page d'identification de wallabag. + +Aucune information n'est partagée entre les différents comptes. + +### Mode libre + +A partir de la version 1.9, l'administrateur peut laisser libre la création de nouveaux comptes. Il doit pour cela l'autoriser en modifiant les lignes suivantes dans le fichier de configuration : + + // registration + @define ('ALLOW_REGISTER', FALSE); + @define ('SEND_CONFIRMATION_EMAIL', FALSE); + +Ensuite, l'utilisateur rentrera lui-même son nom d'utilisateur et son mot de passe pour se créer un compte. Selon la configuration, un courriel de confirmation peut être envoyé aux utilisateurs ayant fourni une adresse électronique. + +## Supprimer un compte + +Il est possible de supprimer son propre compte, depuis la page de configuration. Il suffit de saisir son mot de passe et de demander la suppression. + +Bien évidemment, lorsqu'il ne reste plus qu'un seul compte, il est impossible de le supprimer. diff --git a/docs/fr/Administrateur/Options_cachees.md b/docs/fr/Administrateur/Options_cachees.md new file mode 100644 index 00000000..5d4094d4 --- /dev/null +++ b/docs/fr/Administrateur/Options_cachees.md @@ -0,0 +1,40 @@ +--- +language: Français +currentMenu: hidden +subTitle: Options cachées +--- + +# Options cachées + +## Mise en garde + +**Attention**, cette partie concerne les utilisateurs avancés. Nous allons modifier un fichier important de wallabag, `inc/poche/config.inc.php`, il est donc conseillé de faire une sauvegarde de celui-ci avant toute modification. +**Toute erreur lors d'une modification d'un fichier de wallabag pourra entrainer des dysfonctionnements**. + +Ce fichier est créé lorsque vous installez wallabag. +Installez donc d'abord wallabag, faites une copie du fichier et ouvrez-le avec ~~Sublime Text~~ votre éditeur de texte préféré. + +Dans ce fichier sont définis des paramètres qui ne sont, aujourd'hui, pas encore disponibles dans la page **Configuration** de wallabag. + +## Modification des options avancées + +Chaque paramètre est défini de cette façon : + + @define ('NOM_DU_PARAMETRE', 'Valeur du paramètre'); + +Pour chaque ligne, vous ne pouvez modifier que la partie `Valeur du paramètre`. + +Listons maintenant les différents paramètres que vous pouvez changer : + +* `HTTP_PORT` (par défaut, `80`) : correspond au port HTTP de votre serveur web. À changer si votre serveur web est derrière un proxy. Valeur attendue : un nombre. +* `SSL_PORT` (par défaut, `443`) : correspond au port SSL de votre serveur web. À changer si votre serveur web utilises SSLH. Valeur attendue : un nombre. +* `DEBUG_POCHE` (par défaut, `FALSE`) : si vous rencontrez des problèmes avec wallabag, nous vous demanderons peut-être d'activer le mode Debug. Valeurs attendues : `TRUE` ou `FALSE`. +* `DOWNLOAD_PICTURES` (par défaut, `FALSE`) : permet de télécharger sur votre serveur les images des articles. Ce paramètre est désactivé par défaut pour ne pas surcharger votre serveur web. Nous préférons vous laisser activer vous-même ce paramètre. Valeurs attendues : `TRUE` ou `FALSE`. +* `SHARE_TWITTER` (par défaut, `TRUE`) : permet d'activer le partage vers twitter. Valeurs attendues : `TRUE` ou `FALSE`. +* `SHARE_MAIL` (par défaut, `TRUE`) : permet d'activer le partage par email. Valeurs attendues : `TRUE` ou `FALSE`. +* `SHARE_SHAARLI` (par défaut, `FALSE`) : permet d'activer le partage vers votre installation de Shaarli (gestionnaire de favoris). Valeurs attendues : `TRUE` ou `FALSE`. +* `SHAARLI_URL` (par défaut, `'http://myshaarliurl.com'`) : définit l'URL de votre installation de Shaarli. Valeur attendue : une URL. +* `FLATTR` (par défaut, `TRUE`) : permet d'activer la possibilité de flattrer un article ([Flattr est une plateforme de micro-dons](http://fr.wikipedia.org/wiki/Flattr)). Si un article est flattrable, une icône s'affichera et vous permet d'envoyer un micro-don à l'auteur de l'article. Valeurs attendues : `TRUE` ou `FALSE`. +* `SHOW_PRINTLINK` (par défaut, `'1'`) : permet d'afficher le lien pour imprimer un article. Valeurs attendues : `'0'` pour désactiver ou `'1'` pour activer. +* `SHOW_READPERCENT` (par défaut, `'1'`) : permet d'afficher (sur les thèmes `default`, `dark`, `dmagenta`, `solarized`, `solarized-dark`) le pourcentage de lecture de l'article. Valeurs attendues : `'0'` pour désactiver ou `'1'` pour activer. +* `PAGINATION` (par défaut, `'12'`) : définit le nombre d'articles affichés sur une liste. Valeur attendue : un nombre. \ No newline at end of file diff --git a/docs/fr/Administrateur/Telechargement_et_installation.md b/docs/fr/Administrateur/Telechargement_et_installation.md new file mode 100644 index 00000000..46eb4619 --- /dev/null +++ b/docs/fr/Administrateur/Telechargement_et_installation.md @@ -0,0 +1,121 @@ +--- +language: Français +currentMenu: install +subTitle: Télécharger et installer wallabag +--- + +# Télécharger et installer wallabag + +## Je ne souhaite pas installer wallabag + +Puisque vous ne voulez pas ou ne pouvez pas installer wallabag, nous vous proposons de créer un compte gratuit sur [Framabag](https://framabag.org/), lequel utilise notre logiciel. [Lisez la documentation complète](../Utilisateur/Framabag.md). + +## Je souhaite installer wallabag + +### Je souhaite télécharger wallabag manuellement + +[Télécharger la dernière version de wallabag](http://wllbg.org/latest) et décompresser-là : + + wget http://wllbg.org/latest + unzip latest + mv wallabag-version-number wallabag + +Copiez les fichiers sur votre serveur web. Dans le cas d'Ubuntu/Debian, il s'agit de /var/www/html/ : + + sudo mv wallabag /var/www/html/ + +Puis sautez le paragraphe suivant. + +### Je souhaite télécharger wallabag via composer + +Vous devez installer composer : + + curl -s http://getcomposer.org/installer | php + +Ensuite, sur votre serveur web, exécutez cette commande : + + composer create-project wallabag/wallabag . dev-master + +Tout est téléchargé dans le répertoire courant. + +#### Pré-requis pour votre serveur web + +Wallabag nécessite qu'un certain nombre de composants soient installées sur votre serveur web. +Pour être sûr que votre serveur possède tous les pré-requis, ouvrez dans votre navigateur la page `http://monserveur.com/wallabag/install/index.php`. + +Les composants sont : + +* [PHP 5.3.3 ou plus](http://php.net/manual/fr/install.php) **avec support [PDO](http://php.net/manual/en/book.pdo.php)** +* [XML pour PHP](http://php.net/fr/xml) +* [PCRE](http://php.net/fr/pcre) +* [ZLib](http://php.net/en/zlib) (son absence affectera le traitement des pages compressées) +* [mbstring](http://php.net/en/mbstring) et/ou [iconv](http://php.net/en/iconv) (sinon, certaines pages ne pourront pas être lues - même en anglais) +* L'extension [DOM/XML](http://php.net/manual/en/book.dom.php) +* [Filtrage des données](http://php.net/manual/fr/book.filter.php) +* [GD](http://php.net/manual/en/book.image.php) (son absence empèchera la sauvegarde des images) +* [Tidy pour PHP](http://php.net/fr/tidy) (son absence peut poser problème avec certaines pages) +* [cURL](http://php.net/fr/curl) avec `Parallel URL fetching` (optionel) +* [Parse ini file](http://uk.php.net/manual/en/function.parse-ini-file.php) +* [allow_url_fopen](http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen) (optionel si cURL présent) +* [gettext](http://php.net/manual/fr/book.gettext.php) (nécessaire pour le support multilingues) + +Installez les composants manquants avant de poursuivre. Par exemple pour installer Tidy sur Ubuntu/Debian : + + sudo apt-get install php5-tidy + sudo service apache2 reload + +Note : si voux utilisez IIS comme serveur web, vous devez interdire l'*Authentification Anonyme* et [permettre L'*Authentification de base*](https://technet.microsoft.com/fr-fr/library/cc772009%28v=ws.10%29.aspx) pour autoriser la connexion. + +#### Twig installation + +Pour pouvoir fonctionner, wallabag a besoin de `Twig`, une bibliothèque de modèles. +Si vous ne pouvez pas installer `composer` (dans le cas d'hébergement mutualisé par exemple), nous vous proposons un fichier +incluant `Twig`. Ce fichier peut être télécharger depuis la page `http://monserveur.com/wallabag/install/index.php` (section INSTALLATION TWIG) ou directement ici [http://wllbg.org/vendor](http://wllbg.org/vendor). Décompressez-le dans votre répertoire wallabag. + +Alternativement, vous pouvez installer `Twig` en lançant `composer` depuis votre dossier wallabag (toujours dans le cas d'Ubuntu/Debian : /var/www/html/wallabag/) en exécutant les commandes : + + curl -s http://getcomposer.org/installer | php + php composer.phar install + +### Création de la base de données + +Wallabag peut s'installer sur différents types de bases de données : + +* [SQLite](http://php.net/manual/fr/book.sqlite.php). Le plus simple de tous. Rien de particulier à configurer. +* [MySQL](http://php.net/manual/fr/book.mysql.php). Un système de base de données bien connu, qui est dans la plupart des cas plus efficace que SQLite. +* [PostgreSQL](http://php.net/manual/fr/book.pgsql.php). Certaines personnes l'ont trouvé mieux que MySQL. + +Nous vous conseillons d'utiliser MySQL, plus performante. Il est alors nécessaire de créer une nouvelle base (par exemple `wallabag`), un nouvel utilisateur (par exemple `wallabag`) et un mot de passe (ici `VotreMotdePasse`). Vous pouvez pour cela utiliser `phpMyAdmin`, ou exécuter les commandes suivantes : + + mysql -p -u root + mysql> CREATE DATABASE wallabag; + mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse'; + mysql> exit + +*Note :* Si vous utilisez MySQL ou Postgresql, vous devrez **remplir tous les champs**, sinon l'installation ne fonctionera pas et un message d'erreur vous dira ce qui ne va pas. Vous devez créer manuellement la base de données qui sera utilisée par wallabag avec un outil comme PHPMyAdmin ou en ligne de commande. + +### Permissions + +Le serveur web doit avoir accès en écriture aux répertoires `assets`, `cache` et `db`. Sans cela, un message vous indiquera que l'installation est impossible : + + sudo chown -R www-data:www-data /var/www/html/wallabag + +### Installation de wallabag. Enfin. + +Accédez à wallabag depuis votre navigateur : `http://votreserveur.com/wallabag`. Si votre serveur est bien configuré, vous arrivez sur l'écran d'installation. + +Renseignez le type de votre base de données (`sqlite`, `mysql` ou `postgresql`) et les informations de votre base de données. Dans le cas de la base MySQL créée plus haut, la configuration standard sera : + + Database engine: MySQL + Server: localhost + Database: wallabag + Username: wallabag + Password: VotreMotdePasse + +Créez enfin votre premier utilisateur et son mot de passe (différents de l'utilisateur de la base de données). + +wallabag est maintenant installé. + +### Connexion + +Depuis votre navigateur, vous arrivez sur l'écran d'identification : saisissez votre identifiant et votre mot de passe et vous voici connecté. diff --git a/docs/fr/Administrateur/sessions.md b/docs/fr/Administrateur/sessions.md new file mode 100644 index 00000000..717e55e1 --- /dev/null +++ b/docs/fr/Administrateur/sessions.md @@ -0,0 +1,26 @@ +--- +language: Français +currentMenu: sessions +subTitle: Problème de sessions +--- + +Si vous vous retrouvez à être déconnecté même après avoir valider le *Stay signed in checkbox*, +lancez les commandes suivantes comme administrateur (ou avec sudo) : + +``` +mkdir /var/lib/wallabag-sessions +chown www-data:www-data /var/lib/wallabag-sessions +``` + +*NOTE : L'utilisateur et le groupe www-data pourrait ne pas exister. +Vous pouvez alors utiliser ```chown http:http /var/lib/wallabag-sessions``` à la place.* + +Ensuite, en utilisant apache, ajoutez : `php_admin_value session.save_path /var/lib/wallabag-sessions` +à votre vhost apache, tel que `wallabag-apache.conf`. +Enfin, redémarrez apache, en lançant par exemple : ```/etc/init.d/apache2 restart``` + +Si vous utilisez nginx, ajoutez `php_admin_value[session.save_path] = /var/lib/wallabag-sessions` +à votre fichier de configuration de nginx. +Ensuite, redémarrez nginx : ```/etc/init.d/nginx restart``` + +*NOTE : si vous utilisez systemd, vous devriez faire `systemctl restart apache2` (ou nginx).* diff --git a/docs/fr/Contribuer_au_projet.md b/docs/fr/Contribuer_au_projet.md new file mode 100644 index 00000000..879cdaaa --- /dev/null +++ b/docs/fr/Contribuer_au_projet.md @@ -0,0 +1,52 @@ +--- +language: Français +currentMenu: help_us +subTitle: Contribuer au projet +--- + +# Contribuer au projet +## Soumettre des bugs +### Demande de support + +Si vous avez un problème lors de l'installation ou de l'utilisation de wallabag (que ça soit l'application web ou les applications pour smartphone), utilisez le site de support [http://support.wallabag.org](http://support.wallabag.org). + +Nous verrons alors si nous pouvons vous dépanner rapidement ou alors s'il s'agit un nouveau bug qu'il nous faudra corriger. + +Il est préférable d'utiliser le site de support plutôt que de nous envoyer un mail : le suivi est plus pratique pour vous comme pour nous et la résolution de votre problème pourra resservir pour un autre utilisateur. + +### Créer un nouveau ticket + +Si vous avez trouvé un bug lors de votre utilisation de wallabag, merci d'ouvrir un nouveau ticket sur Github (un compte est nécessaire). + +**Avant toute chose**, pensez à lire [les recommandations nécessaires pour la rédaction d'un nouveau ticket](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). Au mieux vous renseignez votre ticket, au mieux nous pourrons vous aider. + +* si c'est un bug avec l'application web, [ouvrez un nouveau ticket ici](https://github.com/wallabag/wallabag/issues/new) +* si c'est un bug avec l'application Android, [ouvrez un nouveau ticket ici](https://github.com/wallabag/android-app/issues/new) +* si c'est un bug avec l'application Windows Phone, [ouvrez un nouveau ticket ici](https://github.com/wallabag/windowsphone-app) +* si c'est un bug avec l'application iOS, [ouvrez un nouveau ticket ici](https://github.com/wallabag/ios-app/issues/new) +* si c'est un bug avec l'extension Firefox, [ouvrez un nouveau ticket ici](https://github.com/wallabag/firefox-ext/issues/new) +* si c'est un bug avec l'extension Chrome, [ouvrez un nouveau ticket ici](https://github.com/wallabag/chrome-ext/issues/new) + +## Écrire et corriger la documentation + +La documentation que vous êtes en train de lire n'est sûrement pas complète, à jour, traduite dans votre langue. C'est pourquoi nous vous invitons à participer à sa rédaction. + +Le dépôt Github se trouve ici : [https://github.com/wallabag/documentation](https://github.com/wallabag/documentation). + +## Corriger les bugs, résoudre les problèmes : faire du support + +Deux possibilités : +* lorsqu'un utilisateur de wallabag pose une nouvelle question [sur le site de support](http://support.wallabag.org), en tant qu'utilisateur avancé de wallabag, vous pouvez lui répondre. +* sur Github, des tickets correspondent sûrement à vos compétences. [Parcourez la liste des tickets](https://github.com/wallabag/wallabag/issues) et servez-vous. + +Si vous souhaitez proposer une modification dans le code de wallabag, vous êtes le bienvenu. [N'oubliez pas de lire les recommandations pour proposer vos modifications](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). + +## Communiquer + +Rien de compliqué ici, parlez de wallabag autour de vous. Utilisez le mot-clé #wallabag sur tous vos réseaux sociaux préférés : twitter, Facebook, Diaspora*, Google+, etc. + +D'ailleurs, voici la liste de nos comptes sur ces réseaux, si jamais vous voulez nous citer dans un de vos messages : +* [Diaspora*](https://framasphere.org/people/2335ff202f920132196e2a0000053625) +* [twitter](https:/twitter.com/wallabagapp) +* [Facebook](https://www.facebook.com/wallabag) +* [Google+](https://plus.google.com/+WallabagOrg/) diff --git a/docs/fr/Developpeur/Creer_un_nouveau_theme.md b/docs/fr/Developpeur/Creer_un_nouveau_theme.md new file mode 100644 index 00000000..15e89ce3 --- /dev/null +++ b/docs/fr/Developpeur/Creer_un_nouveau_theme.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: theme +subTitle: Créer un nouveau thème +--- + +# Créer un nouveau thème + +TODO \ No newline at end of file diff --git a/docs/fr/Developpeur/Depot_git.md b/docs/fr/Developpeur/Depot_git.md new file mode 100644 index 00000000..458e32ca --- /dev/null +++ b/docs/fr/Developpeur/Depot_git.md @@ -0,0 +1,23 @@ +--- +language: Français +currentMenu: repo +subTitle: Dépôt git de wallabag +--- + +# Dépôt git de wallabag + +Si vous souhaitez contribuer au projet en proposant de nouvelles fonctionnalités ou en corrigeant des bugs, il faut suivre les recommandations que vous lirez ci-dessous concernant le dépôt Git disponible à cette adresse : [https://github.com/wallabag/wallabag](https://github.com/wallabag/wallabag). + +## État des lieux + +Pour la gestion des différentes versions de wallabag, nous utilisons Git. + +Nous utilisons plusieurs branches pour le code source de l'application web de wallabag : + +* la branche `master` : c'est la branche stable, celle qui est téléchargée pour tous ceux qui souhaitent installer wallabag pour leur utilisation. +* la branche `dev` : avant d'être sur la branche `master`, toutes les corrections de bugs et nouvelles fonctionnalités doivent passer par cette branche. Cette branche n'est pas conseillée pour une utilisation en production. +* la branche `v2-symfony` : c'est la branche de la refonte de wallabag. Un chapitre complet lui est consacré. + +## Workflow + +Toutes les consignes concernant le dépôt Git se trouve dans [le fichier CONTRIBUTING.md de wallabag](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). Merci de le lire attentivement avant toute modification. \ No newline at end of file diff --git a/docs/fr/Developpeur/Docker.md b/docs/fr/Developpeur/Docker.md new file mode 100644 index 00000000..b5c9af81 --- /dev/null +++ b/docs/fr/Developpeur/Docker.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: docker +subTitle: Docker +--- + +# Docker + +TODO \ No newline at end of file diff --git a/docs/fr/Developpeur/Ecrire_fichier_configuration.md b/docs/fr/Developpeur/Ecrire_fichier_configuration.md new file mode 100644 index 00000000..e90b6526 --- /dev/null +++ b/docs/fr/Developpeur/Ecrire_fichier_configuration.md @@ -0,0 +1,39 @@ +--- +language: Français +currentMenu: site_config +subTitle: Écrire un fichier de configuration +--- + +# Écrire un fichier de configuration + +wallabag peut utiliser des fichiers de configuration spécifiques à un site pour lire les articles de ce site. Ces fichiers sont stockés dans le répertoire [`inc/3rdparty/site_config/standard`](https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard). + +Le format utilisé pour ces fichiers est [XPath](http://www.w3.org/TR/xpath20/). Inspirez-vous des exemples dans le répertoire pour en créer de nouveaux. + +## Génération automatique de fichiers de configuration + +@FiveFilters a créé un [outil très utile](http://siteconfig.fivefilters.org/) pour créer des fichiers de configuration. Vous devez taper l'adresse d'un article qui vous intéresse. puis vous sélectionnez le contenu que vous souhaitez. + +![siteconfig](https://lut.im/RNaO7gGe/l9vRnO1b) + +Vous devez confirmer cette zone en essayant avec d'autres articles. +Quand vous avez trouvé la bonne zone, cliquez simplement sur *Download Full-Text RSS site config* (Téléchargez la configuration du site Full-Text RSS) pour télécharger le fichier à inclure dans le répertoire. + +## Génération manuelle de fichiers de configuration + +Si l'outil de FiveFilters ne marche pas tel qu´attendu, regardez la source d'un article (Ctrl+U sur Firefox ou Chromium). Cherchez votre contenu parmi le code source et repérez l'attribut `class` ou `id` de la zone que vous souhaitez. + +Une fois que vous avez obtenu l'attribut `id` ou `class`, vous pouvez écrire par exemple l'une ou l'autre de ces lignes : + +``` +body: //div[@class='myclass'] +body: //div[@id='myid'] +``` + +Ensuite, testez votre fichier de configuration avec d'autres articles du même site. Si vous avez trouvé le bon contenu mais que vous voulez enlever des parties inutiles, ajoutez la ligne suivante (avec l'attribut `class` correspondant à la partie inutile) : + +``` +strip: //div[@class='hidden'] +``` + +Vous pouvez regarder d'autres options pour les fichiers de configuration de sites [sur l'aide du site de FiveFilters](http://help.fivefilters.org/customer/portal/articles/223153-site-patterns). diff --git a/docs/fr/Developpeur/Vagrant.md b/docs/fr/Developpeur/Vagrant.md new file mode 100644 index 00000000..b2f83bc8 --- /dev/null +++ b/docs/fr/Developpeur/Vagrant.md @@ -0,0 +1,34 @@ +--- +language: Français +currentMenu: vagrant +subTitle: Vagrant +--- + +# Vagrant + +Pour vous permettre de mettre en place rapidement la configuration requise pour wallabag, nous vous proposons un fichier Vagrantfile. + +[Définition Wikipedia](http://fr.wikipedia.org/wiki/Vagrant) + + Vagrant est un logiciel libre et open-source pour la création et la configuration des environnements de développement virtuel. Il peut être considéré comme un wrapper autour du logiciel de virtualisation comme VirtualBox. + +## Utiliser Vagrant pour wallabag + +Voici la procédure pour exécuter wallabag au sein d'un conteneur Vagrant : + + wget -O wallabag-dev.zip https://github.com/wallabag/wallabag/archive/dev.zip + unzip wallabag-dev.zip + cd wallabag-dev + vagrant up + +Accédez maintenant à `http://localhost:8003` et à vous de jouer ! + +## Qu'a installé le Vagrantfile ? + +Le script installe un serveur LAMP, à savoir : + +* Ubuntu 14.04 +* Un serveur web Apache2 +* PHP5 +* SQLite ou MySQL ou PostgreSQL pour PHP +* XDebug pour PHP diff --git a/docs/fr/Developpeur/v2.md b/docs/fr/Developpeur/v2.md new file mode 100644 index 00000000..470213d0 --- /dev/null +++ b/docs/fr/Developpeur/v2.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: v2 +subTitle: wallabag v2 / symfony2 +--- + +# wallabag v2 / symfony2 + +TODO \ No newline at end of file diff --git a/docs/fr/Utilisateur/Classer_ses_articles.md b/docs/fr/Utilisateur/Classer_ses_articles.md new file mode 100644 index 00000000..447db3c8 --- /dev/null +++ b/docs/fr/Utilisateur/Classer_ses_articles.md @@ -0,0 +1,68 @@ +--- +language: Français +currentMenu: sort_article +subTitle: Classer ses articles +--- + +# Classer ses articles + +Pour pouvoir retrouver plus facilement vos articles, plusieurs méthodes existent. + +## Tags +### Assigner un tag +#### Depuis l'article + +Aujourd'hui, il n'est pas encore possible d'assigner un tag lorsque vous sauvegardez un nouvel article. + +Tout ajout de tag se fera donc sur un article déjà sauvegardé. + +Sur la page de lecture de l'article, se trouve une partie `tags` suivie d'un crayon. Cliquez sur ce crayon. + +Saisissez dans la case les tags que vous souhaitez assigner. Saisissez autant de tags que vous le voulez. Ils doivent être séparés par des virgules et non par des espaces. L'auto-complétion existe ici : si vous tapez les premières lettres d'un tag déjà existant, inutile de taper le mot en entier, sélectionnez-le dans la liste déroulante. Une fois tous vos tags saisis, cliquez sur le bouton **Tag**. + +Vous pouvez ensuite retourner lire votre article. + +#### Depuis la recherche + +Un chapitre complet sur la recherche existe. Ici, nous verrons uniquement comment assigner un tag depuis votre recherche. + +Lorsque votre recherche vous affiche les résultats, vous avez un lien en bas de page `Apply the tag ABCD to this search`. Cliquez dessus : un tag en fonction de la recherche que vous venez d'effectuer (ici `ABCD`) sera assigné à tous les articles trouvés. + +### Retrouver tous les articles d'un même tag + +Dans le menu de wallabag, cliquez sur **Tags**. Ici s'affichent tous les tags que vous avez créés, triés par nombre d'articles au sein de chaque tag. Cliquez sur l'un de ces tags pour retrouver tous les articles correspondants à ce tag. + +## Articles favoris + +Lorsque vous souhaitez mettre de côté un article, vous pouvez le marquer comme favori. + +### Marquer un article comme favori + +Depuis la page de lecture d'un article, ou depuis une liste d'articles (par exemple, la liste des articles non lus), vous pouvez mettre un article comme favori juste en cliquant sur l'étoile qui apparait. +Recliquer sur cette étoile enlèvera le statut **favori** de cet article. + +### Retrouver tous ses articles favoris + +Dans le menu de wallabag, cliquez sur **Favoris** pour retrouver tous les articles que vous avez déjà mis en favori. + +## Articles archivés + +Lorsque vous avez lu un article, vous pouvez l'archiver : ainsi il n'apparaitra plus dans votre liste d'articles non lus. +Le fait d'archiver un article ne le supprime pas de wallabag. + +### Archiver un article + +Depuis la page de lecture d'un article, ou depuis une liste d'articles (par exemple, la liste des articles non lus), vous pouvez archiver un article juste en cliquant sur l'icône ✓. +Recliquer sur cette icône remettra l'article en statut **non lu**. + +### Retrouver tous ses articles archivés + +Dans le menu de wallabag, cliquez sur **Archive** pour retrouver tous les articles que vous avez déjà archivés. + +## Supprimer l'article + +Attention, la suppression d'un article est **définitive** : il est supprimé de la base de données de wallabag. + +Pour supprimer un article, une icône de corbeille se trouve sur la page d'un article ou sur une liste d'articles (articles non lus, favoris ou archivés par exemple). + +Nous vous faisons confiance : c'est pourquoi il n'y a aucune demande de confirmation lors de la suppression. diff --git a/docs/fr/Utilisateur/Configurer_wallabag.md b/docs/fr/Utilisateur/Configurer_wallabag.md new file mode 100644 index 00000000..2d95dc90 --- /dev/null +++ b/docs/fr/Utilisateur/Configurer_wallabag.md @@ -0,0 +1,30 @@ +--- +language: Français +currentMenu: configure +subTitle: Configurer wallabag +--- + +# Configurer wallabag + +Depuis le menu **configuration**, vous avez la possibilité de changer quelques options de wallabag. + +Certaines parties ne seront pas présentées ici car elles bénéficient d'un chapitre complet dans la documentation ([flux RSS](flux_rss.html), [l'import depuis un service tiers](importer_exporter.html), [l'export de vos données](importer_exporter.html), [la conversion en ePub](convertir_en_epub.html) et [le mode multi-utilisateurs](../Administrateur/multi-utilisateurs.html)). + +## Thème + +Des goûts et des couleurs, on ne discute pas. C'est pourquoi wallabag vous propose de changer son habillage pour plaire à chacun. +Sélectionnez le thème de votre choix dans la liste déroulante et validez en cliquant sur **Mettre à jour**. + +## Langue + +Sélectionnez la langue de votre choix dans la liste déroulante et validez en cliquant sur **Mettre à jour**. + +## Mot de passe + +Saisissez votre nouveau mot de passe dans les deux champs prévus et validez en cliquant sur **Mettre à jour**. +Vous serez alors déconnecté et devrez saisir votre nouveau mot de passe pour accéder à wallabag. + +## Vider le cache + +Le cache permet à wallabag d'effectuer certains traitements plus rapidement. +Après une mise à jour de wallabag, il est conseillé de vider le cache. Vous n'avez qu'un clic à faire pour le vider. diff --git a/docs/fr/Utilisateur/Convertir_en_ePub.md b/docs/fr/Utilisateur/Convertir_en_ePub.md new file mode 100644 index 00000000..8172a78c --- /dev/null +++ b/docs/fr/Utilisateur/Convertir_en_ePub.md @@ -0,0 +1,25 @@ +--- +language: Français +currentMenu: epub +subTitle: Convertir en ePub +--- + +# Convertir en ePub + +Pour que vous puissiez lire vos articles sauvegardés depuis votre liseuse, wallabag vous permet de les convertir au format ePub et ainsi vous créer un eBook pour vos longues soirées d'hiver. + +## Mise en garde + +Attention, la génération de fichiers ePub peut être très consommatrice de ressources pour le serveur sur lequel est installé wallabag. Cela dépend du nombre d'articles et de leur longueur. +Ne générez pas un eBook trop important si cela n'est pas nécessaire. + +## Où convertir les articles + +Vous pouvez convertir vos articles depuis différents endroits de wallabag : + +* sur la page de lecture d'un article : le lien ePub convertira ce seul article +* depuis une liste d'articles (articles non lus, favoris ou archivés, articles d'un tag) : un lien en bas de page vous permet de convertir tous les articles de cette catégorie +* depuis une recherche : le lien se trouve en bas de page +* depuis la page de configuration : vous allez pouvoir convertir tous vos articles, peu importe la catégorie dans laquelle ils se trouvent + +TODO parler de calibre \ No newline at end of file diff --git a/docs/fr/Utilisateur/Flux_RSS.md b/docs/fr/Utilisateur/Flux_RSS.md new file mode 100644 index 00000000..78862737 --- /dev/null +++ b/docs/fr/Utilisateur/Flux_RSS.md @@ -0,0 +1,35 @@ +--- +language: Français +currentMenu: rss +subTitle: Flux RSS +--- + +# Flux RSS + +Les flux RSS vous permettent : + +* de lire vos articles depuis votre lecteur de flux RSS préféré +* d'activer les fonctionnalités de lecture pour les applications smartphones + +Tout d'abord, vous devez activer la fonctionnalité RSS en générant votre jeton de flux. +Rendez-vous dans **configuration** de wallabag et créez le jeton dans la partie **Flux**. +À tout moment, vous pouvez générer un nouveau jeton. + +## Lire les articles + +Une fois le jeton créé, vous avez accès à trois flux RSS : + +* celui des articles non lus +* celui des articles favoris +* celui des articles archivés + +Ajoutez le flux de votre choix dans votre lecteur de flux RSS. +Attention, lorsque vous lirez un article depuis votre lecteur de flux, ça ne le marquera pas comme lu dans wallabag. + +### Partager vos lectures + +Si vous souhaitez partager vos lectures avec quelqu'un, envoyez-lui par exemple le flux RSS de vos articles préférés. Ainsi, dès qu'un article sera mis en favori dans wallabag, cette personne pourra également le lire. + +## Activer les fonctionnalités pour smartphones + +Vous avez créé le jeton de flux RSS : il va vous être utile pour configurer votre application smartphone. Pour en savoir sur les applications smartphones, vous pouvez lire [Sauvegarder son premier article](Sauvegarder_son_premier_article.md). \ No newline at end of file diff --git a/docs/fr/Utilisateur/Framabag.md b/docs/fr/Utilisateur/Framabag.md new file mode 100644 index 00000000..258f3dd5 --- /dev/null +++ b/docs/fr/Utilisateur/Framabag.md @@ -0,0 +1,34 @@ +--- +language: Français +currentMenu: framabag +subTitle: Se créer un compte sur Framabag +--- + +# Se créer un compte sur Framabag + +Puisque vous ne souhaitez peut-être pas gérer l'installation et la mise à jour de wallabag, ou puisque vous n'avez peut-être pas les connaissances pour l'installer, il vous est possible de vous créer un compte gratuit sur [Framabag.org](https://www.framabag.org). + +## Création du compte + +Cliquez sur le bouton **Créez votre compte / Create your account**. + +Vous devez saisir certaines informations : votre nom d'utilisateur, votre mot de passe et votre adresse email. Votre adresse n'est utilisée que pour la validation de votre compte, sauf si vous cochez la case pour recevoir la newsletter (3 à 4 envois par an). + +Une fois ce formulaire validé, vous recevez un email avec un lien de confirmation. Cliquez dessus, votre compte sera alors créé. + +Vous recevrez un dernier email avec l'adresse de votre compte Framabag, de la forme `https://www.framabag.org/u/votre-nom-d'utilisateur`. + +## Stockage de vos informations + +Framabag utilise une base de données par utilisateur. Nous ne faisons et ne ferons aucune utilisation de vos données stockées. + +## Vous avez oublié votre mot de passe + +Si vous avez oublié votre mot de passe pour vous connecter à Framabag, un formulaire est disponible [depuis la page d'accueil du service](https://www.framabag.org). +Remplissez-le, un email de confirmation vous sera envoyé et vous permettra de saisir votre nouveau mot de passe. + +## Suppression de votre compte + +Si vous souhaitez supprimer votre compte, contactez-nous par email : [hello@wallabag.org](mailto:hello@wallabag.org) avec l'adresse de création de votre compte, en nous indiquant votre nom d'utilisateur. + +Nous vous répondrons quand votre compte sera supprimé : dès cet instant, plus aucune information vous concernant ne sera stockée sur Framabag. diff --git a/docs/fr/Utilisateur/Importer_exporter.md b/docs/fr/Utilisateur/Importer_exporter.md new file mode 100644 index 00000000..f5dda060 --- /dev/null +++ b/docs/fr/Utilisateur/Importer_exporter.md @@ -0,0 +1,78 @@ +--- +language: Français +currentMenu: import +subTitle: Importer ou exporter ses données +--- + +# Importer ou exporter ses données +## Importer + +Pour importer des données dans wallabag, vous devez vous rendre dans la page **Configuration**. + +### Mise en garde + +L'import de données peut être une **opération gourmande** pour votre serveur. C'est pourquoi elle s'effectue en deux étapes : + +* l'insertion des URL dans la base de données de wallabag +* dans un second temps, la récupération, pour chaque article, du contenu complet + +Ces deux actions ne peuvent pas être effectuées simultanément, car nous vous donnons la possibilité d'importer des milliers de liens, mais aujourd'hui, wallabag n'a pas les possibilités techniques nécessaires pour effectuer tout ce travail automatiquement. + +### Depuis Pocket +#### Exporter ses données depuis Pocket + +Depuis votre compte Pocket, rendez-vous dans vos options. +TODO + +#### Importer ses données Pocket + +Depuis la page de configuration de wallabag, partie **Import**, sélectionnez le fichier `ril_export.html` que Pocket a généré puis cliquez sur **Import**. +wallabag ne fait qu'insérer les liens dans sa base de données. Il faut maintenant lui faire récupérer le contenu de chaque article. + +Pour cela, cliquez sur `Click to finish import` : wallabag récupèrera alors le contenu de 10 articles à la fois. + +TODO + +TODO nouveau ticket : pourquoi quand on clique une fois, ça ne charge pas en boucle ? Il me semblait que ça faisait ça ping @mariroz + +### Depuis Instapaper +#### Exporter ses données depuis Instapaper + +TODO + +#### Importer ses données Instapaper + +TODO + +### Depuis Readability +#### Exporter ses données depuis Readability + +TODO + +#### Importer ses données Readability + +TODO + +### Depuis wallabag + +Puisque vous pouvez exporter vos données de wallabag (lire ci-dessous), il est évidemment possible de les réimporter. + +Dans le formulaire d'import, sélectionnez votre fichier d'export wallabag (au format JSON). Démarrez l'import et voila. + +Contrairement aux imports ci-dessus, le traitement est moins long car toutes les données (titre et contenu des articles) sont déjà présentes dans le fichier, il n'est pas nécessaire pour wallabag d'accéder à chacune des URL. +Par contre, le fichier d'import est forcément plus conséquent. + +### Depuis un fichier HTML ou JSON + +TODO + +## Exporter +Il est possible d'exporter ses données depuis la page **Configuration** de wallabag. Plusieurs raisons possibles : + +* réinstaller wallabag +* quitter le service Framabag pour installer soi-même wallabag +* un compte sur un wallabag multi-utilisateurs souhaite avoir sa propre installation de wallabag +* ... + +Vous téléchargerez alors un fichier [au format JSON](http://fr.wikipedia.org/wiki/JavaScript_Object_Notation). +Comme nous l'avons vu ci-dessus, il est possible d'importer ce fichier dans wallabag. \ No newline at end of file diff --git a/docs/fr/Utilisateur/Lire_un_article.md b/docs/fr/Utilisateur/Lire_un_article.md new file mode 100644 index 00000000..72ebc07e --- /dev/null +++ b/docs/fr/Utilisateur/Lire_un_article.md @@ -0,0 +1,58 @@ +--- +language: Français +currentMenu: read_article +subTitle: Lire un article +--- + +# Lire un article + +Lire un article n'est pas la chose la plus compliquée dans wallabag. Vous n'avez qu'à cliquer sur le titre d'un article pour l'afficher. + +## Revenir là où vous avez laissé votre article + +Si vous quittez un article alors que vous n'êtes qu'à la moitié de celui-ci par exemple, lorsque vous reviendrez, wallabag vous renverra là où vous avez laissé l'article. + +Cette astuce ne fonctionne qu'avec l'application web et pas les applications smartphones. + +## Actions possibles depuis l'article + +Ces actions sont possibles grâce aux icônes affichés en haut de la page. Nous partons du principe que vous utilisez le thème Baggy ([lire la documentation pour changer de thème](Configurer_wallabag.md)), les icônes dans les autres thèmes sont sensiblement les mêmes. +Voici donc ces actions, par ordre d'apparition des icônes. + +### Lire l'article original + +Renvoie vers l'article original. + +### Marquer l'article comme lu + +Archive l'article, qui se retrouvera dans la catégorie **Archive** du menu de wallabag. +Recliquer dessus permet de replacer cet article en état non lu. + +### Mettre l'article en favori + +Marque l'article comme favori, qui se retrouvera dans la catégorie **Favoris** du menu de wallabag. +Recliquer dessus permet d'enlever le statut de favori. + +### Supprimer l'article + +Supprime complètement l'article de wallabag. Il ne pourra être restauré. Attention, aucune confirmation n'est demandée. + +### Partager vers twitter + +Partage le titre et le lien original de l'article sur twitter. + +### Partager par email + +Partage le titre et le lien original de l'article par email. + +### Imprimer l'article + +Ouvre la fenêtre d'impression du navigateur. + +### Convertir en ePub + +Convertit l'article au format ePub. [Un chapitre complet existe](Convertir_en_ePub.md). + +### Signaler que l'article s'affiche mal + +Permet de signaler qu'un article ne s'affiche pas comme attendu. [Un chapitre complet existe](Un_article_est_mal_affiche.md). diff --git a/docs/fr/Utilisateur/Rechercher.md b/docs/fr/Utilisateur/Rechercher.md new file mode 100644 index 00000000..2f84e075 --- /dev/null +++ b/docs/fr/Utilisateur/Rechercher.md @@ -0,0 +1,21 @@ +--- +language: Français +currentMenu: search +subTitle: Rechercher du contenu dans wallabag +--- + +# Rechercher du contenu dans wallabag + +Pour que vous puissiez retrouver un article au plus vite, nous avons mis en place un moteur de recherche complet. + +Cliquez sur **Rechercher** dans le menu de wallabag. Là, saisissez un terme de recherche. + +wallabag ira parcourir tous vos articles et affichera ceux qui contiennent le terme de recherche dans son titre, son contenu ou son URL. + +## Convertir cette recherche au format ePub + +Vous pouvez convertir les articles retournés au format ePub, pour les lire sur une liseuse par exemple. Lisez [Convertir en ePub](Convertir_en_ePub.md) pour en savoir plus. + +## Assigner un tag aux résultats de cette recherche + +Vous pouvez créer un tag en fonction du critère de recherche. Lisez [Classer ses articles](Classer_ses_articles.md) pour en savoir plus. diff --git a/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md b/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md new file mode 100644 index 00000000..e533f78f --- /dev/null +++ b/docs/fr/Utilisateur/Sauvegarder_son_premier_article.md @@ -0,0 +1,101 @@ +--- +language: Français +currentMenu: save_article +subTitle: Sauvegarder son premier article +--- + +# Sauvegarder son premier article + +Une fois connecté sur wallabag, vous avez plusieurs moyens pour sauvegarder un article. + +## Depuis l'application web + +Voyons d'abord comment faire depuis l'application web. Dans le menu, vous avez un lien **Sauvegarder un lien**. En cliquant dessus, un formulaire s'affiche : vous n'avez qu'à saisir l'adresse internet de l'article concerné. + +Validez et le contenu de l'article est enregistré. + +Par défaut, seul le texte est sauvegardé. Si vous souhaitez également conserver une copie des images sur votre serveur, il faut activer le paramètre `DOWNLOAD_PICTURES`. Lisez le chapitre [Les options cachées](../Administrateur/Options_cachees.md) pour en savoir plus. + +## Depuis le bookmarklet + +[Définition Wikipedia](http://fr.wikipedia.org/wiki/Bookmarklet) + + Un bookmarklet est un petit programme JavaScript pouvant être stocké : + * soit en tant qu'URL dans un signet (marque-page ou lien favori) avec la plupart des navigateurs Web ; + * soit en tant qu'hyperlien dans une page web. + +Depuis le menu de wallabag, cliquez sur **configuration**. Dans la première partie de cette page, nous avons listé les différents moyens de sauvegarder un article. Vous trouverez ainsi le bookmarklet (c'est le lien `bag it !`) à glisser / déposer dans la barre de favoris de votre navigateur. + +Dorénavant, lorsque vous souhaitez sauvegarder un article sur lequel vous êtes en train de surfer, vous n'avez qu'à cliquer sur ce bookmarklet et l'article sera automatiquement enregistré. + +## Depuis son smartphone +### Avant toute chose + +Pour pouvoir utiliser une application smartphone, vous devez activer les flux RSS depuis la partie **configuration** de wallabag. Certaines informations seront ainsi affichées, comme votre **token** (jeton de sécurité). Lisez le chapitre [Flux RSS](Flux_RSS.md) pour en savoir plus. + +### Android +#### Installation et configuration + +Vous pouvez télécharger l'application Android depuis le [Google Play Store](https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche) et depuis [F-droid](https://f-droid.org/app/fr.gaulupeau.apps.InThePoche). C'est exactement la même application sur ces deux plateformes de téléchargement. + +Une fois installée, démarrez l'application, rendez-vous dans la partie **settings** et renseignez les champs **URL** (Adresse complète de votre installation de wallabag ou de votre compte Framabag), **User ID** (très souvent, il vous faudra mettre 1 comme valeur). Si vous avez créé plusieurs comptes depuis wallabag, il faudra saisir l'identifiant du compte que vous souhaitez connecter à votre application) et **Token** (recopiez bien tous les caractères du token, disponible dans la **configuration** de wallabag). + +#### Sauvegarde d'un article + +Maintenant que tout est bien configuré, dès que vous naviguerez avec le navigateur de votre smartphone, vous pourrez à tout moment partager un article dans wallabag depuis le menu **Partager** : vous trouverez une entrée **Bag it!** qui ajoutera l'article dans wallabag. + +#### Lecture + +Lorsque vous ouvrez l'application, cliquez sur **Synchronize** : vos articles dernièrement sauvegardés seront ainsi téléchargés sur votre smartphone. + +Vous n'avez maintenant plus besoin de connexion internet : cliquez sur le bouton **List articles** pour commencer votre lecture. + +En bas de chaque article, un bouton **Mark as read** vous permet d'archiver l'article. + +Aujourd'hui, la synchronisation ne s'effectue que dans un sens (de wallabag vers l'application), ce qui empêche de marquer comme lu un article sur wallabag depuis votre smartphone. + +### iOS +#### Installation et configuration +TODO + +#### Utilisation +TODO + +### Windows Phone +#### Installation et configuration + +Vous pouvez télécharger l'application Windows Phone depuis le [Windows Store](http://www.windowsphone.com/fr-fr/store/app/wallabag/ff890514-348c-4d0b-9b43-153fff3f7450) ou directement dans le Store de votre smartphone. + +Une fois installée, l'application affichera une notification au premier lancement, demandant la configuration du serveur wallabag. Rendez-vous dans la partie **Configuration** de l'application en appuyant sur les 3 petits points du menu en bas de l'écran, puis renseignez les champs **URL** (Adresse complète de votre installation de wallabag ou de votre compte Framabag), **User ID** (très souvent, il vous faudra mettre 1 comme valeur). +Si vous avez créé plusieurs comptes depuis wallabag, il faudra saisir l'identifiant du compte que vous souhaitez connecter à votre application) et **Token** (recopiez bien tous les caractères du token, disponible dans la **configuration** de wallabag). +Enfin, sauvegardez les paramètres entrés. + +## Depuis son navigateur +### Extension Firefox classique + +Téléchargez l'extension Firefox [sur le site addons.mozilla.org](https://addons.mozilla.org/firefox/addon/wallabag/) et installez-la comme toute autre extension Firefox. + +Dans les préférences de l'extension, renseignez l'URL complète de votre installation de wallabag ou de votre compte Framabag. + +Personnalisez la barre d'outils de Firefox pour ajouter wallabag (icône `w`). Lorsque vous vous trouvez sur un article que vous souhaitez sauvegarder, cliquez sur cette icône : une nouvelle fenêtre s'ouvrira pour ajouter l'article et elle se refermera automatiquement. + +### Extension Mozilla Services (Social API) + +*Disponible uniquement à compter de wallabag 1.9.1* + +Avec les versions 29 et supérieures de Firefox, votre navigateur possède une interface intégrée permettant le partage direct vers de multiples réseaux sociaux. Dans l'interface de Firefox, elle est symbolisée par un icône en forme d'avion en papier que vous pourrez utiliser pour partager une page, ce qui signifie ici enregistrer un article dans wallabag. +Vous pouvez ajouter ce service depuis la page de configuration de wallabag en cliquant sur Extension Mozilla Services (Social API). Vous devez aussi accepter l'utilisation des Services Firefox. + +### Chrome + +Téléchargez l'extension Chrome [sur le site dédié](https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj) et installez-la comme toute autre extension Chrome. + +Dans les options de l'extension, renseignez l'URL complète de votre installation de wallabag ou de votre compte Framabag. + +Lors de l'installation de l'extension, une nouvelle icône est apparue dans la barre d'outils de Chrome, une icône `w`. Lorsque vous vous trouvez sur un article que vous souhaitez sauvegarder, cliquez sur cette icône : une popup s'ouvrira et vous confirmera que l'article a bien été sauvegardé. + +### Opera + +Les dernières versions d'Opera (15+) permettent d'installer des extensions compatibles avec Chrome. + +Il faut tout d'abord installer l'extension [Download Chrome Extensions](https://addons.opera.com/en/extensions/details/download-chrome-extension-9/) pour installer des extensions à partir du Chrome Web Store. Ensuite, on peut se rendre [sur le site de Google](https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj) et récupérer l'extension Chrome en cliquant sur *Add to Opera*. Vous obtiendrez un message qui vous invitera à confirmer l'action car l'extension ne provient pas d'une source approuvée. Le comportement sera ensuite le même que pour Chrome (ci-dessus). diff --git a/docs/fr/Utilisateur/Un_article_est_mal_affiche.md b/docs/fr/Utilisateur/Un_article_est_mal_affiche.md new file mode 100644 index 00000000..70b70cd4 --- /dev/null +++ b/docs/fr/Utilisateur/Un_article_est_mal_affiche.md @@ -0,0 +1,32 @@ +--- +language: Français +currentMenu: issue +subTitle: Mon article s'affiche mal dans wallabag +--- + +# Mon article s'affiche mal dans wallabag + +Si vous pensez que wallabag récupère mal le contenu d'un article (texte absent ou incomplet), nous vous proposons plusieurs possibilités. + +## Demande d'aide + +Que ça soit par mail ou via un ticket, n'oubliez pas de nous donner certaines informations qui sont importantes pour que nous puissions résoudre le problème au mieux : + +* l'URL de l'article concerné +* ce que wallabag affiche +* ce à quoi vous vous attendiez +* la version de wallabag ou alors si vous utilisez Framabag + +### Ouvrir un ticket sur github + +Pour ouvrir un nouveau ticket, il faut [aller sur github](https://github.com/wallabag/wallabag/issues/new). Un compte est nécessaire. +N'oubliez pas de nous envoyer les informations ci-dessus. + +### Nous envoyer un email + +Envoyez-nous un lien à l'adresse [hello@wallabag.org](mailto:hello@wallabag.org?subject=Mauvais%20affichage%20dans%20wallabag). +N'oubliez pas de nous envoyer les informations ci-dessus. + +## Résoudre ce problème d'affichage + +TODO \ No newline at end of file diff --git a/docs/fr/conf.py b/docs/fr/conf.py new file mode 100644 index 00000000..5c3657c0 --- /dev/null +++ b/docs/fr/conf.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +# +# wallabag documentation build configuration file, created by +# sphinx-quickstart on Fri Oct 16 06:47:23 2015. + +import sys +import os + +extensions = [] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +project = u'wallabag-fr' +copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence' +version = '2.0.0' +release = version +exclude_patterns = ['_build'] +pygments_style = 'sphinx' +html_theme = 'default' +html_static_path = ['_static'] +htmlhelp_basename = 'wallabagfrdoc' + +latex_elements = { +} + +latex_documents = [ + ('index', 'wallabag-fr.tex', u'wallabag Documentation', + u'Nicolas Lœuillet', 'manual'), +] + +man_pages = [ + ('index', 'wallabagfr', u'wallabag Documentation', + [u'Nicolas Lœuillet'], 1) +] + +texinfo_documents = [ + ('index', 'wallabagfr', u'wallabag Documentation', + u'Nicolas Lœuillet', 'wallabagfr', 'One line description of project.', + 'Miscellaneous'), +] + +##### Guzzle sphinx theme + +import guzzle_sphinx_theme +html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' +html_theme_path = guzzle_sphinx_theme.html_theme_path() +html_theme = 'guzzle_sphinx_theme' + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { + '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] +} + +# Register the theme as an extension to generate a sitemap.xml +extensions.append("guzzle_sphinx_theme") + +# Guzzle theme options (see theme.conf for more information) +html_theme_options = { + + # Set the path to a special layout to include for the homepage + # "index_template": "homepage.html", + + # Allow a separate homepage from the master_doc + # homepage = index + + # Set the name of the project to appear in the nav menu + # "project_nav_name": "Guzzle", + + # Set your Disqus short name to enable comments + # "disqus_comments_shortname": "my_disqus_comments_short_name", + + # Set you GA account ID to enable tracking + # "google_analytics_account": "my_ga_account", + + # Path to a touch icon + # "touch_icon": "", + + # Specify a base_url used to generate sitemap.xml links. If not + # specified, then no sitemap will be built. + #"base_url": "http://guzzlephp.org" + + # Allow the "Table of Contents" page to be defined separately from "master_doc" + # tocpage = Contents + + # Allow the project link to be overriden to a custom URL. + # projectlink = http://myproject.url +} diff --git a/docs/fr/index.rst b/docs/fr/index.rst new file mode 100644 index 00000000..c48bd7f2 --- /dev/null +++ b/docs/fr/index.rst @@ -0,0 +1,29 @@ +Documentation de wallabag +========================= + +**wallabag** est une application de lecture différée : elle permet +simplement d’archiver une page web en ne conservant que le contenu. Les +éléments superflus (menu, publicité, etc.) sont supprimés. + +Principales fonctionnalités +--------------------------- + +- tout le contenu est archivé : le texte et les photos +- l’application web est entièrement responsive +- vous pouvez convertir vos articles au format ePub pour les charger + sur votre liseuse +- des applications smartphones vous permettent de lire vos articles + tout en étant déconnecté +- des extensions pour votre navigateur vous permettent d'archiver + rapidement un nouvel article +- plusieurs thèmes graphiques vous permettent d'habiller votre + wallabag comme vous le souhaitez +- et forcément plein d’autres fonctionnalités ! + +Cette documentation est justement là pour faire découvrir toutes les +possibilités de wallabag. C’est parti ! + +.. toctree:: + :maxdepth: 2 + + index diff --git a/docs/fr/requirements.txt b/docs/fr/requirements.txt new file mode 100644 index 00000000..06fc8973 --- /dev/null +++ b/docs/fr/requirements.txt @@ -0,0 +1,2 @@ +Sphinx>=1.3.0,<1.4.0 +guzzle_sphinx_theme>=0.7.0,<0.8.0 diff --git a/docs/img/user/2FA_form.png b/docs/img/user/2FA_form.png new file mode 100644 index 00000000..69b4697d Binary files /dev/null and b/docs/img/user/2FA_form.png differ diff --git a/docs/img/user/activated_account.png b/docs/img/user/activated_account.png new file mode 100644 index 00000000..d1ecc3cc Binary files /dev/null and b/docs/img/user/activated_account.png differ diff --git a/docs/img/user/login_form.png b/docs/img/user/login_form.png new file mode 100644 index 00000000..fddfb35d Binary files /dev/null and b/docs/img/user/login_form.png differ diff --git a/docs/img/user/registration_form.png b/docs/img/user/registration_form.png new file mode 100644 index 00000000..127bf2a7 Binary files /dev/null and b/docs/img/user/registration_form.png differ diff --git a/docs/img/user/sent_email.png b/docs/img/user/sent_email.png new file mode 100644 index 00000000..0713a404 Binary files /dev/null and b/docs/img/user/sent_email.png differ diff --git a/docs/img/user/topbar.png b/docs/img/user/topbar.png new file mode 100644 index 00000000..e20d9fc6 Binary files /dev/null and b/docs/img/user/topbar.png differ diff --git a/docs/img/wallabag.png b/docs/img/wallabag.png new file mode 100644 index 00000000..2dada55d Binary files /dev/null and b/docs/img/wallabag.png differ -- cgit v1.2.3