Difference between revisions of "Template:Hint"

From PINE64
Jump to navigation Jump to search
(use display: table to work with float: right)
(Add more technical notes)
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 +
<!--    -->
 
{{Template}}
 
{{Template}}
 +
 +
A hint box for showing helpful hints.
  
 
== Usage ==
 
== Usage ==
  
<pre><nowiki>{{Hint|This is an hint.}}</nowiki></pre>
+
<nowiki>{{Hint|hint content}}</nowiki>
  
 
== Example ==
 
== Example ==
  
{{Hint|This is an hint.}}
+
<nowiki>{{Hint|This is an hint.}}</nowiki>
</noinclude><includeonly><div style="display: table; min-width: 16em; min-height: 1.6em; margin: .5em 0; padding: .5em 1em; border: 1px solid #9bcdfd; color: #003670; background-color: #d1ecfd;">{{{1|}}}</div></includeonly>
+
<!--      -->
 +
{{Hint | This is an hint.}}
 +
<!--      -->
 +
For a more flexible usage, it doesn't start with "'''Hint:'''" by default,
 +
you may add it manually with <code><nowiki>'''Hint:'''</nowiki></code>:
 +
<!--      -->
 +
<nowiki>{{Hint|'''Hint:''' This is another hint.}}</nowiki>
 +
<!--      -->
 +
{{Hint | '''Hint:''' This is another hint.}}
 +
<!--      -->
 +
== Technical notes ==
 +
 
 +
The boxes use <code>display: table</code> to support both adaptive width and floating siblings, all other alternatives can't archive them as perfect as this solution within just one HTML element. However, it has its own flaw, if you put it into another table, its padding will gone. Avoid putting hints, notes and warnings into any tables until solution was found, or we give up and use two elements for just one box.
 +
 
 +
This template uses class <code>.template-box</code> and <code>.template-hint</code>.
 +
In the future, if the [https://www.mediawiki.org/wiki/Extension:TemplateStyles TemplateStyles Extension] is installed on this MediaWiki instance,
 +
one may move the embedded inline styles to Template Style files.
 +
 
 +
== See also ==
 +
 
 +
* [https://wiki.archlinux.org/title/Template:Tip ArchWiki: Template:Tip]: the template on which this one is based on
 +
* [[Template:Note]]
 +
* [[Template:Warning]]
 +
<!--                  -->
 +
</noinclude><includeonly>
 +
<!--                  -->
 +
<div role="note" class="template-box template-hint" style="
 +
display: table;
 +
min-width: 16em;
 +
min-height: 1.6em;
 +
margin: .5em 0;
 +
padding: .5em 1em;
 +
border: 1px solid #9bcdfd;
 +
color: #003670;
 +
background-color: #d1ecfd;
 +
">{{{1|}}}</div>
 +
<!--      -->
 +
</includeonly>

Revision as of 11:27, 22 September 2021

This page is a template. Check out all pages using this template.
For more information, read Template:Template.

A hint box for showing helpful hints.

Usage

{{Hint|hint content}}

Example

{{Hint|This is an hint.}}
This is an hint.

For a more flexible usage, it doesn't start with "Hint:" by default, you may add it manually with '''Hint:''':

{{Hint|'''Hint:''' This is another hint.}}
Hint: This is another hint.

Technical notes

The boxes use display: table to support both adaptive width and floating siblings, all other alternatives can't archive them as perfect as this solution within just one HTML element. However, it has its own flaw, if you put it into another table, its padding will gone. Avoid putting hints, notes and warnings into any tables until solution was found, or we give up and use two elements for just one box.

This template uses class .template-box and .template-hint. In the future, if the TemplateStyles Extension is installed on this MediaWiki instance, one may move the embedded inline styles to Template Style files.

See also