mirror of
				https://github.com/searxng/searxng
				synced 2024-01-01 19:24:07 +01:00 
			
		
		
		
	docs: fix typos based on #653
This commit is contained in:
		
							parent
							
								
									d90e468769
								
							
						
					
					
						commit
						c2cf46092e
					
				
					 3 changed files with 116 additions and 114 deletions
				
			
		|  | @ -30,15 +30,17 @@ settings. However, the standard way is the following: | |||
| engine file | ||||
| ~~~~~~~~~~~ | ||||
| 
 | ||||
| +---------------------+-----------+-----------------------------------------+ | ||||
| | argument            | type      | information                             | | ||||
| +=====================+===========+=========================================+ | ||||
| | categories          | list      | pages, in which the engine is working   | | ||||
| +---------------------+-----------+-----------------------------------------+ | ||||
| | paging              | boolean   | support multible pages                  | | ||||
| +---------------------+-----------+-----------------------------------------+ | ||||
| | language\_support   | boolean   | support language choosing               | | ||||
| +---------------------+-----------+-----------------------------------------+ | ||||
| +----------------------+-----------+-----------------------------------------+ | ||||
| | argument             | type      | information                             | | ||||
| +======================+===========+=========================================+ | ||||
| | categories           | list      | pages, in which the engine is working   | | ||||
| +----------------------+-----------+-----------------------------------------+ | ||||
| | paging               | boolean   | support multible pages                  | | ||||
| +----------------------+-----------+-----------------------------------------+ | ||||
| | language\_support    | boolean   | support language choosing               | | ||||
| +----------------------+-----------+-----------------------------------------+ | ||||
| | time\_range\_support | boolean   | support search time range               | | ||||
| +----------------------+-----------+-----------------------------------------+ | ||||
| 
 | ||||
| settings.yml | ||||
| ~~~~~~~~~~~~ | ||||
|  | @ -186,126 +188,126 @@ To set another media-type as default, the parameter | |||
| default | ||||
| ~~~~~~~ | ||||
| 
 | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                                        | | ||||
| +====================+====================================================================================================================================+ | ||||
| | url                | string, which is representing the url of the result                                                                                | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, which is representing the title of the result                                                                              | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content            | string, which is giving a general result-text                                                                                      | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                   | | ||||
| +====================+===============================================================================================================+ | ||||
| | url                | string, url of the result                                                                                     | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, title of the result                                                                                   | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------+ | ||||
| | content            | string, general result-text                                                                                   | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish     | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------+ | ||||
| 
 | ||||
| images | ||||
| ~~~~~~ | ||||
| 
 | ||||
| to use this template, the parameter | ||||
| 
 | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                                                               | | ||||
| +====================+===========================================================================================================================================================+ | ||||
| | template           | is set to ``images.html``                                                                                                                                 | | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | url                | string, which is representing the url to the result site                                                                                                  | | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, which is representing the title of the result *(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)*   | | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | img\_src           | string, which is representing the url to the result image                                                                                                 | | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | thumbnail\_src     | string, which is representing the url to a small-preview image                                                                                            | | ||||
| +--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                                           | | ||||
| +====================+=======================================================================================================================================+ | ||||
| | template           | is set to ``images.html``                                                                                                             | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | url                | string, url to the result site                                                                                                        | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, title of the result *(partly implemented)*                                                                                    | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content            | *(partly implemented)*                                                                                                                | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)*      | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | img\_src           | string, url to the result image                                                                                                       | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | thumbnail\_src     | string, url to a small-preview image                                                                                                  | | ||||
| +--------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| 
 | ||||
| videos | ||||
| ~~~~~~ | ||||
| 
 | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                                        | | ||||
| +====================+====================================================================================================================================+ | ||||
| | template           | is set to ``videos.html``                                                                                                          | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | url                | string, which is representing the url of the result                                                                                | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, which is representing the title of the result                                                                              | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content            | *(not implemented yet)*                                                                                                            | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | thumbnail          | string, which is representing the url to a small-preview image                                                                     | | ||||
| +--------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter   | information                                                                                                  | | ||||
| +====================+==============================================================================================================+ | ||||
| | template           | is set to ``videos.html``                                                                                    | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | url                | string, url of the result                                                                                    | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | title              | string, title of the result                                                                                  | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | content            | *(not implemented yet)*                                                                                      | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | thumbnail          | string, url to a small-preview image                                                                         | | ||||
| +--------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| 
 | ||||
| torrent | ||||
| ~~~~~~~ | ||||
| 
 | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter | information                                                                                                                                              | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | template         | is set to ```torrent.html```                                                                                                                             | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | url              | string, which is representing the url of the result                                                                                                      | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title            | string, which is representing the title of the result                                                                                                    | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content          | string, which is giving a 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)* | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | seed             | int, number of seeder                                                                                                                                    | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | leech            | int, number of leecher                                                                                                                                   | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | filesize         | int, size of file in bytes                                                                                                                               | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | files            | int, number of files                                                                                                                                     | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | magnetlink       | string, which is the `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                      | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | torrentfile      | string, which is the torrentfile of the result                                                                                                           | | ||||
| +------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter | information                                                                                                                           | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | template         | is set to ``torrent.html``                                                                                                            | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | url              | string, url of the result                                                                                                             | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title            | string, title of the result                                                                                                           | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content          | string, general result-text                                                                                                           | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)*     | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | seed             | int, number of seeder                                                                                                                 | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | leech            | int, number of leecher                                                                                                                | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | filesize         | int, size of file in bytes                                                                                                            | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | files            | int, number of files                                                                                                                  | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | magnetlink       | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | torrentfile      | string, torrentfile of the result                                                                                                     | | ||||
| +------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| 
 | ||||
| 
 | ||||
| map | ||||
| ~~~ | ||||
| 
 | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter        | information                                                                                                                        | | ||||
| +=========================+====================================================================================================================================+ | ||||
| | url                     | string, which is representing the url of the result                                                                                | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | title                   | string, which is representing the title of the result                                                                              | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | content                 | string, which is giving a general result-text                                                                                      | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | latitude                | latitude 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]``)                                                | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | geojson                 | geojson of result (http://geojson.org)                                                                                             | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | osm.type                | type of osm-object (if OSM-Result)                                                                                                 | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | osm.id                  | id of osm-object (if OSM-Result)                                                                                                   | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.name            | name of object                                                                                                                     | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.road            | street adress of object                                                                                                            | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.house\_number   | house number of object                                                                                                             | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.locality        | city, place of object                                                                                                              | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.postcode        | postcode of object                                                                                                                 | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| | address.country         | country of object                                                                                                                  | | ||||
| +-------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | result-parameter        | information                                                                                                  | | ||||
| +=========================+==============================================================================================================+ | ||||
| | url                     | string, url of the result                                                                                    | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | title                   | string, title of the result                                                                                  | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | content                 | string, general result-text                                                                                  | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | latitude                | latitude 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]``)                          | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | geojson                 | geojson of result (http://geojson.org)                                                                       | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | osm.type                | type of osm-object (if OSM-Result)                                                                           | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | osm.id                  | id of osm-object (if OSM-Result)                                                                             | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.name            | name of object                                                                                               | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.road            | street name of object                                                                                        | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.house\_number   | house number of object                                                                                       | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.locality        | city, place of object                                                                                        | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.postcode        | postcode of object                                                                                           | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| | address.country         | country of object                                                                                            | | ||||
| +-------------------------+--------------------------------------------------------------------------------------------------------------+ | ||||
| 
 | ||||
|  |  | |||
|  | @ -11,7 +11,7 @@ Example plugin | |||
| 
 | ||||
|     name = 'Example plugin' | ||||
|     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 | ||||
|     css_dependencies = tuple()  # optional, list of static css files | ||||
|  |  | |||
|  | @ -16,7 +16,7 @@ Features | |||
|  - No user tracking | ||||
|  - No user profiling | ||||
|  - About 70 supported search engines | ||||
|  - Easy intergration with any search engines | ||||
|  - Easy integration with any search engine | ||||
|  - Cookies are not used by default | ||||
|  - Secure, encrypted connections (HTTPS/SSL) | ||||
|  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights | ||||
|  |  | |||
		Loading…
	
	Add table
		
		Reference in a new issue
	
	 Noémi Ványi
						Noémi Ványi