ZaclysIndustries
/
searxngRebrandZaclys
forked from zaclys/searxng
2
0
Fork 0
Code Issues Pull Requests Activity
searxngRebrandZaclys/docs/user/search_syntax.rst

43 lines
1012 B
ReStructuredText
Raw Normal View History

doc: proofread of the all reST sources (no content change) Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 18:20:56 +00:00
.. _search-syntax:
=============
[enh] initial structure
2015-11-17 22:13:30 +00:00
Search syntax
=============
doc: proofread of the all reST sources (no content change) Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 18:20:56 +00:00
Searx allows you to modify the default categories, engines and search language
via the search query.
[enh] initial structure
2015-11-17 22:13:30 +00:00
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
Prefix ``!``
to set Category/engine
[enh] initial structure
2015-11-17 22:13:30 +00:00
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
Prefix: ``:``
to set language
[enh] initial structure
2015-11-17 22:13:30 +00:00
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
Prefix: ``?``
to add engines and categories to the currently selected categories
[enh] initial structure
2015-11-17 22:13:30 +00:00
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
Abbrevations of the engines and languages are also accepted. Engine/category
modifiers are chainable and inclusive (e.g. with :search:`!it !ddg !wp qwer
<?q=%21it%20%21ddg%20%21wp%20qwer>` search in IT category **and** duckduckgo
**and** wikipedia for ``qwer``).
[enh] initial structure
2015-11-17 22:13:30 +00:00
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
See the :search:`/preferences page <preferences>` for the list of engines,
categories and languages.
[enh] initial structure
2015-11-17 22:13:30 +00:00
Examples
doc: proofread of the all reST sources (no content change) Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 18:20:56 +00:00
========
[enh] initial structure
2015-11-17 22:13:30 +00:00
Search in wikipedia for ``qwer``:
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
- :search:`!wp qwer <?q=%21wp%20qwer>` or
- :search:`!wikipedia qwer :search:<?q=%21wikipedia%20qwer>`
[enh] initial structure
2015-11-17 22:13:30 +00:00
Image search:
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
- :search:`!images Cthulhu <?q=%21images%20Cthulhu>`
[enh] initial structure
2015-11-17 22:13:30 +00:00
Custom language in wikipedia:
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-04 15:48:36 +00:00
- :search:`:hu !wp hackerspace <?q=%3Ahu%20%21wp%20hackerspace>`