Template:Note/doc: Difference between revisions
Template page
More actions
Initial draft |
Added documentation for the new 'header' parameter and the 'example' type. |
||
| Line 48: | Line 48: | ||
}, | }, | ||
"description": { | "description": { | ||
"en": "One of “info”, “reminder”, “warn”, or “error”. This setting affects the color and icon.", | "en": "One of “info”, “example”, “reminder”, “warn”, or “error”. This setting affects the color and icon.", | ||
"es": "Uno de los siguientes: “info”, “reminder”, “warn”, o “error”. Este ajuste afecta al color y al icono.", | "es": "Uno de los siguientes: “info”, “example”, “reminder”, “warn”, o “error”. Este ajuste afecta al color y al icono.", | ||
"fr": "une des valeurs suggérées. Modifie la couleur de la boîte et l'icône associée.", | "fr": "une des valeurs suggérées. Modifie la couleur de la boîte et l'icône associée.", | ||
"cs": "Jedna z možností “info”, “reminder”, “warn”, or “error” (informace, připomenutí, upozornění nebo chyba). Toto nastavení má vliv na barvu a ikonu.", | "cs": "Jedna z možností “info”, “example”, “reminder”, “warn”, or “error” (informace, připomenutí, upozornění nebo chyba). Toto nastavení má vliv na barvu a ikonu.", | ||
"tr": "“info”, “reminder”, “warn” veya “error” değerlerden biri. Bu ayar, rengi ve simgeyi etkiler.", | "tr": "“info”, “example”, “reminder”, “warn” veya “error” değerlerden biri. Bu ayar, rengi ve simgeyi etkiler.", | ||
"pt-br": "Disponíveis: “info” (informação), “reminder” (lembrete), “warn” (aviso) e “error” (erro). Essa configuração afeta a cor e o ícone." | "pt-br": "Disponíveis: “info” (informação), “example(exemplo)”, “reminder” (lembrete), “warn” (aviso) e “error” (erro). Essa configuração afeta a cor e o ícone." | ||
}, | }, | ||
"suggestedvalues": [ | "suggestedvalues": [ | ||
"info", | "info", | ||
"example", | |||
"reminder", | "reminder", | ||
"warn", | "warn", | ||
| Line 66: | Line 67: | ||
}, | }, | ||
"type": "string" | "type": "string" | ||
}, | |||
"header": { | |||
"label": { | |||
"en": "Header", | |||
"es": "Encabezado", | |||
"fr": "En-tête", | |||
"cs": "Hlavička", | |||
"tr": "Başlık", | |||
"pt-br": "cabeçalho" | |||
}, | |||
"description": { | |||
"en": "Header text. This is expected to be used in combination with the 'text' parameter.", | |||
"es": "Nota informativa.", | |||
"fr": "note d'information", | |||
"cs": "Informativní poznámka.", | |||
"tr": "Bilgilendirecek not.", | |||
"pt-br": "Nota informativa." | |||
}, | |||
"type": "content" | |||
}, | }, | ||
"text": { | "text": { | ||
| Line 81: | Line 101: | ||
}, | }, | ||
"description": { | "description": { | ||
"en": "Informative note.", | "en": "Informative note. If the 'header' parameter is used, this will be the body text.", | ||
"es": "Nota informativa.", | "es": "Nota informativa.", | ||
"fr": "note d'information", | "fr": "note d'information", | ||
| Line 98: | Line 118: | ||
"inline", | "inline", | ||
"type", | "type", | ||
"header", | |||
"text" | "text" | ||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
Latest revision as of 12:42, 27 April 2026
Show a note in a box (e.g. a top-of-the-page warning).
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Inline formatting | inline | Show the template without line breaks before and after it.
| Boolean | optional |
| Type | type 2 | One of “info”, “example”, “reminder”, “warn”, or “error”. This setting affects the color and icon.
| String | optional |
| Header | header | Header text. This is expected to be used in combination with the 'text' parameter. | Content | optional |
| Text | text 1 content | Informative note. If the 'header' parameter is used, this will be the body text. | Content | optional |