Commit Graph

1500 Commits (3f6e92eda49579a7fa12b589d7a794448c5dc5bd)

Author SHA1 Message Date
Tachytaenius b89a30a309
Update modding-guide.rst
Change use of word entities to objects because entitiy is a taken word in DF, and remove incorrect slash from a command.
2022-09-13 10:51:38 +01:00
Myk cd83f3fcf1
Remove bad link 2022-09-12 15:04:16 -07:00
Myk 4a7faeef55
editing pass up through Custom raw tokens 2022-09-12 14:51:26 -07:00
myk002 0e30160c3c update documentation documentation 2022-09-12 14:50:48 -07:00
Myk 540a2a9fa7
editing pass up through The structure of the game 2022-09-12 00:14:03 -07:00
Myk 253a1a80ad
add modding guide to guides index 2022-09-11 23:02:04 -07:00
Myk 04754b0a81
Merge branch 'develop' into modding-guide 2022-09-11 23:00:33 -07:00
myk002 d4914e7511
implement mouse click reactions for scrollbar 2022-09-11 19:33:01 -07:00
myk002 f71f034d1d
show full scrollbars instead of just scroll icons 2022-09-11 17:58:10 -07:00
Myk 09372680a2
Merge pull request #2281 from myk002/myk_helpdb_wrap
[helpdb] dynamically wrap long help text, preserving block indents
2022-09-11 14:40:43 -07:00
myk002 2311158792
fix reference to old ls param in Lua API docs
also add another example to the ls example commands
2022-09-11 14:06:21 -07:00
myk002 23994d4f4c
dynamically wrap helpdb long help text (default 80) 2022-09-11 13:41:20 -07:00
lethosor bd51d9c455
Changelog entry for hideGuard 2022-09-10 15:34:17 -04:00
myk002 82e954692e
update changelog 2022-09-10 10:15:08 -07:00
myk002 cae2bca0a7
add dfhack.screen.hideGuard 2022-09-10 09:49:43 -07:00
myk002 2733ce7684
update workflow summary to match the gui version 2022-09-10 09:49:42 -07:00
myk002 a392a5371d
add keybinding for gui/workorder-details 2022-09-07 22:02:33 -07:00
myk002 040d018b8e
fix order of tree designation in autochop 2022-09-07 10:34:56 -07:00
myk002 86e1a8d59c
When smoothing walls, connect to doors and fgates 2022-09-07 10:11:51 -07:00
lethosor 483652e193 Rewrite utils.df_expr_to_ref() for consistency, add tests 2022-09-07 09:14:09 -07:00
myk002 e37b7650fa
update guides
including fixing the ordering of the TOC, which, while in alphabetical
order, was not in a logical order
2022-09-05 20:53:44 -07:00
myk002 73b7f13ad6
tombstone gui/assign-rack 2022-09-05 14:28:35 -07:00
myk002 c0682625f9
tombstone fix/merchants 2022-09-04 23:27:57 -07:00
myk002 df244cd519
tombstone fix/feeding-timers 2022-09-04 23:26:18 -07:00
myk002 d07bc349f8
tombstone fix/diplomats 2022-09-04 23:05:16 -07:00
myk002 e399e2205b
tombstone fix/fat-dwarves 2022-09-04 22:28:03 -07:00
myk002 446c321c62
fix spacing error
and floorplan error
2022-09-04 12:27:50 -07:00
Myk ef1e85e6ff
Make doc docs match the docs 2022-09-03 20:00:38 -07:00
myk002 bd4d17d205
update changelog 2022-09-01 22:48:18 -07:00
myk002 d258035b88
update changelog 2022-08-31 23:39:24 -07:00
myk002 b1a8662c4a
Merge branch 'develop' into docs 2022-08-31 23:00:39 -07:00
myk002 3d162a52ce
Add removed scripts to the graveyard 2022-08-31 22:47:43 -07:00
myk002 074a6ec5cd allow EditFields to ignore specified keys
like "+" and "-", so you can use them as hotkeys in the parent view
2022-08-31 10:22:41 -07:00
myk002 8804dab182
update dreamfort traffic designations 2022-08-29 22:04:22 -07:00
Myk 29d4d530b5
Merge branch 'develop' into modding-guide 2022-08-27 09:00:53 -07:00
Tachytaenius 0b6178f5d2
Apply suggestions from code review
Co-authored-by: Myk <myk.taylor@gmail.com>
2022-08-27 15:24:22 +01:00
Tachytaenius 155525b853 Update Lua API.rst 2022-08-26 20:33:23 -07:00
Tachytaenius 306822b175 Update changelog.txt 2022-08-26 20:33:23 -07:00
myk002 65dd62a96e
remove unnecessary label for probe 2022-08-26 16:51:29 -07:00
myk002 b0ae9ed9c0
align quickfort guides with new defaults 2022-08-26 13:38:19 -07:00
myk002 0d3f5c2904
get new script docs to compile 2022-08-25 21:53:35 -07:00
myk002 25c99b5d1f
make summary text easier to read in text mode 2022-08-25 21:46:23 -07:00
myk002 95cd8f9d54
Merge branch 'develop' into docs 2022-08-19 15:36:07 -07:00
myk002 d0967b7e59
add alt-N keybinding for do-job-now 2022-08-19 09:34:38 -07:00
myk002 eb73de4670
make Usage a proper header 2022-08-17 22:42:02 -07:00
lethosor 72de1873e0
Improve keybinding rendering under the text builder
Previously rendered as e.g. "CtrlShiftK"
2022-08-17 23:18:58 -04:00
lethosor fa8bceba93
Make paragraph labels render as plain text (not bold) under the text builder 2022-08-17 23:17:08 -04:00
lethosor 06c8269002
Update Documentation.rst with examples of dfhack-tool and dfhack-command 2022-08-17 23:04:17 -04:00
lethosor a4e70cf3e1
Remove now-unused dfhack-keybind role 2022-08-17 22:56:06 -04:00
lethosor 7e0581204d
Refactor everything to use make_labeled_paragraph() 2022-08-17 22:37:03 -04:00
lethosor fe7414baae
Make .dfhack-tool-summary styles consistent with Sphinx 5+
Under Sphinx 5, `topic` nodes now render as `<aside>` elements, and without an
explicit background color
2022-08-17 22:22:06 -04:00
myk002 22356e2fd6
resort tags according to new spreadsheet order
also fix tag syncing command so short descriptions with internal periods
are parsed correctly
2022-08-16 09:36:17 -07:00
myk002 4373f865a3
make `dfhack` a "when" tag 2022-08-16 08:23:48 -07:00
myk002 83e1fa7de0
add summary text in its own paragraph element 2022-08-16 00:12:25 -07:00
myk002 60458ad885
reorganize and alphabetize tags 2022-08-15 23:43:02 -07:00
myk002 7acec133ba
organize tags by group, add more info about tools 2022-08-15 23:14:50 -07:00
myk002 b01ef4a962
add todos about not using strong for text output 2022-08-15 23:14:16 -07:00
myk002 df9c37a8b7
Merge branch 'develop' into docs 2022-08-15 17:09:36 -07:00
myk002 8672282fd8
add helpdb, unit test, and document API
note that we have to dynamically sort some of the expected lists for
locale agnosticism
2022-08-15 16:31:52 -07:00
myk002 f7a0423566 update changelog 2022-08-15 16:27:43 -07:00
myk002 6fd0f4505f add dfhack history repository and expose to lua 2022-08-15 16:27:43 -07:00
myk002 7dddb5e2ed document widget mouse integration 2022-08-15 16:24:34 -07:00
myk002 7c3b06d71e update changelog 2022-08-15 16:24:34 -07:00
myk002 79b6cd13e9 support scrolling by half pages in Label 2022-08-15 16:24:34 -07:00
myk002 0aa9a187cf support cursor movement in EditFields 2022-08-15 16:24:34 -07:00
myk002 43b1abcdcf support submit2 for EditFields 2022-08-15 16:24:34 -07:00
myk002 f400ee50f8 refine docs, logging, help text 2022-08-15 16:15:41 -07:00
myk002 a4c8535977 add argparse int checking methods, more docs 2022-08-15 16:15:41 -07:00
myk002 2f9021a3a0 move examples to the examples folder 2022-08-15 16:15:41 -07:00
myk002 9f648d532e modify seedwatch all to actually watch all seeds 2022-08-15 16:11:13 -07:00
myk002 2a3a812b3c
update tag reference in Core.rst 2022-08-13 21:21:48 -07:00
myk002 eb91feff7c
revise tag list and assignments 2022-08-13 21:17:24 -07:00
Myk f6699c0014
Sync tags descriptions from spreadsheet 2022-08-13 13:40:14 -07:00
Myk b21fc8aa75
remove extra space at bottom of tool summary 2022-08-13 13:32:45 -07:00
myk002 f9930b313a
migrate all docs to the new directives
add a summary option for tools and commands so we can output them with
their tags and keybindings at the top of the file.
2022-08-09 22:37:24 -07:00
lethosor 2d60c543fd
Remove "Tool:" line 2022-08-08 21:22:55 -04:00
lethosor e6b5d5b0c1
Remove commas from tag lists 2022-08-08 17:35:58 -04:00
lethosor daf3bc516b
Switch to <topic> to fix line breaks in text output
No visible change in HTML output; PDF looks different but still acceptable
2022-08-08 17:32:42 -04:00
lethosor 6e29ddf2d3
Move space out of <strong> node for better text rendering 2022-08-08 17:32:42 -04:00
lethosor 1e7ce2602e
Shrink tool/command boxes somewhat 2022-08-08 17:32:42 -04:00
lethosor 6b32e008b3
Attempt to port keybinding documentation verification to new extension
Likely requires a sphinx Domain to work with parallel builds properly
2022-08-08 17:32:42 -04:00
lethosor 7651d301d2
Remove extra paragraph around keybindings 2022-08-08 17:32:41 -04:00
lethosor 5a14992aca
Use new directives for a few plugins 2022-08-08 17:32:40 -04:00
lethosor ed95db27f5
Move dfhack-keybind role to tool_docs.py and call from dfhack-command 2022-08-08 17:30:19 -04:00
lethosor 5ef36d210f
Render implicit dfhack-command alongside dfhack-tool unless :no-command: is passed 2022-08-08 17:30:19 -04:00
lethosor 39e9288458
Render commands as literals 2022-08-08 17:30:18 -04:00
lethosor b3d79f87cb
Fix optional name override 2022-08-08 17:30:18 -04:00
lethosor d19ffa1806
Add stub dfhack-command directive, refactor to support 2022-08-08 17:30:18 -04:00
lethosor 12b3363b2c
Make dfhack-tool tags link to tag descriptions 2022-08-08 17:30:18 -04:00
lethosor bb2ca0cc16
Render dfhack-tool as admonition
Getting a section header integrated is complicated, so might as well emulate
Mediawiki with a box-like element instead
2022-08-08 17:30:17 -04:00
lethosor de5f4d3566
Default to document basename in dfhack-tool directive 2022-08-08 17:30:17 -04:00
lethosor e47c681e9c
Use write_file_if_changed() in changelog.py
Speeds up incremental builds significantly
2022-08-08 17:30:17 -04:00
lethosor 89a88e94a9
Allow empty :tags:, give section a name to prevent errors 2022-08-08 17:30:17 -04:00
lethosor d96260556e
Make title visible by putting it in its own section 2022-08-08 17:30:16 -04:00
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 a8d0cc7980
support scrolling by half pages in Label 2022-08-06 23:48:25 -07:00
lethosor 9098914ce4
Add --offline option to docs/build.py to disable image downloads 2022-08-06 22:47:38 -04:00
myk002 6700a8d922
add missing keybinds for filltraffic plugin 2022-08-05 22:31:51 -07:00
myk002 b3a2a10caa
clean up generate doc dirs with ninja clean 2022-08-05 22:05:52 -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