From e92d63d248fa7200dd0da9f1b82a0c89700e05f1 Mon Sep 17 00:00:00 2001 From: PeridexisErrant Date: Sat, 26 Sep 2015 16:50:02 +1000 Subject: [PATCH] Final documentation changes Squashes a couple of commits from the other branch onto the last one here. --- NEWS | 4 ++-- README.html | 6 +++--- docs/Authors.rst | 6 +++--- docs/Binpatches.rst | 3 ++- docs/Plugins.rst | 2 ++ docs/Scripts.rst | 18 +++++++++++++++--- 6 files changed, 27 insertions(+), 12 deletions(-) diff --git a/NEWS b/NEWS index 8f73a0b9d..d8ffd3fef 100644 --- a/NEWS +++ b/NEWS @@ -1,8 +1,8 @@ .. comment This is the changelog file for DFHack. If you add or change anything, note it here under the heading "DFHack Future", in the appropriate section. - Items within each section are listed in order of addition. Try to match the - style and level of detail of the other entries. + Items within each section are listed in alphabetical order to minimise merge + conflicts. Try to match the style and level of detail of the other entries. DFHack Future diff --git a/README.html b/README.html index 78d1c6b38..481058eb4 100644 --- a/README.html +++ b/README.html @@ -4,13 +4,13 @@ - + Page Redirection - If you are not redirected automatically, follow the link to the documentation. + If you are not redirected automatically, follow the link to the documentation. \ No newline at end of file diff --git a/docs/Authors.rst b/docs/Authors.rst index 40055f405..6a86007e6 100644 --- a/docs/Authors.rst +++ b/docs/Authors.rst @@ -5,9 +5,9 @@ particular order. If you should be here and aren't, please get in touch or make a pull request! -======================= ==================== =========================== +======================= ======================= =========================== Name Github Email -======================= ==================== =========================== +======================= ======================= =========================== Petr Mrázek peterix peterix@gmail.com Alexander Gavrilov angavrilov angavrilov@gmail.com doomchild doomchild lee.crabtree@gmail.com @@ -86,4 +86,4 @@ Vjek Kris Parker kaypy Jonas Ask jonask84@gmail.com 8Z 8Z git8z@ya.ru -======================= ==================== =========================== +======================= ======================= =========================== diff --git a/docs/Binpatches.rst b/docs/Binpatches.rst index 994957b1b..4ecdfa79b 100644 --- a/docs/Binpatches.rst +++ b/docs/Binpatches.rst @@ -55,7 +55,8 @@ script uses ``hack/patches//.dif``, thus auto-selecting the version appropriate for the currently loaded executable. This is the preferred method; it's easier to debug, does not cause persistent -problems, and leaves file checksums alone. +problems, and leaves file checksums alone. As with many other commands, users +can simply add it to ``dfhack.init`` to reapply the patch every time DF is run. Patching on disk diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 656df680d..fb948588f 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -2197,6 +2197,8 @@ Examples: * You switch to the adventure game mode, assume control of a creature, then save or retire. * You just created a returnable mountain home and gained an adventurer. +.. _plugins/strangemood: + strangemood =========== Creates a strange mood job the same way the game itself normally does it. diff --git a/docs/Scripts.rst b/docs/Scripts.rst index d28914c47..90f213eb4 100644 --- a/docs/Scripts.rst +++ b/docs/Scripts.rst @@ -23,12 +23,24 @@ the next instruction. This listing is autogenerated from ``.rst`` files in the 3rdparty scripts directory. +.. warning:: + + Because this documentation is pulled in from external sources, + it may not match the DFHack distribution exactly. + + * Some scripts should have a prefix (eg listed as ``myscript``, + should be ``gui/myscript``) but don't. + * Some sections of documentation may refer to scripts which are + not distributed with DFHack. + + .. toctree:: :glob: :maxdepth: 2 /scripts/3rdparty/*/* + ======= devel/* ======= @@ -649,7 +661,7 @@ Runs `plugins/autolabor`, with settings tuned for small but highly skilled workf autounsuspend ============= -Automatically unsuspend construction jobs, on a recurring basis. +Automatically unsuspend jobs in workshops, on a recurring basis. See `scripts/unsuspend` for one-off use, or `plugins/resume` ``all``. ban-cooking @@ -1205,8 +1217,8 @@ Undesignates building base materials for dumping. unsuspend ========= -Unsuspend construction jobs, on a one-off basis. See `scripts/autounsuspend` for regular use. -Equivalent to `plugins/resume` ``all``. +Unsuspend jobs in workshops, on a one-off basis. See `scripts/autounsuspend` +for regular use. .. _scripts/view-item-info: