From 3175e8b33d3cce98f775c0f7348e0064a5907704 Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 22 Jul 2022 10:01:04 -0700 Subject: [PATCH] update tags and text for builtins --- docs/builtins/alias.rst | 2 +- docs/builtins/cls.rst | 2 +- docs/builtins/devel/dump-rpc.rst | 4 ++-- docs/builtins/die.rst | 6 +++--- docs/builtins/disable.rst | 2 +- docs/builtins/enable.rst | 2 +- docs/builtins/fpause.rst | 2 +- docs/builtins/help.rst | 2 +- docs/builtins/hide.rst | 6 +++--- docs/builtins/keybinding.rst | 2 +- docs/builtins/kill-lua.rst | 2 +- docs/builtins/load.rst | 2 +- docs/builtins/ls.rst | 2 +- docs/builtins/plug.rst | 6 +++--- docs/builtins/reload.rst | 2 +- docs/builtins/sc-script.rst | 2 +- docs/builtins/script.rst | 6 +++--- docs/builtins/show.rst | 2 +- docs/builtins/tags.rst | 2 +- docs/builtins/type.rst | 6 +++--- docs/builtins/unload.rst | 2 +- 21 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/builtins/alias.rst b/docs/builtins/alias.rst index 59669fa39..6de550875 100644 --- a/docs/builtins/alias.rst +++ b/docs/builtins/alias.rst @@ -1,7 +1,7 @@ alias ===== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`alias` :index:`Configure helper aliases for other DFHack commands. diff --git a/docs/builtins/cls.rst b/docs/builtins/cls.rst index bc22b54fc..5c1189951 100644 --- a/docs/builtins/cls.rst +++ b/docs/builtins/cls.rst @@ -1,7 +1,7 @@ cls === -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`cls` :index:`Clear the terminal screen. ` Can also diff --git a/docs/builtins/devel/dump-rpc.rst b/docs/builtins/devel/dump-rpc.rst index 7babfb6a7..05f1d4e9e 100644 --- a/docs/builtins/devel/dump-rpc.rst +++ b/docs/builtins/devel/dump-rpc.rst @@ -1,10 +1,10 @@ devel/dump-rpc ============== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`devel/dump-rpc` -:index:`Writes RPC endpoint information to the specified file. +:index:`Write RPC endpoint information to the specified file. ` Usage:: diff --git a/docs/builtins/die.rst b/docs/builtins/die.rst index 8f20a825f..c2ea083fd 100644 --- a/docs/builtins/die.rst +++ b/docs/builtins/die.rst @@ -1,8 +1,8 @@ die === -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`die` -:index:`Instantly exits DF without saving. -` +:index:`Instantly exit DF without saving. +` diff --git a/docs/builtins/disable.rst b/docs/builtins/disable.rst index 3fb989328..1e2336545 100644 --- a/docs/builtins/disable.rst +++ b/docs/builtins/disable.rst @@ -1,7 +1,7 @@ disable ======= -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`disable` :index:`Deactivate a DFHack tool that has some persistent effect. diff --git a/docs/builtins/enable.rst b/docs/builtins/enable.rst index 3a4164485..4630c2004 100644 --- a/docs/builtins/enable.rst +++ b/docs/builtins/enable.rst @@ -1,7 +1,7 @@ enable ====== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`enable` :index:`Activate a DFHack tool that has some persistent effect. diff --git a/docs/builtins/fpause.rst b/docs/builtins/fpause.rst index 2e797129b..927206e8d 100644 --- a/docs/builtins/fpause.rst +++ b/docs/builtins/fpause.rst @@ -1,7 +1,7 @@ fpause ====== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`fpause` :index:`Forces DF to pause. ` This is useful when diff --git a/docs/builtins/help.rst b/docs/builtins/help.rst index 9a1f3f1b8..6249bdbe9 100644 --- a/docs/builtins/help.rst +++ b/docs/builtins/help.rst @@ -1,7 +1,7 @@ help ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`help` :index:`Display help about a command or plugin. diff --git a/docs/builtins/hide.rst b/docs/builtins/hide.rst index 51da0cc4f..3c79f9ff0 100644 --- a/docs/builtins/hide.rst +++ b/docs/builtins/hide.rst @@ -1,11 +1,11 @@ hide ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`hide` -:index:`Hides the DFHack terminal window. -` You can show it again with the `show` +:index:`Hide the DFHack terminal window. +` You can show it again with the `show` command, though you'll need to use it from a `keybinding` set beforehand or the in-game `command-prompt`. diff --git a/docs/builtins/keybinding.rst b/docs/builtins/keybinding.rst index f591ece34..27ab86da6 100644 --- a/docs/builtins/keybinding.rst +++ b/docs/builtins/keybinding.rst @@ -1,7 +1,7 @@ keybinding ========== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`keybinding` :index:`Create hotkeys that will run DFHack commands. diff --git a/docs/builtins/kill-lua.rst b/docs/builtins/kill-lua.rst index 998277f96..3f4bbf3c4 100644 --- a/docs/builtins/kill-lua.rst +++ b/docs/builtins/kill-lua.rst @@ -1,7 +1,7 @@ kill-lua ======== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`kill-lua` :index:`Gracefully stops any currently-running Lua scripts. diff --git a/docs/builtins/load.rst b/docs/builtins/load.rst index e84afe7d9..22e8067f3 100644 --- a/docs/builtins/load.rst +++ b/docs/builtins/load.rst @@ -1,7 +1,7 @@ load ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`load` :index:`Load and register a plugin library. diff --git a/docs/builtins/ls.rst b/docs/builtins/ls.rst index a6d2e637e..775ccfc63 100644 --- a/docs/builtins/ls.rst +++ b/docs/builtins/ls.rst @@ -1,7 +1,7 @@ ls == -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`ls` :index:`List available DFHack commands. ` diff --git a/docs/builtins/plug.rst b/docs/builtins/plug.rst index 38b37aa84..7dbbf0115 100644 --- a/docs/builtins/plug.rst +++ b/docs/builtins/plug.rst @@ -1,11 +1,11 @@ plug ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`plug` -:index:`Lists available plugins and whether they are enabled. -` +:index:`List available plugins and whether they are enabled. +` Usage: diff --git a/docs/builtins/reload.rst b/docs/builtins/reload.rst index 2fa817e3d..a5ab60859 100644 --- a/docs/builtins/reload.rst +++ b/docs/builtins/reload.rst @@ -1,7 +1,7 @@ reload ====== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`reload` :index:`Reload a loaded plugin. ` Developers diff --git a/docs/builtins/sc-script.rst b/docs/builtins/sc-script.rst index eac65b463..feabe4c6f 100644 --- a/docs/builtins/sc-script.rst +++ b/docs/builtins/sc-script.rst @@ -1,7 +1,7 @@ sc-script ========= -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`sc-script` :index:`Run commands when game state changes occur. diff --git a/docs/builtins/script.rst b/docs/builtins/script.rst index 17797ade7..b83f19171 100644 --- a/docs/builtins/script.rst +++ b/docs/builtins/script.rst @@ -1,11 +1,11 @@ script ====== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`script` -:index:`Executes a batch file of DFHack commands. -` It reads a text file and +:index:`Execute a batch file of DFHack commands. +` It reads a text file and runs each line as a DFHack command as if it had been typed in by the user -- treating the input like `an init file `. diff --git a/docs/builtins/show.rst b/docs/builtins/show.rst index 81fda6943..e337bbbb6 100644 --- a/docs/builtins/show.rst +++ b/docs/builtins/show.rst @@ -1,7 +1,7 @@ show ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`show` :index:`Unhides the DFHack terminal window. diff --git a/docs/builtins/tags.rst b/docs/builtins/tags.rst index ad8f03b28..cc5c86a4b 100644 --- a/docs/builtins/tags.rst +++ b/docs/builtins/tags.rst @@ -1,7 +1,7 @@ tags ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`tags` :index:`List the strings that DFHack tools can be tagged with. diff --git a/docs/builtins/type.rst b/docs/builtins/type.rst index 2c16a3078..33ef7562f 100644 --- a/docs/builtins/type.rst +++ b/docs/builtins/type.rst @@ -1,11 +1,11 @@ type ==== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`type` -:index:`Describes how a command is implemented. -` DFHack commands can be provided +:index:`Describe how a command is implemented. +` DFHack commands can be provided by plugins, scripts, or by the core library itself. The ``type`` command can tell you which is the source of a particular command. diff --git a/docs/builtins/unload.rst b/docs/builtins/unload.rst index 15a0fa789..3d1575c20 100644 --- a/docs/builtins/unload.rst +++ b/docs/builtins/unload.rst @@ -1,7 +1,7 @@ unload ====== -Tags: system +Tags: :dfhack-tag:`system` :dfhack-keybind:`unload` :index:`Unload a plugin from memory. `