 | This template is used on approximately 459,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template should not be substituted. |
 | This template uses TemplateStyles: |
This template can be used to create simple, flexible coloured text background.
Please note that this is intended to be a decorative template and not for use on the general encyclopedia. It will not display on articles.
Purpose
[edit]Wikipedia abounds in boxed templates, such as:
Boxes may not always be appropriate; they can be obtrusive. But when boxes are used, they are generally formatted ad hoc. This leads to inconsistencies.
{{Divbox}} provides a straightforward method of presenting any text within a box. Colors are selected using a private style keyword, which sets both box border and background, already chosen to work together, in a visual sense.
The keyword none puts your content inside an invisible box. This is available to offer the identical box model for your content, without a visible box.
This template may be used within another template; or as part of another page.
Usage
[edit]Template general syntax is as follows:
{{divbox|1=style|2=title|3=content|radius=}}
Parameters
[edit]- 1 (Style)
- Mandatory. Use any of the following:
- amberblackbloodredbluebrownforestgoldgraygreennavynoneorangeplainpurplelilacredwhiteyellowfawnttsimargreenvgrayhemaildoublewordperfectivorylavender
- You can forgo "1=", as long as this is the first unnamed parameter in the list.
- 2 (Title)
- Optional. Plain text; appears strong and centered at top. You can forgo "2=", as long as this is the second unnamed parameter in the list.
- 3 (Content)
- Mandatory. Any text, including markup, that is to form the body of the message. You can forgo "3=", as long as this is the third unnamed parameter in the list, and the content does not contain an equals sign (=).
- radius
- Radius of the rounded edges, along with a valid unit, such as px, pt or em. The parameter works on styles that innately have both sharp or round edges, overriding their default edge roundness. You can forgo this entire parameter and its value; but if used, you cannot omit "radius=", which is case sensitive. However, like any named parameter, it may appear in any position (i.e. it does not need to be the last parameter).
Examples
[edit]| What you see | What you type |
|---|---|
| gray:
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|gray|Lorem ipsum|Lorem ipsum dolor...}}
|
| red:
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|radius=5px|red|Lorem ipsum|Lorem ipsum dolor...}}
|
| navy:
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|radius=10px|navy|Lorem ipsum|Lorem ipsum dolor...}}
|
| amber:
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|radius=15px|amber|Lorem ipsum|Lorem ipsum dolor...}}
|
| Without a border or background:
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|none|Lorem ipsum|Lorem ipsum dolor...}}
|
| Without title
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
{{divbox|navy||Lorem ipsum dolor...}}
|
| Content contains '=':
Lorem ipsum Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. |
{{divbox|lavender|Lorem ipsum|3=Lorem <span style="color:#F00;">ipsum</span> dolor...}}
|
Making new divbox styles
[edit]I'd rather hope you were able to find joy within the existing set of styles, but if not, you can create new ones. Follow these instructions to be sure your new style will "play nice" with {{divbox}}. Note that this requires some understanding of CSS.
- Experiment in a drawing program, such as GraphicConverter or Adobe Photoshop, and decide what colors you want for your new box style. You need to find out the HTML color codes for each color.
- Open Template:Divbox/styles.css
- Copy an existing box style, such as
.divbox-red - Paste the new style at the bottom. It must be named
.divbox-XXXXX, where "XXXXX" is your new style name. - Replace the color codes with your new, chosen colors. Save the new page.
- Return to this Talk page and add your new style to this documentation. Remember, a job's not over until the paperwork is done!
Note that you may even change the division box margins and paddings. This is not recommended. There are a couple of good reasons for specifying these values, and in these units. Most users who "roll their own" make choices with unintended consequences; {{divbox}} is meant to help you avoid these pitfalls.
See also
[edit]- {{divhide}}
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Article stub box}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
- {{Hmbox}}