Project page: Edit

Editing BattleTechWiki:Manual of Style

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{Merge|BattleTechWiki:BattleTech Style Guide}}
+
{{Policy}}
{{MoS guideline|BTW:MOS}}
 
 
This '''Manual of Style''' ('''MoS''' or '''MOS''') is the style manual details stylistic elements that all editors should incorporate to help present a uniform style for all '''Sarna.net BattleTechWiki''' articles. This primary page is supported by further detail pages, which are cross-referenced here and listed under {{cl|Manual of Style}}. If any contradiction arises, this page has precedence. Editors should write articles using straightforward, succinct, easily understood language and structure articles with consistent, reader-friendly layouts and formatting.
 
This '''Manual of Style''' ('''MoS''' or '''MOS''') is the style manual details stylistic elements that all editors should incorporate to help present a uniform style for all '''Sarna.net BattleTechWiki''' articles. This primary page is supported by further detail pages, which are cross-referenced here and listed under {{cl|Manual of Style}}. If any contradiction arises, this page has precedence. Editors should write articles using straightforward, succinct, easily understood language and structure articles with consistent, reader-friendly layouts and formatting.
  
Line 35: Line 34:
 
When writing an article, write out the full name and only use abbreviations in subsequent mentions. When editing an article, be careful to ensure that at least the first mention is written out. For example, any reference to House Davion's preeminent university should first be "New Avalon Institute of Science," while only subsequent mentions should be abbreviated as "NAIS." This means that no page should ever have an abbreviated and linked word/phrase, unless that is the sole name for it (e.g. [[ROM]]).
 
When writing an article, write out the full name and only use abbreviations in subsequent mentions. When editing an article, be careful to ensure that at least the first mention is written out. For example, any reference to House Davion's preeminent university should first be "New Avalon Institute of Science," while only subsequent mentions should be abbreviated as "NAIS." This means that no page should ever have an abbreviated and linked word/phrase, unless that is the sole name for it (e.g. [[ROM]]).
  
Sarna BTW has the functionality to use the template {{tl|Abbr}} that can be used to write an abbreviation (including an acronym or initialism) with its meaning. That creates a tooltip indicating the meaning of the term. Usage of the template in place of the full name is reserved for infoboxes or other tables.
+
Sarna BTW has the funcionality to use the template {{tl|Abbr}} that can be used to write an abbreviation (including an acronym or initialism) with its meaning. That creates a tooltip indicating the meaning of the term. Usage of the template in place of the full name is reserved for infoboxes or other tables.
  
 
==Article titles==
 
==Article titles==
Line 79: Line 78:
 
: ''Ex: The 20th century, the 31st century
 
: ''Ex: The 20th century, the 31st century
  
''For the stylistic use of capitalization of certain BattleTech names, see the [[BattleTechWiki:BattleTech Style Guide#BattleTech-specific names|BattleTech Style Guide]].
+
''For the stylistic use of capitalization of certain BattleTech names, see the [[Policy:BattleTech_Style_Guide#BattleTech-specific_names|BattleTech-specific names]] section.
 
 
===Noble titles and military ranks===
 
Common noble titles follow the same general capitalization rules as ordinary military ranks.
 
 
 
* When preceding a name, always capitalize.
 
:: ''Duke Sandoval, Count Anton Vitios, Lady Terens Amaris, Colonel McCarron, Captain Alanna Damu''
 
 
 
* Ranks and titles, when not preceding a name, are not capitalized.<ref name=LDRA>[[:File:Italicized ranks.png| Per Line Developer Ray Arrastia, 02Aug2022]] (screencap)</ref>
 
:: ''She was a major with two lieutenants and a sergeant in her lance.''
 
:: ''Following the battle, he was promoted to commodore and given command of the fleet.''
 
:: ''All the admirals and generals became quiet as General Kerensky prepared to speak.''
 
:: ''The baron of the region was known to employ the militia for his own personal whims.''
 
 
 
* It is permissible to capitalize in cases where the title or rank is being used in place of a person's name.
 
:: ''The Duchess ordered the regiment to garrison her estate.''
 
:: ''The investigator discovered that the Lord himself was behind his predecessor's death.''
 
:: ''Orders came in from the General to commence firing at the break of dawn.''
 
 
 
* Non-English ranks, with the exception of those used by the Federated Suns or Lyrans, are always italicized and capitalized.<ref name=LDRA/>
 
  
 
==English language==
 
==English language==
Line 423: Line 403:
 
** These should be straight, not curly or slanted. See {{section link||Quotation marks}}.
 
** These should be straight, not curly or slanted. See {{section link||Quotation marks}}.
 
** When quoting a quotation that itself contains a quotation, alternate between using double and single quotes for each quotation. See {{section link||For a quotation within a quotation}} for details.
 
** When quoting a quotation that itself contains a quotation, alternate between using double and single quotes for each quotation. See {{section link||For a quotation within a quotation}} for details.
* When quoting text from non-English languages, the outer punctuation should follow [[BattleTechWiki:Manual of Style#Quotation marks|the Manual of Style for English quote marks]]. If there are nested quotations, follow the rules for correct punctuation in that language. If there are multiple styles for a language, the one used by the Wikipedia for that language is preferred unless the punctuation itself is under discussion.
+
* When quoting text from non-English languages, the outer punctuation should follow [[Policy:Manual of Style#Quotation marks|the Manual of Style for English quote marks]]. If there are nested quotations, follow the rules for correct punctuation in that language. If there are multiple styles for a language, the one used by the Wikipedia for that language is preferred unless the punctuation itself is under discussion.
 
*:{{xt|The cynical response "L'auteur aurait dû demander: « à quoi sert-il d'écrire ceci ? » mais ne l'a pas fait" was all he wrote.}}
 
*:{{xt|The cynical response "L'auteur aurait dû demander: « à quoi sert-il d'écrire ceci ? » mais ne l'a pas fait" was all he wrote.}}
 
* Remove spaces before punctuation such as periods and colons.
 
* Remove spaces before punctuation such as periods and colons.
 
* Generally preserve bold and italics {{cross reference|(see {{section link||Italics}})}}, but most other styling should be altered. {{!xt|{{Underline|Underlining}}}}, {{!xt|spac&nbsp;ing}} within words, {{!xt|1=co<span style="color:Goldenrod;">lor</span>s}}, {{!xt|ALL CAPS}}, {{Smallcaps|{{!xt|small caps}}}}, etc. should generally be normalized to plain text. If it {{em|clearly}} indicates emphasis, use italic {{em|emphasis}} ({{tlx|em}}) or, in an already-italic passage, boldface (with {{tlx|strong}}). For titles of books, articles, poems, and so forth, use italics or quotation marks following [[Policy:Article Naming|the guidance for titles]]. Italics can also be added to mark up
 
* Generally preserve bold and italics {{cross reference|(see {{section link||Italics}})}}, but most other styling should be altered. {{!xt|{{Underline|Underlining}}}}, {{!xt|spac&nbsp;ing}} within words, {{!xt|1=co<span style="color:Goldenrod;">lor</span>s}}, {{!xt|ALL CAPS}}, {{Smallcaps|{{!xt|small caps}}}}, etc. should generally be normalized to plain text. If it {{em|clearly}} indicates emphasis, use italic {{em|emphasis}} ({{tlx|em}}) or, in an already-italic passage, boldface (with {{tlx|strong}}). For titles of books, articles, poems, and so forth, use italics or quotation marks following [[Policy:Article Naming|the guidance for titles]]. Italics can also be added to mark up
 
* Expand an abbreviation (not already used in the content before the quotation) as a square-bracketed change, or explain it using {{tlx|abbr}}.
 
* Expand an abbreviation (not already used in the content before the quotation) as a square-bracketed change, or explain it using {{tlx|abbr}}.
* Normalize archaic glyphs and ligatures in English that are unnecessary to the meaning. Examples include ''[[wikt:æ|æ]]''→''ae'', ''[[wikt:œ|œ]]''→''oe'', ''[[wikt:Long s|ſ]]''→''s'', and ''[[wikt:Thorn (letter)#Abbreviations|þ<sup>e</sup>]]''→''the''. {{crossref|(See also [[wikt:Ampersand|Ampersand]].)}}
+
* Normalize archaic glyphs and ligatures in English that are unnecessary to the meaning. Examples include ''[[æ]]''→''ae'', ''[[œ]]''→''oe'', ''[[Long s|ſ]]''→''s'', and ''[[Thorn (letter)#Abbreviations|þ<sup>e</sup>]]''→''the''. {{crossref|(See also {{section link||Ampersand}}.)}}
  
 
However, national varieties should not be changed, as these may involve changes in vocabulary. For example, a quotation from a British source should retain British spelling, even in an article that otherwise uses American spelling. {{crossref|(See {{section link||Consistency within articles}}.)}} Numbers also usually should not be reformatted.
 
However, national varieties should not be changed, as these may involve changes in vocabulary. For example, a quotation from a British source should retain British spelling, even in an article that otherwise uses American spelling. {{crossref|(See {{section link||Consistency within articles}}.)}} Numbers also usually should not be reformatted.
Line 448: Line 428:
  
 
===Attribution===
 
===Attribution===
The reader must be able to determine the source of any quotation, at the very least via a footnote. The source must be named {{em|in article text}} if the quotation is an opinion {{Crossreference|(see {{Section link|Policy:Neutral point of view|Attributing and substantiating biased statements}})}}. When attributing a quotation, avoid [[Policy:Neutral point of view|characterizing it in a biased manner]].
+
The reader must be able to determine the source of any quotation, at the very least via a footnote. The source must be named {{em|in article text}} if the quotation is an opinion {{Crossreference|(see {{Section link|Wikipedia:Neutral point of view|Attributing and specifying biased statements}})}}. When attributing a quotation, avoid [[Wikipedia:Words to avoid#Synonyms for said|characterizing it in a biased manner]].
  
 
===Quotations within quotations===
 
===Quotations within quotations===
Line 456: Line 436:
 
{{Shortcut|MOS:LINKQUOTE|MOS:LWQ}}
 
{{Shortcut|MOS:LINKQUOTE|MOS:LWQ}}
  
Be conservative when linking within quotations: link only to targets that correspond to the meaning clearly intended by the quote's author. Where possible, link from text outside of the quotation instead – either before it or soon after. (If quoting [[w:hypertext|hypertext]], add an editorial note, {{xt|[link in original]}} or {{xt|[link added]}}, as appropriate, to avoid ambiguity as to whether the link was made by the original author.)
+
Be conservative when linking within quotations: link only to targets that correspond to the meaning clearly intended by the quote's author. Where possible, link from text outside of the quotation instead – either before it or soon after. (If quoting [[hypertext]], add an editorial note, {{xt|[link in original]}} or {{xt|[link added]}}, as appropriate, to avoid ambiguity as to whether the link was made by the original author.)
  
 
===<span class="anchor" id="Block quotations"></span><span class="anchor" id="Block quotes"></span>Block quotations===
 
===<span class="anchor" id="Block quotations"></span><span class="anchor" id="Block quotes"></span>Block quotations===
 
{{Shortcut|MOS:BQ|MOS:BLOCKQUOTE}}
 
{{Shortcut|MOS:BQ|MOS:BLOCKQUOTE}}
  
Format a long quote (more than about forty words or a few hundred characters, or consisting of more than one paragraph, regardless of length) as a [[w:block quotation|block quotation]], indented on both sides. Block quotations should be enclosed in {{tlx|blockquote}}.
+
Format a long quote (more than about forty words or a few hundred characters, or consisting of more than one paragraph, regardless of length) as a [[block quotation]], indented on both sides. Block quotations should be enclosed in {{tlx|blockquote}}.
  
 
Do not enclose block quotations in quotation marks (and especially avoid large, decorative quotation marks; those provided by the {{tlx|cquote}} template have been disabled in mainspace). Block quotations using a colored background are also discouraged.
 
Do not enclose block quotations in quotation marks (and especially avoid large, decorative quotation marks; those provided by the {{tlx|cquote}} template have been disabled in mainspace). Block quotations using a colored background are also discouraged.
Line 485: Line 465:
 
Or quote such material inline, with line breaks indicated by <code><nowiki>{{nbsp}}/</nowiki></code>, and paragraph or stanza breaks by <code><nowiki>{{nbsp}}//</nowiki></code>.
 
Or quote such material inline, with line breaks indicated by <code><nowiki>{{nbsp}}/</nowiki></code>, and paragraph or stanza breaks by <code><nowiki>{{nbsp}}//</nowiki></code>.
  
===<span class="anchor" id="Pull quotes"></span><span class="anchor" id="Pull quotes"></span>Pull quotations===
 
 
{{Shortcut|MOS:PQ|MOS:PULLQUOTE}}
 
{{Shortcut|MOS:PQ|MOS:PULLQUOTE}}
 +
{{Anchor|Pull quotes|Pull quote|Pull quotations|nocquote|reason=The old name of Template:Pull_quote was Template:Cquote, and "nocquote" was historically used to refer to this MOS section, which now has its own shortcuts.}}
 +
[[Pull quote]]s do not belong in Wikipedia articles. These are the [[Wikipedia:What Wikipedia is not#Wikipedia is not news|news and magazine style]] of "pulling" material already in the article to reuse it in attention-grabbing decorative quotations. This unencyclopedic approach is a form of [[Wikipedia:Manual of Style/Words to watch#Editorializing|editorializing]], produces [[Wikipedia:Writing better articles#Provide context for the reader|out-of-context]] and [[Wikipedia:Neutral point of view#Due and undue weight|undue emphasis]], and may [[Wikipedia:No original research|lead the reader to conclusions]] not supported in the material.
  
[[w:Pull quote|Pull quote]]s do not belong in articles. These are the news and magazine style of "pulling" material already in the article to reuse it in attention-grabbing decorative quotations. This unencyclopedic approach is a form of [[Policy:Editing|editorializing]], produces [[BattleTechWiki:The perfect article|out-of-context]] and [[Policy:Neutral point of view|undue emphasis]], and may [[Policy:Verifiability|lead the reader to conclusions]] not supported in the material.
+
===Foreign-language quotations===
 +
{{Shortcut|MOS:FOREIGNQUOTE|MOS:QUOTEFOREIGN}}
 +
 
 +
Quotations from foreign-language sources should appear with a translation into English, preferably a modern{{efn|name=recent}} one. Quotations that are translations should be explicitly distinguished from those that are not. Indicate the original source of a translation (if it is available, and not first published within Wikipedia), and the original language (if that is not clear from the context).
 +
 
 +
If the original, untranslated text is available, provide a reference for it or include it, as appropriate.
 +
 
 +
When editors themselves translate foreign text into English, care must always be taken to include the original text, {{em|in italics}} (except for non-Latin-based writing systems), and to use actual and (if at all possible) common English words in the translation. Unless you are certain of your competency to translate something, see [[Wikipedia:Translation]] for assistance.
  
 
==References==
 
==References==
 
<references/>
 
<references/>
 +
 +
[[Category:Manual of Style]]

Please note that all contributions to BattleTechWiki are considered to be released under the GNU FDL 1.2 (see BattleTechWiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Advanced templates:

Editing: {{Merge}}   {{Moratorium}}   {{Otheruses| | | }}

Notices: {{NoEdit}}   {{Sign}}   {{Unsigned|name}}   {{Welcome}}

Administration: {{Essay}}   {{Policy}}   {{Procedure}}

Templates used on this page: