aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/conf.py4
-rw-r--r--docs/en/user/configuration.rst27
-rw-r--r--docs/en/user/import.rst19
-rw-r--r--docs/en/user/installation.rst2
-rw-r--r--docs/en/user/upgrade.rst2
5 files changed, 30 insertions, 24 deletions
diff --git a/docs/en/conf.py b/docs/en/conf.py
index 717b35f1..5926f8c9 100644
--- a/docs/en/conf.py
+++ b/docs/en/conf.py
@@ -11,8 +11,8 @@ templates_path = ['_templates']
11source_suffix = '.rst' 11source_suffix = '.rst'
12master_doc = 'index' 12master_doc = 'index'
13project = u'wallabag' 13project = u'wallabag'
14copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' 14copyright = u'2013-2017, Nicolas Lœuillet - MIT Licence'
15version = '2.1.0' 15version = '2.3.0'
16release = version 16release = version
17exclude_patterns = ['_build'] 17exclude_patterns = ['_build']
18pygments_style = 'sphinx' 18pygments_style = 'sphinx'
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index bba12cb9..0f3ac38f 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -116,16 +116,17 @@ Which variables and operators can I use to write rules?
116 116
117The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): 117The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``):
118 118
119=========== ============================================== ======== ========== 119=========== ============================================== ========== ==========
120Variable Meaning Operator Meaning 120Variable Meaning Operator Meaning
121----------- ---------------------------------------------- -------- ---------- 121----------- ---------------------------------------------- ---------- ----------
122title Title of the entry <= Less than… 122title Title of the entry <= Less than…
123url URL of the entry < Strictly less than… 123url URL of the entry < Strictly less than…
124isArchived Whether the entry is archived or not => Greater than… 124isArchived Whether the entry is archived or not => Greater than…
125isStarred Whether the entry is starred or not > Strictly greater than… 125isStarred Whether the entry is starred or not > Strictly greater than…
126content The entry's content = Equal to… 126content The entry's content = Equal to…
127language The entry's language != Not equal to… 127language The entry's language != Not equal to…
128mimetype The entry's mime-type OR One rule or another 128mimetype The entry's mime-type OR One rule or another
129readingTime The estimated entry's reading time, in minutes AND One rule and another 129readingTime The estimated entry's reading time, in minutes AND One rule and another
130domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" 130domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football"
131=========== ============================================== ======== ========== 131 notmatches Tests that a subject is not matches a search (case-insensitive). Example: title notmatches "football"
132=========== ============================================== ========== ==========
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index f420a131..f6aaa373 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -77,7 +77,7 @@ From Instapaper
77--------------- 77---------------
78 78
79Export your Instapaper data 79Export your Instapaper data
80~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 80~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 81
82On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). 82On the settings (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``).
83 83
@@ -102,7 +102,7 @@ If you were using wallabag v1.x, you need to export your data before migrating t
102 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. 102 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
103 103
104.. note:: 104.. note::
105 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. 105 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://gitter.im/wallabag/wallabag>`__.
106 106
107When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__. 107When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
108 108
@@ -124,7 +124,7 @@ From the previous wallabag instance on which you were before, go to `All article
124From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. 124From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it.
125 125
126.. note:: 126.. note::
127 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. 127 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://gitter.im/wallabag/wallabag>`__.
128 128
129Import via command-line interface (CLI) 129Import via command-line interface (CLI)
130--------------------------------------- 130---------------------------------------
@@ -133,16 +133,21 @@ If you have a CLI access on your web server, you can execute this command to imp
133 133
134:: 134::
135 135
136 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod 136 bin/console wallabag:import username ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
137 137
138Please replace values: 138Please replace values:
139 139
140* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) 140* ``username`` is the user's username
141* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export 141* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
142 142
143If you want to mark all these entries as read, you can add the ``--markAsRead`` option. 143.. note::
144 If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
144 145
145To import a wallabag v2 file, you need to add the option ``--importer=v2``. 146.. note::
147 To import a wallabag v2 file, you need to add the option ``--importer=v2``.
148
149.. note::
150 If you want to pass the user id of the user instead of it's username, add the option ``--useUserId=true``.
146 151
147You'll have this in return: 152You'll have this in return:
148 153
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 81c563f0..f1146b49 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -87,7 +87,7 @@ Execute this command to download and extract the latest package:
87 87
88 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package 88 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
89 89
90You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. 90You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_.
91 91
92Now, read the following documentation to create your virtual host, then access your wallabag. 92Now, read the following documentation to create your virtual host, then access your wallabag.
93If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. 93If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index b4635075..359a355f 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -67,7 +67,7 @@ Download the last release of wallabag:
67 67
68 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 68 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
69 69
70You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. 70You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_.
71 71
72Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 72Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
73 73