62bbfb1296
update examples documentation
2021-08-30 23:10:28 -07:00
65e5b89d4c
add goblet-related aliases
2021-08-30 23:10:28 -07:00
c25d50217c
fix doc typo
2021-08-30 23:10:28 -07:00
4b9df5c2db
minor adjustments to professions; more to come
2021-08-30 23:10:28 -07:00
c8d329e334
add documentation for examples files
2021-08-19 21:58:26 -07:00
a5c329cfb2
add plumbing example and center images
2021-07-30 07:16:03 -07:00
b8ccd6e40b
add dreamfort screenshots to library guide
2021-07-30 07:16:03 -07:00
001e608aa7
Fix invalid role name
...
Resolves #1851
See https://github.com/sphinx-doc/sphinx/pull/8345 for details
2021-05-11 19:46:01 -04:00
5a6263f72c
fix indentation
2021-02-24 21:56:40 -08:00
23461e17c2
separate sand bags into their own stockpile
...
since quantum stockpiling them dumps out their contents
2021-02-24 19:50:29 -08:00
96e91fa5e2
Merge remote-tracking branch 'myk002/myk_aliases_docs' into develop
2021-02-24 13:53:22 -05:00
1be75f269b
Merge remote-tracking branch 'myk002/myk_dreamfort' into develop
...
+typo fix in quickfort-alias-guide.rst
2021-02-20 00:47:59 -05:00
3278519c98
document how to specify containers for stockpiles
...
that are not specified with expansion syntax
2021-02-19 11:43:10 -08:00
b3666da0a6
fix wheelbarrow UI change attribution
2021-02-18 23:11:09 -08:00
cf0506e650
add documentation for #aliases blueprints
2021-02-17 23:10:47 -08:00
4790e23a5c
add more docs for quickfort orders
2021-02-13 07:46:45 -08:00
13fae4628b
add docs for #place-generated manager orders
2021-02-05 17:05:34 -08:00
330bde7660
add heavy feeder piles
...
and other minor fixes found during playtesting
refine the embark profile suggestions
2021-02-04 23:01:12 -08:00
6c6a9968ff
hauling aliases can take from multile stockpiles
2021-02-03 13:51:02 -08:00
824beb0253
documentation for bin/barrel/wb feature
2021-02-01 02:22:04 -08:00
4c7e25739f
more dreamfort refinements (details on forum)
2021-01-31 19:36:05 -08:00
fb143516cd
refresh the dreamfort case study
2021-01-30 19:32:41 -08:00
0c165e020c
fix formatting error
2021-01-30 18:47:34 -08:00
32d4eb001a
update dreamfort case study according to changes
2021-01-30 18:43:39 -08:00
8e53fb450c
use normal title replacement for search-plugin
2021-01-30 00:56:36 -08:00
4bad609e33
use the search plugin for tallow aliases
...
and document the dependency
2021-01-29 12:20:25 -08:00
aeb911878b
document new aliases
2021-01-27 14:57:03 -08:00
d01e61c658
Fix some error message formatting and add some cross-links to docs
...
Followup to #1747
2021-01-22 21:05:20 -05:00
5ef7a81fd1
Merge remote-tracking branch 'myk002/myk_buildingplan_set_settings' into develop
2021-01-22 20:57:30 -05:00
ad39bb3c33
address review comments
2021-01-22 12:48:36 -08:00
0089edde1e
Merge remote-tracking branch 'myk002/myk_docs_ignore' into develop
2021-01-21 00:14:15 -05:00
b5b7319a23
add documentation for #ignore blueprints
2021-01-11 15:58:16 -08:00
b49768a7cf
use and document new {Empty} quickfort keycode
2021-01-11 15:04:41 -08:00
16a8f31b93
high level docs for quickfort blueprint library
2020-12-17 09:59:37 -08:00
45a9106e9f
address review comments
...
- use :: shorthand where we can
- clarify sub-alias docs
- remove note about multiple modifier keys not being supported
2020-12-11 11:22:38 -08:00
4ac6716abc
add default values for optional sub-aliases
2020-12-06 10:37:09 -08:00
96126418ab
remove a tab that snuck in at the end of a line
2020-12-05 18:58:15 -08:00
593d746dd0
add link to blueprint library sources back in
2020-12-05 18:52:13 -08:00
025c9ff758
overhaul quickfort alias documentation
...
- move the alias syntax and usage docs from dfhack-config/quickfort/aliases.txt to a proper guide written in RST. Add examples and more details.
- move the alias library docs from data/quickfort/aliases-common.txt to the new guide
- reorder aliases in aliases-common to match the order in the docs
- factor out the character used to enter the stockpile config screen so we can use the same aliases for stockpiles and hauling routes (use 's' for stockpiles and '{Enter}' for hauling routes)
- reference the new guide in the quickfort user guide
- do an editorial pass of the quickfort user guide
- change name to "Quickfort Blueprint Guide", but only in the text, not the filename, so we don't change the URL
- add `quickfort-blueprint-guide` as a label, in addition to the existing `quickfort-user-guide`
- changed table-like lists to actual tables
- changed "grid" tables into "simple" tables where possible
- used ':kbd:' markers whenever we refer to a single character
- turned Meta blueprints and Notes blueprints sections into subsections of a new "Other blueprint modes" section, in preparation for a few new modes coming in -r5.
- updated out-of date caveat about bookcases, display furniture, and offering places not being supported
2020-12-05 18:36:15 -08:00
01741ce6c6
update quickfort guide and aliases
...
- move bit of alias documentation from aliases-common to aliases.txt
- document new behavior for 'c'ustom stockpiles
2020-11-12 23:23:03 -08:00
76759184d3
reinforce that meta blueprints can't cross files
...
they must refer to labels that are within the same .xlsx or .csv file
2020-11-12 23:23:03 -08:00
93c8de9b23
use numbered lists in meta blueprints section
2020-11-12 23:23:03 -08:00
647093f5c8
quickfort guide: 'c' stockpiles don't make sense
...
explain why "custom" stockpiles aren't meaningful to create in a
blueprint and what the user should do instead
2020-11-12 23:23:03 -08:00
e61839b571
Fix ordered list
2020-10-28 00:01:51 -04:00
a0c86b8a9b
rewrite quickfort user guide into
...
spend more space highlighting how users can use the blueprint plugin to
avoid learning how to write blueprints themselves
2020-10-24 21:14:09 -07:00
05d2e5b65c
update case study: order-dependent aliases
...
since the example I had used no longer exists now that we have
parameterized aliases. I had to find another example in the industry
blueprints. I made it a proper "tip" and added more explanation as well.
2020-10-18 13:49:11 -07:00
6c3bac2d6c
document extended zone configuration syntax
2020-10-17 22:20:39 -07:00
09fbaba726
buildingplan: support all building types
...
Allow buildingplan to handle all building types, update the docs, and add in little extra fixes to ensure all the new types work correctly.
2020-10-16 14:23:35 -07:00
5e63e6e103
Convert some links to use :wiki:
2020-10-09 19:24:52 -04:00
2382247398
Update some docs links to use HTTPS
2020-10-09 19:17:59 -04:00
2fdd6f7aed
Convert to explicit ref targets (occasionally section links) and fix messages() -> message()
2020-10-08 23:19:16 -04:00
f54eb9627d
Merge remote-tracking branch 'myk002/quickfort_case_study' into develop
2020-10-08 01:01:37 -04:00
3e2dd2a396
quickfort docs: dreamfort case study
2020-10-07 14:01:22 -07:00
293bc66f4a
update quickfort docs
...
default dig
notes blueprints
buildingplan
2020-10-06 22:41:54 -07:00
d254ff2401
Tweak links to quickfort command docs
2020-10-06 22:02:14 -04:00
2ff4197afe
Add anchor
2020-10-03 23:56:57 -04:00
5f47491e78
Use custom link roles when possible
2020-10-02 00:22:35 -04:00
90994f2abd
Standardize title
2020-10-01 22:19:33 -04:00
00cd52dca7
Add user guides section to main toctree
2020-10-01 22:17:53 -04:00
myk002
lethosor
Myk Taylor