Template:Userbox/doc: Difference between revisions
documentation for template |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Usage == | == Usage == | ||
This template displays a customizable userbox using [[Module:Userbox]]. | This template displays a customizable userbox using [[Module:Userbox]]. | ||
| Line 40: | Line 39: | ||
[[Category:Userbox templates]] | [[Category:Userbox templates]] | ||
</ | <templatedata> | ||
{ | |||
"params": { | |||
"id": { | |||
"description": "Text or image shown on the left side of the userbox (typically short)", | |||
"example": "MOD", | |||
"label": "ID", | |||
"suggested": true | |||
}, | |||
"id-c": { | |||
"description": "Background color (or gradient) of the ID box. This uses hex colors (#fff for white, #000000 for black).", | |||
"example": "#8f0000", | |||
"label": "ID color", | |||
"type": "string" | |||
}, | |||
"info": { | |||
"description": "The main text content of the userbox.", | |||
"example": "This user is a moderator", | |||
"label": "Info", | |||
"required": true | |||
}, | |||
"info-fc": { | |||
"example": "#fff", | |||
"label": "Info font color", | |||
"description": "Font color of the info box. This uses hex colors (#fff for white, #000000 for black).", | |||
"type": "string" | |||
}, | |||
"id-op": { | |||
"description": "Optional inline styles (e.g. shadows, transitions)." | |||
}, | |||
"info-op": { | |||
"description": "Optional inline styles (e.g. shadows, transitions)." | |||
}, | |||
"border-op": { | |||
"description": "Optional inline styles (e.g. shadows, transitions)." | |||
}, | |||
"border-c": { | |||
"label": "Border color", | |||
"description": "The color of the border. This uses hex colors (#fff for white, #000000 for black)", | |||
"example": "#6a000", | |||
"type": "string" | |||
}, | |||
"nocat": { | |||
"label": "No automatic categorisation", | |||
"description": "If set to true, disable automatic categorisation.", | |||
"type": "string" | |||
} | |||
}, | |||
"paramOrder": [ | |||
"id", | |||
"info", | |||
"border-c", | |||
"id-c", | |||
"info-fc", | |||
"id-op", | |||
"info-op", | |||
"border-op", | |||
"nocat" | |||
], | |||
"description": "Create a custom userbox to add to your profile, which can do multiple things, including tell others about yourself and show others the achievements you have made." | |||
} | |||
</templatedata> | |||