vimhelp: Better offline generation capabilities

help.txt now always gets remapped to index.html. It does mean you can't
navigate to a "help.txt.html" page anymore, but it makes most static
sites happier as you don't have to add manual server logic to remap the
root folder listing to a manual `help.txt.html` as most web servers can
handle index.html automatically.

Also, remove refereces to TomSelect even for online mode, as we want to
generate an "online" mode version even for static sitate gneeration just
to take advantage of the other features like a better header and
light/dark mode switching. Should ideally use another config variable to
control this instead of just blanket commenting out.

Author: ychin

vimhelp/scripts/h2h.py

@@ -123,8 +123,12 @@ def run(args):
         content = infile.read_text()
         print(f"Processing {infile}...")
         html = h2h.to_html(infile.name, content)
+        if infile.name != "help.txt":
+            out_filename = f"{infile.name}.html"
+        else:
+            out_filename = "index.html"
         if args.out_dir is not None:
-            with (args.out_dir / f"{infile.name}.html").open("w") as f:
+            with (args.out_dir / out_filename).open("w") as f:
                 f.write(prelude)
                 f.write(html)
 

vimhelp/static/vimhelp-v5.js

@@ -2,6 +2,7 @@
 
 // "Go to keyword" entry
 
+/*
 new TomSelect("#vh-select-tag", {
     maxItems: 1,
     loadThrottle: 250,
@@ -24,6 +25,7 @@ new TomSelect("#vh-select-tag", {
         }
     }
 });
+*/
 
 // Theme switcher
 

vimhelp/templates/page.html

@@ -8,9 +8,12 @@
 <!-- {{project.favicon_notice}} -->
 
 {% if mode != "offline" %}
+{% if project.name != 'MacVim' %}
+{# MacVim does not host this on a server and cannot do dynamic queries #}
 <link rel="stylesheet" href="{{static_dir}}tom-select-2.2.2.min.css">
 <script defer src="{{static_dir}}tom-select-2.2.2.base.min.js"></script>
 {% endif %}
+{% endif %}
 
 <link rel="stylesheet" href="{{static_dir}}vimhelp-v5.css" type="text/css">
 <noscript><link rel="stylesheet" href="{{static_dir}}noscript.css" type="text/css"></noscript>
@@ -61,13 +64,15 @@ <h1>{{project.name}} help files</h1>
 {% if mode != "offline" %}
 <div class="bar">
   <div class="ql">{{sitenavi}}</div>
+  {% if project.name != "MacVim" %}
   <div class="srch" id="go-to-tag">
     <select id="vh-select-tag"></select>
   </div>
   <form class="srch" action="https://duckduckgo.com" method="get" target="_blank" rel="noopener noreferrer">
     <input type="hidden" name="sites" value="{{project.vimdoc_site}}">
     <input type="search" name="q" id="vh-srch-input" placeholder="Site search">
   </form>
+  {% endif %}
   {% if filename != "help.txt" %}
   {{theme_switcher}}
   {% endif %}

vimhelp/vimhelp/vimh2h.py

@@ -182,8 +182,11 @@ def add_tags(self, filename, contents):
                 in_example = True
 
     def do_add_tag(self, filename, tag):
-        if self._mode == "online" and filename == "help.txt":
-            htmlfilename = "/"
+        if filename == "help.txt":
+            if self._mode == "online":
+                htmlfilename = "/"
+            else:
+                htmlfilename = "index.html"
         else:
             htmlfilename = filename + ".html"
         self._urls[tag] = Link(filename, htmlfilename, tag)
@@ -334,7 +337,7 @@ def to_html(self, filename, contents):
                 out.append(FAQ_LINE)
 
         static_dir = "/" if self._mode == "online" else ""
-        helptxt = "./" if self._mode == "online" else "help.txt.html"
+        helptxt = "./" if self._mode == "online" else "index.html"
 
         return flask.render_template(
             "page.html",