diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst index 68db5ed13..8efa9e0cd 100644 --- a/docs/guides/quickfort-user-guide.rst +++ b/docs/guides/quickfort-user-guide.rst @@ -33,7 +33,7 @@ Browse them on your computer or :source:`online `, or run ``quickfort list -l`` at the ``[DFHack]#`` prompt to list them, and then ``quickfort run`` to apply them to your fort! -See the `Links section <#links>`__ for more information and online resources. +See the `Links`_ section for more information and online resources. .. contents:: Table of Contents @@ -143,7 +143,7 @@ If no modeline appears in the first cell, the file or sheet is interpreted as a ``#dig`` blueprint. There are also "meta" and "notes" blueprints, but we'll talk about -`those <#meta-blueprints>`__ `later <#notes-blueprints>`__. +`those ` `later `. Optionally following this keyword and a space, you may enter a comment. This comment will appear in the output of ``quickfort list`` when run from the @@ -406,6 +406,8 @@ each floor. The marker must appear in the first column of the row to be recognized, just like a modeline. +.. _quickfort-dig-priorities: + Dig priorities ~~~~~~~~~~~~~~ @@ -675,6 +677,8 @@ Which would result in a carved track simliar to a constructed track of the form: trackNE trackEW trackNW # # # # # +.. _quickfort-modeline: + Modeline markers ~~~~~~~~~~~~~~~~ @@ -708,18 +712,20 @@ elements before we discuss them in more detail: #dig label(digdining) hidden() managed by the digwholefort meta blueprint #zone label(pastures) message(remember to assign animals to the new pastures) +.. _quickfort-label: + Blueprint labels ```````````````` Labels are displayed in the ``quickfort list`` output and are used for addressing specific blueprints when there are multiple blueprints in a single -file or spreadsheet sheet (see `Packaging a set of -blueprints <#packaging-a-set-of-blueprints>`__ below). If a blueprint has no -label, the label becomes the ordinal of the blueprint's position in the file or -sheet. For example, the label of the first blueprint will be "1" if it is not -otherwise set, the label of the second blueprint will be "2" if it is not -otherwise set, etc. Labels that are explicitly defined must start with a letter -to ensure the auto-generated labels don't conflict with user-defined labels. +file or spreadsheet sheet (see `Packaging a set of blueprints`_ below). If a +blueprint has no label, the label becomes the ordinal of the blueprint's +position in the file or sheet. For example, the label of the first blueprint +will be "1" if it is not otherwise set, the label of the second blueprint will +be "2" if it is not otherwise set, etc. Labels that are explicitly defined must +start with a letter to ensure the auto-generated labels don't conflict with +user-defined labels. Start positions ``````````````` @@ -755,6 +761,8 @@ to the ``masonw`` blueprint above could look like this: #meta start(center of workshop) a mason workshop /masonw +.. _quickfort-hidden: + Hiding blueprints ````````````````` @@ -762,7 +770,9 @@ A blueprint with a ``hidden()`` marker won't appear in ``quickfort list`` output unless the ``--hidden`` flag is specified. The primary reason for hiding a blueprint (rather than, say, deleting it or moving it out of the ``blueprints/`` folder) is if a blueprint is intended to be run as part of a larger sequence -managed by a `meta blueprint <#meta-blueprints>`__. +managed by a `meta blueprint `. + +.. _quickfort-message: Messages ```````` @@ -778,6 +788,8 @@ series of blueprints. For long or multi-part messages, you can embed newlines: "#meta label(surface1) message(This would be a good time to start digging the industry level. Once the area is clear, continue with /surface2.) clear the embark site and set up pastures" +.. _quickfort-packaging: + Packaging a set of blueprints ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -845,6 +857,8 @@ files and just give related blueprints similar names: But the naming and organization is completely up to you. +.. _quickfort-meta: + Meta blueprints ~~~~~~~~~~~~~~~ @@ -861,11 +875,10 @@ blueprint packages follow this pattern: Those three "apply"s in the middle might as well get done in one command instead of three. A meta blueprint can encode that sequence. A meta blueprint refers to -other blueprints by their label (see the `Modeline markers -<#modeline-markers>`__ section above) in the same format used by the ``DFHack#`` -quickfort command: ``/