Clean up other docs to match

Some deduplication in Scripts and Plugins, links in NEWS, add content
and link to files in index.
develop
PeridexisErrant 2015-11-06 00:59:48 +11:00
parent 0ba6f73dcd
commit 3cc0b34d73
4 changed files with 18 additions and 23 deletions

@ -197,8 +197,8 @@ Lua
New Internal Commands New Internal Commands
--------------------- ---------------------
- `hide, show`: hide and show the console on Windows - `hide`, `show`: hide and show the console on Windows
- sc-script: Allows additional scripts to be run when certain events occur (similar to onLoad*.init scripts) - `sc-script`: Allows additional scripts to be run when certain events occur (similar to onLoad*.init scripts)
New Plugins New Plugins
----------- -----------

@ -6,7 +6,8 @@ DFHack plugins are the commands, that are compiled with a specific version.
They can provide anything from a small keybinding, to a complete overhaul of They can provide anything from a small keybinding, to a complete overhaul of
game subsystems or the entire renderer. game subsystems or the entire renderer.
Most are listed here, hopefully organised in a way you will find useful. Most commands offered by plugins are listed here,
hopefully organised in a way you will find useful.
.. contents:: .. contents::
:depth: 4 :depth: 4
@ -351,11 +352,6 @@ UI Upgrades
When that is not appropriate because they merely add keybinding hints to When that is not appropriate because they merely add keybinding hints to
existing DF screens, they deliberately use red instead of green for the key. existing DF screens, they deliberately use red instead of green for the key.
.. _hotkeys:
hotkeys
=======
Shows the DFHack keybindings active on the current screen.
.. _manipulator: .. _manipulator:

@ -2,20 +2,10 @@
DFHack Scripts DFHack Scripts
############## ##############
Lua or ruby scripts placed in the ``hack/scripts/`` directory are considered for Lua or ruby scripts placed in the :file:`hack/scripts/` directory
execution as if they were native DFHack commands. They are listed at the end are considered for execution as if they were native DFHack commands.
of the ``ls`` command output.
Note: scripts in subdirectories of hack/scripts/ can still be called, but will The following pages document all the scripts in the DFHack standard library.
only be listed by ls if called as ``ls -a``. This is intended as a way to hide
scripts that are obscure, developer-oriented, or should be used as keybindings
or from the init file. See the page for each type for details.
``kill-lua`` stops any currently-running Lua scripts. By default, scripts can
only be interrupted every 256 instructions. Use ``kill-lua force`` to interrupt
the next instruction.
The following pages document all the standard DFHack scripts.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

@ -4,8 +4,15 @@ Welcome to DFHack's documentation!
Introduction Introduction
============ ============
DFHack is a Dwarf Fortress memory access library, distributed with scripts DFHack is a Dwarf Fortress memory access library, distributed with
and plugins implementing a wide variety of useful functions and tools. a wide variety of useful scripts and plugins.
The project is currently hosted at https://www.github.com/DFHack/dfhack,
and can be downloaded from `the releases page
<http://github.com/DFHack/dfhack/releases>`_.
All new releases are announced in :forums:`the bay12 forums thread <139553>`,
which is also a good place for discussion and questions.
For users, it provides a significant suite of bugfixes and interface For users, it provides a significant suite of bugfixes and interface
enhancements by default, and more can be enabled. There are also many tools enhancements by default, and more can be enabled. There are also many tools
@ -29,6 +36,7 @@ User Manual
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
docs/Introduction
docs/Core docs/Core
docs/Plugins docs/Plugins
docs/Scripts docs/Scripts
@ -53,4 +61,5 @@ For Developers
docs/Compile docs/Compile
docs/Lua API docs/Lua API
library/xml/SYNTAX library/xml/SYNTAX
library/xml/how-to-update
docs/Binpatches docs/Binpatches