More docs work.

develop
Petr Mrázek 2012-02-05 06:02:44 +01:00
parent ebeae664d7
commit e51e4f6bd2
5 changed files with 70 additions and 65 deletions

@ -534,19 +534,19 @@ Manage control of repeat jobs.
Usage Usage
----- -----
workflow enable [option...], workflow disable [option...] ``workflow enable [option...], workflow disable [option...]``
If no options are specified, enables or disables the plugin. If no options are specified, enables or disables the plugin.
Otherwise, enables or disables any of the following options: Otherwise, enables or disables any of the following options:
- drybuckets: Automatically empty abandoned water buckets. - drybuckets: Automatically empty abandoned water buckets.
- auto-melt: Resume melt jobs when there are objects to melt. - auto-melt: Resume melt jobs when there are objects to melt.
workflow jobs ``workflow jobs``
List workflow-controlled jobs (if in a workshop, filtered by it). List workflow-controlled jobs (if in a workshop, filtered by it).
workflow list ``workflow list``
List active constraints, and their job counts. List active constraints, and their job counts.
workflow count <constraint-spec> <cnt-limit> [cnt-gap], workflow amount <constraint-spec> <cnt-limit> [cnt-gap] ``workflow count <constraint-spec> <cnt-limit> [cnt-gap], workflow amount <constraint-spec> <cnt-limit> [cnt-gap]``
Set a constraint. The first form counts each stack as only 1 item. Set a constraint. The first form counts each stack as only 1 item.
workflow unlimit <constraint-spec> ``workflow unlimit <constraint-spec>``
Delete a constraint. Delete a constraint.
Function Function
@ -565,28 +565,40 @@ the frequency of jobs being toggled.
Constraint examples Constraint examples
------------------- -------------------
Keep metal bolts within 900-1000, and wood/bone within 150-200. Keep metal bolts within 900-1000, and wood/bone within 150-200.
* workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 ::
* workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50
workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50
Keep the number of prepared food & drink stacks between 90 and 120 Keep the number of prepared food & drink stacks between 90 and 120
* workflow count FOOD 120 30 ::
* workflow count DRINK 120 30
workflow count FOOD 120 30
workflow count DRINK 120 30
Make sure there are always 25-30 empty bins/barrels/bags. Make sure there are always 25-30 empty bins/barrels/bags.
* workflow count BIN 30 ::
* workflow count BARREL 30
* workflow count BOX/CLOTH,SILK,YARN 30 workflow count BIN 30
workflow count BARREL 30
workflow count BOX/CLOTH,SILK,YARN 30
Make sure there are always 15-20 coal and 25-30 copper bars. Make sure there are always 15-20 coal and 25-30 copper bars.
* workflow count BAR//COAL 20 ::
* workflow count BAR//COPPER 30
workflow count BAR//COAL 20
workflow count BAR//COPPER 30
Collect 15-20 sand bags and clay boulders. Collect 15-20 sand bags and clay boulders.
* workflow count POWDER_MISC/SAND 20 ::
* workflow count BOULDER/CLAY 20
workflow count POWDER_MISC/SAND 20
workflow count BOULDER/CLAY 20
Make sure there are always 80-100 units of dimple dye. Make sure there are always 80-100 units of dimple dye.
* workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20 ::
workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20
In order for this to work, you have to set the material of the PLANT input on In order for this to work, you have to set the material of the PLANT input on
the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command. the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command.

@ -1168,7 +1168,7 @@ repeats with the last selected parameters.</p>
<div class="section" id="usage"> <div class="section" id="usage">
<h3><a class="toc-backref" href="#id98">Usage</a></h3> <h3><a class="toc-backref" href="#id98">Usage</a></h3>
<dl class="docutils"> <dl class="docutils">
<dt>workflow enable [option...], workflow disable [option...]</dt> <dt><tt class="docutils literal">workflow enable <span class="pre">[option...],</span> workflow disable <span class="pre">[option...]</span></tt></dt>
<dd><p class="first">If no options are specified, enables or disables the plugin. <dd><p class="first">If no options are specified, enables or disables the plugin.
Otherwise, enables or disables any of the following options:</p> Otherwise, enables or disables any of the following options:</p>
<ul class="last simple"> <ul class="last simple">
@ -1176,13 +1176,13 @@ Otherwise, enables or disables any of the following options:</p>
<li>auto-melt: Resume melt jobs when there are objects to melt.</li> <li>auto-melt: Resume melt jobs when there are objects to melt.</li>
</ul> </ul>
</dd> </dd>
<dt>workflow jobs</dt> <dt><tt class="docutils literal">workflow jobs</tt></dt>
<dd>List workflow-controlled jobs (if in a workshop, filtered by it).</dd> <dd>List workflow-controlled jobs (if in a workshop, filtered by it).</dd>
<dt>workflow list</dt> <dt><tt class="docutils literal">workflow list</tt></dt>
<dd>List active constraints, and their job counts.</dd> <dd>List active constraints, and their job counts.</dd>
<dt>workflow count &lt;constraint-spec&gt; &lt;cnt-limit&gt; [cnt-gap], workflow amount &lt;constraint-spec&gt; &lt;cnt-limit&gt; [cnt-gap]</dt> <dt><tt class="docutils literal">workflow count <span class="pre">&lt;constraint-spec&gt;</span> <span class="pre">&lt;cnt-limit&gt;</span> <span class="pre">[cnt-gap],</span> workflow amount <span class="pre">&lt;constraint-spec&gt;</span> <span class="pre">&lt;cnt-limit&gt;</span> <span class="pre">[cnt-gap]</span></tt></dt>
<dd>Set a constraint. The first form counts each stack as only 1 item.</dd> <dd>Set a constraint. The first form counts each stack as only 1 item.</dd>
<dt>workflow unlimit &lt;constraint-spec&gt;</dt> <dt><tt class="docutils literal">workflow unlimit <span class="pre">&lt;constraint-spec&gt;</span></tt></dt>
<dd>Delete a constraint.</dd> <dd>Delete a constraint.</dd>
</dl> </dl>
</div> </div>
@ -1199,46 +1199,39 @@ the frequency of jobs being toggled.</p>
</div> </div>
<div class="section" id="constraint-examples"> <div class="section" id="constraint-examples">
<h3><a class="toc-backref" href="#id100">Constraint examples</a></h3> <h3><a class="toc-backref" href="#id100">Constraint examples</a></h3>
<dl class="docutils"> <p>Keep metal bolts within 900-1000, and wood/bone within 150-200.</p>
<dt>Keep metal bolts within 900-1000, and wood/bone within 150-200.</dt> <pre class="literal-block">
<dd><ul class="first last simple"> workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
<li>workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100</li> workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50
<li>workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50</li> </pre>
</ul> <p>Keep the number of prepared food &amp; drink stacks between 90 and 120</p>
</dd> <pre class="literal-block">
<dt>Keep the number of prepared food &amp; drink stacks between 90 and 120</dt> workflow count FOOD 120 30
<dd><ul class="first last simple"> workflow count DRINK 120 30
<li>workflow count FOOD 120 30</li> </pre>
<li>workflow count DRINK 120 30</li> <p>Make sure there are always 25-30 empty bins/barrels/bags.</p>
</ul> <pre class="literal-block">
</dd> workflow count BIN 30
<dt>Make sure there are always 25-30 empty bins/barrels/bags.</dt> workflow count BARREL 30
<dd><ul class="first last simple"> workflow count BOX/CLOTH,SILK,YARN 30
<li>workflow count BIN 30</li> </pre>
<li>workflow count BARREL 30</li> <p>Make sure there are always 15-20 coal and 25-30 copper bars.</p>
<li>workflow count BOX/CLOTH,SILK,YARN 30</li> <pre class="literal-block">
</ul> workflow count BAR//COAL 20
</dd> workflow count BAR//COPPER 30
<dt>Make sure there are always 15-20 coal and 25-30 copper bars.</dt> </pre>
<dd><ul class="first last simple"> <p>Collect 15-20 sand bags and clay boulders.</p>
<li>workflow count BAR//COAL 20</li> <pre class="literal-block">
<li>workflow count BAR//COPPER 30</li> workflow count POWDER_MISC/SAND 20
</ul> workflow count BOULDER/CLAY 20
</dd> </pre>
<dt>Collect 15-20 sand bags and clay boulders.</dt> <p>Make sure there are always 80-100 units of dimple dye.</p>
<dd><ul class="first last simple"> <pre class="literal-block">
<li>workflow count POWDER_MISC/SAND 20</li> workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20
<li>workflow count BOULDER/CLAY 20</li>
</ul> In order for this to work, you have to set the material of the PLANT input on
</dd> the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command.
<dt>Make sure there are always 80-100 units of dimple dye.</dt> </pre>
<dd><ul class="first simple">
<li>workflow amount POWDER_MISC//MUSHROOM_CUP_DIMPLE:MILL 100 20</li>
</ul>
<p class="last">In order for this to work, you have to set the material of the PLANT input on
the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command.</p>
</dd>
</dl>
</div> </div>
</div> </div>
</div> </div>

@ -1 +1 @@
Subproject commit 64a7aeb6a87b7b5067ace8f6a869b7b4fe6561a4 Subproject commit 03b768f1158e675f2a4937ce857f2cd5acb58103

@ -1 +1 @@
Subproject commit c114ec5f995aec69631187212254309464f82775 Subproject commit 23fbb78edaff35a62887803e178a24f9148ffc84

@ -1 +1 @@
Subproject commit 92627e39cb3502812cd5a131716d3d1da8ef625a Subproject commit f824e83b5c4f4dfc1bbe60681d8dc6ed88f3f4f9