From 1cad77601e15bf543ddab5326a3c38c665a63ced Mon Sep 17 00:00:00 2001 From: myk002 Date: Tue, 19 Jul 2022 23:11:02 -0700 Subject: [PATCH] update formatting for plugin docs --- docs/plugins/3dveins.rst | 6 +++++- docs/plugins/add-spatter.rst | 3 +++ docs/plugins/autochop.rst | 3 +++ docs/plugins/autoclothing.rst | 6 +++++- docs/plugins/autodump-destroy-here.rst | 3 +++ docs/plugins/autodump-destroy-item.rst | 3 +++ docs/plugins/autodump.rst | 9 +++++++-- docs/plugins/autofarm.rst | 6 +++++- docs/plugins/autogems-reload.rst | 3 +++ docs/plugins/autogems.rst | 3 +++ docs/plugins/autohauler.rst | 6 +++++- docs/plugins/autolabor.rst | 9 +++++++-- docs/plugins/automaterial.rst | 3 +++ docs/plugins/automelt.rst | 3 +++ docs/plugins/autotrade.rst | 3 +++ docs/plugins/blueprint.rst | 21 +++++++++++++++------ docs/plugins/building-hacks.rst | 3 +++ docs/plugins/buildingplan.rst | 3 +++ docs/plugins/burrows.rst | 3 +++ 19 files changed, 85 insertions(+), 14 deletions(-) diff --git a/docs/plugins/3dveins.rst b/docs/plugins/3dveins.rst index 9a074a4c8..89c241df6 100644 --- a/docs/plugins/3dveins.rst +++ b/docs/plugins/3dveins.rst @@ -1,6 +1,9 @@ 3dveins ======= +Tags: +:dfhack-keybind:`3dveins` + Rewrites layer veins to expand in 3D space. Existing, flat veins are removed and new 3D veins that naturally span z-levels are generated in their place. The transformation preserves the mineral counts reported by `prospect`. @@ -11,7 +14,8 @@ Usage:: The ``verbose`` option prints out extra information to the console. -Example:: +Example +------- 3dveins diff --git a/docs/plugins/add-spatter.rst b/docs/plugins/add-spatter.rst index b6bb97cf7..92808017c 100644 --- a/docs/plugins/add-spatter.rst +++ b/docs/plugins/add-spatter.rst @@ -1,6 +1,9 @@ add-spatter =========== +Tags: +:dfhack-keybind:`add-spatter` + Make tagged reactions produce contaminants. The plugin is intended to give some use to all those poisons that can be bought from caravans. It automatically enables itself when you load a world with reactions that include names starting diff --git a/docs/plugins/autochop.rst b/docs/plugins/autochop.rst index 7c517e901..704b97143 100644 --- a/docs/plugins/autochop.rst +++ b/docs/plugins/autochop.rst @@ -1,6 +1,9 @@ autochop ======== +Tags: +:dfhack-keybind:`autochop` + Auto-harvest trees when low on stockpiled logs. This plugin can designate trees for chopping when your stocks are low on logs. diff --git a/docs/plugins/autoclothing.rst b/docs/plugins/autoclothing.rst index a3c53a65a..a8cc001dd 100644 --- a/docs/plugins/autoclothing.rst +++ b/docs/plugins/autoclothing.rst @@ -1,6 +1,9 @@ autoclothing ============ +Tags: +:dfhack-keybind:`autoclothing` + Automatically manage clothing work orders. It allows you to set how many of each clothing type every citizen should have. @@ -15,7 +18,8 @@ anything your civilization can produce, such as "dress" or "mitten". When invoked without a number, it shows the current configuration for that material and item. -Examples: +Examples +-------- * ``autoclothing cloth "short skirt" 10``: Sets the desired number of cloth short skirts available per citizen to 10. diff --git a/docs/plugins/autodump-destroy-here.rst b/docs/plugins/autodump-destroy-here.rst index 375a799c0..35356166c 100644 --- a/docs/plugins/autodump-destroy-here.rst +++ b/docs/plugins/autodump-destroy-here.rst @@ -1,6 +1,9 @@ autodump-destroy-here ===================== +Tags: +:dfhack-keybind:`autodump-destroy-here` + Destroy items marked for dumping under cursor. If called again before the game is resumed, cancels destruction of the items. This is an alias for the `autodump` command ``autodump destroy-here``, intended for use as a keybinding. diff --git a/docs/plugins/autodump-destroy-item.rst b/docs/plugins/autodump-destroy-item.rst index a9f3554c3..9447590d0 100644 --- a/docs/plugins/autodump-destroy-item.rst +++ b/docs/plugins/autodump-destroy-item.rst @@ -1,6 +1,9 @@ autodump-destroy-item ===================== +Tags: +:dfhack-keybind:`autodump-destroy-item` + Destroy the selected item. The item may be selected in the :kbd:`k` list or in the container item list. If called again before the game is resumed, cancels destruction of the item. diff --git a/docs/plugins/autodump.rst b/docs/plugins/autodump.rst index 83b50e498..5ac0d1cd5 100644 --- a/docs/plugins/autodump.rst +++ b/docs/plugins/autodump.rst @@ -1,6 +1,9 @@ autodump ======== +Tags: +:dfhack-keybind:`autodump` + Quickly designate or teleport items to be dumped. When `enabled `, this plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``autodump`` option is selected for the stockpile, any items placed in the stockpile will @@ -19,7 +22,8 @@ Usage:: enable autodump autodump [] -Options: +Options +------- - ``destroy`` Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is @@ -35,7 +39,8 @@ Options: - ``forbidden`` Only process forbidden items (default: only unforbidden). -Examples: +Examples +-------- - ``autodump`` Teleports all unforbidden items marked for dumping to the cursor position. diff --git a/docs/plugins/autofarm.rst b/docs/plugins/autofarm.rst index d66830fe0..9a3e16d43 100644 --- a/docs/plugins/autofarm.rst +++ b/docs/plugins/autofarm.rst @@ -1,6 +1,9 @@ autofarm ======== +Tags: +:dfhack-keybind:`autofarm` + Automatically manage farm crop selection. This plugin periodically scans your plant stocks and assigns crops to your farm plots based on which plant stocks are low (as long as you have the appropriate seeds). The target threshold for @@ -24,7 +27,8 @@ following command:: lua "for _,plant in ipairs(df.global.world.raws.plants.all) do if plant.flags.SEED then print(plant.id) end end" -Examples: +Examples +-------- - ``autofarm default 30`` Set the default threshold to 30. diff --git a/docs/plugins/autogems-reload.rst b/docs/plugins/autogems-reload.rst index a37117746..0988496cb 100644 --- a/docs/plugins/autogems-reload.rst +++ b/docs/plugins/autogems-reload.rst @@ -1,6 +1,9 @@ autogems-reload =============== +Tags: +:dfhack-keybind:`autogems-reload` + Reloads the autogems configuration file. You might need to do this if you have manually modified the contents while the game is running. diff --git a/docs/plugins/autogems.rst b/docs/plugins/autogems.rst index ad3b0f9c3..724752217 100644 --- a/docs/plugins/autogems.rst +++ b/docs/plugins/autogems.rst @@ -1,6 +1,9 @@ autogems ======== +Tags: +:dfhack-keybind:`autogems` + Automatically cut rough gems. This plugin periodically scans your stocks of rough gems and creates manager orders for cutting them at a Jeweler's Workshop. diff --git a/docs/plugins/autohauler.rst b/docs/plugins/autohauler.rst index 3bdd00950..f28044479 100644 --- a/docs/plugins/autohauler.rst +++ b/docs/plugins/autohauler.rst @@ -1,6 +1,9 @@ autohauler ========== +Tags: +:dfhack-keybind:`autohauler` + Automatically manage hauling labors. Similar to `autolabor`, but instead of managing all labors, ``autohauler`` only addresses hauling labors, leaving the assignment of skilled labors entirely up to you. You can use the in-game @@ -40,7 +43,8 @@ Usage: - ``autohauler debug`` In the next cycle, output the state of every dwarf. -Examples: +Examples +-------- - ``autohauler HAUL_STONE haulers`` Set stone hauling as a hauling labor (this is already the default). diff --git a/docs/plugins/autolabor.rst b/docs/plugins/autolabor.rst index b60146d28..f402703c8 100644 --- a/docs/plugins/autolabor.rst +++ b/docs/plugins/autolabor.rst @@ -1,6 +1,9 @@ autolabor ========= +Tags: +:dfhack-keybind:`autolabor` + Automatically manage dwarf labors. Autolabor attempts to keep as many dwarves as possible busy while allowing dwarves to specialize in specific skills. @@ -49,7 +52,8 @@ dwarfs that meet any of these conditions: We stop assigning dwarves when we reach the maximum allowed. -Advanced usage: +Advanced usage +-------------- - ``autolabor [] []`` Set range of dwarves assigned to a labor, optionally specifying the size of @@ -68,7 +72,8 @@ Advanced usage: See `autolabor-artisans` for a differently-tuned setup. -Examples: +Examples +-------- - ``autolabor MINE 5`` Keep at least 5 dwarves with mining enabled. diff --git a/docs/plugins/automaterial.rst b/docs/plugins/automaterial.rst index 51701a1fc..429a25d70 100644 --- a/docs/plugins/automaterial.rst +++ b/docs/plugins/automaterial.rst @@ -1,6 +1,9 @@ automaterial ============ +Tags: +:dfhack-keybind:`automaterial` + Sorts building materials by recent usage. This makes building constructions (walls, floors, fortifications, etc) much easier by saving you from having to trawl through long lists of materials each time you place one. diff --git a/docs/plugins/automelt.rst b/docs/plugins/automelt.rst index 749aac28a..b16368ac5 100644 --- a/docs/plugins/automelt.rst +++ b/docs/plugins/automelt.rst @@ -1,6 +1,9 @@ automelt ======== +Tags: +:dfhack-keybind:`automelt` + Quickly designate items to be melted. When `enabled `, this plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``automelt`` option is selected for the stockpile, any items placed in the stockpile will automatically diff --git a/docs/plugins/autotrade.rst b/docs/plugins/autotrade.rst index e695a0a53..405621b2b 100644 --- a/docs/plugins/autotrade.rst +++ b/docs/plugins/autotrade.rst @@ -1,6 +1,9 @@ autotrade ========= +Tags: +:dfhack-keybind:`autotrade` + Quickly designate items to be traded. When `enabled `, this plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``autotrade`` option is selected for the stockpile, any items placed in the stockpile will automatically diff --git a/docs/plugins/blueprint.rst b/docs/plugins/blueprint.rst index edfc1f096..9d74fa47a 100644 --- a/docs/plugins/blueprint.rst +++ b/docs/plugins/blueprint.rst @@ -1,6 +1,9 @@ blueprint ========= +Tags: +:dfhack-keybind:`blueprint` + Record a live game map in a quickfort blueprint. With ``blueprint``, you can export the structure of a portion of your fortress in a blueprint file that you (or anyone else) can later play back with `quickfort`. @@ -16,7 +19,8 @@ Usage:: blueprint [] [ []] [] blueprint gui [ []] [] -Examples: +Examples +-------- - ``blueprint gui`` Runs `gui/blueprint`, the interactive frontend, where all configuration for @@ -30,7 +34,8 @@ Examples: the start of the blueprint area is set to a specific value instead of using the in-game cursor position. -Positional Parameters: +Positional parameters +--------------------- - ``width`` Width of the area (in tiles) to translate. @@ -46,7 +51,8 @@ Positional Parameters: some characters other than numbers so the name won't be confused with the optional ``depth`` parameter. -Phases: +Phases +------ If you want to generate blueprints only for specific phases, add their names to the commandline, anywhere after the blueprint base name. You can list multiple @@ -68,7 +74,8 @@ phases; just separate them with a space. If no phases are specified, phases are autodetected. For example, a ``#place`` blueprint will be created only if there are stockpiles in the blueprint area. -Options: +Options +------- - ``-c``, ``--cursor ,,`` Use the specified map coordinates instead of the current cursor position for @@ -98,7 +105,8 @@ Options: "none", which will create a standard quickfort `multi-blueprint ` file. -Output formats: +Output formats +-------------- Here are the values that can be passed to the ``--format`` flag: @@ -109,7 +117,8 @@ Here are the values that can be passed to the ``--format`` flag: Makes the blueprints in the ``.csv`` files easier to read and edit with a text editor by adding extra spacing and alignment markers. -Splitting output into multiple files: +Splitting output into multiple files +------------------------------------ The ``--splitby`` flag can take any of the following values: diff --git a/docs/plugins/building-hacks.rst b/docs/plugins/building-hacks.rst index 950d1751a..78e94fba6 100644 --- a/docs/plugins/building-hacks.rst +++ b/docs/plugins/building-hacks.rst @@ -1,6 +1,9 @@ building-hacks ============== +Tags: +:dfhack-keybind:`building-hacks` + Allows mods to create and manage powered workshops. Usage:: diff --git a/docs/plugins/buildingplan.rst b/docs/plugins/buildingplan.rst index 4b21da8af..62a239e3d 100644 --- a/docs/plugins/buildingplan.rst +++ b/docs/plugins/buildingplan.rst @@ -1,6 +1,9 @@ buildingplan ============ +Tags: +:dfhack-keybind:`buildingplan` + Plan building construction before you have materials. This plugin adds a planning mode for building placement. You can then place furniture, constructions, and other buildings before the required materials are available, diff --git a/docs/plugins/burrows.rst b/docs/plugins/burrows.rst index 658b7d209..f863dd439 100644 --- a/docs/plugins/burrows.rst +++ b/docs/plugins/burrows.rst @@ -1,6 +1,9 @@ burrows ======= +Tags: +:dfhack-keybind:`burrows` + Quick commands for burrow control. Allows manipulating burrows and automated burrow expansion while digging.