Template:Mxt/User CSS for a monospaced coding font: Difference between revisions
meta>SMcCandlish typo |
m 31 revisions imported |
||
| (22 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>{{Wikipedia how-to}}</noinclude> | <noinclude>{{Wikipedia how-to}}</noinclude><includeonly><div style="float:right; padding:0 1em;">{{navbar|Mxt/User CSS for a monospaced coding font|plain=y}}</div></includeonly> | ||
You can consistently use a monospaced font with well-designed characters for coding | You can consistently use a monospaced font with well-designed characters for coding (e.g., to distinguish clearly between <code>l</code>, <code>1</code>, and <code>I</code>, and between <code>O</code> and <code>0</code>). | ||
Add something like one of the code snippets below into your | Add something like one of the code snippets below into your {{samp|[[Special:MyPage/common.css]]}} page, replacing {{kbd|"Roboto Mono"}} with whatever your preferred coding font is ([https://fonts.google.com/specimen/Roboto+Mono Roboto Mono] was picked as a freely-available coding font for this example). | ||
If you don't want to manually add this code to your CSS page but would rather <code>@import</code> (transclude) it, see [[meta:User:SMcCandlish/codefont.css]] for quick instructions. | |||
This code will do the following: | This code will do the following: | ||
* Apply a consistent monospace font of your choice (and the fallback system-default | * Apply a consistent monospace font of your choice (and the fallback system-default {{samp|monospace}}, should that font go missing or not have characters you need) to all the normally monospaced HTML elements like {{tag|code|o}}, {{tag|pre|o}}, etc. | ||
* Do the same for additional site-wide classes (as identified so far, e.g. <code>. | * Do the same for the classes used by {{tlx|mxt}} and other monospaced templates in the {{tlx|xt}} family | ||
* Do the same for additional site-wide classes (as identified so far, e.g. <code>.monospaced</code>) that output as monospace. | |||
* Make the three most frequently encountered editing fields also use this font stack: the main editing window, the edit summary line, and the search entry box. | * Make the three most frequently encountered editing fields also use this font stack: the main editing window, the edit summary line, and the search entry box. | ||
If you know of an additional class to add here, please update this page or mention it on [[Template talk:Mxt/User CSS for a monospaced coding font|the talk page]]. | If you know of an additional class to add here, please update this page or mention it on [[Template talk:Mxt/User CSS for a monospaced coding font|the talk page]]. | ||
<!--DO NOT ADD var TO THIS LIST! It must be able to inherit the font of surrounding text, because it is used outside code, as in "If <var>A</var> then <var>B</var>", and in math equations.--> | |||
'''Horizontal style''' | '''Horizontal style''' | ||
{{syntaxhighlight|lang=css|1= | {{syntaxhighlight|lang=css|1= | ||
/* Use my font, when available, for code */ | /* Use my font, when available, for code */ | ||
code, pre, samp, kbd, tt | code, pre, samp, kbd, tt, .example-mono, .userlinks-username, .monospaced, .keyboard-key, .button, .plaincode { font-family: "Roboto Mono", monospace !important; } | ||
/* Make some of the editable stuff monospaced */ | /* Make some of the editable stuff monospaced */ | ||
#wpTextbox1, #wpSummary, #searchInput, #searchText { font-family: "Roboto Mono", monospace !important; } | #wpTextbox1, #wpSummary, #searchInput, #searchText { font-family: "Roboto Mono", monospace !important; } | ||
| Line 28: | Line 31: | ||
kbd, | kbd, | ||
tt, | tt, | ||
.example-mono, | .example-mono, | ||
. | .userlinks-username, | ||
. | .monospaced, | ||
. | .keyboard-key, | ||
.button | |||
.plaincode { | |||
font-family: "Roboto Mono", monospace !important; | font-family: "Roboto Mono", monospace !important; | ||
} | } | ||
| Line 44: | Line 48: | ||
}} | }} | ||
If you'd like to help clean up instances of the {{tag|tt}} element – which has not been valid HTML since the 1990s, and should usually be replaced with {{tag|code}} (this may vary by context) – you can add something like the following to your | {{anchor|Cleanup efforts}}'''Cleanup efforts''' | ||
If you'd like to help clean up instances of the {{tag|{{!mxt|tt}}}} element – which has not been valid HTML since the 1990s, and should usually be replaced with {{tag|{{mxt|code}}}} (this may vary by context) – you can add something like the following to your {{samp|common.css}} to make {{tag|{{!mxt|tt}}|o}} stick out like a sore thumb: | |||
{{syntaxhighlight|lang=css|1= | {{syntaxhighlight|lang=css|1= | ||
/* Flag bad code for cleanup */ | /* Flag bad code for cleanup */ | ||
tt { color: DarkRed; background: Pink; } | tt { color: DarkRed; background: Pink; } | ||
}}<noinclude> | }} | ||
{{Documentation|content=This is a documentation snippet page transcluded (without the banner or this doc section) into other template documentation for consistency. It takes no parameters. | |||
You can also do this with {{tag|font|o}}, {{tag|center|o}}, {{tag|strike|o}}, and other [[Wikipedia:HTML 5#Obsolete elements and attributes|deprecated elements]]. For CSS you can just import for this, see [[meta:User:SMcCandlish/lint.css]].<noinclude><!-- | |||
-->{{Documentation|content=This is a documentation snippet page transcluded (without the banner or this doc section) into other template documentation for consistency. It takes no parameters. | |||
Typical usage: | Typical usage: | ||
| Line 60: | Line 69: | ||
</nowiki></pre> | </nowiki></pre> | ||
It can also be used as a stand-alone how-to page; a redirect to it, [[Help:User CSS for a monospaced coding font]], is categorized as such. | It can also be used as a stand-alone how-to page; a redirect to it, [[Help:User CSS for a monospaced coding font]], is categorized as such. It is also transcluded as a section, at [[Help:User style#User CSS for a monospaced coding font]]. | ||
[[Category:Template documentation]] | [[Category:Template documentation]] | ||
<!--End documentation.-->}}</noinclude> | <!--End documentation.-->}}</noinclude> | ||
Latest revision as of 14:13, 3 September 2020
 | This help page is a how-to guide. It details processes or procedures of some aspect(s) of Wikipedia's norms and practices. It is not one of Wikipedia's policies or guidelines, as it has not been thoroughly vetted by the community. |
You can consistently use a monospaced font with well-designed characters for coding (e.g., to distinguish clearly between l, 1, and I, and between O and 0).
Add something like one of the code snippets below into your Special:MyPage/common.css page, replacing "Roboto Mono" with whatever your preferred coding font is (Roboto Mono was picked as a freely-available coding font for this example).
If you don't want to manually add this code to your CSS page but would rather @import (transclude) it, see meta:User:SMcCandlish/codefont.css for quick instructions.
This code will do the following:
- Apply a consistent monospace font of your choice (and the fallback system-default monospace, should that font go missing or not have characters you need) to all the normally monospaced HTML elements like
<code>,<pre>, etc. - Do the same for the classes used by
{{mxt}}and other monospaced templates in the{{xt}}family - Do the same for additional site-wide classes (as identified so far, e.g.
.monospaced) that output as monospace. - Make the three most frequently encountered editing fields also use this font stack: the main editing window, the edit summary line, and the search entry box.
If you know of an additional class to add here, please update this page or mention it on the talk page.
Horizontal style <syntaxhighlight lang="css">/* Use my font, when available, for code */ code, pre, samp, kbd, tt, .example-mono, .userlinks-username, .monospaced, .keyboard-key, .button, .plaincode { font-family: "Roboto Mono", monospace !important; } /* Make some of the editable stuff monospaced */
- wpTextbox1, #wpSummary, #searchInput, #searchText { font-family: "Roboto Mono", monospace !important; }</syntaxhighlight>
Vertical style <syntaxhighlight lang="css">/* Use my font, when available, for code */ code, pre, samp, kbd, tt, .example-mono, .userlinks-username, .monospaced, .keyboard-key, .button .plaincode {
font-family: "Roboto Mono", monospace !important;
} /* Make some of the editable stuff monospaced */
- wpTextbox1,
- wpSummary,
- searchInput,
- searchText {
font-family: "Roboto Mono", monospace !important;
}</syntaxhighlight>
Cleanup efforts
If you'd like to help clean up instances of the <tt>...</tt> element – which has not been valid HTML since the 1990s, and should usually be replaced with <code>...</code> (this may vary by context) – you can add something like the following to your common.css to make <tt> stick out like a sore thumb:
<syntaxhighlight lang="css">/* Flag bad code for cleanup */ tt { color: DarkRed; background: Pink; }</syntaxhighlight>
You can also do this with <font>, <center>, <strike>, and other deprecated elements. For CSS you can just import for this, see meta:User:SMcCandlish/lint.css.
Template documentationThis is a documentation snippet page transcluded (without the banner or this doc section) into other template documentation for consistency. It takes no parameters.
Typical usage:
== User CSS for a monospaced coding font ==
{{collapse top|left=y|title=Have monospaced templates in this group – and your editing window – use your preferred monospaced font:}}
{{Mxt/User CSS for a monospaced coding font}}
{{collapse bottom}}
It can also be used as a stand-alone how-to page; a redirect to it, Help:User CSS for a monospaced coding font, is categorized as such. It is also transcluded as a section, at Help:User style#User CSS for a monospaced coding font.
