Template:Infobox/doc: Difference between revisions
Add icon parameter |
Add requires parameter |
||
| Line 15: | Line 15: | ||
|name | |name | ||
|The name of the object. Default is the page name. | |The name of the object. Default is the page name. | ||
|- | |||
|requires | |||
|The required software to use the object. | |||
|- | |- | ||
|nocategory | |nocategory | ||
Revision as of 08:06, 13 August 2024
Parameters
The following table provides a list of available parameters. Since the infobox is general-purpose, not all parameters must be used.
| Parameter | Description |
|---|---|
| category (required) | The category the object fits into. Valid choices are: "palette", "node". |
| icon (required) | The icon representing the object. |
| name | The name of the object. Default is the page name. |
| requires | The required software to use the object. |
| nocategory | Suppress assignment to categories (e.g., when using the template on documentation pages). |
Node
These parameters are only necessary if the category is "Node".
| Parameter | Description |
|---|---|
| node-palette | The palette the node belongs to. Multiple palettes can be assigned using "node-palette2", "node-palette3", etc. |
| node-type | The type of the node. Valid choices are: "function"; "structure", "constant", "vim", "vi", "control", "express-vi", "node". The default is "node". |
Palette
These parameters are only necessary if the category is "Palette".
| Parameter | Description |
|---|---|
| palette-image (required) | The image of the palette. |
| palette-parent (required) | The parent palette. |
| palette-item-<row><col> | The item on the specific row and column of the palette. For example, the top-left item is "palette-item-11", the second item on the first row is "palette-item-12" and the first item on the second row is "palette-item-21".
|