Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

UniWiki:Manual of Style/Text formatting: Difference between revisions

From EVE University Wiki
Djavin novienta (talk | contribs)
Arin Mara (talk | contribs)
m Replaced em template
 
(12 intermediate revisions by one other user not shown)
Line 43: Line 43:
The use of italics for emphasis on the UniWiki should follow good English print style. The most [[UniWiki:Manual of Style/Accessibility|accessible]] way to indicate emphasis is with the HTML {{tag|em}}. Emphasis may be used to draw attention to an important word or phrase within a sentence, when the point or thrust of the sentence may otherwise not be apparent to readers, or to stress a contrast:
The use of italics for emphasis on the UniWiki should follow good English print style. The most [[UniWiki:Manual of Style/Accessibility|accessible]] way to indicate emphasis is with the HTML {{tag|em}}. Emphasis may be used to draw attention to an important word or phrase within a sentence, when the point or thrust of the sentence may otherwise not be apparent to readers, or to stress a contrast:


:{{xt|Gellner accepts that knowledge must be knowledge {{em|of}} something.}}
:{{xt|Gellner accepts that knowledge must be knowledge ''of'' something.}}


It may be preferable to avoid the need for emphasis by rewriting a sentence more explicitly. Use of emphasis more than once in a sentence is rarely helpful to readers, unless the emphasized terms are being directly compared.
It may be preferable to avoid the need for emphasis by rewriting a sentence more explicitly. Use of emphasis more than once in a sentence is rarely helpful to readers, unless the emphasized terms are being directly compared.


{{em|Other, non-emphasis, uses of italics on Wikipedia should use <code><nowiki>''...''</nowiki></code> markup, not {{tag|em|o}}.}}
''Other, non-emphasis, uses of italics on Wikipedia should use <code><nowiki>''...''</nowiki></code> markup, not {{tag|em|o''.}}


===Names and titles===
===Names and titles===
Line 56: Line 56:
* '''Major works of art and artifice,''' such as albums, books, video games, films, journals, magazines, epic poems, television programs, and radio shows. Medium of publication or presentation is not a factor; a video feature only released on video tape, disc or the Internet is considered a "film" for these purposes, and so on. ''(See {{section link|UniWiki:Manual of Style/Titles|Italics}} for details.)''
* '''Major works of art and artifice,''' such as albums, books, video games, films, journals, magazines, epic poems, television programs, and radio shows. Medium of publication or presentation is not a factor; a video feature only released on video tape, disc or the Internet is considered a "film" for these purposes, and so on. ''(See {{section link|UniWiki:Manual of Style/Titles|Italics}} for details.)''


:{{em|Minor works}} (and any specifically-titled subdivisions of italicized major works) are given in double quotation marks. ''See below: [[#When not to use italics|When not to use italics]] for details.''
:''Minor works'' (and any specifically-titled subdivisions of italicized major works) are given in double quotation marks. ''See below: [[#When not to use italics|When not to use italics]] for details.''


:These cases are well-established conventions recognized in most style guides. Do not apply italics to other categories or instances because you feel they are creative or artful (e.g. game or sport moves, logical arguments, "artisanal" products, schools of practice or thought, etc.).
:These cases are well-established conventions recognized in most style guides. Do not apply italics to other categories or instances because you feel they are creative or artful (e.g. game or sport moves, logical arguments, "artisanal" products, schools of practice or thought, etc.).
Line 108: Line 108:


====Mathematics variables====
====Mathematics variables====
{{main|UniWiki:Manual of Style/Mathematics}}
 
Symbols for mathematics variables, either used within mathematical formulas or used in isolation, are simply italicized:
Symbols for mathematics variables, either used within mathematical formulas or used in isolation, are simply italicized:
* <code><nowiki>The value of ''y'' when ''x'' = 3</nowiki></code> ⇒ {{xt|1= The value of ''y'' when ''x'' = 3}}
* <code><nowiki>The value of ''y'' when ''x'' = 3</nowiki></code> ⇒ {{xt|1= The value of ''y'' when ''x'' = 3}}
Line 129: Line 129:
Here, the cross-referenced article does not topically make a good target for a running-text link from the phrase "[[Wikipedia:Demographics of France|largest population in Europe]]", or any other text in the sentence, but has been deemed relevant enough to mention in passing without relegating it to the "See also" section at the bottom of the article.  In any case where such a link in running text [[UniWiki:Manual of Style/Linking#Piped links|would be proper]], it is preferred over a parenthetical, explicit cross-reference.
Here, the cross-referenced article does not topically make a good target for a running-text link from the phrase "[[Wikipedia:Demographics of France|largest population in Europe]]", or any other text in the sentence, but has been deemed relevant enough to mention in passing without relegating it to the "See also" section at the bottom of the article.  In any case where such a link in running text [[UniWiki:Manual of Style/Linking#Piped links|would be proper]], it is preferred over a parenthetical, explicit cross-reference.


Like hatnotes, these parenthetical cross-references are set off by being italicized in their entirety, as [[UniWiki:Manual of Style/Self-references to avoid|UniWiki self-references]], and not part of the article content proper. Unlike some traditional reference works, the convention that has evolved on the UniWiki is {{em|not}} to individually italicize "see" or "see also". The UniWiki's own article titles are not put in quotation marks in such cross-references.
Like hatnotes, these parenthetical cross-references are set off by being italicized in their entirety, as [[UniWiki:Manual of Style/Self-references to avoid|UniWiki self-references]], and not part of the article content proper. Unlike some traditional reference works, the convention that has evolved on the UniWiki is ''not'' to individually italicize "see" or "see also". The UniWiki's own article titles are not put in quotation marks in such cross-references.


=== When not to use italics ===
=== When not to use italics ===
Line 156: Line 156:
Reduced font sizes should be used sparingly. Avoid using smaller font sizes in elements that already use a smaller font size, such as infoboxes, navboxes and reference sections. In no case should the resulting font size drop below 85% of the page font size (or 11px).
Reduced font sizes should be used sparingly. Avoid using smaller font sizes in elements that already use a smaller font size, such as infoboxes, navboxes and reference sections. In no case should the resulting font size drop below 85% of the page font size (or 11px).


=== <span id="Colour" ></span>Color ===
=== Color ===
{{Main article|Wikipedia:Manual of Style/Accessibility#Color}}
{{main|UniWiki:Manual of Style/Accessibility#Color}}
====In prose ====
====In prose ====
Prose text should never be manually colored. Refrain from implementing [[Help:Link color|colored links]] that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons.
Prose text should never be manually colored. Refrain from implementing [[Wikipedia:Help:Link color|colored links]] that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons.


====In templates and tables ====
====In templates and tables ====
{{anchor|In navboxes|reason=Old section name.}}{{shortcut|MOS:NAVBOXCOLOUR|MOS:NAVBOXCOLOR}}
 
#Colors used in templates such as [[Wikipedia:Categories, lists, and navigation templates#Navigation templates|navboxes]] and [[Wikipedia:Infobox|infoboxes]], and in [[Wikipedia:Table|tables]], should not make reading difficult, including for colorblind or otherwise visually impaired readers.
#Colors used in templates such as [[Wikipedia:Wikipedia:Categories, lists, and navigation templates#Navigation templates|navboxes]] and [[Wikipedia:Wikipedia:Infobox|infoboxes]], and in [[Wikipedia:Wikipedia:Table|tables]], should not make reading difficult, including for colorblind or otherwise visually impaired readers.
#Colors that are useful for identification and are {{em|appropriate, representative, and accessible}} may be used with discretion and common sense. In general, text color should not be anything other than black or white (excluding the standard colors of hyperlinks), and background colors should contrast the text color enough to make the template easily readable.
#Colors that are useful for identification and are ''appropriate, representative, and accessible'' may be used with discretion and common sense. In general, text color should not be anything other than black or white (excluding the standard colors of hyperlinks), and background colors should contrast the text color enough to make the template easily readable.
#An "appropriate, representative" color, when intended to identify with an organization's logo or branding, should use the most prominent {{em|accessible}} color in the logo. For example, {{oldid|Template:Pink Panther|433595147|Template:Pink Panther}} should be using a background of <code>F6D4E6</code> {{color sample|#F6D4E6}} (the color of the body in [[:File:Pink Panther.png]]) rather than <code>E466A9</code> {{color sample|#E466A9}} (the color of the background in that image). A representative color useful in a navbox is often already present in an article's infobox (if included), and these are sometimes specified programmatically. For example, [[Template:National Register of Historic Places|the navbox]] associated with the [[National Register of Historic Places]] and other related categorizations should conform to Wikipedia's [[Wikipedia:NRHP colors legend|NRHP colors legend]].
#An "appropriate, representative" color, when intended to identify with an organization's logo or branding, should use the most prominent ''accessible'' color in the logo. A representative color useful in a navbox is often already present in an article's infobox (if included).
#In the case that no properly identifying, accessible color exists; or the subject of the template or table should not be identified with a particular color (e.g., an average biography), the default colors provided by the template or the table class should be used.
#In the case that no properly identifying, accessible color exists; or the subject of the template or table should not be identified with a particular color (e.g., an average biography), the default colors provided by the template or the table class should be used.
#If an article includes several navboxes whose colors conflict with each other, discretion should be used to minimize the visual disruption by using the default colors for navboxes.
#If an article includes several navboxes whose colors conflict with each other, discretion should be used to minimize the visual disruption by using the default colors for navboxes.


=== Font family ===
=== Font family ===
{{shortcut|MOS:FONTFAMILY}}
[[Wikipedia:Font family (HTML)|Font families]] should not be explicitly defined in an article, with the exception of PUA characters (next section), because this interferes with the UniWiki's flexibility, and it is impossible to foresee what fonts will be installed on a user's computer.
[[Font family (HTML)|Font families]] should not be explicitly defined in an article, with the exception of PUA characters (next section), because this interferes with Wikipedia's flexibility, and it is impossible to foresee what fonts will be installed on a user's computer.


Articles used to explicitly define font families for special characters, because older browsers could not automatically select an appropriate font. This is no longer dealt with by using explicit font definitions in the articles. Certain definitions can be invoked by using special templates {{crossref|(see [[Help:Special characters]], {{tl|Unicode}}, and {{tl|IPA}})}}.
Articles used to explicitly define font families for special characters, because older browsers could not automatically select an appropriate font. This is no longer dealt with by using explicit font definitions in the articles.


=== Capital letters ===
=== Capital letters ===
{{Main article|Wikipedia:Manual of Style/Capital letters}}
{{main|UniWiki:Manual of Style/Capital letters}}
The use of capital (upper-case) letters, including small-capitals style, is covered in detail at [[WP:Manual of Style/Capital letters]].
The use of capital (upper-case) letters, including small-capitals style, is covered in detail at [[UniWiki:Manual of Style/Capital letters]].


=== Citations ===
=== Citations ===
{{Main article|Wikipedia:Citing sources}}
:''See also: [[Wikipedia:Wikipedia:Citing sources|Wikipedia:Citing sources]]''
Text formatting in citations should follow, consistently within an article, an established citation style or system. Options include either of Wikipedia's own template-based [[Help:Citation Style 1|Citation Style 1]] and [[Help:Citation Style 2|Citation Style 2]], and any other well-recognized citation system. The formatting applied by the [[Wikipedia:Citation templates|citation templates]] should not be evaded.<ref>In unusual cases, the default formatting may need to be adjusted to conform to some other guideline, e.g. italicization of a non-English term in a title that would otherwise not be italicized.</ref> Parameters should be accurate,<ref>Attempting to misuse citation template parameters to output data they are not designed for typically results in garbled [[COinS]] metadata output. For special cases, use a textual note after the end of the citation template and before the closing <code><nowiki>&lt;/ref&gt;</nowiki></code> tag.</ref> and should not be omitted if the formatting applied by the template is not in agreement with the text-formatting guidelines above.
Text formatting in citations should follow, consistently within an article, an established citation style or system. Options include any well-recognized citation system. Parameters should be accurate,<ref>Attempting to misuse citation template parameters to output data they are not designed for typically results in garbled [[Wikipedia:COinS|COinS]] metadata output. For special cases, use a textual note after the end of the citation template and before the closing <code><nowiki>&lt;/ref&gt;</nowiki></code> tag.</ref> and should not be omitted if the formatting applied by the template is not in agreement with the text-formatting guidelines above.


== Private Use Area and invisible formatting characters ==
== Private Use Area and invisible formatting characters ==
{{anchor|PUA and RTL}}The only invisible characters in the editable text should be spaces and tabs. However, other invisible characters are often inserted inadvertently by pasting from a word processor. These can cause confusion with editors and handling problems with editing software. Any necessary invisible or [[Private Use Area]] (PUA) characters should be substituted with their decimal or hexadecimal code values (that is, as <code>&{{var|...}};</code>) so that they can be edited properly. A template, {{tl|PUA}}, is used to mark PUA characters; it has no effect on the text, but places the article in a tracking category.  {{crossref|(See the next sections for examples.)}}
The only invisible characters in the editable text should be spaces and tabs. However, other invisible characters are often inserted inadvertently by pasting from a word processor. These can cause confusion with editors and handling problems with editing software. Any necessary invisible or [[Wikipedia:Private Use Area|Private Use Area]] (PUA) characters should be substituted with their decimal or hexadecimal code values so that they can be edited properly.
 
=== Mixed right-to-left text ===
{{shortcut|MOS:RTL|MOS:LTR}}
When right-to-left text is embedded in certain left-to-right contexts, such as when tagged with a reference, it may require control characters to display properly. The marker to return to left-to-right text should be encoded as [[Left-to-right mark|<code>&amp;lrm;</code>]] or supplied through the template {{tlx|Rtl-lang}}.
 
Depending on your browser, there may be a difference between the display of unformatted Urdu:<br /><!--NOTE: The display of the "unformatted" ones may look particularly weird in certain browsers when previewing this section by itself; that's kind of an illustration of the problem, so don't worry about it. -->
{{in5}}{{!xt|<code>خ ?<nowiki><ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; خ ?{{dummy ref}}
with formatted:<br />
{{in5}}{{xt|<code>خ&amp;lrm; ?<nowiki><ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; خ&lrm; ?{{dummy ref}} or {{xt|<code><nowiki>{{Rtl-lang|ur|خ}} ?<ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; {{Rtl-lang|ur|خ}} ?{{dummy ref}}
 
and unformatted:<br />
{{in5}}{{!xt|<code>(خ)<nowiki><ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; (خ){{dummy ref}}<br />
with formatted:<br />
{{in5}}{{xt|<code>(خ)&amp;lrm;<nowiki><ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; (خ)&lrm;{{dummy ref}} or {{xt|<code><nowiki>{{Rtl-lang|ur|(خ)}}<ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>}}:&nbsp;&nbsp; {{Rtl-lang|ur|(خ)}}{{dummy ref}}
 
If there is intervening LTR text, as in <code>خ abc<nowiki><ref></nowiki>{{var|citation details}}<nowiki></ref></nowiki></code>, a control character is not required. Spacing and most punctuation, however, are not defined as either LTR or RTL, so the direction of the text needs to be reset manually.


===PUA characters===
===PUA characters===
{{shortcut|MOS:PUA}}
[[Wikipedia:Private Use Area|Private Use Area]] (PUA) characters are in three ranges of code points (<code>U+E000</code>–<code>U+F8FF</code> in the [[Wikipedia:Plane (Unicode)#Basic Multilingual Plane|BMP]], and in [[Wikipedia:Plane (Unicode)#Private Use Area planes|planes 15 and 16]]). PUA characters should normally be avoided, but they are sometimes used when they are found in common fonts.
[[Private Use Area]] (PUA) characters are in three ranges of code points (<code>U+E000</code>–<code>U+F8FF</code> in the [[Plane (Unicode)#Basic Multilingual Plane|BMP]], and in [[Plane (Unicode)#Private Use Area planes|planes 15 and 16]]). PUA characters should normally be avoided, but they are sometimes used when they are found in common fonts, especially when the character itself is the topic of discussion.  


Where PUA characters cannot be replaced with non-PUA Unicode characters, they should be converted to their (hexa)decimal code values (that is, &#...; or &#x...;). However, whenever a PUA character has a Unicode equivalent, it should instead be replaced with that equivalent (Unicodified).  The Unicode may be obvious when text is copied and pasted from a document that uses the PUA for bullets or similar characters in Latin text, but similar things happen with punctuation and emoticons in documents using Japanese and other scripts, so an editor familiar with those scripts may be needed.  In Chinese documents it's not uncommon for the PUA to be used for characters that now have full Unicode support, due to poorer support for Chinese characters when those fonts were designed.  Such PUA characters, which are sometimes found on Wikipedia in references and footnotes, should not be substituted with their (hexa)decimal values, as that will lock in the illegible character. If you're moderately familiar with the script, an internet search of the surrounding text will often locate a fully Unicode version of the text which can be used to correct the Wikipedia article.  
Where PUA characters cannot be replaced with non-PUA Unicode characters, they should be converted to their (hexa)decimal code values (that is, &#...; or &#x...;). However, whenever a PUA character has a Unicode equivalent, it should instead be replaced with that equivalent (Unicodified).  The Unicode may be obvious when text is copied and pasted from a document that uses the PUA for bullets or similar characters in Latin text, but similar things happen with punctuation and emoticons in documents using Japanese and other scripts, so an editor familiar with those scripts may be needed.  Such PUA characters, which are sometimes found on the UniWiki in references and footnotes, should not be substituted with their (hexa)decimal values, as that will lock in the illegible character. If you're moderately familiar with the script, an internet search of the surrounding text will often locate a fully Unicode version of the text which can be used to correct the UniWiki article.  


Because browsers do not know which fonts to use for PUA characters, it is necessary for Wikipedia to specify them. {{tl|Unicode}} or {{tl|IPA}} formatting is sufficient in some cases.  Otherwise the fonts should be specified through html markup, as in the example below.  Note that if a font is not specified, or if none of the fonts are installed, readers will only see a numbered box in place of the PUA character.  
Because browsers do not know which fonts to use for PUA characters, it is necessary for the UniWiki to specify them. The fonts should be specified through html markup, as in the example below.  Note that if a font is not specified, or if none of the fonts are installed, readers will only see a numbered box in place of the PUA character.
 
Tagging a (hexa)decimal code with the template {{tl|PUA}} will enable future editors to review the page, and to Unicodify the character if it is included in future expansions of Unicode. This happened, for example, at [[strident vowel]], where a non-Unicode symbol for the sound was used in the literature and added to the PUA of SIL's IPA fonts.  Unicode didn't support it until several years after the Wikipedia article was written, and once the fonts were updated to support it, the PUA character in the article was replaced with its new Unicode value.
 
For example,
:{{xt|1=<code><nowiki>SIL added these letters at U+F267 and U+F268: <span style="font-family:Gentium Plus, Charis SIL, Doulos SIL, serif">{{PUA|&amp;#xf267;}}, {{PUA|&amp;#xf268;}}</span>.</nowiki></code>}}
which renders as:
:SIL added these letters at U+F267 and U+F268: <span style="font-family:Gentium Plus, Charis SIL, Doulos SIL, serif">{{PUA|&#xf267;}}, {{PUA|&#xf268;}}</span>.
 
{{crossref|See [[:Category:Articles with wanted PUA characters]] and especially [[Tengwar#Unicode]] for examples of PUA characters which cannot easily be replaced.}}


== See also ==
== See also ==
*[[WP:Advanced text formatting]]
*[[Wikipedia:Help:Advanced text formatting|Wikipedia:Advanced text formatting]]
*[[WP:Manual of Style/Capital letters]]
*[[UniWiki:Manual of Style/Capital letters]]
*[[WP:Manual of Style/Command-line examples]]
*[[Wikipedia:WP:Stop bolding everything|Wikipedia:Stop bolding everything]] (essay)
*[[WP:Manual of Style#Ligatures]]
*[[WP:Stop bolding everything]] (essay)


==References==
==References==
{{reflist}}
{{reflist}}
[[Category:UniWiki Manual of Style]]