Template:Ambox/doc - Revision history

Etenne: /* date */

2022-06-17T03:40:14Z

date

← Older revision		Revision as of 03:40, 17 June 2022
Line 90:		Line 90:

	=== ''date'' ===		=== ''date'' ===
	Passing the ''date'' parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a [[~~Wikipedia:~~Bots\|bot]]). This will be displayed after the message in a smaller font.		Passing the ''date'' parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a [[Bots\|bot]]). This will be displayed after the message in a smaller font.

	~~Passing this parameter also enables [[:Category:Wikipedia maintenance categories sorted by month\|monthly cleanup categorisation]] when the ''cat'' parameter is also defined~~.		.

	=== ''info'' ===		=== ''info'' ===

Etenne: /* Example */

2022-06-17T01:44:05Z

Example

← Older revision		Revision as of 01:44, 17 June 2022
Line 22:		Line 22:
	</pre>		</pre>

	==~~Example~~==		==Examples==
	<pre>		<pre>
	{{ambox		{{ambox
Line 38:		Line 38:
	\| info = '''this is info'''		\| info = '''this is info'''
	}}		}}

			'''Default ambox'''
			<pre>
			{{ambox
			\| info = '''this is info'''
			}}
			</pre>
			{{ambox
			\| info = '''this is info'''
			}}

	==Common parameters==		==Common parameters==
	=== ''name'' ===		=== ''name'' ===

Etenne at 01:13, 17 June 2022

2022-06-17T01:13:58Z

← Older revision		Revision as of 01:13, 17 June 2022
Line 28:		Line 28:
	\| text= this is text.<br>		\| text= this is text.<br>
	\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]		\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]
	\| info = this is info		\| info = '''this is info'''
	}}		}}
	</pre>		</pre>
Line 36:		Line 36:
	\| text= this is text.<br>		\| text= this is text.<br>
	\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]		\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]
	\| info = this is info		\| info = '''this is info'''
	}}		}}
	==Common parameters==		==Common parameters==

Etenne at 01:07, 17 June 2022

2022-06-17T01:07:53Z

← Older revision		Revision as of 01:07, 17 June 2022
Line 23:		Line 23:

	==Example==		==Example==
			<pre>
	{{ambox		{{ambox
	\| style=border-color:Cyan;		\| style=border-color:Cyan;
Line 29:		Line 30:
	\| info = this is info		\| info = this is info
	}}		}}
			</pre>

			{{ambox
			\| style=border-color:Cyan;
			\| text= this is text.<br>
			\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]
			\| info = this is info
			}}
	==Common parameters==		==Common parameters==
	=== ''name'' ===		=== ''name'' ===

Etenne: /* Basic usage */

2022-06-17T01:05:40Z

Basic usage

← Older revision		Revision as of 01:05, 17 June 2022
Line 21:		Line 21:
	}}		}}
	</pre>		</pre>

			==Example==
			{{ambox
			\| style=border-color:Cyan;
			\| text= this is text.<br>
			\| image = [[File:OOjs UI icon notice-warning.svg.png\|50px]]
			\| info = this is info
			}}

	==Common parameters==		==Common parameters==

Etenne at 23:35, 16 June 2022

2022-06-16T23:35:51Z

← Older revision		Revision as of 23:35, 16 June 2022
Line 9:		Line 9:
	\| subst = <includeonly>{{subst:substcheck}}</includeonly>		\| subst = <includeonly>{{subst:substcheck}}</includeonly>
	\| small = {{{small\|}}}		\| small = {{{small\|}}}
	\| style=border-color:(purple; red; orange; yellow; blue(default); gray;)		\| style=border-color:(purple; magenta; red; pink; orange; yellow; chartreuse; green; Cyan; violet; blue(default); brown; gray; black;)
	\| type =		\| type =
	\| image =		\| image =

Etenne: /* Basic usage */

2022-06-16T23:25:42Z

Basic usage

← Older revision		Revision as of 23:25, 16 June 2022
Line 9:		Line 9:
	\| subst = <includeonly>{{subst:substcheck}}</includeonly>		\| subst = <includeonly>{{subst:substcheck}}</includeonly>
	\| small = {{{small\|}}}		\| small = {{{small\|}}}
			\| style=border-color:(purple; red; orange; yellow; blue(default); gray;)
	\| type =		\| type =
	\| image =		\| image =

Etenne at 19:58, 16 June 2022

2022-06-16T19:58:16Z

← Older revision		Revision as of 19:58, 16 June 2022
Line 21:		Line 21:
	</pre>		</pre>

			==Common parameters==
			=== ''name'' ===
			The ''name'' parameter specifies the name of the template, without the Template namespace prefix. For example {{Tl\|Underlinked}} specifies {{Para\|name\|Underlinked}}.

			This parameter should be updated if the template is ever moved. The purpose of this parameter is twofold:
			* If incorrectly [[Wikipedia:Substitution\|substituted]], it allows the meta-template to notify the name of the template which has been substituted, which may help editors to fix the problem.
			* It allows the template to have a more useful display on its template page, for example to show the date even when not specified, and to apply categorisation of the template itself.

			=== ''subst'' ===
			The ''subst'' parameter allows the meta-template to detect whether the template has been incorrectly substituted, and give an appropriate warning. It will also add such pages to [[:Category:Pages with incorrectly substituted templates]]. Just copy the code exactly as it appears in the box.

			=== ''small'' ===
			The ''small'' parameter should be passed through the template, as this will allow editors to use the small format by specifying {{para\|small\|left}} on an article:
			{{Ambox\|nocat=true\|small=left\|text=This is the small left-aligned Ambox format.}}
			Otherwise the standard format will be produced:
			{{Ambox\|nocat=true\|text=This is the standard Ambox format.}}

			Other variations:
			* For templates which should ''never'' be small, specify {{Para\|small\|no}} or do not pass the small parameter at all.
			* For templates which should ''always'' be small, just specify {{Para\|small\|left}}.
			* For templates which should ''default to small'', try {{para\|small\|<nowiki>{{{small\|left}}}</nowiki>}}. This will allow an editor to override by using {{para\|small\|no}} on an article.

			To use a small box that adjusts its width to match the text, use {{para\|style\|width: auto; margin-right: 0px;}} and {{para\|textstyle\|width: auto;}} together:
			{{Ambox\|nocat=true\|small=left\|style=width: auto; margin-right: 0px;\|textstyle=width: auto; margin-right: 0px;\|text=This is the small left-aligned Ambox format with flexible width.}}

			See {{section link\|\|sect}} below for more information on how to limit {{para\|small}} display to cases when the template is being used for a section instead of the whole article (recommended, to prevent inconsistent top-of-article display).


			=== ''talk'' ===
			Some article message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the ''talk'' parameter through, i.e. {{para\|talk\|<nowiki>{{{talk\|}}}</nowiki>}}

			This parameter may then be used by an editor as follows:
			* {{para\|talk\|SECTION HEADING}} – the link will point to the specified section on the article's talk page, e.g. {{para\|talk\|Foo}}
			* {{para\|talk\|FULL PAGE NAME}} – the template will link to the page specified (which may include a [[Help:Link#Section linking (anchors)\|section anchor]]), e.g. {{para\|talk\|Talk:Banana#Foo}}

			Notes:
			* When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
			* In order to make sure there is always a link to the talk page, you can use {{para\|talk\|<nowiki>{{{talk\|#}}}</nowiki>}}.
			* If the talk page does not exist, there will be no link, whatever the value of the parameter.

			=== ''date'' ===
			Passing the ''date'' parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a [[Wikipedia:Bots\|bot]]). This will be displayed after the message in a smaller font.

			Passing this parameter also enables [[:Category:Wikipedia maintenance categories sorted by month\|monthly cleanup categorisation]] when the ''cat'' parameter is also defined.

			=== ''info'' ===
			This parameter is for specifying additional information. Whatever you add here will appear after the date, and will not be displayed if the template is being wrapped in {{tl\|multiple issues}}.

			=== ''removalnotice'' ===
			If you specify {{para\|removalnotice\|yes}}, then the following notice will be displayed after the date and after the ''info'' text:
			* <small>[[Help:Maintenance template removal\|Learn how and when to remove this template message]].</small>
			This will not be displayed if the template is being wrapped in {{tl\|multiple issues}}.

			=== ''cat'' ===
			This parameter defines a monthly cleanup category. If {{para\|cat\|CATEGORY}} then:
			* articles will be placed in '''Category:CATEGORY from DATE''' if {{para\|date\|DATE}} is specified.
			* articles will be placed in '''Category:CATEGORY''' if the date is not specified.

			For example, {{Tl\|No footnotes}} specifies {{Para\|cat\|Articles lacking in-text citations}} and so an article with the template {{Tlx\|No footnotes\|2=date=June 2010}} will be placed in [[:Category:Articles lacking in-text citations from June 2010]].

			The ''cat'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.

			=== ''all'' ===
			The ''all'' parameter defines a category into which all articles should be placed.

			The ''all'' parameter should not be linked, nor should the prefix <code>Category:</code> be used.

Etenne at 18:47, 16 June 2022

2022-06-16T18:47:41Z

← Older revision		Revision as of 18:47, 16 June 2022
Line 27:		Line 27:


	<~~includeonly>{{Sandbox other\|\|~~		<noinclude>
	~~<!-- Categories below this line; interwikis at Wikidata --~~>		[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>
	[[Category:~~Mbox templates~~{{~~#translation:~~}}]]
	}}</~~includeonly~~>

	~~{{collapse bottom}}~~

Etenne at 18:45, 16 June 2022

2022-06-16T18:45:20Z

← Older revision		Revision as of 18:45, 16 June 2022
Line 1:		Line 1:
	{{Documentation subpage}}		<noinclude> {{Documentation subpage}}</noinclude>