Template:Ednote/doc

From Gentoo Wiki
Jump to:navigation Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Not to be confused with Template:Note.


Editor note: annotations for articles, to highlight important information for other editors.

This template is very visible for all wiki readers, so please use it accordingly and don't overuse it. It can be helpful for important information that should not be missed by editors, or to draw attention to particular points that shouldn't be overlooked.

The "important=true" parameter may be added for very important notes that shouldn't be missed.

Source comments may be used for less important information.

Parameters

Editor note: annotations for other editors to provide useful information.

Template parameters

ParameterDescriptionTypeStatus
Note text1

Add the text

Contentrequired
Recipient2

Change default text of specific recipient of note

Contentoptional
importantimportant

For very important notes, make note stand out and not fold-in

Booleanoptional

Usage

{{Ednote|Note to editors.}}

See the template's testcases:


Parameter: unnamed
Wiki code {{Ednote|Some information.}}

Main version
  Note to editors

Some information.

Sandbox version
  Note to editors Some information.
Change who the message is for (e.g. translators, admins...). Parameter: unnamed1, unnamed2.
Wiki code {{Ednote|Some information.|translators}}

Main version
  Note to translators

Some information.

Sandbox version
  Note to translators Some information.
Make important notice. Parameter: unnamed1, optional unnamed2, important=true.
Wiki code {{Ednote|Some information.|important=true}}

Main version
  Note to editors

Some information.

Sandbox version
  Note to editors Some information.

See also