Template:Ambox/doc: Difference between revisions

From Sword of Moonlight Wiki
Jump to navigation Jump to search
Created page with "<includeonly><!-- --><div class="ambox {{{class|}}} {{#ifeq:{{lc:{{{tiny|}}}}}|yes|tiny}}"<!-- --> style="--ambox-color: {{{color|}}};"><!-- --><div class="ambox-icon">[[File:{{{icon|Ambox banner content.svg}}}{{!}}{{#ifeq:{{lc:{{{tiny|}}}}}|yes|48x20px|48x48px}}|alt=]]</div><!-- --><div class="ambox-content"><!-- start ambox content -->{{#if: {{{title|}}} | <p class="ambox-title">{{{title}}}</p> }}<!-- --><p class="ambox-text">{{{message|No..."
No edit summary
Line 1: Line 1:
<includeonly><!--
== Usage ==
{{#ifeq:{{ROOTPAGENAME}}|Ambox|"Ambox" is an abbreviation for '''A'''rticle '''m'''essage '''box'''. You can use amboxes in articles to indicate something important about the current page, often in the header.|
This '''message template''' is an [[Template:Ambox|article message box]], or '''ambox'''. The documentation below discusses how to use each ambox provided by the wiki.
}}


--><div class="ambox {{{class|}}} {{#ifeq:{{lc:{{{tiny|}}}}}|yes|tiny}}"<!--
== Premade amboxes ==
  --> style="--ambox-color: {{{color|}}};"><!--
=== Problem notice amboxes ===
 
These amboxes are used temporarily to notify other editors and visitors about a problem with an article. These amboxes support the following parameters:
  --><div class="ambox-icon">[[File:{{{icon|Ambox banner content.svg}}}{{!}}{{#ifeq:{{lc:{{{tiny|}}}}}|yes|48x20px|48x48px}}|alt=]]</div><!--
 
  --><div class="ambox-content"><!-- start ambox content
      -->{{#if: {{{title|}}} | <p class="ambox-title">{{{title}}}</p> }}<!--
      --><p class="ambox-text">{{{message|No text provided.}}}{{#if: {{{date|}}} |<nowiki> </nowiki>(Message added: {{{date}}}) }}</p><!--
  --></div><!-- end ambox content


--></div><!-- end ambox
* <code>|tiny=</code>: If set to <code>yes</code>, the box will have less padding and the icon will be much smaller than default.
* <code>|class=</code>: Any additional CSS classes to add to the ambox container element.
* <code>|date=</code>: The date the ambox was added to the page.
* <code>|nocat=</code>: If set to <code>yes</code>, no category will be added to the page. Use this only when creating documentation.


--></includeonly><noinclude>
'''Note:''' Premade amboxes need the base {{t|Ambox}} template to work.
{{documentation}}
{| class="wikitable"
[[Category:Notice templates]]</noinclude>
! Code !! Result
|-
| {{t|Cleanup}} || {{Cleanup|nocat=yes}}
|-
| {{t|Delete}} || {{Delete|nocat=yes}}
|-
| {{t|Merge|Example}} || {{Merge|Template:Ambox{{!}}Example|nocat=yes}}
|-
| {{t|Move|Example}} || {{Move|Template:Ambox{{!}}Example|nocat=yes}}
|-
| {{t|Split|Example}}<br/><br/>{{t|Split|Example 1|Example 2|Example 3}} || {{Split|Template:Ambox{{!}}Example|nocat=yes}}
{{Split|Template:Ambox{{!}}Example 1|Template:Ambox{{!}}Example 2|Template:Ambox{{!}}Example 3|nocat=yes}}
|-
| {{t|Stub}} || {{Stub|nocat=yes}}
|-
 
|}
 
=== Informational amboxes ===
These amboxes are intended as permanent fixtures to a page, to notify visitors about some piece of information relevant to the page. These amboxes support the following parameters in addition to any listed:
 
* <code>|tiny=</code>, if set to <code>Yes</code> the image will be much smaller than default
* <code>|class=</code>, any additional classes to add to the ambox container
 
{| class="wikitable"
! Code !! Additional parameters !! Result
|-
| {{t|Spoiler warning}} ||  || {{Spoiler warning|nocat=yes}}
|-
| {{t|No direct use}} || || {{No direct use|nocat=yes}}
|-
| {{t|Uses Lua}} || <code><nowiki>|1=</nowiki></code>, a comma-separated list of modules used || {{Uses Lua|nocat=yes}}
 
|}
 
=== Optional parameters ===
You can use optional parameters to further customize a premade ambox. The example below is using <code>tiny=yes</code> and <code>date=01/01/2021</code>.
{{Cleanup|tiny=yes|date=01/01/2021|nocat=yes}}
 
== Creating a custom ambox ==
You can create additional ambox templates as needed using the following parameters:
<pre>
{{Ambox
| color = The left border color.
| icon = The icon image to be displayed.
| title = The optional title.
| message = The explanation text displayed.
| tiny = If you want the tiny version of the ambox, fill the parameter with "yes".
| date = An optional date of creation for the message.
| class = An optional CSS class for the ambox.
}}
</pre>
 
== Dependencies ==
For this template to work properly, you need the following:
* <code>.ambox</code> and any related classes, found in [[MediaWiki:Common.css]].
<includeonly>[[Category:Notice templates]]</includeonly>
__NOTOC__
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 07:21, 12 September 2024

Usage

"Ambox" is an abbreviation for Article message box. You can use amboxes in articles to indicate something important about the current page, often in the header.

Premade amboxes

Problem notice amboxes

These amboxes are used temporarily to notify other editors and visitors about a problem with an article. These amboxes support the following parameters:

  • |tiny=: If set to yes, the box will have less padding and the icon will be much smaller than default.
  • |class=: Any additional CSS classes to add to the ambox container element.
  • |date=: The date the ambox was added to the page.
  • |nocat=: If set to yes, no category will be added to the page. Use this only when creating documentation.

Note: Premade amboxes need the base {{Ambox}} template to work.

Code Result
{{Cleanup}}

This page does not meet Sword of Moonlight Wiki's page quality standards. You can edit it to help fixing grammar, formatting, or code issues.

{{Delete}}

Candidate for Deletion

This page lacks relevance for Sword of Moonlight Wiki and is a candidate for deletion.

{{Merge|<Example>}}

It has been proposed that this page be merged with Example.

{{Move|<Example>}}

It has been proposed that this page be moved to Example.

{{Split|<Example>}}

{{Split|<Example 1>|<Example 2>|<Example 3>}}

It has been proposed that this page be split into a new page titled Example.

It has been proposed that this page be split into new pages titled Example 1, Example 2 and Example 3.

{{Stub}}

This page is a stub. You can help Sword of Moonlight Wiki by expanding it.

Informational amboxes

These amboxes are intended as permanent fixtures to a page, to notify visitors about some piece of information relevant to the page. These amboxes support the following parameters in addition to any listed:

  • |tiny=, if set to Yes the image will be much smaller than default
  • |class=, any additional classes to add to the ambox container
Code Additional parameters Result
{{Spoiler warning}}

Spoiler Warning

This page contains spoilers. View at your own discretion.

{{No direct use}}

Don't call this template directly from any content page!

This template is intended to be used inside of another template. Then that template in turn may be used on content pages.

{{Uses Lua}} |1=, a comma-separated list of modules used

This template uses one or more modules written in the Lua programming language.

For more information, see Wikipedia:Lua or the Lua reference manual on mediawiki.org. Modules used include: None provided.


Optional parameters

You can use optional parameters to further customize a premade ambox. The example below is using tiny=yes and date=01/01/2021.

This page does not meet Sword of Moonlight Wiki's page quality standards. You can edit it to help fixing grammar, formatting, or code issues. (Message added: 01/01/2021)

Creating a custom ambox

You can create additional ambox templates as needed using the following parameters:

{{Ambox
| color = The left border color.
| icon = The icon image to be displayed.
| title = The optional title.
| message = The explanation text displayed.
| tiny = If you want the tiny version of the ambox, fill the parameter with "yes".
| date = An optional date of creation for the message.
| class = An optional CSS class for the ambox.
}}

Dependencies

For this template to work properly, you need the following: