update docs for dig (again)

docs/plugins/dig.rst

@@ -17,24 +17,33 @@ Make complicated dig patterns easy.
 Usage:
 
 ``digv [x] [-p<number>]``
-    Designate all of the selected vein for digging.
+    :index:`Designate all of the selected vein for digging.
+    <digv; Designate all of the selected vein for digging.>`
 ``digvx [-p<number>]``
-    Also cross z-levels, digging stairs as needed.  Alias for ``digv x``.
+    :index:`Dig a vein across z-levels, digging stairs as needed.
+    <digvx; Dig a vein across z-levels, digging stairs as needed.>`
+    This is an alias for ``digv x``.
 ``digl [x] [undo] [-p<number>]``
-    Like ``digv``, for layer stone. If ``undo`` is specified, removes the
+    :index:`Dig all of the selected layer stone.
-    layer designation instead (for if you accidentally set 50 levels at once).
+    <digl; Dig all of the selected layer stone.>` If ``undo`` is specified,
+    removes the designation instead (for if you accidentally set 50 levels at
+    once).
 ``diglx [-p<number>]``
-    Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
+    :index:`Dig layer stone across z-levels, digging stairs as needed.
+    <diglx; Dig layer stone across z-levels, digging stairs as needed.>` This
+    is an alias for ``digl x``.
 ``digcircle [<diameter>] [<solidity>] [<action>] [<designation>] [-p<number>]``
-    Designate circles. The diameter is the number of tiles across the center of
+    :index:`Designate circles. <digcircles; Designate circles.>` The diameter
-    the circle that you want to dig. See the `digcircle`_ section below for
+    is the number of tiles across the center of the circle that you want to dig.
-    options.
+    See the `digcircle`_ section below for options.
 ``digtype [<designation>] [-p<number>]``
-    Designate all vein tiles of the selected type. See the `digtype`_ section
+    :index:`Designate all vein tiles of the selected type.
-    below for options.
+    <digtype; Designate all vein tiles of the selected type.>` See the `digtype`_
+    section below for options.
 ``digexp [<pattern>] [<filter>] [-p<number>]``
-    Designate dig patterns for exploratory mining. See the `digexp`_ section
+    :index:`Designate dig patterns for exploratory mining.
-    below for options
+    <digexp; Designate dig patterns for exploratory mining.>` See the `digexp`_
+    section below for options
 
 All commands support specifying the priority of the dig designations with
 ``-p<number>``, where the number is from 1 to 7. If a priority is not specified,
@@ -43,8 +52,8 @@ the priority selected in-game is used as the default.
 Examples
 --------
 
-``digcircle filled 3``
+``digcircle filled 3 -p2``
-    Dig a filled circle with a diameter of 3 tiles.
+    Dig a filled circle with a diameter of 3 tiles at dig priority 2.
 ``digcircle``
     Do it again (previous parameters are reused).
 ``expdig diag5 hidden``

plugins/dig.cpp

@@ -28,7 +28,6 @@ command_result digv (color_ostream &out, vector <string> & parameters);
 command_result digvx (color_ostream &out, vector <string> & parameters);
 command_result digl (color_ostream &out, vector <string> & parameters);
 command_result diglx (color_ostream &out, vector <string> & parameters);
-command_result digauto (color_ostream &out, vector <string> & parameters);
 command_result digexp (color_ostream &out, vector <string> & parameters);
 command_result digcircle (color_ostream &out, vector <string> & parameters);
 command_result digtype (color_ostream &out, vector <string> & parameters);
@@ -40,44 +39,37 @@ REQUIRE_GLOBAL(world);
 DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
 {
     commands.push_back(PluginCommand(
-        "digv","Dig a whole vein.",digv,Gui::cursor_hotkey,
+        "digv",
-        "  Designates a whole vein under the cursor for digging.\n"
+        "Dig a whole vein.",
-        "Options:\n"
+        digv,
-        "  x - follow veins through z-levels with stairs.\n"
+        Gui::cursor_hotkey));
-        ));
     commands.push_back(PluginCommand(
-        "digvx","Dig a whole vein, following through z-levels.",digvx,Gui::cursor_hotkey,
+        "digvx",
-        "  Designates a whole vein under the cursor for digging.\n"
+        "Dig a whole vein, following through z-levels.",
-        "  Also follows the vein between z-levels with stairs, like 'digv x' would.\n"
+        digvx,
-        ));
+        Gui::cursor_hotkey));
    commands.push_back(PluginCommand(
-        "digl","Dig layerstone.",digl,Gui::cursor_hotkey,
+        "digl",
-        "  Designates layerstone under the cursor for digging.\n"
+        "Dig layerstone.",
-        "  Veins will not be touched.\n"
+        digl,
-        "Options:\n"
+        Gui::cursor_hotkey));
-        "  x    - follow layer through z-levels with stairs.\n"
-        "  undo - clear designation (can be used together with 'x').\n"
-        ));
     commands.push_back(PluginCommand(
-        "diglx","Dig layerstone, following through z-levels.",diglx,Gui::cursor_hotkey,
+        "diglx",
-        "  Designates layerstone under the cursor for digging.\n"
+        "Dig layerstone, following through z-levels.",
-        "  Also follows the stone between z-levels with stairs, like 'digl x' would.\n"
+        diglx,
-        ));
+        Gui::cursor_hotkey));
-    commands.push_back(PluginCommand("digexp","Select or designate an exploratory pattern.",digexp));
+    commands.push_back(PluginCommand(
-    commands.push_back(PluginCommand("digcircle","Dig designate a circle (filled or hollow)",digcircle));
+        "digexp",
-    //commands.push_back(PluginCommand("digauto","Mark a tile for continuous digging.",autodig));
+        "Select or designate an exploratory pattern.",
-    commands.push_back(PluginCommand("digtype", "Dig all veins of a given type.", digtype,Gui::cursor_hotkey,
+        digexp));
-        "For every tile on the map of the same vein type as the selected tile, this command designates it to have the same designation as the selected tile. If the selected tile has no designation, they will be dig designated.\n"
+    commands.push_back(PluginCommand(
-        "If an argument is given, the designation of the selected tile is ignored, and all appropriate tiles are set to the specified designation.\n"
+        "digcircle",
-        "Options:\n"
+        "Dig designate a circle (filled or hollow)",
-        "  dig\n"
+        digcircle));
-        "  channel\n"
+    commands.push_back(PluginCommand(
-        "  ramp\n"
+        "digtype",
-        "  updown - up/down stairs\n"
+        "Dig all veins of a given type.",
-        "  up     - up stairs\n"
+        digtype,Gui::cursor_hotkey));
-        "  down   - down stairs\n"
-        "  clear  - clear designation\n"
-        ));
     return CR_OK;
 }
 
@@ -1420,12 +1412,6 @@ command_result digl (color_ostream &out, vector <string> & parameters)
     return CR_OK;
 }
 
-
-command_result digauto (color_ostream &out, vector <string> & parameters)
-{
-    return CR_NOT_IMPLEMENTED;
-}
-
 command_result digtype (color_ostream &out, vector <string> & parameters)
 {
     //mostly copy-pasted from digv