Template:Cmbox/doc: Difference between revisions
(Change to using new name of template: "cambox" -> "cmbox".) |
(Copying and adapting doc from ambox. Intermediate save.) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<includeonly>{{intricate template}}</includeonly> |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
||
__NOTOC__ |
|||
This is the {{tl|cmbox}} or '''category message box''' meta-template. |
This is the {{tl|cmbox}} or '''category message box''' meta-template. |
||
It is used to create message box templates for category pages, such as {{tl|CatDiffuse}} etc. |
It is used to create message box templates for category pages, such as {{tl|CatDiffuse}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features. |
||
This template works exactly like {{tl|ambox}} and uses the same parameters, see full documentation there. |
This template works exactly like {{tl|ambox}} and uses the same parameters, see full documentation there. |
||
| Line 11: | Line 12: | ||
The styles of category space message boxes and the usage of this template is currently being standardised and discussed on the [[{{TALKPAGENAME}}|talk page]] of this template. Thus don't use this meta-template for real category message boxes yet, but feel free to use it for testing. |
The styles of category space message boxes and the usage of this template is currently being standardised and discussed on the [[{{TALKPAGENAME}}|talk page]] of this template. Thus don't use this meta-template for real category message boxes yet, but feel free to use it for testing. |
||
| ⚫ | |||
=== Usage === |
|||
Simple usage example: |
|||
<pre> |
|||
{{cmbox | text = Some text.}} |
|||
</pre> |
|||
{{cmbox | text = Some text.}} |
|||
Complex example: |
|||
<pre> |
|||
{{cmbox |
|||
| type = style |
|||
| image = [[Image:Emblem-question-yellow.svg|38px]] |
|||
| style = width: 400px; color: red; font-weight: bold; font-style: italic; |
|||
| text = The message body text. |
|||
}} |
|||
</pre> |
|||
{{cmbox |
|||
| type = style |
|||
| image = [[Image:Emblem-question-yellow.svg|38px]] |
|||
| style = width: 400px; color: red; font-weight: bold; font-style: italic; |
|||
| text = The message body text. |
|||
}} |
|||
=== Category message box types === |
=== Category message box types === |
||
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type. |
|||
| ⚫ | |||
{{cmbox |
{{cmbox |
||
| type = speedy |
| type = speedy |
||
| text = type=<u>speedy</u> – Speedy deletion templates such as {{tl|db-catempty}}. |
|||
| text = speedy |
|||
}} |
}} |
||
{{cmbox |
{{cmbox |
||
| type = delete |
| type = delete |
||
| text = delete |
| text = type=<u>delete</u> – Deletion templates such as {{tl|cfd}}. |
||
}} |
}} |
||
{{cmbox |
{{cmbox |
||
Revision as of 18:14, May 9, 2008
 | This is a documentation subpage for Template:Cmbox. It may contain usage information, categories and other content that is not part of the original template page. |
This is the {{cmbox}} or category message box meta-template.
It is used to create message box templates for category pages, such as {{CatDiffuse}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.
This template works exactly like {{ambox}} and uses the same parameters, see full documentation there.
Suggested style standard
The styles of category space message boxes and the usage of this template is currently being standardised and discussed on the talk page of this template. Thus don't use this meta-template for real category message boxes yet, but feel free to use it for testing.
When this template is used to build actual category message boxes they should contain the same (long) texts as before, with links to explanations and they can use more specific images than the default images shown here.
Usage
Simple usage example:
{{cmbox | text = Some text.}}
Page Module:Message box/cmbox.css has no content.
 | Some text. |
Complex example:
{{cmbox
| type = style
| image = [[Image:Emblem-question-yellow.svg|38px]]
| style = width: 400px; color: red; font-weight: bold; font-style: italic;
| text = The message body text.
}}
Page Module:Message box/cmbox.css has no content.
 | The message body text. |
Category message box types
The following examples use different type parameters but use no image parameters thus they use the default images for each type.
Page Module:Message box/cmbox.css has no content.
 | type=speedy – Speedy deletion templates such as {{db-catempty}}. |
Page Module:Message box/cmbox.css has no content.
| type=delete – Deletion templates such as {{cfd}}. |
Page Module:Message box/cmbox.css has no content.
 | content |
Page Module:Message box/cmbox.css has no content.
 | style |
Page Module:Message box/cmbox.css has no content.
| notice |
Page Module:Message box/cmbox.css has no content.
 | move |
Page Module:Message box/cmbox.css has no content.
 | protection |
To discuss these boxes and to see or make other examples go to the talk page.
Technical details
This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.
See also
- {{ambox}} – The meta-template for article message boxes.
- {{imbox}} – The meta-template for image space message boxes.
