doxygen: improve the search help text.

diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py
index e7b47559c10263e72297035b6dc24178c2b91192..8de8f1798284692c53cda161be94051ffc4d8eea 100755 (executable)
--- a/doxygen/dox2html5.py
+++ b/doxygen/dox2html5.py
@@ -2606,7 +2606,13 @@ def parse_doxyfile(state: State, doxyfile, config = None):
         'M_PAGE_FINE_PRINT': ['[default]'],
         'M_SEARCH_DISABLED': ['NO'],
         'M_SEARCH_DOWNLOAD_BINARY': ['NO'],
-        'M_SEARCH_HELP': ['Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path.'],
+        'M_SEARCH_HELP': [
+"""Search for symbols, directories, files, pages or modules. You can omit any
+prefix from the symbol or file path; adding a <code>:</code> or <code>/</code>
+suffix lists all members of given symbol or directory. Navigate through the
+list using <span class="m-label m-dim">&darr;</span> and
+<span class="m-label m-dim">&uarr;</span>, press
+<span class="m-label m-dim">Enter</span> to go."""],
         'M_SEARCH_EXTERNAL_URL': ['']
     }
 

diff --git a/doxygen/templates/base.html b/doxygen/templates/base.html
index b1acb216fc8ed74ec9cf6d973554023b75715be6..2f503f6f874fb864bb4b09c515f996fa234667d1 100644 (file)
--- a/doxygen/templates/base.html
+++ b/doxygen/templates/base.html
@@ -106,7 +106,7 @@
           <input type="search" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" />
           <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.{% if M_SEARCH_EXTERNAL_URL %} Enable it or <a href="{{ M_SEARCH_EXTERNAL_URL|replace('{query}', '') }}">use an external search engine</a>.{% endif %}</noscript>
           <div id="search-help" class="m-text m-dim m-text-center">
-            {{ M_SEARCH_HELP }}
+            {{ M_SEARCH_HELP|indent(12) }}
           </div>
           <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.{% if M_SEARCH_EXTERNAL_URL %}<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="{{ M_SEARCH_EXTERNAL_URL }}">search with external engine</a>?{% endif %}</div>
           <ul id="search-results"></ul>

diff --git a/doxygen/test/layout_minimal/index.html b/doxygen/test/layout_minimal/index.html
index fe3e201474c51dcd17bfd28ffca17aabbacd1874..4a6924531fb587ce1bc0a0820d2a25e96598cb73 100644 (file)
--- a/doxygen/test/layout_minimal/index.html
+++ b/doxygen/test/layout_minimal/index.html
@@ -62,7 +62,12 @@
           <input type="search" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" />
           <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
           <div id="search-help" class="m-text m-dim m-text-center">
-            Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path.
+            Search for symbols, directories, files, pages or modules. You can omit any
+            prefix from the symbol or file path; adding a <code>:</code> or <code>/</code>
+            suffix lists all members of given symbol or directory. Navigate through the
+            list using <span class="m-label m-dim">&darr;</span> and
+            <span class="m-label m-dim">&uarr;</span>, press
+            <span class="m-label m-dim">Enter</span> to go.
           </div>
           <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
           <ul id="search-results"></ul>

diff --git a/doxygen/test/layout_search_binary/Doxyfile b/doxygen/test/layout_search_binary/Doxyfile
index ac4ebd4d493205fa67a89d129dc19e1afff67ac0..546e9ea44f17d76c3b99a0d4985888e2b60f584e 100644 (file)
--- a/doxygen/test/layout_search_binary/Doxyfile
+++ b/doxygen/test/layout_search_binary/Doxyfile
@@ -5,3 +5,4 @@ M_THEME_COLOR           =
 M_LINKS_NAVBAR1         =
 M_LINKS_NAVBAR2         =
 M_SEARCH_DOWNLOAD_BINARY = YES
+M_SEARCH_HELP           = "Halp."

diff --git a/doxygen/test/layout_search_binary/index.html b/doxygen/test/layout_search_binary/index.html
index d779083b3e3b06370e18927932705fc4fb277599..c486e7a8d49d1e5b5b208e1bccdfdb4da963640d 100644 (file)
--- a/doxygen/test/layout_search_binary/index.html
+++ b/doxygen/test/layout_search_binary/index.html
@@ -57,7 +57,7 @@
           <input type="search" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" />
           <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
           <div id="search-help" class="m-text m-dim m-text-center">
-            Search for symbols, headers, pages or example source files. You can omit any prefix from the symbol or file path.
+            Halp.
           </div>
           <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
           <ul id="search-results"></ul>

diff --git a/doxygen/test/test_doxyfile.py b/doxygen/test/test_doxyfile.py
index df7404bb1d8e4f8081ccee56771e1ae26f0183a4..3cb8e273df56285b5e234bf0760331ef40016710 100644 (file)
--- a/doxygen/test/test_doxyfile.py
+++ b/doxygen/test/test_doxyfile.py
@@ -51,8 +51,13 @@ class Doxyfile(unittest.TestCase):
             'M_SEARCH_DISABLED': False,
             'M_SEARCH_DOWNLOAD_BINARY': False,
             'M_SEARCH_EXTERNAL_URL': '',
-            'M_SEARCH_HELP': 'Search for symbols, headers, pages or example source files. '
-                             'You can omit any prefix from the symbol or file path.',
+            'M_SEARCH_HELP':
+"""Search for symbols, directories, files, pages or modules. You can omit any
+prefix from the symbol or file path; adding a <code>:</code> or <code>/</code>
+suffix lists all members of given symbol or directory. Navigate through the
+list using <span class="m-label m-dim">&darr;</span> and
+<span class="m-label m-dim">&uarr;</span>, press
+<span class="m-label m-dim">Enter</span> to go.""",
             'M_THEME_COLOR': '#22272e',
             'OUTPUT_DIRECTORY': '',
             'PROJECT_BRIEF': 'is cool',