Template:Infobox/doc: Difference between revisions
m Move intricate warning to be included |
Add conference category with mandatory parameters: conference-banner, conference-date, and conference-url |
||
| Line 9: | Line 9: | ||
|- | |- | ||
|category (required) | |category (required) | ||
|The category the object fits into. Valid choices are: "node", "palette", "presentation". | |The category the object fits into. Valid choices are: "node", "palette", "presentation", "conference". | ||
|- | |- | ||
|icon (required) | |icon (required) | ||
| Line 60: | Line 60: | ||
===Presentation=== | ===Presentation=== | ||
These parameters are only necessary if the category is "Presentation". | |||
{| class="wikitable" | {| class="wikitable" | ||
!Parameter | !Parameter | ||
| Line 69: | Line 70: | ||
|presentation-presenter (required) | |presentation-presenter (required) | ||
|Name of the presenter. There can be multiple presenters using "presentation-presenter2", "presentation-presenter3", etc. | |Name of the presenter. There can be multiple presenters using "presentation-presenter2", "presentation-presenter3", etc. | ||
|} | |||
==Conference== | |||
These parameters are only necessary if the category is "Conference". | |||
{| class="wikitable" | |||
!Parameter | |||
!Description | |||
|- | |||
|conference-banner (required) | |||
|Banner image for the conference | |||
|- | |||
|conference-date (required) | |||
|Date at which the conference takes place. | |||
|- | |||
|conference-url (required) | |||
|Homepage of the conference. | |||
|} | |} | ||
<includeonly> | <includeonly> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</includeonly> | </includeonly> | ||
Revision as of 09:29, 17 August 2024
|
This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.
|
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: "node", "palette", "presentation", "conference". |
| 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. This is only necessary for categories "node" and "palette". |
| status | The status of the node. Valid choices are: "deprecated". |
| 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". |
| node-connector-pane-image | The connector pane image of the 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. Multiple palettes can be assigned with "palette-parent2", "palette-parent3", etc. |
| 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". |
Presentation
These parameters are only necessary if the category is "Presentation".
| Parameter | Description |
|---|---|
| presentation-conference (required) | Page name for the conference |
| presentation-presenter (required) | Name of the presenter. There can be multiple presenters using "presentation-presenter2", "presentation-presenter3", etc. |
Conference
These parameters are only necessary if the category is "Conference".
| Parameter | Description |
|---|---|
| conference-banner (required) | Banner image for the conference |
| conference-date (required) | Date at which the conference takes place. |
| conference-url (required) | Homepage of the conference. |