Documentation updates for the hotkeys plugin.

NEWS

@@ -1,5 +1,8 @@
 DFHack future
 
+    New plugins:
+        - hotkeys (by Falconne): Shows ingame viewscreen with all dfhack keybindings active in current mode.
+
 DFHack 0.40.11-r1
 
     Internals:

Readme.html

@@ -534,6 +534,7 @@ access DF memory and allow for easier development of new tools.</p>
 <li><a class="reference internal" href="#gui-clone-uniform" id="id163">gui/clone-uniform</a></li>
 <li><a class="reference internal" href="#gui-companion-order" id="id164">gui/companion-order</a></li>
 <li><a class="reference internal" href="#gui-gm-editor" id="id165">gui/gm-editor</a></li>
+<li><a class="reference internal" href="#hotkeys" id="idhotkeys">Hotkeys</a></li>
 <li><a class="reference internal" href="#gui-liquids" id="id166">gui/liquids</a></li>
 <li><a class="reference internal" href="#gui-mechanisms" id="id167">gui/mechanisms</a></li>
 <li><a class="reference internal" href="#gui-mod-manager" id="id168">gui/mod-manager</a></li>
@@ -3356,6 +3357,16 @@ the same as version above.</li>
 <p>This editor allows to change and modify almost anything in df. Press '?' for an
 in-game help.</p>
 </div>
+<div class="section" id="hotkeys">
+<h2><a class="toc-backref" href="#idhotkeys">Hotkeys</a></h2>
+<p>Opens an in-game screen showing DFHack keybindings that are valid in the current mode.</p>
+<img alt="images/hotkeys.png" src="images/hotkeys.png" />
+<p>Type <tt class="docutils literal">hotkeys</tt> into the DFHack console to open the screen, or bind the command to a
+globally active hotkey in dfhack.init, e.g.:</p>
+<pre class="literal-block">
+keybinding add Ctrl-F1 hotkeys
+</pre>
+</div>
 <div class="section" id="gui-liquids">
 <h2><a class="toc-backref" href="#id166">gui/liquids</a></h2>
 <p>To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.</p>

Readme.rst

@@ -2766,10 +2766,9 @@ Opens an in-game screen showing DFHack keybindings that are valid in the current
 .. image:: images/hotkeys.png
 
 Type ``hotkeys`` into the DFHack console to open the screen, or bind the command to a
-globally active hotkey in dfhack.init, e.g.:
+globally active hotkey in dfhack.init, e.g.::
-
- ``keybinding add Ctrl-F1 hotkeys``
 
+    keybinding add Ctrl-F1 hotkeys
 
 gui/liquids
 ===========

dfhack.init-example

@@ -2,6 +2,9 @@
 # Generic dwarfmode bindings #
 ##############################
 
+# show all current key bindings
+keybinding add Ctrl-F1 hotkeys
+
 # toggle the display of water level as 1-7 tiles
 keybinding add Ctrl-W twaterlvl