Commit Graph

340 Commits (10525aa6ae5de16afad0eee1f970015bf6099d29)

Author SHA1 Message Date
lethosor c44c8721c9
Initial attempt at dfhack-tool directive
Doesn't appear to produce headings that can be used as link targets...
2022-08-08 17:30:16 -04:00
myk002 6700a8d922
add missing keybinds for filltraffic plugin 2022-08-05 22:31:51 -07:00
myk002 f7acc5cfc6
sync tags spreadsheet to git
spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995
sync command - for fname in *rst; do name=$(echo $fname | sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv | ~/Downloads/csvtotags.sh); sed -ri "s;[*]*Tags:.*;$tagline;" $fname; done
contents of csvtotags.sh -

fgrep . | sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' | awk -F, '
function tag(idx, tagname) {
    if ($idx == "TRUE") {
        if (hastag == 1) {printf(", ")}
        printf("`tag/%s`", tagname)
        hastag = 1
    }
}

{
printf("%s", "**Tags:** ")

hastag = 0
tag(2, "adventure")
tag(3, "fort")
tag(4, "legends")
tag(5, "embark")
tag(6, "system")
tag(7, "dev")
tag(8, "auto")
tag(9, "productivity")
tag(10, "inspection")
tag(11, "design")
tag(12, "quickfort")
tag(13, "interface")
tag(14, "fps")
tag(15, "fix")
tag(16, "mod")
tag(17, "armok")
tag(18, "animals")
tag(19, "buildings")
tag(20, "items")
tag(21, "jobs")
tag(22, "map")
tag(23, "labors")
tag(24, "units")
tag(25, "stockpiles")
tag(26, "trees")

printf("\n")
}
'
2022-08-05 17:55:33 -07:00
myk002 ebfe00b112
editing pass of short descriptions
and fix some short description parsing
2022-08-05 10:08:23 -07:00
myk002 6f48c1f4d0
remove some cruft from autobutcher docs 2022-08-05 08:08:47 -07:00
myk002 46c3862a08
update docs for zone 2022-08-05 08:08:34 -07:00
pre-commit-ci[bot] feed91d098 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-08-04 07:34:33 +00:00
Myk 8f242ac5cc
Update tweak.rst 2022-08-04 00:24:36 -07:00
Myk 5e9dde8a61
Update autobutcher.rst 2022-08-04 00:22:07 -07:00
Myk 26863fe468
Update zone.rst 2022-08-04 00:18:06 -07:00
myk002 5c9be942a5
update docs for workflow 2022-08-03 23:40:35 -07:00
myk002 b2ab93b3cd
update docs for autonestbox 2022-08-03 23:35:13 -07:00
myk002 3b17448597
update docs for autobutcher 2022-08-03 23:34:56 -07:00
myk002 6686f703ae
update docs for workNow 2022-07-31 13:41:30 -07:00
myk002 e4c5b14670
update docs for tweak 2022-07-31 13:41:30 -07:00
myk002 a5a57a8631
update docs for tubefill 2022-07-31 13:41:30 -07:00
myk002 a6bdd9e3dc
update docs for trackstop 2022-07-31 13:41:30 -07:00
myk002 2362d60a3a
update docs for title-folder and title-version 2022-07-31 13:41:30 -07:00
myk002 51f79f9464
update docs for tiletypes 2022-07-31 13:41:30 -07:00
myk002 b240748684
update docs for tailor 2022-07-31 13:41:29 -07:00
myk002 3d0eab1a9b
update docs for strangemood 2022-07-31 13:41:29 -07:00
myk002 464f566928
update docs for stonesense 2022-07-31 13:41:29 -07:00
myk002 e1e245b4b4
update docs for stocks 2022-07-31 13:41:29 -07:00
myk002 5621a19278
update docs for stockpiles 2022-07-31 13:41:29 -07:00
myk002 08d434d16e
update docs for stockflow 2022-07-31 13:41:29 -07:00
myk002 479494e5a6
update docs for steam-engine 2022-07-31 13:41:29 -07:00
myk002 af0631cbd9
update docs for spectate 2022-07-31 13:41:29 -07:00
myk002 7261914826
update docs for sort 2022-07-31 13:41:29 -07:00
myk002 a1f937e354
update docs for siege-engine 2022-07-31 13:41:28 -07:00
myk002 8f7a23ee4d
update docs for showmood 2022-07-31 13:41:28 -07:00
myk002 edb7bd3168
update docs for seedwatch 2022-07-31 13:41:28 -07:00
myk002 feda5851e9
add example for ruby plugin 2022-07-31 13:41:28 -07:00
Myk 8cc0cee9a8
Fix grammar in power meter docs 2022-07-30 07:37:46 -07:00
myk002 f785a910ff
update docs for search 2022-07-29 17:38:23 -07:00
myk002 438293c0a0
update docs for reveal 2022-07-29 17:12:15 -07:00
myk002 c6d5fcb378
update docs for resume 2022-07-29 17:12:01 -07:00
myk002 a7011421b4
update docs for rendermax 2022-07-29 16:31:37 -07:00
myk002 eef7812bf6
update docs for rename 2022-07-29 16:08:00 -07:00
myk002 7a4e8ea18e
some plugins can't be directly enabled by the user 2022-07-29 16:05:49 -07:00
myk002 e513253d8d
update docs for regrass 2022-07-28 23:20:24 -07:00
myk002 1270cf3f0a
update docs for prospector 2022-07-28 23:12:11 -07:00
myk002 cf69a1a2cf
update docs for probe 2022-07-28 23:04:07 -07:00
myk002 1bbe996d58
update docs for power-meter 2022-07-28 22:55:20 -07:00
myk002 2d400fb571
update docs for plants
n.b. original docs were a lie.
2022-07-28 22:51:17 -07:00
myk002 2e2abbe87a
update docs for petcapRemover
and make it actually start running when it is enabled
2022-07-28 16:46:10 -07:00
myk002 380b003b56
fix list formatting for manipulator 2022-07-28 06:05:35 -07:00
myk002 ac2d943fb1
remove commas from cleaners index entry 2022-07-28 05:41:29 -07:00
myk002 a6fb509cc7
convert table to list so it's readable in text rendering 2022-07-28 04:05:41 -07:00
myk002 e8bc9d9c0e
fix formatting in mousequery docs 2022-07-28 03:49:52 -07:00
myk002 5b8d8d7fe8
update docs for orders 2022-07-28 03:48:27 -07:00
myk002 88648284b0
update docs for nestboxes 2022-07-28 03:25:00 -07:00
myk002 f68b58c460
update docs for mousequery 2022-07-28 03:22:32 -07:00
myk002 bcab483b57
update docs for mode 2022-07-28 02:50:37 -07:00
myk002 b6f20ee61a
update docs for manipulator 2022-07-28 02:49:46 -07:00
myk002 756900393f
update docs for misery 2022-07-28 02:47:32 -07:00
myk002 6aabf5f3c3
no commas in index params 2022-07-28 02:47:32 -07:00
myk002 ddae1aa900
update docs for liquids 2022-07-27 17:14:40 -07:00
myk002 52a0b0f2ca
update docs for lair 2022-07-27 17:14:30 -07:00
myk002 e94f1891c2
update docs for labormanager 2022-07-27 17:14:18 -07:00
myk002 58c0f94a2d
order autolabor docs similarly to labormanager 2022-07-27 17:14:00 -07:00
myk002 ed113466d9
update docs for isoworldremote 2022-07-27 16:29:54 -07:00
myk002 382ad84125
add example for job item-type 2022-07-27 16:14:24 -07:00
myk002 2008fd3955
update docs for jobutils.
I was unable to find an example usage for `job item-type`. I couldn't
find any combination of jobs or parameters that worked.
2022-07-27 16:03:49 -07:00
myk002 e677e8098d
add docs for plugins that only provide Lua apis 2022-07-27 15:48:11 -07:00
myk002 6293b71e9e
Revert "remove docs for non-enableable, command-less plugin"
This reverts commit c88423e655.
2022-07-26 22:01:39 -07:00
myk002 c88423e655
remove docs for non-enableable, command-less plugin 2022-07-25 22:05:32 -07:00
myk002 4438134711
add missing keybinding for infiniteSky 2022-07-25 22:01:28 -07:00
myk002 06fc84fb39
update docs for infiniteSky 2022-07-25 22:00:56 -07:00
myk002 69d88a62dd
update docs for hotkeys 2022-07-25 21:54:34 -07:00
myk002 b93e3365f6
update docs for get plants 2022-07-25 21:50:52 -07:00
myk002 094f8d7257
fix typos in forceequip cpp/docs 2022-07-25 16:57:08 -07:00
myk002 367ac0064e
update docs for generated-creature-renamer 2022-07-25 16:54:28 -07:00
myk002 eb0f016804
update docs for forceequip 2022-07-25 16:40:19 -07:00
myk002 82953d8b2f
fix doc build errors 2022-07-25 13:37:52 -07:00
myk002 20ccd3a99c
update docs for follow 2022-07-25 10:55:31 -07:00
myk002 e13aae2ce1
update docs for flows 2022-07-25 10:55:04 -07:00
myk002 ea3dfe399e
update docs for fixveins 2022-07-25 10:54:11 -07:00
myk002 9c0bd6bd70
update docs for fix-unit-occupancy 2022-07-25 10:23:26 -07:00
myk002 2654de583f
update docs for filltraffic 2022-07-25 10:23:05 -07:00
myk002 ab9c3a07c4
add missing 'enable' usage for dwarfmonitor 2022-07-25 10:22:42 -07:00
myk002 989befa582
update docs for fastdwarf 2022-07-25 10:22:23 -07:00
myk002 a6cb79c237
remove defunct tool fix-armory 2022-07-25 10:21:59 -07:00
myk002 886289d805
update docs for fix-armory 2022-07-25 10:21:33 -07:00
myk002 38c17b5215
update docs for RemoteFortressReader 2022-07-25 06:56:21 -07:00
myk002 4132dbdbbb
remove docs for no-command, un-enableable plugin
it's already documented in lua-api
2022-07-25 06:51:40 -07:00
myk002 98ad22dddd
align remaining plugin docs to plugin names 2022-07-25 06:08:59 -07:00
myk002 02cc085a43
update docs for embark-tools 2022-07-24 23:59:04 -07:00
myk002 d94fef36ff
update docs for embark-assistant 2022-07-24 23:39:13 -07:00
myk002 32e2ac2103
update docs for dwarfvet 2022-07-24 23:24:52 -07:00
myk002 595fb221b8
code block is not valid json 2022-07-24 23:24:35 -07:00
myk002 ac11cde213
update docs for dwarfmonitor 2022-07-24 23:22:51 -07:00
Myk d624e91673
Fix missing newline 2022-07-24 20:59:24 -07:00
myk002 b2ca3cb194
update docs for diggingInvaders 2022-07-24 20:12:04 -07:00
myk002 60b599865c
update docs for digFlood 2022-07-24 17:01:50 -07:00
myk002 ca06d1d9c5
update docs for dig (again) 2022-07-24 16:08:35 -07:00
myk002 9dd62f2291
update docs for dig 2022-07-23 22:40:33 -07:00
myk002 5f56d79235
move dfhack.history to dfhack-config/dfhack.history 2022-07-23 21:55:49 -07:00
myk002 947889873d
update all docs I've done so far to new standards 2022-07-23 16:03:40 -07:00
myk002 3141ecbec2
remove cromulate. it has outlived its purpose 2022-07-22 21:04:22 -07:00
myk002 5dde613a12
fix formatting errors 2022-07-22 19:06:50 -07:00
myk002 a7346dd05b
add missing labels 2022-07-22 17:51:48 -07:00
myk002 4cb57d25f1
update dig-now docs 2022-07-22 17:46:33 -07:00
myk002 675f2edee2
update deramp docs 2022-07-22 17:46:22 -07:00
myk002 0f3811b933
update debugfilter docs 2022-07-22 17:46:11 -07:00
myk002 65b3ce6e96
remove unattached docs and plugins 2022-07-22 17:45:23 -07:00
myk002 19a4905933
update docs for "c" plugins 2022-07-22 16:42:36 -07:00
myk002 b38ccfe03d
fix typo in automaterial docs 2022-07-22 10:18:32 -07:00
myk002 d637c87496
ensure all plugins are indexed 2022-07-22 10:15:03 -07:00
pre-commit-ci[bot] 3522b89f5c [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-07-22 14:20:02 +00:00
myk002 53cdf57043
add missing digv label 2022-07-22 00:08:03 -07:00
myk002 6b9803daaf
update docs up to the end of the b's 2022-07-22 00:05:53 -07:00
myk002 d9a1104473
update docs for cleanowned 2022-07-20 14:51:06 -07:00
myk002 e9e477c680
update docs for clean and spotclean 2022-07-20 13:51:03 -07:00
myk002 1f3c4cdd18
update docs for cleanconst 2022-07-20 13:26:30 -07:00
myk002 d3dd12c38f
update docs for changevein 2022-07-20 13:24:27 -07:00
myk002 fae5f0635a
update docs for changelayer 2022-07-20 13:21:05 -07:00
myk002 ddd2e5003a
update docs for changeitem 2022-07-20 13:00:27 -07:00
myk002 0fe4bed121
document both burrow command and burrows plugin 2022-07-20 12:42:27 -07:00
myk002 1cad77601e
update formatting for plugin docs 2022-07-19 23:11:02 -07:00
myk002 66b7bcaf1a
update docs for burrows 2022-07-18 17:09:48 -07:00
myk002 19a4accca4
update docs for bulidingplan 2022-07-18 16:58:01 -07:00
myk002 629c22b148
update docs for building-hacks 2022-07-18 16:38:28 -07:00
myk002 154dc7c96c
update docs for blueprint 2022-07-18 16:32:43 -07:00
myk002 2bc6e09ba0
fix formatting typos 2022-07-18 16:20:43 -07:00
myk002 08154ca1b5
update docs for autotrade 2022-07-18 16:13:27 -07:00
myk002 fd84fdce73
update docs for automelt 2022-07-18 16:13:20 -07:00
myk002 0ba3a4684b
update docs for automaterial 2022-07-18 16:13:04 -07:00
myk002 87e67ea8b3
update docs for autolabor 2022-07-18 14:53:06 -07:00
myk002 6c760d1a3d
update docs for autohauler 2022-07-18 14:33:24 -07:00
myk002 b1916f16b1
update docs for autogems 2022-07-18 13:59:11 -07:00
myk002 3ca7997d3e
update docs for autofarm 2022-07-18 13:49:51 -07:00
myk002 25bc59297b
update docs for autodump (and related hotkeys) 2022-07-18 13:28:16 -07:00
myk002 3969a366ec
update docs for autoclothing 2022-07-18 13:02:03 -07:00
myk002 51c817191c
update docs for autochop 2022-07-18 12:52:38 -07:00
myk002 5ff31e0cc1
remove defunct advtools plugin 2022-07-18 12:36:11 -07:00
myk002 02ba204f5b
update docs for add-spatter 2022-07-18 11:39:52 -07:00
myk002 2207f26992
update docs for 3dveins 2022-07-18 11:34:58 -07:00
pre-commit-ci[bot] 12557f8dc1
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-07-10 20:19:12 -07:00
myk002 3e2320aa60
split the plugin docs into individual files 2022-07-10 20:19:11 -07:00
myk002 8d99b7e6e1
prepare for plugin doc split 2022-07-10 20:19:09 -07:00