Template:Schematic/doc

This template displays a grid of block sprites to symbolically represent a Minecraft structure (primarily redstone circuits and mechanisms).

Usage
Schematic uses named parameters to modify the schematic's default appearance, and unnamed parameters to define the sprites used in the schematic:

The caption parameter may be added to create a caption under the schematic. Adding a caption automatically also creates a box surrounding the schematic and caption, and floats the box to page right.


 * The Redstone Style Guide recommends adding  at the end of the caption of the first schematic in an article (and to others if helpful), which adds a standardized link to the schematic help page.

The clear parameter may be added to force the schematic to drop below other floated elements. Its value may be  (to drop below only left-floated elements),   (to drop below only right-floated elements),   (to drop below  all floated elements), or   (the default).

The float parameter may be added to change the side to which the schematic floats if a caption is added. The only value recognized is  -- anything else defaults back to floating to the right.


 * A schematic with no caption or float parameters acts like any other wiki table, ending the previous line and pushing subsequent text to a new line.

The size parameter may be added to specify the width and height of the sprite cells in pixels. Its value should be a simple number with no units added (e.g., ). If omitted, size defaults to 32.

The param parameters specify the content of the schematic. When multiple params are defined, the resulting sprites or text are displayed in individual table cells, one after the other, unless a plus sign is used to stack them in the same cell.


 * A sprite identifier (see list below) displays a sprite from the image on the right.
 * A plus sign indicates that the next parameter should be stacked on top of the previous parameter, rather than starting a new cell.
 * A dash starts a new row.
 * Anything else is simply displayed as center-aligned text within the cell's bounding box (empty parameters or whitespace parameters are displayed as empty cells).
 * Overflow text is not displayed, so this is primarily intended to be used to display one or two characters in a schematic (such as input and output locations, feature markers to be referenced in text, numbers representing light levels or distance, etc.).
 * HTML character entity references may be needed for some characters, such as  for the pipe character: ,   for an equals sign,   for a plus sign (to be displayed as text rather than stacking the next param), or   for a dash (to be displayed as text rather than starting a new row).