Template:Infobox subsystem/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
TheOnlyZac (talk | contribs) (Cleanup, added example) |
TheOnlyZac (talk | contribs) (Added doc for description param) |
||
| Line 4: | Line 4: | ||
{{Infobox subsystem |
{{Infobox subsystem |
||
| title= |
| title= |
||
| description= A sample subsystem |
|||
| startup= |
| startup= 0x123456 |
||
| update= |
| update= 0x2468C0 |
||
}} |
}} |
||
<pre> |
<pre> |
||
{{Infobox subsystem |
{{Infobox subsystem |
||
| title= |
| title= |
||
| description= A sample subsystem |
|||
| startup= |
| startup= 0x123456 |
||
| update= |
| update= 0x2468C0 |
||
}} |
}} |
||
</pre> |
</pre> |
||
| Line 17: | Line 19: | ||
The template takes the following optional parameters: |
The template takes the following optional parameters: |
||
* <tt>title</tt> - Title of the infobox. Default is the page name. |
* <tt>title</tt> - Title of the infobox. Default is the page name. |
||
* <tt>description</tt> - A brief description of the subsystems purpose/function |
|||
* <tt>startup</tt> - Memory offset of the startup function for the system in the executable. |
* <tt>startup</tt> - Memory offset of the startup function for the system in the executable. |
||
* <tt>update</tt> - Memory offset of the update function for the system in the executable. |
* <tt>update</tt> - Memory offset of the update function for the system in the executable. |
||
| Line 42: | Line 45: | ||
"type": "number", |
"type": "number", |
||
"suggested": true |
"suggested": true |
||
}, |
|||
"update": { |
|||
"label": "update function", |
|||
"description": "Offset of the update function in the elf", |
|||
"example": "0x123456", |
|||
"type": "string" |
|||
}, |
|||
"description": { |
|||
"description": "A brief description of the system's function/purpose", |
|||
"type": "string" |
|||
} |
} |
||
}, |
}, |
||
| Line 49: | Line 62: | ||
"image", |
"image", |
||
"caption", |
"caption", |
||
"description", |
|||
"width", |
"width", |
||
"startup" |
"startup", |
||
"update" |
|||
] |
] |
||
} |
} |
||
Latest revision as of 22:23, 23 November 2022
This is the infobox template for subsystems. It will automatically categorize the article based on its namespace.
Usage
| Subsystem | |
|---|---|
 | |
| Description | A sample subsystem |
| Startup Function | 0x123456 |
| Update Function | 0x2468C0 |
{{Infobox subsystem
| title=
| description= A sample subsystem
| startup= 0x123456
| update= 0x2468C0
}}
The template takes the following optional parameters:
- title - Title of the infobox. Default is the page name.
- description - A brief description of the subsystems purpose/function
- startup - Memory offset of the startup function for the system in the executable.
- update - Memory offset of the update function for the system in the executable.
Template data
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateData for Infobox subsystem
An infobox for use on subsystem articles.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| name | name | no description | String | optional |
| image | image | no description | File | optional |
| caption | caption | no description | String | optional |
| description | description | A brief description of the system's function/purpose | String | optional |
| width | width | no description | Unknown | optional |
| startup function | startup | The memory address of the startup function in the ELF
| Number | suggested |
| update function | update | Offset of the update function in the elf
| String | optional |