Template:Clear/doc: Difference between revisions

Latest revision as of 00:54, 3 September 2020

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

This template is used in MediaWiki:Abusefilter-warning-DS.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

This template is used on approximately 2,430,000 pages, or roughly 36155% of all 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. The markup provided will be confusing to many editors, and as this template provides documentation for itself, there is little justification for substitution.

Description

This template makes content wait until existing content is completed in all columns. It is often used to prevent text from flowing next to unrelated images.

Usage

{{clear}} — adds <div style="clear:both;"></div>
{{clear|left}} — adds <div style="clear:left;"></div>
{{clear|right}} — adds <div style="clear:right;"></div>

For technical details, see the discussion in the talk page.

Examples

Example without {{clear}}

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

Without {{clear}}, this section starts at the right of the image.

Example that uses {{clear}}

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

{{clear}} placed before this section, so it appears below the image.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Clear

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.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Side	`1`	Can be 'right' or 'left' so content is delayed until just the right or left column is complete. The default clears both columns.	Line	optional

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+{{Documentation subpage}}
-<includeonly>{{pp-template|small=yes}}</includeonly>
+<!-- Please add categories to the /doc subpage, and interwikis at Wikidata (see Wikipedia:Wikidata) -->
+{{used in system|in [[MediaWiki:Abusefilter-warning-DS]]}}
+{{high-risk| 2227248 |all-pages = yes}}
+{{Nosubst|The markup provided will be confusing to many editors, and as this template provides documentation for itself, there is little justification for substitution.}}
+{{#ifeq:{{FULLPAGENAME}}|Template:Clear|{{Template shortcut|-|Br|Clr}}}}
-This template adds <tt>&lt;div style="clear:both;"&gt;&lt;/div&gt;</tt>;
+== Description ==
-for technical XHTML details, see [[Template talk:Clear]].
+This template makes content wait until existing content is completed in all columns. It is often used to prevent text from flowing next to unrelated images.
-== Documentation ==
+== Usage ==
-{{tlx|clear}}: Makes content wait until existing content is completed in all columns.  Often used to stop text from flowing next to unrelated images.
+* {{tlx|clear}} — adds <code>&lt;div style="clear:both;"&gt;&lt;/div&gt;</code>
+* {{tlx|clear|left}} — adds <code>&lt;div style="clear:left;"&gt;&lt;/div&gt;</code>
+* {{tlx|clear|right}} — adds <code>&lt;div style="clear:right;"&gt;&lt;/div&gt;</code>
+For technical details, see [[Template talk:Clear|the discussion in the talk page]].
-===Usage===
+== Examples ==
- <nowiki>{{Clear}}</nowiki>
-The template may also be [[Wikipedia:Template substitution|substituted]], but as the markup provided will be confusing to many editors, and this template provides documentation for itself, there is little justification for substitution.
+=== Example without {{tlf|clear}} ===
+[[File:HeidelbergTun.jpg|200px|left]]
+{{Lorem ipsum}}
-== Example without the {{tnull|clear}} template==
+==== New section without template ====
-[[Image:HeidelbergTun.jpg|200px|left]]
+Without {{tl|clear}}, this section starts at the right of the image.
-{{lorem}}
+{{clear}}
-=== New section ===
-See how this section starts at the right of the image, with the line actually overlapping the image
-<div style="clear:both;"></div> <!-- a genuine use of the template! -->
+=== Example that uses {{tlf|clear}} ===
-== Example with the {{tnull|clear}} template ==
+[[File:HeidelbergTun.jpg|200px|left]]
-[[Image:HeidelbergTun.jpg|200px|left]]
+{{Lorem ipsum}}<br/>
-{{lorem}}
 '''{{tnull|clear}}'''
-<div style="clear:both;"></div>
+{{clear}}
-=== New section ===
-See how this looks much better?
-== See also ==
+==== New section with template ====
-* {{Lts|clearleft}} delays content until left column is complete.
+{{tl|clear}} placed before this section, so it appears below the image.
-* {{Lts|clearright}} delays content until right column is complete.
-* {{Lts|-}} is similar, but technically different.
-*: ''The fine points of {{Tl|clear}} vs. {{Tl|-}} are discussed in [[Template talk:-#- versus clear|Template talk:-]].''
+== TemplateData ==
+{{TemplateData header}}
+<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": "line",
+			"required": false
+		}
+	},
+	"format": "inline"
+}</templatedata>
-<includeonly>
+== See also ==
+* {{tl|Clear left}} (implemented using this template)
-[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
+* {{tl|Clear right}} (implemented using this template)
+* {{tl|Clear2}}
+* {{tl|Float}}
+* {{tl|Stack}}
-[[ar:قالب:تحديد]]
+<includeonly>{{sandbox other||
-[[bg:Шаблон:Clear]]
+<!-- Add categories below this line, and interwikis at Wikidata -->
-[[de:Vorlage:Absatz]]
+[[Category:Line-handling templates]]
-[[es:Plantilla:Clear]]
+[[Category:Wikipedia XHTML tag-replacing templates]]
-[[hy:Կաղապար:Ազատ]]
+}}</includeonly>
-[[is:Snið:Ryðja]]
-[[ia:Patrono:Clear]]
-[[it:Template:Clear]]
-[[ja:Template:Clear]]
-[[ka:თარგი:გასუფთავება]]
-[[vi:Tiêu bản:Clear]]
-[[fi:Malline:Clear]]
-[[no:mal:Clear]]
-[[pl:Szablon:Clear]]
-[[pt:Predefinição:Limpar]]
-[[sv:Mall:Clear]]
-[[zh:Template:Clear]]
-</includeonly>

Template:Clear/doc: Difference between revisions

Latest revision as of 00:54, 3 September 2020

Contents

Description

Usage

Examples

Example without {{clear}}

New section without template

Example that uses {{clear}}

New section with template

TemplateData

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages