quickfort: refresh aliases docs and doc r+ -> r+&

data/quickfort/aliases-common.txt

@@ -7,7 +7,7 @@
 # The aliases in this file were tested in DF 0.47.04 on 2020 Jul 18.
 #
 # The aliases are generally split into three categories:
-# 1) The aliases that name a type disables everything else for that stockpile
+# 1) The aliases that name a type disable everything else for that stockpile
 #    category and enable only that type. For example, "preparedfood" enables
 #    prepared food and disables all other types of food.
 # 2) The aliases that start with "forbid" only forbid (or toggle) the named type
@@ -17,6 +17,10 @@
 #
 # Aliases that don't fit into those two categories have comments explaining
 # their usage.
+#
+# There is also a non-alphanumeric alias built into the code for the common
+# shorthand for "make room":
+#   r+   expands to r+&
 
 
 ########################################
@@ -55,10 +59,12 @@ quantum: {linksonly}{nocontainers}{enableanimals}{enablefood}{furnitureprefix}{e
 # Run one of the quantumstopfrom* aliases over a track stop that is set to dump
 # into a quantum stockpile. The alias will set up the stop to accept all types
 # (the actual types stored in the quantum stockpile is controlled by the feeder
-# stockpile) and link the indicated adjacent feeder stockpile. All you need to
+# stockpile) and link the indicated adjacent feeder stockpile (for example, the
-# do afterwards is assign a vehicle to the stop (and optionally give the route a
+# quantumstopfromsouth alias will link to a feeder stockpile to the South). All
-# name --see the namelastroute* aliases below). The track stop does not need to
+# you need to do afterwards is assign a vehicle to the stop (and optionally
-# be constructed yet, but the feeder stockpile needs to exist so we can link it.
+# give the route a name --see the namelastroute* aliases below). The track stop
+# does not need to be constructed yet, but the feeder stockpile needs to exist
+# so we can link it.
 quantumstopprefix: ^hrs&xxx&{enablesequence 17}^
 quantumstopfromeast: {quantumstopprefix}s{Right}p^{Left}^q
 quantumstopfromsouth: {quantumstopprefix}s{Down}p^{Up}^q
@@ -130,7 +136,7 @@ permitmiscliquid:     {foodprefix}{Right}{Down 18}p^
 noseeds: {disablefood}{enablefood}{forbidseeds}
 
 # enables all food except for the types listed above
-food:    {noseeds}{forbidpreparedfood}{forbidunpreparedfish}{forbidplants}{forbidbooze}{forbiddye}{forbidtallow}{forbidmiscliquid}
+food: {noseeds}{forbidpreparedfood}{forbidunpreparedfish}{forbidplants}{forbidbooze}{forbiddye}{forbidtallow}{forbidmiscliquid}
 
 
 ##################################

dfhack-config/quickfort/aliases.txt

@@ -3,7 +3,7 @@
 # This file defines custom keycode shortcuts for query mode blueprints.
 # Definitions in this file take precedence over any definitions in the baseline
 # aliases configuration file at hack/data/quickfort/aliases-common.txt. See that
-# file for aliases that are already defined.
+# file for the many useful aliases that are already defined.
 #
 # If possible, build on the baseline aliases when defining your own aliases. If
 # the DF UI screens change, updated baseline aliases may allow your aliases to
@@ -18,36 +18,42 @@
 # matter of mimicking the keys used to navigate through the menus and select
 # options. Use the aliases in your blueprint spreadsheets by writing an alias by
 # itself in a cell, like "nocontainers", or reference an alias in a larger
-# sequence by enclosing in in curly brackets, like "{nocontainers}{linksonly}"
+# sequence by enclosing it in curly brackets, like "{nocontainers}{linksonly}"
 #
 # For example, say you have the following build and place blueprints:
 #
-# #build start(4;1;upper left corner of stockpile) mason stockpile
+# #build start(4;1;upper left corner of stockpile) build masonry workshop
-# ~,  ~, ~, `, `, `
+# ~, ~,~,`,`,`
-# ~, wm, ~, `, `, `
+# ~,wm,~,`,`,`
-# ~,  ~, ~, `, `, `
+# ~, ~,~,`,`,`
 #
-# #place start(4;1;upper left corner of stockpile) build mason
+# #place start(4;1;upper left corner of stockpile) place stockpile for mason
-# ~, ~, ~, s, s, s
+# ~,~,~,s,s,s
-# ~, ~, ~, s, s, s
+# ~,~,~,s,s,s
-# ~, ~, ~, s, s, s
+# ~,~,~,s,s,s
 #
 # and you want to configure the stockpile to hold only non-economic ("other")
 # stone and to give to the adjacent mason workshop. You could write the
 # keystrokes directly:
 #
 # #query start(4;1;upper left corner of stockpile) configure mason
-# ~, ~, ~, s{Down 5}deb{Right}{Down 2}p^, `, `
+# ~,~,~,s{Down 5}deb{Right}{Down 2}p^,`,`
-# ~, ~, ~, g{Left 2}&, `, `
+# ~,~,~,g{Left 2}&,                   `,`
-# ~, ~, ~, `, `, `
+# ~,~,~,`,                            `,`
 #
 # or you could use alias names:
 #
 # #query start(4;1;upper left corner of stockpile) configure mason
-# ~, ~, ~, otherstone, `, `
+# ~,~,~,otherstone,`,`
-# ~, ~, ~, give2left,  `, `
+# ~,~,~,give2left, `,`
-# ~, ~, ~, `,          `, `
+# ~,~,~,`,         `,`
 #
+# you can combine the two aliases above into a single cell as well, if desired:
+#
+# #query start(4;1;upper left corner of stockpile) configure mason
+# ~,~,~,{otherstone}{give2left},`,`
+# ~,~,~,`,                      `,`
+# ~,~,~,`,                      `,`
 #
 # The syntax for defining aliases is:
 #   aliasname: keystrokes
@@ -63,10 +69,10 @@
 #
 # Anything enclosed within curly brackets can also have a number after it,
 # indicating how many times that alias or keycode should be repeated. For
-# example: "{buildblocks 9}" or "{Down 5}".
+# example: "{togglesequence 9}" or "{Down 5}".
 #
 # Ctrl, Alt, and Shift modifiers can be specified for the next keycode by adding
-# them as keycodes. For example, Alt-h is written as "{Alt}h".
+# them into the key sequence. For example, Alt-h is written as "{Alt}h".
 #
 # Some frequently-used keystrokes are assigned shorthand characters. Think of
 # them as single-character aliases that don't need to be surrounded in curly
@@ -80,3 +86,5 @@
 # If you need literal verisons of the shorthand characters, surround them in
 # curly brackets, for example: "{~}"
 #
+#
+# Add your custom aliases here: