Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/order-trim-workorders.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
order-trim-workorders
=====================

.. dfhack-tool::
:summary: Pick, pretty-format, and trim work orders from DFHack order JSON files.
:tags: fort gui workorders
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can't just make up new tags here you; there is no gui tag which is why the build fails

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I've removed that line as I wasn't using tags appropriately.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not tagging the tool at all is also not a solution. Release select appropriate tags from the collection of available tags


This script provides a two-step UI for trimming work order files in
``dfhack-config/orders``:

1. A picker that lists ``.json`` files and filters by filename.
2. A trimmer that opens a pretty-formatted ``.txt`` variant and lets you mark
whole work-order objects for deletion.

When a work order is marked, the full top-level JSON object is targeted
(including lines currently hidden by hide-noise view filtering).

Usage
-----

::

order-trim-workorders
order-trim-workorders --file <orders.json>

Arguments
---------

``--file <path-or-name>``
Pretty-formats the target ``.json`` into its ``.txt`` variant without
opening the picker UI. If only a filename is provided, it is resolved under
``dfhack-config/orders``.

Picker controls
---------------

- Type in ``Search`` to filter filenames.
- :kbd:`Enter` or click opens the selected file in the trimmer.
- :kbd:`Esc` closes.

Trimmer controls
----------------

- Click to select a line.
- Toggle mark for the selected work order with:

- double left-click on the same line, or
- :kbd:`Enter` / :kbd:`Space`

- Hotkeys:

- :kbd:`Alt` + :kbd:`D`: apply deletions (remove all marked lines)
- :kbd:`Alt` + :kbd:`S`: save
- :kbd:`Alt` + :kbd:`R`: reload from disk
- :kbd:`Alt` + :kbd:`H`: toggle hide-noise display filter

- :kbd:`Esc` closes (prompts if there are unsaved changes).

Notes
-----

- Save writes both the working ``.txt`` file and its companion ``.json`` file.
- Search in the trimmer shows whole matching work-order groups.
- Alternating row colors are used to help distinguish adjacent work orders.
Loading
Loading