Template:NoteBox

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
{{{text}}}
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:NoteBox/doc.

Show a note in a box (e.g. a top-of-the-page warning) in four different styles depending on the parameters type:

Usage

{{NoteBox
 |type =
 |1    =
}}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Show a note in a box (e.g. a top-of-the-page warning) in four different styles depending on the parameters <code>type</code>:<div style="font-weight: lighter"> <div role="note" class="note note-info ">info (standard)</div> <div role="note" class="note note-reminder ">reminder</div> <div role="note" class="note note-warn ">warn</div> <div role="note" class="note note-error ">error</div> == See also ==

  • [[:Template:Mbox|&#123;&#123;Mbox&#125;&#125;]] – different message boxes
  • [[:Template:Warning|&#123;&#123;Warning&#125;&#125;]]
  • [[:Template:Image message box|&#123;&#123;Image message box&#125;&#125;]]
  • [[:Template:Message box|&#123;&#123;Message box&#125;&#125;]]
  • [[:Template:Box|&#123;&#123;Box&#125;&#125;]]
</div>

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Text1 text

Informative note.

Contentsuggested
Inline formattinginline

Show the template without line breaks before and after it.

Default
0
Auto value
1
Booleanoptional
Typetype 2

One of “info”, “reminder”, “warn”, or “error”. This setting affects the color and icon.

Suggested values
info reminder warn error
Default
info
Stringoptional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Localization

العربية  Deutsch  English  français  Bahasa Indonesia  македонски  Nederlands  русский  中文

This template makes use of {{Autotranslate}} and the translate extension. The layout of the template can be found under Template:NoteBox/layout.