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.develop
							parent
							
								
									4f799a152a
								
							
						
					
					
						commit
						f9930b313a
					
				| @ -1,8 +1,13 @@ | ||||
| cls | ||||
| === | ||||
| **Tags:** `tag/system` | ||||
| :dfhack-keybind:`cls` | ||||
| 
 | ||||
| :index:`Clear the terminal screen. <cls; Clear the terminal screen.>` Can also | ||||
| be invoked as ``clear``. Note that this command does not delete command history. | ||||
| It just clears the text on the screen. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Clear the terminal screen. | ||||
|     :tags: system | ||||
| 
 | ||||
| Can also be invoked as ``clear``. Note that this command does not delete command | ||||
| history. It just clears the text on the screen. | ||||
| 
 | ||||
| Usage:: | ||||
| 
 | ||||
|     cls | ||||
|  | ||||
| @ -1,7 +1,12 @@ | ||||
| die | ||||
| === | ||||
| **Tags:** `tag/system` | ||||
| :dfhack-keybind:`die` | ||||
| 
 | ||||
| :index:`Instantly exit DF without saving. | ||||
| <die; Instantly exit DF without saving.>` | ||||
| .. dfhack-tool:: | ||||
|     :summary: Instantly exit DF without saving. | ||||
|     :tags: system | ||||
| 
 | ||||
| Use to exit DF quickly and safely. | ||||
| 
 | ||||
| Usage:: | ||||
| 
 | ||||
|     die | ||||
|  | ||||
| @ -1,14 +1,13 @@ | ||||
| plug | ||||
| ==== | ||||
| **Tags:** `tag/system` | ||||
| :dfhack-keybind:`plug` | ||||
| 
 | ||||
| :index:`List available plugins and whether they are enabled. | ||||
| <plug; List available plugins and whether they are enabled.>` | ||||
| .. dfhack-tool:: | ||||
|     :summary: List available plugins and whether they are enabled. | ||||
|     :tags: system | ||||
| 
 | ||||
| Usage: | ||||
| Usage:: | ||||
| 
 | ||||
| ``plug`` | ||||
|     Lists available plugins and whether they are enabled. | ||||
| ``plug <plugin> [<plugin> ...]`` | ||||
|     Lists only the named plugins. | ||||
|     plug [<plugin> [<plugin> ...]] | ||||
| 
 | ||||
| If run with parameters, it lists only the named plugins. Otherwise it will list | ||||
| all available plugins. | ||||
|  | ||||
| @ -1,11 +1,14 @@ | ||||
| add-spatter | ||||
| =========== | ||||
| **Tags:** `tag/adventure`, `tag/fort`, `tag/mod`, `tag/items` | ||||
| 
 | ||||
| :index:`Make tagged reactions produce contaminants. | ||||
| <add-spatter; Make tagged reactions produce contaminants.>` Give some use to all | ||||
| those poisons that can be bought from caravans! The plugin automatically enables | ||||
| itself when you load a world with reactions that include names starting with | ||||
| ``SPATTER_ADD_``. These reactions will then produce contaminants on items | ||||
| instead of improvements. The contaminants are immune to being washed away by | ||||
| water or destroyed by `clean`. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Make tagged reactions produce contaminants. | ||||
|     :tags: adventure fort mod items | ||||
|     :no-command: | ||||
| 
 | ||||
| Give some use to all those poisons that can be bought from caravans! The plugin | ||||
| automatically enables itself when you load a world with reactions that include | ||||
| names starting with ``SPATTER_ADD_``, so there are no commands to run to use it. | ||||
| These reactions will then produce contaminants on items instead of improvements. | ||||
| The contaminants are immune to being washed away by water or destroyed by | ||||
| `clean`. | ||||
|  | ||||
| @ -1,7 +1,9 @@ | ||||
| building-hacks | ||||
| ============== | ||||
| **Tags:** `tag/fort`, `tag/mod`, `tag/buildings` | ||||
| 
 | ||||
| Provides a Lua API for creating powered workshops. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a Lua API for creating powered workshops. | ||||
|     :tags: fort mod buildings | ||||
|     :no-command: | ||||
| 
 | ||||
| See `building-hacks-api` for more details. | ||||
|  | ||||
| @ -1,7 +1,9 @@ | ||||
| cxxrandom | ||||
| ========= | ||||
| **Tags:** `tag/dev` | ||||
| 
 | ||||
| Provides a Lua API for random distributions. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a Lua API for random distributions. | ||||
|     :tags: dev | ||||
|     :no-command: | ||||
| 
 | ||||
| See `cxxrandom-api` for details. | ||||
|  | ||||
| @ -1,7 +1,9 @@ | ||||
| eventful | ||||
| ======== | ||||
| **Tags:** `tag/dev`, `tag/mod` | ||||
| 
 | ||||
| Provides a Lua API for reacting to in-game events. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a Lua API for reacting to in-game events. | ||||
|     :tags: dev mod | ||||
|     :no-command: | ||||
| 
 | ||||
| See `eventful-api` for details. | ||||
|  | ||||
| @ -1,5 +1,9 @@ | ||||
| isoworldremote | ||||
| ============== | ||||
| **Tags:** `tag/dev`, `tag/mod` | ||||
| 
 | ||||
| Provides a `remote API <remote>` used by Isoworld. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a remote API used by Isoworld. | ||||
|     :tags: dev mod | ||||
|     :no-command: | ||||
| 
 | ||||
| See `remote` for related remote APIs. | ||||
|  | ||||
| @ -1,7 +1,9 @@ | ||||
| luasocket | ||||
| ========= | ||||
| **Tags:** `tag/dev`, `tag/mod` | ||||
| 
 | ||||
| Provides a Lua API for accessing network sockets. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a Lua API for accessing network sockets. | ||||
|     :tags: dev mod | ||||
|     :no-command: | ||||
| 
 | ||||
| See `luasocket-api` for details. | ||||
|  | ||||
| @ -1,7 +1,9 @@ | ||||
| map-render | ||||
| ========== | ||||
| **Tags:** `tag/dev` | ||||
| 
 | ||||
| Provides a Lua API for rerendering portions of the map. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Provides a Lua API for rerendering portions of the map. | ||||
|     :tags: dev | ||||
|     :no-command: | ||||
| 
 | ||||
| See `map-render-api` for details. | ||||
|  | ||||
| @ -1,8 +1,10 @@ | ||||
| pathable | ||||
| ======== | ||||
| **Tags:** `tag/dev`, `tag/inspection`, `tag/interface`, `tag/map` | ||||
| 
 | ||||
| Marks tiles that are reachable from the cursor. This plugin provides a Lua API, | ||||
| but no direct commands. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Marks tiles that are reachable from the cursor. | ||||
|     :tags: dev inspection interface map | ||||
|     :no-command: | ||||
| 
 | ||||
| See `pathable-api` for details. | ||||
| This plugin provides a Lua API, but no direct commands. See `pathable-api` for | ||||
| details. | ||||
|  | ||||
| @ -1,7 +1,11 @@ | ||||
| power-meter | ||||
| =========== | ||||
| **Tags:** `tag/fort`, `tag/mod`, `tag/buildings` | ||||
| 
 | ||||
| Allow presure plates to measure power. If you run `gui/power-meter` while | ||||
| building a pressure plate, the pressure plate can be modified to detect power | ||||
| being supplied to gear boxes built in the four adjacent N/S/W/E tiles. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Allow presure plates to measure power. | ||||
|     :tags: fort mod buildings | ||||
|     :no-command: | ||||
| 
 | ||||
| If you run `gui/power-meter` while building a pressure plate, the pressure | ||||
| plate can be modified to detect power being supplied to gear boxes built in the | ||||
| four adjacent N/S/W/E tiles. | ||||
|  | ||||
| @ -1,14 +1,15 @@ | ||||
| regrass | ||||
| ======= | ||||
| **Tags:** `tag/adventure`, `tag/fort`, `tag/armok`, `tag/animals` | ||||
| :dfhack-keybind:`regrass` | ||||
| 
 | ||||
| Regrows all the grass. Use this command if your grazers have eaten everything | ||||
| down to the dirt. | ||||
| .. dfhack-tool:: | ||||
|     :summary: Regrows all the grass. | ||||
|     :tags: adventure fort armok animals | ||||
| 
 | ||||
| Use this command if your grazers have eaten everything down to the dirt. | ||||
| 
 | ||||
| Usage:: | ||||
| 
 | ||||
|     regrass [max] | ||||
| 
 | ||||
| Specify the 'max' option to pack more grass onto a tile than what the game | ||||
| Specify the 'max' keyword to pack more grass onto a tile than what the game | ||||
| normally allows to give your grazers extra chewing time. | ||||
|  | ||||
Some files were not shown because too many files have changed in this diff Show More
		Loading…
	
		Reference in New Issue