Template:Clear/doc: Difference between revisions

Latest revision as of 09:26, 11 July 2016

This is a documentation subpage for Template:Clear.
It contains usage information, categories and other content that is not part of the original template page.

File:Ambox warning orange.svg

This template is used on 1,100,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.

Shortcuts {{-}} {{Br}} {{Clr}}

This template adds <div style="clear:both;"></div>, <div style="clear:left;"></div>, or <div style="clear:right;"></div>; for technical XHTML details, see Template talk:Clear.

{{clear}}: Makes content wait until existing content is completed in all columns. Often used to stop text from flowing next to unrelated images.

Usage

File:Imbox notice.png

This template should not be substituted. The markup provided will be confusing to many editors, and as this template provides documentation for itself, there is little justification for substitution.

{{clear}}
{{clear|left}}
{{clear|right}}

Example without {{clear}}

File:HeidelbergTun.jpg

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

New section without template

See how this section starts at the right of the image?

Example that uses {{clear}}

File:HeidelbergTun.jpg

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
{{clear}}

New section with template

See how this section appears below the image?

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Clear

<templatedata>{

 "description": "Makes content wait until existing content is completed in all columns. Often used to stop text from flowing next to unrelated images, so text will appear on a full width line under the image.",
 "params": {
   "1": {
     "label": "side",
     "description": "can be 'right' or 'left' so content is delayed until just the right or left column is complete. The default clears both columns.",
     "type": "string",
     "required": false
   }
 }

}</templatedata>