Commit Graph

84 Commits (c7f3902e0d12d131e88372f38c9f86fa175304a4)

Author SHA1 Message Date
lethosor 597ed1510e Update documentation
Ref #741, #744, #747, #748, #749, #756
2015-11-25 20:56:30 -05:00
PeridexisErrant 842b9c5191 Implement feature as a script, add magma option
Functionality is exactly equivalent to the plugin, but with a new option
for players who want to enable magma furnaces without spoilers.
2015-11-17 16:43:56 +09:30
PeridexisErrant 2ba9ef04e3 Replace drybuckets plugin with a script
Also closes #248, by checking job and building flags.
2015-11-17 13:55:43 +09:30
Sebastian Wolfertz e209e3937a Typo Restrictliquid fixed
restrictliquid is actually restrictliquids.

This time with lengthened underline for sphinx.
2015-11-10 07:50:38 +01:00
lethosor 1da42c9115 Add automaterial label 2015-11-07 15:55:21 -05:00
lethosor e176c3ea05 Merge remote-tracking branch 'PeridexisErrant/docs-again' into develop 2015-11-07 15:50:11 -05:00
PeridexisErrant 0bb203e7c9 Replace initflags plugin with scripts
Progress towards #722
2015-11-07 23:42:14 +11:00
PeridexisErrant 6dacbe3d9f Add docs for "sort" and "diggingInvaders" plugins
I don't know how these were missed, but I've now checked everything
listed by "plug" but not (previously) a heading in Plugins.rst
2015-11-07 17:05:57 +11:00
PeridexisErrant 3d801d45c6 Flatten plugin documentation
The obvious solution to not knowing how to categories plugins well is to
do so a little less.  This commit does not rearrange them though, since
I thought that counterproductive without a better idea of what to do.

- removed many headings that are not commands
- fixed a few links and added some
- clarified stockpiles plugins
2015-11-07 14:01:18 +11:00
PeridexisErrant 1c25f8f1a3 Unify docs for designation and map-mod plugins
Plus some cleanup and flattening of the behaviour mod plugin docs
2015-11-07 13:04:47 +11:00
PeridexisErrant a1110b36e8 Add shortlink for issues, update links
Also moved search above local table of contents in sidebar, which can
get very long.
2015-11-07 11:35:44 +11:00
PeridexisErrant 3506921447 Add cross-links for similar commands 2015-11-07 10:53:12 +11:00
PeridexisErrant 7f212178ca Move unused docs to plugin source files
This way they can easily be restored when the plugins are reactivated,
but don't confuse users until then.
2015-11-07 10:13:21 +11:00
PeridexisErrant bc91928f8d Explain ":foo" parsing mode in Core notes 2015-11-06 11:58:33 +11:00
PeridexisErrant 18a921baef Further clarify Core; move plugins out; other fixes
- Fix formatting of (c) in license
- Avoid possible issues with script linting
- Move plugin docs out of Core.rst
- Fix some builtin docs, tweak other bits
2015-11-06 11:44:43 +11:00
lethosor 7fc2a226da Add missing backtick 2015-11-05 19:37:51 -05:00
PeridexisErrant 3cc0b34d73 Clean up other docs to match
Some deduplication in Scripts and Plugins, links in NEWS, add content
and link to files in index.
2015-11-06 10:15:21 +11:00
PeridexisErrant 4257940b22 fix typo in dig docs 2015-10-30 14:47:49 +11:00
PeridexisErrant a8ab595428 Tweak plugins docs
- Minor updates and clarifying edits
- Better use of markup throughout the document
- linked references to bugs and other things
- moved gui/siege-engine docs to the script
2015-10-29 12:46:31 +11:00
PeridexisErrant c113d9b579 Format future news 2015-10-24 22:57:08 +11:00
PeridexisErrant a60e525a5c Add custom styles for keybindings and ingame text
And use them in Plugins.rst.  Styles copied from
PeridexisErrant/DF-Walkthrough, and derived from the wiki.
2015-10-23 12:57:18 +11:00
PeridexisErrant a305c40bb2 Finish formatting old NEWS 2015-10-20 14:08:34 +11:00
PeridexisErrant fb2fdd0e89 Format more of the NEWS file 2015-10-20 13:29:46 +11:00
PeridexisErrant 18d2bc6183 Format 0.40.24-r3 changelog
Including plenty of nice hyperlinks and a formatting which looks a lot
better in HTML (but still decent in raw text, too).
2015-10-19 14:59:35 +11:00
PeridexisErrant c5d6e693f8 Use command name only for internal hyperlinks
Because it's not actually that important to the user how a command is
implemented, and the docs should reflect that.  This also makes them
easier to write!
2015-10-19 14:16:19 +11:00
orthographic-pedant ce80a42b24 Typo: accross -> across
Closes #707
2015-09-30 16:32:44 -04:00
PeridexisErrant e92d63d248 Final documentation changes
Squashes a couple of commits from the other branch onto the last one
here.
2015-09-26 16:50:02 +10:00
PeridexisErrant 2302698b22 Consolidate binpatch docs. Closes #546
Binpatches aren't used much at the moment, so this has two purposes:
collate information so it's easier to write them again, and remove it
from other sections where it's useless.

Note that if the standalone binpatch.exe is removed, the 'patching on
disk' section can be cleanly removed from 'Using a patch' by deleting
lines 44-47 & 61-90.
2015-09-26 12:28:09 +10:00
PeridexisErrant b51e3f88f3 Use DFHack favicon, fix whitespace 2015-09-26 12:28:09 +10:00
PeridexisErrant d57e84fc0f Document all missing plugins, update NEWS
Checked with a throwaway script, and added the missing entries.  NEWS
now has a comment on how to use the file, which is only visible in the
raw text version.  Added the documentation changes to NEWS.
2015-09-26 12:28:08 +10:00
PeridexisErrant 00a261cc81 More internal links and consistent formatting
Links everywhere, and formatting throughout Plugins.rst
2015-09-26 12:28:07 +10:00
PeridexisErrant 0307b0830f Plugins internal links, more formatting 2015-09-26 12:28:04 +10:00
PeridexisErrant 780a9f3677 Internal links and link targets, formatted tables
* Enabled internal links; a phrase in backticks is linked to the
corresponding link target and turns into the corresponding title.
* Linked all existing references in Scripts.rst
* Created corresponding link targets
* Fixed formatting of some tables of arguments.
2015-09-26 12:28:03 +10:00
PeridexisErrant 8141de869b Split readme into files for scripts, plugins, and base
The plugin docs are still a mess, but the base and scripts are now close
to manageable.
2015-09-22 23:30:22 +10:00