on master help sign in
docs: fix typos based on #653
commitc2cf46092e7e805587fde191ea9c620ee2bcb158 authorNoémi Ványi <sitbackandwait@gmail.com> dateFri 4 Nov 2016, 18:38 (10 years ago) parentd90e468
3 files changed+116−114
docs/dev/engine_overview.rst+114−112 docs/dev/plugins.rst+1−1 docs/index.rst+1−1
docs/dev/engine_overview.rst+114−112
@@ -30,15 +30,17 @@ settings. However, the standard way is the following:
3030engine file
3131~~~~~~~~~~~
3232
33−+---------------------+-----------+-----------------------------------------+
34−| argument | type | information |
35−+=====================+===========+=========================================+
36−| categories | list | pages, in which the engine is working |
37−+---------------------+-----------+-----------------------------------------+
38−| paging | boolean | support multible pages |
39−+---------------------+-----------+-----------------------------------------+
40−| language\_support | boolean | support language choosing |
41−+---------------------+-----------+-----------------------------------------+
33++----------------------+-----------+-----------------------------------------+
34+| argument | type | information |
35++======================+===========+=========================================+
36+| categories | list | pages, in which the engine is working |
37++----------------------+-----------+-----------------------------------------+
38+| paging | boolean | support multible pages |
39++----------------------+-----------+-----------------------------------------+
40+| language\_support | boolean | support language choosing |
41++----------------------+-----------+-----------------------------------------+
42+| time\_range\_support | boolean | support search time range |
43++----------------------+-----------+-----------------------------------------+
4244
4345settings.yml
4446~~~~~~~~~~~~
@@ -186,126 +188,126 @@ To set another media-type as default, the parameter
186188default
187189~~~~~~~
188190
189−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
190−| result-parameter | information |
191−+====================+====================================================================================================================================+
192−| url | string, which is representing the url of the result |
193−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
194−| title | string, which is representing the title of the result |
195−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
196−| content | string, which is giving a general result-text |
197−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
198−| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published |
199−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
191++--------------------+---------------------------------------------------------------------------------------------------------------+
192+| result-parameter | information |
193++====================+===============================================================================================================+
194+| url | string, url of the result |
195++--------------------+---------------------------------------------------------------------------------------------------------------+
196+| title | string, title of the result |
197++--------------------+---------------------------------------------------------------------------------------------------------------+
198+| content | string, general result-text |
199++--------------------+---------------------------------------------------------------------------------------------------------------+
200+| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
201++--------------------+---------------------------------------------------------------------------------------------------------------+
200202
201203images
202204~~~~~~
203205
204206to use this template, the parameter
205207
206−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
207−| result-parameter | information |
208−+====================+===========================================================================================================================================================+
209−| template | is set to ``images.html`` |
210−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
211−| url | string, which is representing the url to the result site |
212−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
213−| title | string, which is representing the title of the result *(partly implemented)* |
214−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
215−| content | *(partly implemented)* |
216−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
217−| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(partly implemented)* |
218−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
219−| img\_src | string, which is representing the url to the result image |
220−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
221−| thumbnail\_src | string, which is representing the url to a small-preview image |
222−+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
208++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
209+| result-parameter | information |
210++====================+=======================================================================================================================================+
211+| template | is set to ``images.html`` |
212++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
213+| url | string, url to the result site |
214++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
215+| title | string, title of the result *(partly implemented)* |
216++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
217+| content | *(partly implemented)* |
218++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
219+| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)* |
220++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
221+| img\_src | string, url to the result image |
222++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223+| thumbnail\_src | string, url to a small-preview image |
224++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223225
224226videos
225227~~~~~~
226228
227−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
228−| result-parameter | information |
229−+====================+====================================================================================================================================+
230−| template | is set to ``videos.html`` |
231−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
232−| url | string, which is representing the url of the result |
233−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
234−| title | string, which is representing the title of the result |
235−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
236−| content | *(not implemented yet)* |
237−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
238−| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published |
239−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
240−| thumbnail | string, which is representing the url to a small-preview image |
241−+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
229++--------------------+--------------------------------------------------------------------------------------------------------------+
230+| result-parameter | information |
231++====================+==============================================================================================================+
232+| template | is set to ``videos.html`` |
233++--------------------+--------------------------------------------------------------------------------------------------------------+
234+| url | string, url of the result |
235++--------------------+--------------------------------------------------------------------------------------------------------------+
236+| title | string, title of the result |
237++--------------------+--------------------------------------------------------------------------------------------------------------+
238+| content | *(not implemented yet)* |
239++--------------------+--------------------------------------------------------------------------------------------------------------+
240+| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
241++--------------------+--------------------------------------------------------------------------------------------------------------+
242+| thumbnail | string, url to a small-preview image |
243++--------------------+--------------------------------------------------------------------------------------------------------------+
242244
243245torrent
244246~~~~~~~
245247
246−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
247−| result-parameter | information |
248−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
249−| template | is set to ```torrent.html``` |
250−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
251−| url | string, which is representing the url of the result |
252−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
253−| title | string, which is representing the title of the result |
254−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
255−| content | string, which is giving a general result-text |
256−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
257−| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(not implemented yet)* |
258−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
259−| seed | int, number of seeder |
260−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
261−| leech | int, number of leecher |
262−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
263−| filesize | int, size of file in bytes |
264−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
265−| files | int, number of files |
266−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
267−| magnetlink | string, which is the `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result |
268−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
269−| torrentfile | string, which is the torrentfile of the result |
270−+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
248++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
249+| result-parameter | information |
250++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
251+| template | is set to ``torrent.html`` |
252++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
253+| url | string, url of the result |
254++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
255+| title | string, title of the result |
256++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
257+| content | string, general result-text |
258++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
259+| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)* |
260++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
261+| seed | int, number of seeder |
262++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
263+| leech | int, number of leecher |
264++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
265+| filesize | int, size of file in bytes |
266++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
267+| files | int, number of files |
268++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
269+| magnetlink | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result |
270++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271+| torrentfile | string, torrentfile of the result |
272++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271273
272274
273275map
274276~~~
275277
276−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
277−| result-parameter | information |
278−+=========================+====================================================================================================================================+
279−| url | string, which is representing the url of the result |
280−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
281−| title | string, which is representing the title of the result |
282−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
283−| content | string, which is giving a general result-text |
284−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
285−| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published |
286−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
287−| latitude | latitude of result (in decimal format) |
288−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
289−| longitude | longitude of result (in decimal format) |
290−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
291−| boundingbox | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``) |
292−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
293−| geojson | geojson of result (http://geojson.org) |
294−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
295−| osm.type | type of osm-object (if OSM-Result) |
296−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
297−| osm.id | id of osm-object (if OSM-Result) |
298−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
299−| address.name | name of object |
300−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
301−| address.road | street adress of object |
302−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
303−| address.house\_number | house number of object |
304−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
305−| address.locality | city, place of object |
306−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
307−| address.postcode | postcode of object |
308−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
309−| address.country | country of object |
310−+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
278++-------------------------+--------------------------------------------------------------------------------------------------------------+
279+| result-parameter | information |
280++=========================+==============================================================================================================+
281+| url | string, url of the result |
282++-------------------------+--------------------------------------------------------------------------------------------------------------+
283+| title | string, title of the result |
284++-------------------------+--------------------------------------------------------------------------------------------------------------+
285+| content | string, general result-text |
286++-------------------------+--------------------------------------------------------------------------------------------------------------+
287+| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
288++-------------------------+--------------------------------------------------------------------------------------------------------------+
289+| latitude | latitude of result (in decimal format) |
290++-------------------------+--------------------------------------------------------------------------------------------------------------+
291+| longitude | longitude of result (in decimal format) |
292++-------------------------+--------------------------------------------------------------------------------------------------------------+
293+| boundingbox | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``) |
294++-------------------------+--------------------------------------------------------------------------------------------------------------+
295+| geojson | geojson of result (http://geojson.org) |
296++-------------------------+--------------------------------------------------------------------------------------------------------------+
297+| osm.type | type of osm-object (if OSM-Result) |
298++-------------------------+--------------------------------------------------------------------------------------------------------------+
299+| osm.id | id of osm-object (if OSM-Result) |
300++-------------------------+--------------------------------------------------------------------------------------------------------------+
301+| address.name | name of object |
302++-------------------------+--------------------------------------------------------------------------------------------------------------+
303+| address.road | street name of object |
304++-------------------------+--------------------------------------------------------------------------------------------------------------+
305+| address.house\_number | house number of object |
306++-------------------------+--------------------------------------------------------------------------------------------------------------+
307+| address.locality | city, place of object |
308++-------------------------+--------------------------------------------------------------------------------------------------------------+
309+| address.postcode | postcode of object |
310++-------------------------+--------------------------------------------------------------------------------------------------------------+
311+| address.country | country of object |
312++-------------------------+--------------------------------------------------------------------------------------------------------------+
311313
docs/dev/plugins.rst+1−1
@@ -11,7 +11,7 @@ Example plugin
1111
1212 name = 'Example plugin'
1313 description = 'This plugin extends the suggestions with the word "example"'
14− default_on = False # disable by default
14+ default_on = False # disabled by default
1515
1616 js_dependencies = tuple() # optional, list of static js files
1717 css_dependencies = tuple() # optional, list of static css files
docs/index.rst+1−1
@@ -16,7 +16,7 @@ Features
1616 - No user tracking
1717 - No user profiling
1818 - About 70 supported search engines
19− - Easy intergration with any search engines
19+ - Easy integration with any search engine
2020 - Cookies are not used by default
2121 - Secure, encrypted connections (HTTPS/SSL)
2222 - Hosted by organisations, such as La Quadrature du Net, which promote digital rights