diff options
| author | Petr Mrázek | 2012-02-05 06:02:44 +0100 |
|---|---|---|
| committer | Petr Mrázek | 2012-02-05 06:02:44 +0100 |
| commit | e51e4f6bd2e334f790089f511172cdf8fc2aa6ff (patch) | |
| tree | 030c4eee0881ac4b6fcd9bf0df9b4d0bbf0a36e0 | |
| parent | ebeae664d70bcfdb20845b5380813d7d8cc897bd (diff) | |
| download | dfhack-e51e4f6bd2e334f790089f511172cdf8fc2aa6ff.tar.gz dfhack-e51e4f6bd2e334f790089f511172cdf8fc2aa6ff.tar.bz2 dfhack-e51e4f6bd2e334f790089f511172cdf8fc2aa6ff.tar.xz | |
More docs work.
| -rw-r--r-- | README.rst | 46 | ||||
| -rw-r--r-- | Readme.html | 83 | ||||
| m--------- | library/xml | 0 | ||||
| m--------- | plugins/df2mc | 0 | ||||
| m--------- | plugins/stonesense | 0 |
5 files changed, 67 insertions, 62 deletions
@@ -534,19 +534,19 @@ Manage control of repeat jobs. Usage ----- -workflow enable [option...], workflow disable [option...] +``workflow enable [option...], workflow disable [option...]`` If no options are specified, enables or disables the plugin. Otherwise, enables or disables any of the following options: - drybuckets: Automatically empty abandoned water buckets. - 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). -workflow list +``workflow list`` 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. -workflow unlimit <constraint-spec> +``workflow unlimit <constraint-spec>`` Delete a constraint. Function @@ -565,28 +565,40 @@ the frequency of jobs being toggled. Constraint examples ------------------- 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 - * 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. - * 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. - * 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. - * 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. - * 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 the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command.
\ No newline at end of file diff --git a/Readme.html b/Readme.html index 7d9e9bbc..0801996d 100644 --- a/Readme.html +++ b/Readme.html @@ -1168,7 +1168,7 @@ repeats with the last selected parameters.</p> <div class="section" id="usage"> <h3><a class="toc-backref" href="#id98">Usage</a></h3> <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. Otherwise, enables or disables any of the following options:</p> <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> </ul> </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> -<dt>workflow list</dt> +<dt><tt class="docutils literal">workflow list</tt></dt> <dd>List active constraints, and their job counts.</dd> -<dt>workflow count <constraint-spec> <cnt-limit> [cnt-gap], workflow amount <constraint-spec> <cnt-limit> [cnt-gap]</dt> +<dt><tt class="docutils literal">workflow count <span class="pre"><constraint-spec></span> <span class="pre"><cnt-limit></span> <span class="pre">[cnt-gap],</span> workflow amount <span class="pre"><constraint-spec></span> <span class="pre"><cnt-limit></span> <span class="pre">[cnt-gap]</span></tt></dt> <dd>Set a constraint. The first form counts each stack as only 1 item.</dd> -<dt>workflow unlimit <constraint-spec></dt> +<dt><tt class="docutils literal">workflow unlimit <span class="pre"><constraint-spec></span></tt></dt> <dd>Delete a constraint.</dd> </dl> </div> @@ -1199,46 +1199,39 @@ the frequency of jobs being toggled.</p> </div> <div class="section" id="constraint-examples"> <h3><a class="toc-backref" href="#id100">Constraint examples</a></h3> -<dl class="docutils"> -<dt>Keep metal bolts within 900-1000, and wood/bone within 150-200.</dt> -<dd><ul class="first last simple"> -<li>workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100</li> -<li>workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50</li> -</ul> -</dd> -<dt>Keep the number of prepared food & drink stacks between 90 and 120</dt> -<dd><ul class="first last simple"> -<li>workflow count FOOD 120 30</li> -<li>workflow count DRINK 120 30</li> -</ul> -</dd> -<dt>Make sure there are always 25-30 empty bins/barrels/bags.</dt> -<dd><ul class="first last simple"> -<li>workflow count BIN 30</li> -<li>workflow count BARREL 30</li> -<li>workflow count BOX/CLOTH,SILK,YARN 30</li> -</ul> -</dd> -<dt>Make sure there are always 15-20 coal and 25-30 copper bars.</dt> -<dd><ul class="first last simple"> -<li>workflow count BAR//COAL 20</li> -<li>workflow count BAR//COPPER 30</li> -</ul> -</dd> -<dt>Collect 15-20 sand bags and clay boulders.</dt> -<dd><ul class="first last simple"> -<li>workflow count POWDER_MISC/SAND 20</li> -<li>workflow count BOULDER/CLAY 20</li> -</ul> -</dd> -<dt>Make sure there are always 80-100 units of dimple dye.</dt> -<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> +<p>Keep metal bolts within 900-1000, and wood/bone within 150-200.</p> +<pre class="literal-block"> +workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 +workflow amount AMMO:ITEM_AMMO_BOLTS/WOOD,BONE 200 50 +</pre> +<p>Keep the number of prepared food & drink stacks between 90 and 120</p> +<pre class="literal-block"> +workflow count FOOD 120 30 +workflow count DRINK 120 30 +</pre> +<p>Make sure there are always 25-30 empty bins/barrels/bags.</p> +<pre class="literal-block"> +workflow count BIN 30 +workflow count BARREL 30 +workflow count BOX/CLOTH,SILK,YARN 30 +</pre> +<p>Make sure there are always 15-20 coal and 25-30 copper bars.</p> +<pre class="literal-block"> +workflow count BAR//COAL 20 +workflow count BAR//COPPER 30 +</pre> +<p>Collect 15-20 sand bags and clay boulders.</p> +<pre class="literal-block"> +workflow count POWDER_MISC/SAND 20 +workflow count BOULDER/CLAY 20 +</pre> +<p>Make sure there are always 80-100 units of dimple dye.</p> +<pre class="literal-block"> + 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 +the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command. +</pre> </div> </div> </div> diff --git a/library/xml b/library/xml -Subproject 64a7aeb6a87b7b5067ace8f6a869b7b4fe6561a +Subproject 03b768f1158e675f2a4937ce857f2cd5acb5810 diff --git a/plugins/df2mc b/plugins/df2mc -Subproject c114ec5f995aec69631187212254309464f8277 +Subproject 23fbb78edaff35a62887803e178a24f9148ffc8 diff --git a/plugins/stonesense b/plugins/stonesense -Subproject 92627e39cb3502812cd5a131716d3d1da8ef625 +Subproject f824e83b5c4f4dfc1bbe60681d8dc6ed88f3f4f |
