tailor: add docs

Ref #1398
develop
lethosor 2019-11-02 21:07:10 -04:00
parent ba8b828e69
commit c2e5ae844c
2 changed files with 20 additions and 5 deletions

@ -1480,7 +1480,7 @@ Some widgets support additional options:
.. _dwarfvet: .. _dwarfvet:
dwarfvet dwarfvet
============ ========
Enables Animal Caretaker functionality Enables Animal Caretaker functionality
Always annoyed your dragons become useless after a minor injury? Well, with Always annoyed your dragons become useless after a minor injury? Well, with
@ -1831,6 +1831,21 @@ nestboxes
Automatically scan for and forbid fertile eggs incubating in a nestbox. Automatically scan for and forbid fertile eggs incubating in a nestbox.
Toggle status with `enable` or `disable`. Toggle status with `enable` or `disable`.
.. _tailor:
tailor
======
Whenever the bookkeeper updates stockpile records, this plugin will scan every unit in the fort,
count up the number that are worn, and then order enough more made to replace all worn items.
If there are enough replacement items in inventory to replace all worn items, the units wearing them
will have the worn items confiscated (in the same manner as the `cleanowned` plugin) so that they'll
reeequip with replacement items.
Use the `enable` and `disable` commands to toggle this plugin's status, or run
``tailor status`` to check its current status.
================ ================
Map modification Map modification
================ ================

@ -50,7 +50,7 @@ const char *usage = (
" tailor status\n" " tailor status\n"
" Display plugin status\n" " Display plugin status\n"
"\n" "\n"
"Whenever the bookkeeper updates stockpile records, the plugin will scan every unit in the fort, \n" "Whenever the bookkeeper updates stockpile records, this plugin will scan every unit in the fort,\n"
"count up the number that are worn, and then order enough more made to replace all worn items.\n" "count up the number that are worn, and then order enough more made to replace all worn items.\n"
"If there are enough replacement items in inventory to replace all worn items, the units wearing them\n" "If there are enough replacement items in inventory to replace all worn items, the units wearing them\n"
"will have the worn items confiscated (in the same manner as the _cleanowned_ plugin) so that they'll\n" "will have the worn items confiscated (in the same manner as the _cleanowned_ plugin) so that they'll\n"