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 383: Line 363:
  
 
Tables should not be used simply for layout, either. If the information you are editing is not tabular in nature, it probably does not belong in a table: Try not to use tables for putting a caption under a photograph, arranging a group of links, or other strictly visual features. It makes the article harder to edit. Also, when compared with tables, wikimarkup is more flexible, easier to use, and less esoteric when used for desktop publishing, page elements, and page orientation and positioning.
 
Tables should not be used simply for layout, either. If the information you are editing is not tabular in nature, it probably does not belong in a table: Try not to use tables for putting a caption under a photograph, arranging a group of links, or other strictly visual features. It makes the article harder to edit. Also, when compared with tables, wikimarkup is more flexible, easier to use, and less esoteric when used for desktop publishing, page elements, and page orientation and positioning.
 
==Quotations==
 
{{See also|Policy:Quotations}}
 
{{Shortcut|MOS:QUOTE|MOS:QUOTATIONS}}
 
 
Brief quotations of copyrighted text may be used to illustrate a point, establish context, or attribute a point of view or idea. While quotations are an indispensable part of BTW, try not to overuse them. Using too many quotes is incompatible with an encyclopedic writing style and may be a [[BattleTechWiki:Copyrights|copyright infringement]]. It is generally recommended that content be written in Wikipedia editors' own words. Consider paraphrasing quotations into plain and concise text when appropriate (while being aware that close paraphrasing can still violate copyright).
 
 
===Original wording===
 
{{Shortcut|MOS:PMC|MOS:SIC|MOS:TYPOFIX}}
 
 
Quotations must be [[Policy:Verifiability|verifiably]] attributed, and the wording of the quoted text should be faithfully reproduced. This is referred to as the {{strong|principle of minimal change}}. Where there is good reason to change the wording, bracket the changed text; for example, {{!xt|"Ocyrhoe told him his fate"}} might be quoted as {{xt|"Ocyrhoe told [her father] his fate"}}. If there is a significant error in the original, follow it with {{tlx|sic}} (producing {{xt|{{sic}}}}) to show that the error was not made by BTW. However, insignificant spelling and typographic errors should simply be silently corrected (for example, correct {{!xt|basicly}} to {{xt|basically}}).
 
 
Use [[#Ellipses|ellipses]] to indicate omissions from quoted text. Legitimate omissions include extraneous, irrelevant, or parenthetical words, and unintelligible speech ({{!xt|umm}} and {{!xt|hmm}}), but do not omit text where doing so would remove important context or alter the meaning of the text. Vulgarities and obscenities should be shown exactly as they appear in the quoted source; editors should put offensive material in articles ({{!xt|G-d d--m it!}}), but if the text being quoted ''itself'' does so, copy the text verbatim and use {{tlx|sic}} to indicate that the text is quoted as shown in the source.
 
 
In direct quotations, retain dialectal and archaic spellings, including capitalization (but not archaic glyphs and ligatures, as detailed below).
 
 
===<span class="anchor" id="Quotation point of view"></span>Point of view===
 
{{Shortcut|MOS:QUOTEPOV}}
 
{{See also|Policy:Neutral point of view|}}
 
 
Quotation should be used, with attribution, to present emotive opinions that cannot be expressed in BattleTechWiki's own voice, but never to present cultural norms as simply opinional:
 
 
* Acceptable: {{xt|Siskel and Ebert called the film "unforgettable".}}
 
* Unacceptable: {{!xt|The site is considered "sacred" by the religion's scriptures.}}
 
 
Concise opinions that are not overly emotive can often be reported with attribution instead of direct quotation. Use of quotation marks around simple descriptive terms can imply something doubtful regarding the material being quoted; sarcasm or weasel words such as ''supposedly'' or ''so-called'', might be inferred.
 
 
* Permissible: {{xt|Siskel and Ebert called the film interesting.}}
 
* Unnecessary and may imply doubt: {{!xt|Siskel and Ebert called the film "interesting".}}
 
* Should be quoted: {{xt|Siskel and Ebert called the film "interesting but heart-wrenching".}}
 
 
===Typographic conformity===
 
{{Shortcut|MOS:CONFORM}}
 
 
A quotation is not a [[wikt:facsimile|facsimile]] and, in most cases, it is not a requirement that the original formatting be preserved. Formatting and other purely typographical elements of quoted text. "Quoted text" for typographic conformity and many other purposes includes titles of works, names of organizations, and other strings that are, in essence, quoted. This has no effect on searching for the works we have cited, since all major search engines disregard punctuation marks. These should be adapted to BTW's conventions without comment, provided that doing so will not change or obscure meaning or intent of the text. These are alterations which make no difference when the text is read aloud, for example:
 
 
* Normalize dashes and hyphens: see {{Section link||Dashes}}. Use the style chosen for the article: unspaced [[w:em dash|em dash]] or spaced [[w:em dash|em dash]].
 
* Convert apostrophes and quotation marks to Wikipedia's style:
 
** 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 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.
 
*:{{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.
 
* 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}}.
 
* 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]].)}}
 
 
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.
 
 
Direct quotation should not be used to preserve the formatting preferred by an external publisher (especially when the material would otherwise be unchanged), as this tends to have the effect of [[w:Scare quotes|scare-quoting]]:
 
* {{em|Acceptable}}: {{xt|The animal is listed as endangered on the IUCN Red List of Threatened Species.}}
 
* {{em|Unacceptable}}: {{!xt|The animal is listed as "Endangered" on the IUCN Red List of Threatened Species.}}
 
 
Italics can be used to mark a particular usage as a [[w:term of art|term of art]] (a case of "[[Policy:Editing|words as words]]"), especially when it is unfamiliar or should not be reworded by a non-expert:
 
* {{em|Permissible}}: {{xt|The animal is listed as ''critically endangered'' on the IUCN Red List of Threatened Species.}}
 
 
When quoting a complete sentence, it is usually recommended to keep the first word capitalized. However, if the quoted passage has been integrated into the surrounding sentence (for example, with an introduction such as "{{var|X}} said that"), the original capital letter may be lower-cased.
 
* {{xt|LaVesque's report stated: "The equipment was selected for its low price. This is the primary reason for criticism of the program."}}
 
* {{xt|LaVesque's report said that "the equipment was selected for its low price".}}
 
* {{xt|The program was criticized primarily because "the equipment was selected for its low price", according to LaVesque.}}
 
 
It is not normally necessary to explicitly note changes in capitalization. However, for more precision, the altered letter may be put inside square brackets: {{nobr|"The" → "[t]he".}}
 
* {{xt|The program was criticized primarily because {{nobr|"[t]he}} equipment was selected for its low price", according to LaVesque.}}
 
 
===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]].
 
 
===Quotations within quotations===
 
See {{section link||For a quotation within a quotation}}.
 
 
===Linking===
 
{{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.)
 
 
===<span class="anchor" id="Block quotations"></span><span class="anchor" id="Block quotes"></span>Block quotations===
 
{{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}}.
 
 
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.
 
 
Use {{tnull|blockquote}} and so on only for actual quotations; [[#Indentation|indentation for other purposes]] is done differently.
 
 
It is conventional to precede a block quotation with an introductory sentence (or sentence fragment) and append the source citation to that line. Alternatively, the {{tnull|blockquote}} template provides parameters for attribution and citation which will appear below the quotation. {{Crossref|(For use of dashes with attributions, see {{section link||Other uses (em dash only)}}.)}} This below-quotation attribution style is intended for famous quotations and is unusual in articles because it may strike an inappropriate tone. A quotation with no cited source should be flagged with {{tlx|quote without source}}, or deleted.
 
 
Line breaks and indentation inside a {{tnull|blockquote}} or {{tag|blockquote|o}} are generally ignored; use {{xtag|poem}} or {{tlx|poem quote}} for poetry, lyrics, and similar material:
 
 
<syntaxhighlight lang="wikitext">
 
{{blockquote|<poem>
 
What this grim, ungainly, ghastly, gaunt, and ominous bird of yore
 
            Meant in croaking "Nevermore."
 
</poem>}}
 
</syntaxhighlight>
 
This gives:
 
{{xt|{{blockquote|<poem>
 
What this grim, ungainly, ghastly, gaunt, and ominous bird of yore
 
            Meant in croaking "Nevermore."
 
</poem>}}}}
 
 
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}}
 
 
[[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.
 
  
 
==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: