@@ -37,15 +37,16 @@ settings. However, the standard way is the following:
3737engine file
3838-----------
3939
40−======================= =========== ===========================================
40+======================= =========== ========================================================
4141argument type information
42−======================= =========== ===========================================
42+======================= =========== ========================================================
4343categories list pages, in which the engine is working
4444paging boolean support multible pages
4545language_support boolean support language choosing
4646time_range_support boolean support search time range
47−engine_type str ``online`` by default, ``offline``
48−======================= =========== ===========================================
47+engine_type str ``online`` by default, other possibles values are
48+ ``offline``, ``online_dictionnary``, ``online_currency``
49+======================= =========== ========================================================
4950
5051.. _engine settings:
5152
@@ -111,22 +112,49 @@ passed arguments
111112These arguments can be used to construct the search query. Furthermore,
112113parameters with default value can be redefined for special purposes.
113114
115+If the ``engine_type`` is ``online```:
116+
117+====================== ============== ========================================================================
118+argument type default-value, information
119+====================== ============== ========================================================================
120+url str ``''``
121+method str ``'GET'``
122+headers set ``{}``
123+data set ``{}``
124+cookies set ``{}``
125+verify bool ``True``
126+headers.User-Agent str a random User-Agent
127+category str current category, like ``'general'``
128+safesearch int ``0``, between ``0`` and ``2`` (normal, moderate, strict)
129+time_range Optional[str] ``None``, can be ``day``, ``week``, ``month``, ``year``
130+pageno int current pagenumber
131+language str specific language code like ``'en_US'``, or ``'all'`` if unspecified
132+====================== ============== ========================================================================
133+
134+
135+If the ``engine_type`` is ``online_dictionnary```, in addition to the ``online`` arguments:
136+
114137====================== ============ ========================================================================
115138argument type default-value, information
116139====================== ============ ========================================================================
117−url string ``''``
118−method string ``'GET'``
119−headers set ``{}``
120−data set ``{}``
121−cookies set ``{}``
122−verify boolean ``True``
123−headers.User-Agent string a random User-Agent
124−category string current category, like ``'general'``
125−started datetime current date-time
126−pageno int current pagenumber
127−language string specific language code like ``'en_US'``, or ``'all'`` if unspecified
140+from_lang str specific language code like ``'en_US'``
141+to_lang str specific language code like ``'en_US'``
142+query str the text query without the languages
128143====================== ============ ========================================================================
129144
145+If the ``engine_type`` is ``online_currency```, in addition to the ``online`` arguments:
146+
147+====================== ============ ========================================================================
148+argument type default-value, information
149+====================== ============ ========================================================================
150+amount float the amount to convert
151+from str ISO 4217 code
152+to str ISO 4217 code
153+from_name str currency name
154+to_name str currency name
155+====================== ============ ========================================================================
156+
157+
130158parsed arguments
131159----------------
132160
@@ -137,12 +165,12 @@ request:
137165=================== =========== ==========================================================================
138166argument type information
139167=================== =========== ==========================================================================
140−url string requested url
141−method string HTTP request method
168+url str requested url
169+method str HTTP request method
142170headers set HTTP header information
143−data set HTTP data information (parsed if ``method != 'GET'``)
171+data set HTTP data information
144172cookies set HTTP cookies
145−verify boolean Performing SSL-Validity check
173+verify bool Performing SSL-Validity check
146174max_redirects int maximum redirects, hard limit
147175soft_max_redirects int maximum redirects, soft limit. Record an error but don't stop the engine
148176raise_for_httperror bool True by default: raise an exception if the HTTP code of response is >= 300