Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f9930b3

Browse files
myk002myk002
committed
migrate all docs to the new directives
add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
1 parent 4f799a1 commit f9930b3

122 files changed

Lines changed: 913 additions & 665 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/builtins/alias.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
alias
22
=====
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`alias`
5-
6-
:index:`Configure helper aliases for other DFHack commands.
7-
<alias; Configure helper aliases for other DFHack commands.>` Aliases are
8-
resolved immediately after built-in commands, which means that an alias cannot
9-
override a built-in command, but can override a command implemented by a plugin
10-
or script.
3+
4+
.. dfhack-tool::
5+
:summary: Configure helper aliases for other DFHack commands.
6+
:tags: system
7+
8+
Aliases are resolved immediately after built-in commands, which means that an
9+
alias cannot override a built-in command, but can override a command implemented
10+
by a plugin or script.
1111

1212
Usage:
1313

‎docs/builtins/cls.rst‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
cls
22
===
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`cls`
53

6-
:index:`Clear the terminal screen. <cls; Clear the terminal screen.>` Can also
7-
be invoked as ``clear``. Note that this command does not delete command history.
8-
It just clears the text on the screen.
4+
.. dfhack-tool::
5+
:summary: Clear the terminal screen.
6+
:tags: system
7+
8+
Can also be invoked as ``clear``. Note that this command does not delete command
9+
history. It just clears the text on the screen.
10+
11+
Usage::
12+
13+
cls

‎docs/builtins/devel/dump-rpc.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
devel/dump-rpc
22
==============
3-
Tags: `tag/system`
4-
:dfhack-keybind:`devel/dump-rpc`
53

6-
:index:`Write RPC endpoint information to the specified file.
7-
<devel/dump-rpc; Writes RPC endpoint information to the specified file.>`
4+
.. dfhack-tool::
5+
:summary: Dump RPC endpoint info.
6+
:tags: dev
7+
8+
Write RPC endpoint information to the specified file.
89

910
Usage::
1011

‎docs/builtins/die.rst‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
die
22
===
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`die`
53

6-
:index:`Instantly exit DF without saving.
7-
<die; Instantly exit DF without saving.>`
4+
.. dfhack-tool::
5+
:summary: Instantly exit DF without saving.
6+
:tags: system
7+
8+
Use to exit DF quickly and safely.
9+
10+
Usage::
11+
12+
die

‎docs/builtins/disable.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
disable
22
=======
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`disable`
53

6-
:index:`Deactivate a DFHack tool that has some persistent effect.
7-
<disable; Deactivate a DFHack tool that has some persistent effect.>` See the
8-
`enable` command for more info.
4+
.. dfhack-tool::
5+
:summary: Deactivate a DFHack tool that has some persistent effect.
6+
:tags: system
7+
8+
See the `enable` command for more info.
99

1010
Usage::
1111

‎docs/builtins/enable.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
enable
22
======
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`enable`
53

6-
:index:`Activate a DFHack tool that has some persistent effect.
7-
<enable; Activate a DFHack tool that has some persistent effect.>` Many plugins
8-
and scripts can be in a distinct enabled or disabled state. Some of them
9-
activate and deactivate automatically depending on the contents of the world
10-
raws. Others store their state in world data. However a number of them have to
11-
be enabled globally, and the init file is the right place to do it.
4+
.. dfhack-tool::
5+
:summary: Activate a DFHack tool that has some persistent effect.
6+
:tags: system
7+
8+
Many plugins and scripts can be in a distinct enabled or disabled state. Some
9+
of them activate and deactivate automatically depending on the contents of the
10+
world raws. Others store their state in world data. However a number of them
11+
have to be enabled globally, and the init file is the right place to do it.
1212

1313
Most such plugins or scripts support the built-in ``enable`` and `disable`
1414
commands. Calling them at any time without arguments prints a list of enabled

‎docs/builtins/fpause.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
fpause
22
======
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`fpause`
53

6-
:index:`Forces DF to pause. <fpause; Forces DF to pause.>` This is useful when
7-
your FPS drops below 1 and you lose control of the game.
4+
.. dfhack-tool::
5+
:summary: Forces DF to pause.
6+
:tags: system
7+
8+
This is useful when your FPS drops below 1 and you lose control of the game.
89

910
Usage::
1011

‎docs/builtins/help.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
help
22
====
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`help`
53

6-
:index:`Display help about a command or plugin.
7-
<help; Display help about a command or plugin.>` Can also be invoked as ``?``
8-
or ``man`` (short for "manual").
4+
.. dfhack-tool::
5+
:summary: Display help about a command or plugin.
6+
:tags: system
7+
8+
Can also be invoked as ``?`` or ``man`` (short for "manual").
99

1010
Usage::
1111

‎docs/builtins/hide.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
hide
22
====
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`hide`
53

6-
:index:`Hide the DFHack terminal window.
7-
<hide; Hide the DFHack terminal window.>` You can show it again with the `show`
8-
command, though you'll need to use it from a `keybinding` set beforehand or the
9-
in-game `command-prompt`.
4+
.. dfhack-tool::
5+
:summary: Hide the DFHack terminal window.
6+
:tags: system
7+
8+
You can show it again with the `show` command, though you'll need to use it from
9+
a `keybinding` set beforehand or the in-game `command-prompt`.
1010

1111
Only available on Windows.
1212

‎docs/builtins/keybinding.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
keybinding
22
==========
3-
**Tags:** `tag/system`
4-
:dfhack-keybind:`keybinding`
53

6-
:index:`Create hotkeys that will run DFHack commands.
7-
<keybinding; Create hotkeys that will run DFHack commands.>` Like any other
8-
command, it can be used at any time from the console, but bindings are not
9-
remembered between runs of the game unless re-created in `dfhack.init`.
4+
.. dfhack-tool::
5+
:summary: Create hotkeys that will run DFHack commands.
6+
:tags: system
7+
8+
Like any other command, it can be used at any time from the console, but
9+
bindings are not remembered between runs of the game unless re-created in
10+
`dfhack.init`.
1011

1112
Hotkeys can be any combinations of Ctrl/Alt/Shift with A-Z, 0-9, F1-F12, or
1213
``\``` (the key below the ``Esc`` key.

0 commit comments

Comments
 (0)