Template:Base16/Documentation: Difference between revisions

Latest revision as of 11:54, 16 April 2024

Template:Base16 template makes it easy to convert from decimal to hexadecimal.

Usage

It accepts one mandatory parameter, the decimal number to be converted to a hexadecimal. Decimals and fractions will be rounded down.

A optional parameter controls the display of a subscript:

The number is, by default, formatted with a final subscript 16 to display the base.
With |hex, the base will display as hex.
Using |no or |none hides the subscript and forces the display of at least two hexadecimal digits (instead of just one for values lower than 16).
Use |digit to show a single digit without the subscript and without the 0 prefix.

Return

To convert a number to a base 16:

{{Base16|0}} → 0₁₆

{{Base16|15}} → F₁₆

{{Base16|3256}} → CB8₁₆

To convert a number to a base hex:

{{Base16|0|hex}} → 0_hex

{{Base16|15|hex}} → F_hex

{{Base16|3256|hex}} → CB8_hex

To display single digits:

{{Base16|0|digit}} → 0

{{Base16|10|digit}} → A

{{Base16|15|digit}} → F

To convert an RGB color from decimal code to hex code:

{{Base16|255|no}}{{Base16|165|no}}{{Base16|0|no}} → FFA500

Not a number input: {{Base16|}} →; {{Base16}} → 0₁₆; {{Base16|foobar}} → foobar; {{Base16|A B}} → A B

@@ Line 1: / Line 1: @@
 <includeonly>[[Category:Conversion Template]]</includeonly>
 {{Template|Base16}} template makes it easy to convert from decimal to {{wp|hexadecimal}}.
-=== Usage ===
+==Usage==
-Use: <code><nowiki>{{Base16|x}}</nowiki></code> where x is the decimal number to be converted to a hexadecimal. Decimals and fractions will be rounded down. The number is, by default, formatted with a final subscript 16 to display the base. An optional second parameter of <code><nowiki>|hex</nowiki></code> will replace the base with "hex".
+It accepts one {{Parameter|mandatory}}, the decimal number to be converted to a hexadecimal. Decimals and fractions will be rounded down.
-To opt out of the subscript, use a second parameter of <code><nowiki>|no</nowiki></code> (or equivalently <code><nowiki>|none</nowiki></code>), which also forces the display of at least two hexadecimal digits (instead of just one for values lower than 16).
+A {{Parameter|optional}} controls the display of a subscript:
+* The number is, by default, formatted with a final subscript {{code|16}} to display the base.
+* With {{Code|<nowiki>|hex</nowiki>}}, the base will display as {{code|hex}}.
+* Using {{Code|<nowiki>|no</nowiki>}} or {{Code|<nowiki>|none</nowiki>}} hides the subscript and forces the display of at least two hexadecimal digits (instead of just one for values lower than 16).
+* Use {{Code|<nowiki>|digit</nowiki>}} to show a single digit without the subscript and without the 0 prefix.
-To show a single digit, without the subscript and without the 0 prefix, set the second parameter to <code><nowiki>|digit</nowiki></code>.
+==Return==
-===Examples===
 To convert a number to a base 16:
-: <code><nowiki>{{Base16|0}}</nowiki></code> → {{Base16|0}}
+: {{Code|<nowiki>{{Base16|0}}</nowiki>}} → {{Base16|0}}
-: <code><nowiki>{{Base16|15}}</nowiki></code> → {{Base16|15}}
+: {{Code|<nowiki>{{Base16|15}}</nowiki>}} → {{Base16|15}}
-: <code><nowiki>{{Base16|3256}}</nowiki></code> → {{Base16|3256}}
+: {{Code|<nowiki>{{Base16|3256}}</nowiki>}} → {{Base16|3256}}
 To convert a number to a base hex:
-: <code><nowiki>{{Base16|0|hex}}</nowiki></code> → {{Base16|0|hex}}
+: {{Code|<nowiki>{{Base16|0|hex}}</nowiki>}} → {{Base16|0|hex}}
-: <code><nowiki>{{Base16|15|hex}}</nowiki></code> → {{Base16|15|hex}}
+: {{Code|<nowiki>{{Base16|15|hex}}</nowiki>}} → {{Base16|15|hex}}
-: <code><nowiki>{{Base16|3256|hex}}</nowiki></code> → {{Base16|3256|hex}}
+: {{Code|<nowiki>{{Base16|3256|hex}}</nowiki>}} → {{Base16|3256|hex}}
 To display single digits:
-: <code><nowiki>{{Base16|0|digit}}</nowiki></code> → {{Base16|0|digit}}
+: {{Code|<nowiki>{{Base16|0|digit}}</nowiki>}} → {{Base16|0|digit}}
-: <code><nowiki>{{Base16|10|digit}}</nowiki></code> → {{Base16|10|digit}}
+: {{Code|<nowiki>{{Base16|10|digit}}</nowiki>}} → {{Base16|10|digit}}
-: <code><nowiki>{{Base16|15|digit}}</nowiki></code> → {{Base16|15|digit}}
+: {{Code|<nowiki>{{Base16|15|digit}}</nowiki>}} → {{Base16|15|digit}}
-To convert an [[RGB color model|RGB color]] from decimal code to [[hex code]]:
+To convert an {{wp|RGB color}} from decimal code to {{wp|hex code}}:
-: <code><nowiki>{{Base16|255|no}}{{Base16|165|no}}{{Base16|0|no}}</nowiki></code> → {{Base16|255|no}}{{Base16|165|no}}{{Base16|0|no}}
+: {{Code|<nowiki>{{Base16|255|no}}{{Base16|165|no}}{{Base16|0|no}}</nowiki>}} → {{Base16|255|no}}{{Base16|165|no}}{{Base16|0|no}}
 ;Not a number input
-: <code><nowiki>{{Base16|}}</nowiki></code> → {{Base16|}}
+: {{Code|<nowiki>{{Base16|}}</nowiki>}} → {{Base16|}}
-: <code><nowiki>{{Hexadecimal}}</nowiki></code> → {{Hexadecimal}}
+: {{Code|<nowiki>{{Base16}}</nowiki>}} → {{Base16}}
-: <code><nowiki>{{Base16|foobar}}</nowiki></code> → {{Base16|foobar}}
+: {{Code|<nowiki>{{Base16|foobar}}</nowiki>}} → {{Base16|foobar}}
-: <code><nowiki>{{Base16|A B}}</nowiki></code> → {{Base16|A B}}
+: {{Code|<nowiki>{{Base16|A B}}</nowiki>}} → {{Base16|A B}}