OwlBurst/Ponysearch
1
0
Fork 0
forked from Ponysearch/Ponysearch
Code Pull requests Activity

docs: fix typos based on #653

Browse source
This commit is contained in:
Noémi Ványi 2016-11-04 18:38:07 +01:00
parent d90e468769
commit c2cf46092e
3 changed files with 116 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

226
docs/dev/engine_overview.rst
View file

@ -30,15 +30,17 @@ settings. However, the standard way is the following:
engine file engine file
~~~~~~~~~~~ ~~~~~~~~~~~
+---------------------+-----------+-----------------------------------------+ +----------------------+-----------+-----------------------------------------+
| argument | type | information | | argument | type | information |
+=====================+===========+=========================================+ +======================+===========+=========================================+
| categories | list | pages, in which the engine is working | | categories | list | pages, in which the engine is working |
+---------------------+-----------+-----------------------------------------+ +----------------------+-----------+-----------------------------------------+
| paging | boolean | support multible pages | | paging | boolean | support multible pages |
+---------------------+-----------+-----------------------------------------+ +----------------------+-----------+-----------------------------------------+
| language\_support | boolean | support language choosing | | language\_support | boolean | support language choosing |
+---------------------+-----------+-----------------------------------------+ +----------------------+-----------+-----------------------------------------+
| time\_range\_support | boolean | support search time range |
+----------------------+-----------+-----------------------------------------+
settings.yml settings.yml
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -186,126 +188,126 @@ To set another media-type as default, the parameter
default default
~~~~~~~ ~~~~~~~
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------+
| result-parameter | information | | result-parameter | information |
+====================+====================================================================================================================================+ +====================+===============================================================================================================+
| url | string, which is representing the url of the result | | url | string, url of the result |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------+
| title | string, which is representing the title of the result | | title | string, title of the result |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------+
| content | string, which is giving a general result-text | | content | string, general result-text |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------+
| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published | | publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------+
images images
~~~~~~ ~~~~~~
to use this template, the parameter to use this template, the parameter
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| result-parameter | information | | result-parameter | information |
+====================+===========================================================================================================================================================+ +====================+=======================================================================================================================================+
| template | is set to ``images.html`` | | template | is set to ``images.html`` |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| url | string, which is representing the url to the result site | | url | string, url to the result site |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| title | string, which is representing the title of the result *(partly implemented)* | | title | string, title of the result *(partly implemented)* |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| content | *(partly implemented)* | | content | *(partly implemented)* |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(partly implemented)* | | publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)* |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| img\_src | string, which is representing the url to the result image | | img\_src | string, url to the result image |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| thumbnail\_src | string, which is representing the url to a small-preview image | | thumbnail\_src | string, url to a small-preview image |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
videos videos
~~~~~~ ~~~~~~
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| result-parameter | information | | result-parameter | information |
+====================+====================================================================================================================================+ +====================+==============================================================================================================+
| template | is set to ``videos.html`` | | template | is set to ``videos.html`` |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| url | string, which is representing the url of the result | | url | string, url of the result |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| title | string, which is representing the title of the result | | title | string, title of the result |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| content | *(not implemented yet)* | | content | *(not implemented yet)* |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published | | publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
| thumbnail | string, which is representing the url to a small-preview image | | thumbnail | string, url to a small-preview image |
+--------------------+------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+--------------------------------------------------------------------------------------------------------------+
torrent torrent
~~~~~~~ ~~~~~~~
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| result-parameter | information | | result-parameter | information |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| template | is set to ```torrent.html``` | | template | is set to ``torrent.html`` |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| url | string, which is representing the url of the result | | url | string, url of the result |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| title | string, which is representing the title of the result | | title | string, title of the result |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| content | string, which is giving a general result-text | | content | string, general result-text |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(not implemented yet)* | | publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)* |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| seed | int, number of seeder | | seed | int, number of seeder |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| leech | int, number of leecher | | leech | int, number of leecher |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| filesize | int, size of file in bytes | | filesize | int, size of file in bytes |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| files | int, number of files | | files | int, number of files |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| magnetlink | string, which is the `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result | | magnetlink | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| torrentfile | string, which is the torrentfile of the result | | torrentfile | string, torrentfile of the result |
+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+---------------------------------------------------------------------------------------------------------------------------------------+
map map
~~~ ~~~
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| result-parameter | information | | result-parameter | information |
+=========================+====================================================================================================================================+ +=========================+==============================================================================================================+
| url | string, which is representing the url of the result | | url | string, url of the result |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| title | string, which is representing the title of the result | | title | string, title of the result |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| content | string, which is giving a general result-text | | content | string, general result-text |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published | | publishedDate | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| latitude | latitude of result (in decimal format) | | latitude | latitude of result (in decimal format) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| longitude | longitude of result (in decimal format) | | longitude | longitude of result (in decimal format) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| boundingbox | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``) | | boundingbox | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| geojson | geojson of result (http://geojson.org) | | geojson | geojson of result (http://geojson.org) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| osm.type | type of osm-object (if OSM-Result) | | osm.type | type of osm-object (if OSM-Result) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| osm.id | id of osm-object (if OSM-Result) | | osm.id | id of osm-object (if OSM-Result) |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.name | name of object | | address.name | name of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.road | street adress of object | | address.road | street name of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.house\_number | house number of object | | address.house\_number | house number of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.locality | city, place of object | | address.locality | city, place of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.postcode | postcode of object | | address.postcode | postcode of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+
| address.country | country of object | | address.country | country of object |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+--------------------------------------------------------------------------------------------------------------+

2
docs/dev/plugins.rst
View file

@ -11,7 +11,7 @@ Example plugin
name = 'Example plugin' name = 'Example plugin'
description = 'This plugin extends the suggestions with the word "example"' description = 'This plugin extends the suggestions with the word "example"'
default_on = False # disable by default default_on = False # disabled by default
js_dependencies = tuple() # optional, list of static js files js_dependencies = tuple() # optional, list of static js files
css_dependencies = tuple() # optional, list of static css files css_dependencies = tuple() # optional, list of static css files

2
docs/index.rst
View file

@ -16,7 +16,7 @@ Features
- No user tracking - No user tracking
- No user profiling - No user profiling
- About 70 supported search engines - About 70 supported search engines
- Easy intergration with any search engines - Easy integration with any search engine
- Cookies are not used by default - Cookies are not used by default
- Secure, encrypted connections (HTTPS/SSL) - Secure, encrypted connections (HTTPS/SSL)
- Hosted by organisations, such as La Quadrature du Net, which promote digital rights - Hosted by organisations, such as La Quadrature du Net, which promote digital rights