Template:UI/doc

UI is a template used to create a generic UI.

UIPage is a template used to transclude another UI page to your page with custom settings.

UI Syntax
title

Parameters

 * - The UI title. This can be any form of text.
 * - The UI Slots. This can be a unnamed argument list, where each parameter can be a slot item, or custom html, or a comma-separated list of options.
 * You can use - to force a new UI row. This will make all remaining slots in the row blanks. If the amount of slots on the row exceeds 9, it will automatically go to a new line.
 * The first comma-separated item is the slot item, the second is the slot's optional Go-To id, the third is the custom slot title, the fourth is the custom slot text.
 * You can leave a list argument to be empty, it will not be interpreted.
 * The syntax for a list entry would be [; count][, [[; ]][, [ ][, ]]]|undefined.
 * An example list entry where you wanted to a link to another UI called diamond, where the display item would be an Enchanted Diamond, and it would have custom Text.
 * Enchanted Diamond; 32, diamond, &aCustom Title, &cCustom Text
 * Produces:
 * Enchanted Emerald; 32, custom-id; none, &aCustom Title, &cCustom Text
 * Produces:
 * To manually set by coordinates, you can supply a parameter like 1, 5 at the beginning. The format for such an argument is, =.
 * Source code example: 1, 5=Diamond
 * You can also supply a parameter like row 1 or row1 to set an entire UI row to the value provided. This argument will represent slots, and is an iteration. The max number for an argument like this is.
 * You can do the same thing for columns by using parameters like column 1 or col 3. The maximum number to start/end is.
 * You can insert $n into the argument to repersent the current iteration number.
 * This subsitution can be escaped with \$n.
 * An option for this argument delimited by a semicolon at the end of the input is the starting/ending number for the iteration. The format for such an argument is ; [, ], which would start the iteration at and end at, and set row 1 to the values provided.  defaults to the end of row and can be omitted.
 * Source code example:
 * If instead written in the format of ;,, , [ , ...], the corresponding columns denoted by each of row 1 will be set to the values provided.
 * Source code example:


 * - Repositions the automatic "Go Back" Arrow in the UI, with the format of ,. Setting this to "none" disables the automatic "Go Back" Arrow in the UI. can also be used to disable it.
 * - Repositions the automatic "Close" Barrier in the UI, with the format of ,. Setting this to "none" disables the automatic "Close" Barrier in the UI. can also be used to disable it.
 * - The ID of the UI (without the ui- prefix). This is needed for when UI Tabbers are used.
 * - The ID of the UI to return to (without the ui- prefix) when the "Go Back" Arrow is clicked. This is needed for when UI Tabbers are used and if this UI is a child UI.
 * - The text of the "Go Back" Arrow in the UI.
 * - The link of the "Go Back" Arrow in the UI.
 * - Hides the UI. This is needed for when UI Tabbers are used and if this UI is a child UI. Default off.
 * - The fill mode. Defualts true. Setting to true will default all slots to "Blank". Setting to false will default all slots to an "Empty" slot. Setting to border will default border slots to be "Blank" and all other slots "Empty".
 * - The maximum number of rows for the UI. This may be any number, but it UI's are traditionally 6 rows tall. Defaults to 6.
 * - The maximum number of columns for the UI. This may be any number, but it UI's are traditionally 9 columns tall. Defaults to 9.
 * - Whether s unspecified should be set to none automatically, instead of linking to the page name of slot item. Default off.

UIPage Syntax
page name

Only the first UI will be substituted with the custom options. Templates that do not start with {{UI||undefined will NOT be transcluded.

Parameters

 * - The page name that contains the UI(s) you want to transclude. This can be any page that exists on the (main) namespace.
 * - Any optional parameters that can be used with UI. This will replace/add to the options of the first transcluded UI.

Examples
Note: All examples have hide set to false.