Template:Notice: Difference between revisions

From The Reed and Rite
mNo edit summary
m Changed asterisk in "Prevent Dismissal" section to a superscript number.
 
(52 intermediate revisions by the same user not shown)
Line 13: Line 13:
</includeonly><noinclude>
</includeonly><noinclude>
== Description ==
== Description ==
This template is a parent template that helps build [[:Category: Notices|Notice Templates]]. It is not intended to be used on its own, but rather to be used to help build other derivative templates.
This template is a parent template that helps build [[:Help:Templates#Notices|Notice Templates]]. It is not intended to be used on its own, but rather to be used to help build other [[:Template:Notice#Derivative Templates|derivative templates]].


== Usage ==
== Usage ==
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Text Only</span><br><span style="font-weight: normal;">The only required parameter for this template is <code>text=</code>, which will populate the template with your input.</span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Text Only</span><br><div style="text-align: left;"><span style="font-weight: normal;">The only required parameter for this template is <code>text=</code>, which will populate the template with your input.</span></div>
|-
|-
! width=40%|You Type
! width=38%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: center;"
| <pre>{{notice
| <pre>{{notice|text=This is a notice.}}</pre>
|text=This is a notice.
}}</pre>
| {{notice|text=This is a notice.}}
| {{notice|text=This is a notice.}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Add a Heading</span><br><span style="font-weight: normal;">You have the option to also add a bold header by passing <code>header=</code>.<br>'''Note:''' If you wish for the main text to be bold, surround your <code>text=</code> input with triple apostrophes. (<code><nowiki>'''INPUT'''</nowiki></code>) </span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Add a Bold Header</span><br><div style="text-align: left;"><span style="font-weight: normal;">You have the option to also add a bold header by passing <code>header=</code>.<br><span style="font-size: 90%;"><br>'''Note:''' If you wish for the regular text to be bold, surround your <code>text=</code> input with triple apostrophes. (<code><nowiki>'''INPUT'''</nowiki></code>)</span></span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|header=This is a header.
|header=This is a header.
Line 39: Line 37:
| {{notice|header=This is a header.|text=This is the regular text.}}
| {{notice|header=This is a header.|text=This is the regular text.}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Adjust Width</span><br><span style="font-weight: normal;">By default, the width of the notice will be 65% the width of the page or container where it is used.<br>You can adjust this value by passing <code>width=</code> and defining the width as either a percentage (e.g., <code>80%</code>) or a pixel width (e.g., <code>300px</code>). </span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Adjust Width</span><br><div style="text-align: left;"><span style="font-weight: normal;">By default, the width of the notice will be 65% the width of the page or container where it is used. You can adjust this value by passing <code>width=</code> and defining the width as either a percentage (preferred), e.g., <code>80%</code>, or a pixel width, e.g., <code>300px</code>.</span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|text=This notice's width is 100%.
|text=This notice's width is 100%.
|width=100%
|width=100%
}}</pre>
}}</pre>
| {{notice|text=This notice's width is 100%.|width=100%
| {{notice|text=This notice's width is 100%.|width=100%}}{{notice|text=This notice's width is 50%.|width=50%}}
}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Adjust Alignment</span><br><span style="font-weight: normal;">By default, the notice will be centered on the page or in the container where it is used.<br>You can adjust its alignment by passing <code>align=</code> with either the value <code>LEFT</code> or <code>RIGHT</code>. </span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Adjust Alignment</span><br><div style="text-align: left;"><span style="font-weight: normal;">By default, the notice will be centered on the page or within the container where it is used. You can adjust its alignment by passing <code>align=</code> with either the value <code>LEFT</code> or <code>RIGHT</code>.</span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|text=This notice is aligned left.
|text=A left/right aligned notice.
|align=LEFT/RIGHT
|align=LEFT/RIGHT
}}</pre>
}}</pre>
| {{notice|text=This notice is aligned left.|align=left}}{{notice|text=This notice is aligned right.|align=right}}
| {{notice|text=A left aligned notice.|align=left}}{{notice|text=A right aligned notice.|align=right}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Adjust Color</span><br><span style="font-weight: normal;">By default, the notice will have a light gray background with a gray border.<br>You can adjust its background color by passing <code>color=</code> with a color value in one of three forms ('''Note:''' By adding a color value, the border is removed.):<br>1. A [https://htmlcolorcodes.com/color-names/ Named HTML Color] (e.g., <code>red</code>)<br>2. A [https://www.color-hex.com hex color code] (e.g., <code>#ff0000 </code>)<br>3. An RGB value (e.g., <code>rgb(255, 0, 0)</code>)</span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Adjust Color</span><br><div style="text-align: left;"><span style="font-weight: normal;">By default, the notice will have a light gray background with a gray border. You can adjust its background color by passing <code>color=</code> with a color value in one of three forms:<br>1. A [https://htmlcolorcodes.com/color-names/ Named HTML Color] (e.g., <code>red</code>)<br>2. A [https://www.color-hex.com hex color code] (e.g., <code>#ff0000</code>)<br>3. An [https://rgbcolorpicker.com RGB/RGBA value] (e.g., <code>rgb(255, 0, 0)</code>)<br><br>Adding a value not following one of the forms above will cause the background color to be transparent. Please select a shade of color light enough that the black text remains legible.<span style="font-size: 90%;"><br><br>'''Note:''' By adding a color value, the border is removed.<span></span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|text=This notice is light green.
|text=A light green notice.
|color=#bdcca1
|color=#bdcca1
}}</pre>
}}</pre>
| {{notice|text=This notice is light green.|color=#bdcca1}}
| {{notice|text=A light green notice.|color=#bdcca1}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Add a Border</span><br><span style="font-weight: normal;">Explanation ([https://coding-help.fandom.com/wiki/Borders Border Help])</span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Add a Border</span><br><div style="text-align: left;"><span style="font-weight: normal;">'''It is preferred to have notices display without a border''', however you can add a border by passing <code>border=</code>. Your input should follow the standard HTML border format of <code>SIZE PATTERN COLOR</code>, e.g., <code>1px solid blue</code>.<br><span style="font-size: 90%;"><br>'''Note:''' You can find further details on HTML borders [https://coding-help.fandom.com/wiki/Borders here].</span></span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|text=This notice has a blue border.
|text=A notice with a blue border.
|border=1px solid blue
|border=1px solid blue
}}</pre>
}}</pre>
| {{notice|text=This notice has a blue border.|border=1px solid blue}}
| {{notice|text=A notice with a blue border.|border=1px solid blue}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Prevent Dismissal</span><br><span style="font-weight: normal;">Explanation</span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Prevent Dismissal</span><br><div style="text-align: left;"><span style="font-weight: normal;">By default, notices have an "'''x'''" in the top right corner that, if clicked, will make the notice disappear.<sup>1</sup> You can pass <code>dismiss=no</code> to hide the "'''x'''", preventing the option to hide the notice. To unhide any notices you may have previously dismissed, select "Reset Notices" from the Tools menu in the upper, right hand corner of the page.<br><br>1. <span style="font-size: 90%;">Only users who are logged in have the ability to dismiss notices. Anonymous users (i.e., not logged in) cannot dismiss notices, regardless if <code>dismiss=no</code> is passed.</span></span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
!You Get
!You Get
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{notice
| <pre>{{notice
|text=This notice is not dismissible.
|text=This notice is not dismissible.
Line 95: Line 92:
| {{notice|text=This notice is not dismissible.|dismiss=no}}
| {{notice|text=This notice is not dismissible.|dismiss=no}}
|-  
|-  
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Clear Other Elements</span><br><span style="font-weight: normal;">Explanation</span>
! colspan="2" style="text-align: center;" | <span style="font-size: 125%;">Clear Other Elements</span><br><div style="text-align: left;"><span style="font-weight: normal;">On very rare occasions, a notice may overlap with other elements present on the page. You can prevent this by passing <code>clear=yes</code>. '''This parameter should only be used as a last resort as passing it may give unexpected or undesired results. Instead, try adjusting using the width or alignment parameters or adding a line break between the notice template and the other element(s).'''</span></div>
|-
|-
! width=30%|You Type
! width=30%|You Type
Line 101: Line 98:
|-  
|-  
| colspan="2" style="text-align: center;" | '''Without using <code>clear=yes</code>.'''
| colspan="2" style="text-align: center;" | '''Without using <code>clear=yes</code>.'''
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{quote}}{{notice
| <pre>{{quote}}{{notice
|text=This notice is not using "clear=yes".
|text=This notice is not using "clear=yes".
Line 115: Line 112:
|-  
|-  
| colspan="2" style="text-align: center;" | '''Using <code>clear=yes</code>.'''
| colspan="2" style="text-align: center;" | '''Using <code>clear=yes</code>.'''
|- style="text-align: left; background-color: white;"
|- style="text-align: left;"
| <pre>{{quote}}{{notice
| <pre>{{quote}}{{notice
|text=This notice is using "clear=yes".
|text=Using "clear=yes".
|clear=yes
|clear=yes
}}</pre>
}}</pre>
Line 125: Line 122:
|width=250px
|width=250px
|align=left
|align=left
}}{{notice
}}{{notice|text=Using <code>clear=yes</code>.|clear=yes}}
|text=This notice is using <code>clear=yes</code>.
|clear=yes
}}
|}
|}



Latest revision as of 19:26, 29 May 2025

Description

This template is a parent template that helps build Notice Templates. It is not intended to be used on its own, but rather to be used to help build other derivative templates.

Usage

Text Only
The only required parameter for this template is text=, which will populate the template with your input.
You Type You Get
{{notice|text=This is a notice.}}
×
This is a notice.
Add a Bold Header
You have the option to also add a bold header by passing header=.

Note: If you wish for the regular text to be bold, surround your text= input with triple apostrophes. ('''INPUT''')
You Type You Get
{{notice
|header=This is a header.
|text=This is the regular text.
}}
×
This is a header.
This is the regular text.
Adjust Width
By default, the width of the notice will be 65% the width of the page or container where it is used. You can adjust this value by passing width= and defining the width as either a percentage (preferred), e.g., 80%, or a pixel width, e.g., 300px.
You Type You Get
{{notice
|text=This notice's width is 100%.
|width=100%
}}
×
This notice's width is 100%.
×
This notice's width is 50%.
Adjust Alignment
By default, the notice will be centered on the page or within the container where it is used. You can adjust its alignment by passing align= with either the value LEFT or RIGHT.
You Type You Get
{{notice
|text=A left/right aligned notice.
|align=LEFT/RIGHT
}}
×
A left aligned notice.
×
A right aligned notice.
Adjust Color
By default, the notice will have a light gray background with a gray border. You can adjust its background color by passing color= with a color value in one of three forms:
1. A Named HTML Color (e.g., red)
2. A hex color code (e.g., #ff0000)
3. An RGB/RGBA value (e.g., rgb(255, 0, 0))

Adding a value not following one of the forms above will cause the background color to be transparent. Please select a shade of color light enough that the black text remains legible.

Note: By adding a color value, the border is removed.
You Type You Get
{{notice
|text=A light green notice.
|color=#bdcca1
}}
×
A light green notice.
Add a Border
It is preferred to have notices display without a border, however you can add a border by passing border=. Your input should follow the standard HTML border format of SIZE PATTERN COLOR, e.g., 1px solid blue.

Note: You can find further details on HTML borders here.
You Type You Get
{{notice
|text=A notice with a blue border.
|border=1px solid blue
}}
×
A notice with a blue border.
Prevent Dismissal
By default, notices have an "x" in the top right corner that, if clicked, will make the notice disappear.1 You can pass dismiss=no to hide the "x", preventing the option to hide the notice. To unhide any notices you may have previously dismissed, select "Reset Notices" from the Tools menu in the upper, right hand corner of the page.

1. Only users who are logged in have the ability to dismiss notices. Anonymous users (i.e., not logged in) cannot dismiss notices, regardless if dismiss=no is passed.
You Type You Get
{{notice
|text=This notice is not dismissible.
|dismiss=no
}}
This notice is not dismissible.
Clear Other Elements
On very rare occasions, a notice may overlap with other elements present on the page. You can prevent this by passing clear=yes. This parameter should only be used as a last resort as passing it may give unexpected or undesired results. Instead, try adjusting using the width or alignment parameters or adding a line break between the notice template and the other element(s).
You Type You Get
Without using clear=yes.
{{quote}}{{notice
|text=This notice is not using "clear=yes".
}}
“

A thing someone said. ”

—Who Said It
×
This notice is not using clear=yes.
Using clear=yes.
{{quote}}{{notice
|text=Using "clear=yes".
|clear=yes
}}
“

A thing someone said. ”

—Who Said It
×
Using clear=yes.

Derivative Templates