summaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2019-12-04 16:48:36 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2019-12-12 12:39:38 +0100
commitaf2cae6d1d71859e867a9fbc5da604ef6a898794 (patch)
tree648bcb7d4e23ad3a39696fad2585357f0c94dbd6 /docs/user
parent25fa7da6c8276ed8958793e1b88071eab6b413f5 (diff)
downloadsearxng-af2cae6d1d71859e867a9fbc5da604ef6a898794.tar.gz
searxng-af2cae6d1d71859e867a9fbc5da604ef6a898794.zip
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>
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/search_syntax.rst33
1 files changed, 19 insertions, 14 deletions
diff --git a/docs/user/search_syntax.rst b/docs/user/search_syntax.rst
index af26ea83c..90f901ba7 100644
--- a/docs/user/search_syntax.rst
+++ b/docs/user/search_syntax.rst
@@ -4,30 +4,35 @@ Search syntax
Searx allows you to modify the default categories, engines and search
language via the search query.
-Category/engine prefix: ``!``
+Prefix ``!``
+ to set Category/engine
-Language prefix: ``:``
+Prefix: ``:``
+ to set language
-Prefix to add engines and categories to the currently selected
-categories: ``?``
+Prefix: ``?``
+ to add engines and categories to the currently selected categories
-Abbrevations of the engines and languages are also accepted.
-Engine/category modifiers are chainable and inclusive (e.g. with
-`!it !ddg !wp qwer <https://searx.me/?q=%21it%20%21ddg%20%21wp%20qwer>`_
-search in IT category **and** duckduckgo **and** wikipedia for ``qwer``).
+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``).
-See the `/preferences page <https://searx.me/preferences>`_ for the
-list of engines, categories and languages.
+See the :search:`/preferences page <preferences>` for the list of engines,
+categories and languages.
Examples
~~~~~~~~
Search in wikipedia for ``qwer``:
-`!wp qwer <https://searx.me/?q=%21wp%20qwer>`__ or
-`!wikipedia qwer <https://searx.me/?q=%21wikipedia%20qwer>`_
+
+- :search:`!wp qwer <?q=%21wp%20qwer>` or
+- :search:`!wikipedia qwer :search:<?q=%21wikipedia%20qwer>`
Image search:
-`!images Cthulhu <https://searx.me/?q=%21images%20Cthulhu>`_
+
+- :search:`!images Cthulhu <?q=%21images%20Cthulhu>`
Custom language in wikipedia:
-`:hu !wp hackerspace <https://searx.me/?q=%3Ahu%20%21wp%20hackerspace>`_
+
+- :search:`:hu !wp hackerspace <?q=%3Ahu%20%21wp%20hackerspace>`