From 95bffbb590bbf1cd4166997c818c5dc13b4c348d Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Wed, 23 Nov 2022 13:22:43 +0100
Subject: [PATCH] DOC: Formatting for the shortcuts document.
---
src/doc/extension/query_templates.rst | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/src/doc/extension/query_templates.rst b/src/doc/extension/query_templates.rst
index 9f120f75..8c331386 100644
--- a/src/doc/extension/query_templates.rst
+++ b/src/doc/extension/query_templates.rst
@@ -1,3 +1,7 @@
+===============
+Query shortcuts
+===============
+
Introduction
============
@@ -7,11 +11,10 @@ data as query strings which are used frequently. They can be stored and
reused.
.. figure:: images/shortcut_toolbox.png
- :alt: The Shortcuts in the Query Panel; Note the Toolbox for in the
- top right
+ :alt: Shortcuts in the query panel. There is a
+ toolbox for editing shortcuts in the top right.
- The Shortcuts in the Query Panel; Note the Toolbox for in the top
- right
+ Shortcuts in the query panel. Note the toolbox for editing shortcuts in the top right
There are two ways to integrate query templates into the WebUI:
@@ -47,7 +50,7 @@ It now opens a form with two input fields, ``Description`` and
The view to create a new shortcut
-See `2.4 <#basic-shortcut>`__ and `2.5 <#advanced-shortcut>`__ for
+See `Basic Shortcut`_ and `Advanced Shortcut`_ for
further explanation of the components of a Query Shortcut.
Edit the fields and click ``Submit`` for the creation of the new
@@ -177,6 +180,10 @@ Each placeholder *id* must occur only once in both components – if you
need to use two years in your shortcut you have to use ``{year1}`` and
``{year2}`` or any other combinations of placeholder *ids*.
+
+Global Shortcuts
+================
+
Example for global_query_shortcuts.json
---------------------------------------
--
GitLab