From ffe13474affd1265170181796d31223825a89feb Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sat, 7 Oct 2023 19:35:42 -0700 Subject: [PATCH] fix some doc formatting --- docs/devel/click-monitor.rst | 1 + docs/gui/color-schemes.rst | 2 +- docs/modtools/change-build-menu.rst | 6 ++++-- docs/modtools/create-tree.rst | 5 ++++- docs/modtools/create-unit.rst | 7 ++++++- docs/modtools/extra-gamelog.rst | 6 ++++-- docs/modtools/force.rst | 5 ++++- docs/modtools/if-entity.rst | 15 ++++++++------- docs/modtools/interaction-trigger.rst | 5 ++++- docs/modtools/projectile-trigger.rst | 7 ++++++- docs/modtools/reaction-product-trigger.rst | 7 ++++++- 11 files changed, 48 insertions(+), 18 deletions(-) diff --git a/docs/devel/click-monitor.rst b/docs/devel/click-monitor.rst index 38bdfa4215..6dce54918e 100644 --- a/docs/devel/click-monitor.rst +++ b/docs/devel/click-monitor.rst @@ -12,4 +12,5 @@ Usage ----- :: + enable devel/click-monitor diff --git a/docs/gui/color-schemes.rst b/docs/gui/color-schemes.rst index 83e99a021b..d6a7f832d1 100644 --- a/docs/gui/color-schemes.rst +++ b/docs/gui/color-schemes.rst @@ -7,7 +7,7 @@ gui/color-schemes This is an in-game interface for `color-schemes`, which allows you to modify the colors in the Dwarf Fortress interface. This script must be called from either -the title screen (shown when you first start the Dwarf Fortress game) or a +the title screen (shown when you first start the Dwarf Fortress game) or the fortress main map screen. Usage diff --git a/docs/modtools/change-build-menu.rst b/docs/modtools/change-build-menu.rst index 2fffec91a7..349559b4e7 100644 --- a/docs/modtools/change-build-menu.rst +++ b/docs/modtools/change-build-menu.rst @@ -17,7 +17,8 @@ your changes each time the world loads. Just to be clear: You CANNOT use this script AT ALL if there is no world loaded! -**Usage:** +Usage +----- ``enable modtools/change-build-menu``: @@ -92,7 +93,8 @@ loaded! changes you no longer want/need. -**Module Usage:** +Module Usage +------------ To use this script as a module put the following somewhere in your own script: diff --git a/docs/modtools/create-tree.rst b/docs/modtools/create-tree.rst index e425c02229..e2a4a12d47 100644 --- a/docs/modtools/create-tree.rst +++ b/docs/modtools/create-tree.rst @@ -7,7 +7,10 @@ modtools/create-tree Spawns a tree. -Usage:: +Usage +----- + +:: -tree treeName specify the tree to be created diff --git a/docs/modtools/create-unit.rst b/docs/modtools/create-unit.rst index 9c338bde20..fc4f713d65 100644 --- a/docs/modtools/create-unit.rst +++ b/docs/modtools/create-unit.rst @@ -5,7 +5,12 @@ modtools/create-unit :summary: Create arbitrary units. :tags: unavailable dev -Creates a unit. Usage:: +Creates a unit. + +Usage +----- + +:: -race raceName (obligatory) diff --git a/docs/modtools/extra-gamelog.rst b/docs/modtools/extra-gamelog.rst index 2c79594771..f465fdeaa2 100644 --- a/docs/modtools/extra-gamelog.rst +++ b/docs/modtools/extra-gamelog.rst @@ -8,7 +8,9 @@ modtools/extra-gamelog This script writes extra information to the gamelog. This is useful for tools like :forums:`Soundsense <60287>`. -Usage:: +Usage +----- + +:: modtools/extra-gamelog enable - modtools/extra-gamelog disable diff --git a/docs/modtools/force.rst b/docs/modtools/force.rst index 01831201c1..9f71183fa1 100644 --- a/docs/modtools/force.rst +++ b/docs/modtools/force.rst @@ -7,7 +7,10 @@ modtools/force This tool triggers events like megabeasts, caravans, and migrants. -Usage:: +Usage +----- + +:: -eventType event specify the type of the event to trigger diff --git a/docs/modtools/if-entity.rst b/docs/modtools/if-entity.rst index 9846842b31..6b32c2f863 100644 --- a/docs/modtools/if-entity.rst +++ b/docs/modtools/if-entity.rst @@ -11,18 +11,19 @@ To use this script effectively it needs to be called from "raw/onload.init". Calling this from the main dfhack.init file will do nothing, as no world has been loaded yet. -Usage: +Usage +----- -- ``id``: +``id`` Specify the entity ID to match -- ``cmd [ commandStrs ]``: +``cmd [ commandStrs ]`` Specify the command to be run if the current entity matches the entity given via -id All arguments are required. -Example: +Example +------- -- Print a message if you load an elf fort, but not a dwarf, human, etc. fort:: - - if-entity -id "FOREST" -cmd [ lua "print('Dirty hippies.')" ] +``if-entity -id "FOREST" -cmd [ lua "print('Dirty hippies.')" ]`` + Print a message if you load an elf fort, but not a dwarf, human, etc. fort. diff --git a/docs/modtools/interaction-trigger.rst b/docs/modtools/interaction-trigger.rst index f1ea4b61df..547bc7784f 100644 --- a/docs/modtools/interaction-trigger.rst +++ b/docs/modtools/interaction-trigger.rst @@ -10,7 +10,10 @@ scanning the announcements for the correct attack verb, so the attack verb must be specified in the interaction. It includes an option to suppress this announcement after it finds it. -Usage:: +Usage +----- + +:: -clear unregisters all triggers diff --git a/docs/modtools/projectile-trigger.rst b/docs/modtools/projectile-trigger.rst index d50c434dec..987bc7e065 100644 --- a/docs/modtools/projectile-trigger.rst +++ b/docs/modtools/projectile-trigger.rst @@ -5,7 +5,12 @@ modtools/projectile-trigger :summary: Run DFHack commands when projectiles hit their targets. :tags: unavailable dev -This triggers dfhack commands when projectiles hit their targets. Usage:: +This triggers dfhack commands when projectiles hit their targets. + +Usage +----- + +:: -clear unregister all triggers diff --git a/docs/modtools/reaction-product-trigger.rst b/docs/modtools/reaction-product-trigger.rst index 32ede32949..b3b4e421b6 100644 --- a/docs/modtools/reaction-product-trigger.rst +++ b/docs/modtools/reaction-product-trigger.rst @@ -6,7 +6,12 @@ modtools/reaction-product-trigger :tags: unavailable dev This triggers dfhack commands when reaction products are produced, once per -product. Usage:: +product. + +Usage +----- + +:: -clear unregister all reaction hooks