update docs for dwarfmonitor

docs/plugins/dwarfmonitor.rst

@@ -1,35 +1,48 @@
 dwarfmonitor
 ============
-Records dwarf activity to measure fort efficiency.
+Tags:
-
-Options:
-
-:enable <mode>:     Start monitoring ``mode``. ``mode`` can be "work", "misery",
-                    "weather", or "all".  This will enable all corresponding widgets,
-                    if applicable.
-:disable <mode>:    Stop monitoring ``mode``, and disable corresponding widgets, if applicable.
-:stats:             Show statistics summary
-:prefs:             Show dwarf preferences summary
-:reload:            Reload configuration file (``dfhack-config/dwarfmonitor.json``)
-
 :dfhack-keybind:`dwarfmonitor`
 
-Widget configuration:
+:index:`Measure fort happiness and efficiency.
-
+<dwarfmonitor; Measure fort happiness and efficiency.>` Also show heads-up
-The following types of widgets (defined in :file:`hack/lua/plugins/dwarfmonitor.lua`)
+display widgets with live fort statistics.
-can be displayed on the main fortress mode screen:
+
-
+Usage:
-:date:      Show the in-game date
+
-:misery:    Show overall happiness levels of all dwarves
+``dwarfmonitor enable <mode>``
-:weather:   Show current weather (rain/snow)
+    Start tracking a specific facet of fortress life. The ``mode`` can be
-:cursor:    Show the current mouse cursor position
+    "work", "misery", "date", "weather", or "all".  This will show the
+    corresponding on-screen widgets, if applicable.
+``dwarfmonitor disable <mode>``
+    Stop monitoring ``mode`` and disable corresponding widgets.
+``dwarfmonitor stats``
+    Show statistics summary.
+``dwarfmonitor prefs``
+    Show summary of dwarf preferences.
+``dwarfmonitor reload``
+    Reload the widget configuration file (``dfhack-config/dwarfmonitor.json``).
+
+Widget configuration
+--------------------
+
+The following types of widgets (defined in
+:file:`hack/lua/plugins/dwarfmonitor.lua`) can be displayed on the main fortress
+mode screen:
+
+``misery``
+    Show overall happiness levels of all dwarves.
+``date``
+    Show the in-game date.
+``weather``
+    Show current weather (e.g. rain/snow).
+``cursor``
+    Show the current mouse cursor position.
 
 The file :file:`dfhack-config/dwarfmonitor.json` can be edited to control the
-positions and settings of all widgets displayed. This file should contain a
+positions and settings of all widgets. This file should contain a JSON object
-JSON object with the key ``widgets`` containing an array of objects - see the
+with the key ``widgets`` containing an array of objects:
-included file in the ``dfhack-config`` folder for an example:
 
-.. code-block:: lua
+.. code-block:: json
 
     {
         "widgets": [
@@ -45,7 +58,7 @@ included file in the ``dfhack-config`` folder for an example:
 X and Y coordinates begin at zero (in the upper left corner of the screen).
 Negative coordinates will be treated as distances from the lower right corner,
 beginning at 1 - e.g. an x coordinate of 0 is the leftmost column, while an x
-coordinate of 1 is the rightmost column.
+coordinate of -1 is the rightmost column.
 
 By default, the x and y coordinates given correspond to the leftmost tile of
 the widget. Including an ``anchor`` option set to ``right`` will cause the

plugins/dwarfmonitor.cpp

@@ -2075,20 +2075,9 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector <Plugin
 
     commands.push_back(
         PluginCommand(
-        "dwarfmonitor", "Records dwarf activity to measure fort efficiency",
+            "dwarfmonitor",
-        dwarfmonitor_cmd, false,
+            "Records dwarf activity to measure fort efficiency",
-        "dwarfmonitor enable <mode>\n"
+            dwarfmonitor_cmd));
-        "  Start monitoring <mode>\n"
-        "    <mode> can be \"work\", \"misery\", \"weather\", or \"all\"\n"
-        "dwarfmonitor disable <mode>\n"
-        "    <mode> as above\n\n"
-        "dwarfmonitor stats\n"
-        "  Show statistics summary\n"
-        "dwarfmonitor prefs\n"
-        "  Show dwarf preferences summary\n\n"
-        "dwarfmonitor reload\n"
-        "  Reload configuration file (dfhack-config/dwarfmonitor.json)\n"
-        ));
 
     dm_lua::state=Lua::Core::State;
     if (dm_lua::state == NULL)