View source for Template:Table/Schematic/doc

{{Documentation header}}
{{Shortcut|schematic}}
{{Lua|Schematic}}
{{Schematic
|caption='''Schematic of 3-clock'''
|input+le-e!|SB|rd-ew!|rd-ew!|-
|output+rr-w1|rt-n|rr-e2|SB
}}
This template displays a grid of block sprites to symbolically represent a ''Minecraft'' structure (primarily redstone circuits and mechanisms).

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

<pre>
{{Schematic
|caption=<caption>
|captionstyle=<captionstyle>
|clear=<clear>
|float=<float>
|size=<size>
|style=<style>
|tablestyle=<tablestyle>
|<param1>|<param2>|…
}}
</pre>

;caption
:The optional ''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. An icon link to the [[mcw:Help:Schematic|schematic help page]] is automatically added to all captions.

;captionstyle
:The optional ''captionstyle'' parameter may be added to change the appearance of the caption area and contents. Its value should be a [[wikipedia:css|css]] declaration or declaration group with no surrounding braces or quotes (e.g., <code>captionstyle=color: red; text-align: center;</code>). This parameter has no effect if ''caption'' and ''float'' are not specified.

;clear
:The optional ''clear'' parameter may be added to force the schematic to drop below other floated elements. Its value may be <code>left</code> (to drop below only left-floated elements), <code>right</code> (to drop below only right-floated elements), <code>both</code> (to drop below  all floated elements), or <code>none</code> (the default).

;float
:The optional ''float'' parameter may be added to change the side to which the schematic floats if a caption is added. The only value recognized is <code>left</code> -- 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.

;size
:The optional ''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., <code>size=16</code>). If omitted, size defaults to 32.

;style
:The optional ''style'' parameter may be added to change the appearance of the schematic's surrounding box. Its value should be a [[wikipedia:css|css]] declaration or declaration group with no surrounding braces or quotes (e.g., <code>style=background-color: yellow;</code>). This parameter has no effect if ''caption'' and ''float'' are not specified.

;tablestyle
:The optional ''tablestyle'' parameter may be added to change the appearance of the schematic table. Its value should be a [[wikipedia:css|css]] declaration or declaration group with no surrounding braces or quotes (e.g., <code>tablestyle=background-color: green;</code>).

;param
:The ''param'' parameters specify the content of the schematic. When multiple ''param''s 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.

[[File:SchematicSprite.png|thumb|Sprite sheet for Schematic]]
:* A ''sprite identifier'' (see [[#List of identifiers|list below]]) displays a sprite from the image on the right.
:* A ''hyphen'' (<code>-</code>) 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.).
:** [[wikipedia:List of XML and HTML character entity references|HTML character entity references]] may be needed for some characters, such as <code>&amp;#124;</code> for the pipe character: <code>|</code>, <code>&amp;#61;</code> for an equals sign, <code>&amp;#43;</code> for a plus sign (to be displayed as text rather than stacking the next param), or <code><nowiki>&ndash;</nowiki></code> for a dash.  <code>&amp;#x305;</code> after a letter will provide a "combining overline" over the letter (used to indicate an inverse signal such as Q&#x305;).

:Multiple sprites and text may be stacked in the same cell by separating them with a ''plus sign'' (<code>+</code>), lower layers before upper layers.

=== Considerations ===
Overuse of the schematic template can create a high server load, resulting in long page generation times or even a time-out failure. This server load is proportional to the number of schematic cells on a page (for example, one 100-cell schematic and ten 10-cell schematics produce roughly the same server load). When the number of schematic cells on a page start to exceed a few hundred (or fewer, with other high-load templates), consider using {{Tl|LoadBox}} or {{Tl|LoadPage}} to offload some or all schematics into user-requested subpages.

{{LoadPage|Template:Schematic/examples|Examples}}

== List of identifiers ==
A '''sprite identifier''' is a string of characters that specify which sprite to display.

Identifiers use the following syntax:
# A case-sensitive abbreviation of the name of the block, usually two or three letters long. Many blocks also have IDs that are the full name of the block.
# A hyphen (<code>-</code>) if the ID has any modifiers.
# <code>$</code> indicates a side view sprite.
# Directions are indicated by <code>n</code> (north), <code>s</code> (south), <code>e</code> (east), <code>w</code> (west), <code>u</code> (up), and <code>d</code> (down). Directions are relative to the schematic, not necessarily the ''Minecraft'' world. If the mechanism must be built in a particular orientation to work, these directions should agree with each other.
# A number is used for some blocks with multiple states. (e.g. repeaters, composters)
# <code>!</code> usually indicates a powered/activated component.

{{LoadPage|Template:SchematicSprite/ids-basic|Basic identifiers|h3}}
{{LoadPage|Template:SchematicSprite/ids-redstone|Redstone identifiers|h3}}

== See also ==
;[[mcw:Help:Schematic]]
:Guide to reading wiki schematics
;[[mcw:Minecraft Wiki:Style guide/Redstone|Redstone style guide]]
:Guide to writing wiki articles about redstone structures, including tips for authoring schematics

{{See Also/Sprites}}

<includeonly>
[[Category:Sprite templates]]
[[Category:Table templates]]
</includeonly>