Следната документация на шаблона е включена чрез Шаблон:Cmbox/doc. (редактиране | история)
| Този шаблон използва Lua:
|
{{Cmbox}} е акроним за "[C]ategory [m]essage[box]".
Основно се ползва индиректно чрез извикването му от други шаблони за изграждане на съобщителните карета в страниците за категории. Също както {{Ambox}}, {{Mbox}} и т.н. предлага разнообразие от цветове, изображения и няколко други възможности.
Прост пример за използване на шаблона:
{{cmbox | text = Някакво съобщение.}}
| Някакво съобщение. |
Малко по-сложен вариант, при който картинката, стила и типа на карето се задават от редактора:
{{cmbox
| type = style
| image = [[Файл:Icon apps query.svg|38п]]
| style = width: 400px; color: red; font-weight: bold; font-style: italic
| text = Някакво съобщение.
}}
| Някакво съобщение. |
Списък с най-често ползваните параметри:
{{cmbox
| type = serious / delete / content / style / notice / merge / protection
| image = none / [[Файл:Изображение.svg|40px]]
| imageright = [[Файл:Изображение.svg|40px]]
| class = CSS клас който ще бъде приложен върху карето
| style = CSS стойности
| textstyle = CSS стойности
| text = Някакво съобщение.
}}
Параметърът type определя цвета на карето и ползваното изображение в ляво от съобщението (параметър image). Шесте основни типа съобщителни карета за категории са показани по-долу:
| type=serious – При сериозни поводи, като искане за уточняване на значимостта, предложения за изтриване и други подобни. |
| type=content – При предупреждения и проблеми с голяма значимост. |
| type=notice – Всякакви видове бележки. |
| type= protection – За защитени страници. |
Изображенията по-горе са включени по подразбиране за всички меташаблони ползващи Модул:Message box. В много случай обаче, е по-подходящо да се използва изображение по-добре описващо текста/проблема в карето. Примери за това са дедни по-долу:
| type = style image = [[Файл:Sub-arrows.svg|40px]] Това изображение се ползва при {{Раздроби категория}}. |
| type = merge image = [[Файл:Redirect arrow bg.svg|58px]] Това изображение се ползва при {{Пренасочи категория}}. |
Няколко примера за методите по които различните параметри могат да бъдат комбинирани за постигане на желаната визия:
| Без зададен тип и изображение (по подразбиране) |
| Без зададен тип и image=none – без ползване на изображение, а text ползва цялата площ на карето. |
| image = [[Файл:Current event marker.png|64px]] imageright = [[Файл:Nuvola apps bookcase.svg|40px]] | |
Ако се наложи ескейпване на специални символи/знаци в text параметъра, ползвайте следните наставления:
{{cmbox
| text = <div>
Знакът = както и начална и крайна къдрави скоби { } могат да се ползват както са.
Но за вертикална черта {{!}}, за двойни крайни къдрави скоби }},
а за комбинация от двете |}}.
</div>
}}
|
Знакът = както и начална и крайна къдрави скоби { } могат да се ползват както са.
Но за вертикална черта |, за двойни крайни къдрави скоби }},
а за комбинация от двете |}}.
|
- {{Ambox}}, При съобщителни карета за статии.
- {{Imbox}}, При съобщителни карета за страници на файлове (изображения).
- {{Tmbox}}, При съобщителни карета за беседи.
- {{Fmbox}}, При съобщителни карета за горни и долни колонтитули на потребителски страници, както и за системни съобщения.
- {{Ombox}}, При съобщителни карета за други страници не попадащи в горните раздели.
- {{Mbox}}, При съобщителни карета ползвани в разнообразни Именни пространства (Namespaces).