MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs for search

develop
myk002 2022-07-29 17:38:23 -07:00
parent aa3a389b6f
commit f785a910ff
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/plugins/search.rst
Unescape Escape View File

@ -1,40 +1,44 @@
.. _search-plugin: .. _search-plugin:
search search
====== ======
The search plugin adds search to the Stocks, Animals, Trading, Stockpile, Tags:
Noble (assignment candidates), Military (position candidates), Burrows
(unit list), Rooms, Announcements, Job List and Unit List screens. The search plugin adds search capabilities to the Stocks, Animals, Trading,
Stockpile, Noble (assignment candidates), Military (position candidates),
Burrows (unit list), Rooms, Announcements, Job List, and Unit List screens.
Usage::
enable search
.. image:: ../images/search.png .. image:: ../images/search.png
Searching works the same way as the search option in :guilabel:`Move to Depot`. Searching works the same way as the search option in :guilabel:`Move to Depot`.
You will see the Search option displayed on screen with a hotkey (usually :kbd:`s`). You will see the Search option displayed on screen with a hotkey
Pressing it lets you start typing a query and the relevant list will start (usually :kbd:`s`). Pressing it lets you start typing a query and the relevant
filtering automatically. list will start filtering automatically.
Pressing :kbd:`Enter`, :kbd:`Esc` or the arrow keys will return you to browsing the now Pressing :kbd:`Enter`, :kbd:`Esc` or the arrow keys will return you to browsing
filtered list, which still functions as normal. You can clear the filter the now filtered list, which still functions as normal. You can clear the filter
by either going back into search mode and backspacing to delete it, or by either going back into search mode and backspacing to delete it, or pressing
pressing the "shifted" version of the search hotkey while browsing the the "shifted" version of the search hotkey while browsing the list (e.g. if the
list (e.g. if the hotkey is :kbd:`s`, then hitting :kbd:`Shift`:kbd:`s` will clear any hotkey is :kbd:`s`, then hitting :kbd:`Shift`:kbd:`s` will clear any filter).
filter).
Leaving any screen automatically clears the filter. Leaving any screen automatically clears the filter.
In the Trade screen, the actual trade will always only act on items that In the Trade screen, the actual trade will always only act on items that are
are actually visible in the list; the same effect applies to the Trade actually visible in the list; the same effect applies to the Trade Value numbers
Value numbers displayed by the screen. Because of this, the :kbd:`t` key is displayed by the screen. Because of this, the :kbd:`t` key is blocked while
blocked while search is active, so you have to reset the filters first. search is active, so you have to reset the filters first. Pressing
Pressing :kbd:`Alt`:kbd:`C` will clear both search strings. :kbd:`Alt`:kbd:`C` will clear both search strings.
In the stockpile screen the option only appears if the cursor is in the In the stockpile screen the option only appears if the cursor is in the
rightmost list: rightmost list:
.. image:: ../images/search-stockpile.png .. image:: ../images/search-stockpile.png
Note that the 'Permit XXX'/'Forbid XXX' keys conveniently operate only Note that the 'Permit XXX'/'Forbid XXX' keys conveniently operate only on items
on items actually shown in the rightmost list, so it is possible to select actually shown in the rightmost list, so it is possible to select only fat or
only fat or tallow by forbidding fats, then searching for fat/tallow, and tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats
using Permit Fats again while the list is filtered. again while the list is filtered.