From e37b7650fa3875e29f1987536c08cf88df684336 Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 5 Sep 2022 20:53:44 -0700 Subject: [PATCH] update guides including fixing the ordering of the TOC, which, while in alphabetical order, was not in a logical order --- docs/guides/examples-guide.rst | 10 +++++----- docs/guides/index.rst | 6 ++++-- docs/guides/quickfort-alias-guide.rst | 7 ++++--- docs/guides/quickfort-library-guide.rst | 4 ++-- docs/guides/quickfort-user-guide.rst | 5 ++--- 5 files changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/guides/examples-guide.rst b/docs/guides/examples-guide.rst index f61ada4d7..74f94c20b 100644 --- a/docs/guides/examples-guide.rst +++ b/docs/guides/examples-guide.rst @@ -1,8 +1,8 @@ .. _config-examples-guide: .. _dfhack-examples-guide: -DFHack Example Configuration File Index -======================================= +DFHack Config File Examples +=========================== The :source:`hack/examples ` folder contains ready-to-use examples of various DFHack configuration files. You can use them by copying them @@ -14,8 +14,8 @@ The ``init/`` subfolder ----------------------- The :source:`init/ ` subfolder contains useful DFHack -`init-files` that you can copy into your main Dwarf Fortress folder -- the same -directory as ``dfhack.init``. +`init-files` that you can copy into your :file:`dfhack-config/init` folder -- +the same directory as ``dfhack.init``. .. _onMapLoad-dreamfort-init: @@ -35,7 +35,7 @@ it is useful (and customizable) for any fort. It includes the following config: - Periodically enqueues orders to shear and milk shearable and milkable pets. - Sets up `autofarm` to grow 30 units of every crop, except for pig tails, which is set to 150 units to support the textile industry. -- Sets up `seedwatch` to keep 30 of every type of seed. +- Sets up `seedwatch` to protect 30 of every type of seed. - Configures `prioritize` to automatically boost the priority of important and time-sensitive tasks that could otherwise get ignored in busy forts, like hauling food, tanning hides, storing items in vehicles, pulling levers, and diff --git a/docs/guides/index.rst b/docs/guides/index.rst index 7208b5276..d0125921f 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -6,6 +6,8 @@ These pages are detailed guides covering DFHack tools. .. toctree:: :maxdepth: 1 - :glob: - * + /docs/guides/examples-guide + /docs/guides/quickfort-library-guide + /docs/guides/quickfort-user-guide + /docs/guides/quickfort-alias-guide diff --git a/docs/guides/quickfort-alias-guide.rst b/docs/guides/quickfort-alias-guide.rst index 6afad7569..d4be8aecd 100644 --- a/docs/guides/quickfort-alias-guide.rst +++ b/docs/guides/quickfort-alias-guide.rst @@ -1,10 +1,11 @@ .. _quickfort-alias-guide: -Quickfort Keystroke Alias Guide -=============================== +Quickfort Keystroke Alias Reference +=================================== Aliases allow you to use simple words to represent complicated key sequences -when configuring buildings and stockpiles in quickfort ``#query`` blueprints. +when configuring buildings and stockpiles in quickfort ``#query`` and +``#config`` blueprints. For example, say you have the following ``#build`` and ``#place`` blueprints:: diff --git a/docs/guides/quickfort-library-guide.rst b/docs/guides/quickfort-library-guide.rst index be76c7afe..de5409ab3 100644 --- a/docs/guides/quickfort-library-guide.rst +++ b/docs/guides/quickfort-library-guide.rst @@ -1,8 +1,8 @@ .. _blueprint-library-guide: .. _quickfort-library-guide: -Blueprint Library Index -======================= +Quickfort Blueprint Library +=========================== This guide contains a high-level overview of the blueprints available in the :source:`quickfort blueprint library `. diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 0af0924b0..9c7d3ed44 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -29,9 +29,8 @@ For those just looking to apply existing blueprints, check out the `quickfort command's documentation ` for syntax. There are also many ready-to-use blueprints available in the ``blueprints/library`` subfolder in your DFHack installation. Browse them on your computer or -:source:`online `, or run ``quickfort list`` at the -``[DFHack]#`` prompt to list them, and then ``quickfort run`` to apply them to -your fort! +:source:`online `, or run `gui/quickfort` to browse +and apply them to your fort! Before you become an expert at writing blueprints, though, you should know that the easiest way to make a quickfort blueprint is to build your plan "for real"