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}} + {{nutshell|Attempt as much as possible to the following English language guidelines when creating and editing '''BattleTechWiki''' articles.}} − 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 article details stylistic elements that all editors should incorporate to help present a uniform style for all BattleTechWiki articles. − − As a general rule of thumb, Sarna BTW seeks to emulate the established style used in official BattleTech products, though there are some Sarna.net BTW-specific exceptions as outlined below. The default style is that of [[w:The Chicago Manual of Style|The Chicago Manual of Style (CMOS)]]. The BattleTech style departs from the CMOS in certain cases, and on the Sarna.net BattleTechWiki both are trumped by certain rules which are specific to this wiki. − − ==Publisher's BattleTech Style== − [[Catalyst Game Labs]], the current BattleTech producer, maintains a "Writer's Bible" document which includes a Style Guide section; previously, their Style Guide existed as a separate document. Neither of these documents is cleared for public release and those who have access to them are under a [[w:Non-disclosure agreement|non-disclosure agreement (NDA)]] which prohibits them from sharing the document. Consequently, Sarna BTW cannot directly adopt the actual BattleTech style guide. However, the following digest has been created with CGL's permission to be perused by the Sarna BTW: − − ===Capitalization=== − Some words are always capitalized in BattleTech while others are not; while the list may seem counterintuitive at times, the general rule is that BattleTech-specific concepts are highlighted in this way: − *BattleMech, OmniMech, ProtoMech, OmniVehicle, OmniFighter, DropShip, JumpShip, WarShip, DropShuttle − *Clan tactical units: Point, Star, Binary, Nova, Trinary, Supernova, Cluster, Galaxy − *Inner Sphere, Clans, Periphery (when referring to the respective society/region) − *Trial of [...] (when referring to a formalized trial under Clan rules) − * Top-tier titles: Archon, Archon-Prince, Captain-General, Chancellor, Coordinator, Exarch, First Lord, First Prince, Magestrix, Minister-General, Primus, Protector, Warden-General, Warlord (when referring to the Draconis Combine title) − *names of military commands/units − *Gauss − − By contrast, the following words or groups of words are not capitalized despite their frequent use and possibly special meaning in BattleTech: − *vehicles (tank, hovertank), infantry, battle armor, battlesuit, powered armor, aerofighter, aerospace fighter, small craft − *Weight classes: ultralight, light, medium, heavy, assault, colossal, superheavy − *Ranks other than those mentioned above, except when used as part of a name − *Experience ratings: green, regular, veteran, elite (they are only capitalized as nouns in game rules) − *Clan castes: warrior, scientist, merchant, technician, laborer − *''touman'' − − ====CamelCase==== − Note that BattleTech frequently makes use of "odd" capitalization in a fashion many have come to call ''CamelCase'', where words have capital letters in the middle, usually composite words where each composite element begins with a capital letter (e.g. BattleTech, BattleMech, MechWarrior, DropShip, ilClan). Others are abbrevations (e.g. IrTech). While this is the accepted and correct spelling in BattleTech, there is no comprehensive list of such words; there does not seem to be an established correct spelling for LosTech/Lostech/lostech, for example. − − ====Military Operations==== − For a time, military operations were written in all-capital letters in BattleTech publications. This practice has been discontinued, and there is no mention of it in the latest official Style Guide. Sarna.net BTW has opted to maintain the all-capital spelling for consistency across the wiki. ==Abbreviations== ==Abbreviations== 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. ==Article titles== ==Article titles== Article titles should be in the form of a singular noun, such as [[BattleMech]]. Article titles should be in the form of a singular noun, such as [[BattleMech]]. − Abbreviations/Acronyms should be used in a page name if the subject is known primarily by its abbreviation and that abbreviation is primarily associated with the subject. ==Boldface== ==Boldface== Line 56:
Line 24: :* Proper nouns (per standard grammatical rules) are capitalized; a few terms in BattleTech have become rather "common" yet remain proper names and are capitalized accordingly. Other terms are presented as mixed proper/common nouns and have mixed capitalization preferred when presented on Sarna. The following (living) list provides the preferred capitalization format for select terms: :* Proper nouns (per standard grammatical rules) are capitalized; a few terms in BattleTech have become rather "common" yet remain proper names and are capitalized accordingly. Other terms are presented as mixed proper/common nouns and have mixed capitalization preferred when presented on Sarna. The following (living) list provides the preferred capitalization format for select terms: ::* [https://discord.com/channels/845495550803705886/992054758753972234/993632542571901058 Gauss rifle] ::* [https://discord.com/channels/845495550803705886/992054758753972234/993632542571901058 Gauss rifle] − ::* Beagle active probe + :* One notable exception to the above: Sarna capitalizes the proper name of military operations. − ::* Angel ECM suite + :: ''Ex: [[Operation BIRD DOG]], [[Operation SAKKAKU]]'' − − * In infobox lists of weapons, the numeral begins the sentence: "1x medium laser" should be used rather than "1x Medium laser". * The families ruling the five [[Successor States]] should be referred to with capitals, i.e. House Davion, House Kurita, House Liao, House Marik, and House Steiner. * The families ruling the five [[Successor States]] should be referred to with capitals, i.e. House Davion, House Kurita, House Liao, House Marik, and House Steiner. − * Clan commands are always capitalized, such as with Point, Star, Nova, Trinary, Supernova, Cluster, and Galaxy; ''touman'' is not capitalized unless at the start of a sentence or table cell. + * Clan commands are always capitalized, such as with Point, Star, Nova, Trinary, Supernova, Cluster, Galaxy, and Touman. Clans do not have an "officer" or "enlisted" corps. They have trueborn and freeborn, and every rank is a regimented form of their "Warrior Corps". These include Point Commander, Star Commander, Star Captain, Star Colonel, and Khan, which are capitalized. − ** Clans do not have an "officer" or "enlisted" corps. They have trueborn and freeborn, and every rank is a regimented form of their "Warrior Corps". These include Point Commander, Star Commander, Star Captain, Star Colonel, and Khan, which are capitalized. − − * Clan subordinate and supreme roles often use camel case: saFactor, ovKhan, ilClan. − − * Clan Trials are always capitalized: Trial of Possession, Trial of Annihilation. Words derived from these Trials are also capitalized: Clan Widowmaker was Absorbed, the Smoke Jaguars were Annihilated, the Nova Cats were Abjured. − * "Clan" should be capitalized whenever referring to the descendants of Kerensky. Clan Jade Falcon. "I am a Clan warrior." The Northwind Highlanders also use the term "clan"—in a different context—and should be capitalized only when used with a proper name: Clan McDougal. Yakuza clans are not capitalized except when used as part of a full name: the Nogachi Clan. + * "Clan" should be capitalized whenever referring to the descendants of Kerensky. Clan Jade Falcon. "I am a Clan warrior." The Northwind Highlanders also use the term "clan"—in a different context—and should be capitalized only when used with a proper name: Clan McDougal. Yakuza clans are not capitalized excepted when used as part of a full name: the Nogachi Clan. * Military commands are also capitalized: * Military commands are also capitalized: Line 79:
Line 40: : ''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 107:
Line 49: Italics have several uses. Italics have several uses. # Sparingly for emphasis. # Sparingly for emphasis. − # To indicate specific BattleMech, OmniMech, aerospace fighter, DropShip, WarShip, and JumpShip designs, such as ''Dire Wolf'', ''Avalon'', and ''Shilone''. Italics should also be used for specific names of vehicles of all types, such as ''Kerensky's Blues'' and ''Prometheus''. + # To indicate a specific BattleMech, OmniMech, aerospace fighter, DropShip, WarShip, and JumpShip designs, such as ''Dire Wolf'', ''Avalon'', and ''Shilone''. Italics should also be used for specific names of vehicles of all types, such as ''Kerensky's Blues'' and ''Prometheus''. # Non-English words, except those of Federated Suns or Lyran ranks.<ref>[[:File:Italicized ranks.png| Per Line Developer Ray Arrastia, 02Aug2022]] (screencap)</ref> # Non-English words, except those of Federated Suns or Lyran ranks.<ref>[[:File:Italicized ranks.png| Per Line Developer Ray Arrastia, 02Aug2022]] (screencap)</ref> # Titles of books. # Titles of books. Line 130:
Line 72: Sometimes ''or'' is ambiguous in another way: "Wild dogs, or dingoes, inhabit this stretch of land". Are wild dogs and dingoes the same or different? For one case write: "wild dogs (dingoes) inhabit ..." (dingoes ''are'' wild dogs); for the other case write: "either wild dogs or dingoes inhabit ..." (I don't know which). Sometimes ''or'' is ambiguous in another way: "Wild dogs, or dingoes, inhabit this stretch of land". Are wild dogs and dingoes the same or different? For one case write: "wild dogs (dingoes) inhabit ..." (dingoes ''are'' wild dogs); for the other case write: "either wild dogs or dingoes inhabit ..." (I don't know which). − − ===Apostrophes=== − Apostrophes have two main uses in English: contractions and possessives. Contractions ending in -s and possessives are easy to confuse with each other and with plural. It's not a recent development. − − ====Contractions==== − A contraction is two words joined to make another. Unlike compound words, contractions usually have sound changes and lose some letters. − * Will not → won't − * Is not → isn't − * It is, it has → it's − * Can not → can't (Cannot is also acceptable but isnot and willnot aren't) − * Am not, is not, has not, have not... → ain't (Yes, it's a word but it's not acceptable in formal language to many people. Kind of silly to get upset about it, really.) − − ====Possessives==== − Possessives show ownership - ''Bob's battle armor belongs to Bob''. − * If there's just one owner, add -'s. − ** If the word already ends with -s, it's permissible to just add an apostrophe. Whether it's proper to add -'s depends on the authority; a reasonable rule of thumb is to use whichever sounds more natural. − ** For words that end in a silent -s (''e.g.'' corps) add -'s. − * If there's more than one owner and the word ends in -s, add an apostrophe; '''never''' insert an apostrophe before the -s that's already there. − ** For plurals that don't end in -s, add -'s. ''e.g.'' Children → children's, aircraft → aircraft's, deer → deer's. (Yes, the plural of anything ending with -craft is properly just like the singular, though this is shifting.) − * Statements of quantity take an apostrophe if "worth of" is stated or implied: two years' wages, an hour's work. − * Possessive pronouns (his, hers, yours, theirs, etc.) '''never''' take an apostrophe. − * If you're not sure whether to use -'s or -s', it's often easier to use other words. ''e.g.'' Whether a Clan action is spoken of metaphorically ("the Wolf woke up") or as a group of people ("the Falcons were arrogant") can be confusing. "The Falcons attack" (kreegah!) sounds exactly the same as "the Falcon's attack" (the act of one of them slapped a wolf) and "the Falcons' attack" (the act of a group of Falcons amusing themselves at civilians' expense); writing "the Falcon attack", using an adjective that avoids the need for apostrophes, is a lot less mental work. − − ====Incorrect usage==== − Apostrophes are sometimes misused, especially for words already ending with -s, symbols, and numbers. − * Abbreviations. This was allowable at one time but is now archaic. − * Plurals. Whether word, name, symbol or number, -'s to form a plural is incorrect. − ** The Joneses, not The Jones's or The Jones'. − ** <nowiki>#</nowiki>s, not <nowiki>#'</nowiki>s. − ** 3080s, not 3080's. ===Colons=== ===Colons=== Line 209:
Line 121: ====Other dashes==== ====Other dashes==== These are avoided on Sarna, notably the double-hyphen (--). These are avoided on Sarna, notably the double-hyphen (--). − − ===Diacritics=== − Diacritics, also called ''diacritical marks'' and ''accents'', are modifiers added to letters to indicate a change in sound, indicate stress or tone, sometimes even create new letters. American English often omits these markers even when writing foreign languages but it is allowable to use them. − * Always use diacritics if they are part of a canon spelling: ''Warrior: Coupé'', JàrnFòlk, ''Araña'' MilitiaMech, Escorpión Imperio. Sometimes canon spellings ignore modern rules: Reneé Mazner rather than Renée, Chasseurs á Cheval rather than Chasseurs à Cheval. − * For some reason, CGL products sometimes switch grave (‘) and acute (’) accents inconsistently: Josè Estevez rather than José, Chasseurs à Cheval rather than Chasseurs á Cheval. Sometimes this is canon, sometimes an editing error specific to a product or even a single page. ===Hyphens=== ===Hyphens=== Line 220:
Line 127: # To link certain '''prefixes''' with their main word (''non-linear'', ''sub-section'', ''super-achiever''): # To link certain '''prefixes''' with their main word (''non-linear'', ''sub-section'', ''super-achiever''): #: There is a clear trend, not yet complete, to join both elements in all varieties of English (''subsection''), particularly in North America (''nonlinear''). British English tends to hyphenate when the letters brought into contact are the same (''nonlinear'', ''subabdominal'', but ''non-negotiable'', ''sub-basement'') or are vowels (''intra-atomic'', ''pre-existing'', ''pre-industrial'', ''semi-intensive'', ''co-opt''), or where a word is uncommon (''co-proposed'', ''re-target'') or may be misread (''sub-era'', not ''subera''). North American English reflects the same factors, but tends strongly to close up without a hyphen when possible. Consult a good dictionary, and see [https://en.wikipedia.org/wiki/Wikipedia:ENGVAR WP:ENGVAR]. #: There is a clear trend, not yet complete, to join both elements in all varieties of English (''subsection''), particularly in North America (''nonlinear''). British English tends to hyphenate when the letters brought into contact are the same (''nonlinear'', ''subabdominal'', but ''non-negotiable'', ''sub-basement'') or are vowels (''intra-atomic'', ''pre-existing'', ''pre-industrial'', ''semi-intensive'', ''co-opt''), or where a word is uncommon (''co-proposed'', ''re-target'') or may be misread (''sub-era'', not ''subera''). North American English reflects the same factors, but tends strongly to close up without a hyphen when possible. Consult a good dictionary, and see [https://en.wikipedia.org/wiki/Wikipedia:ENGVAR WP:ENGVAR]. − #* Conversely, there is a recent trend to incorrectly insert a hyphen into long-established compound words (''e.g.'' over-night rather than overnight, out-come rather than outcome, re-appeared rather than reappeared); spellcheckers often won't catch this error if both parts are normally words in their own right. # To link related terms in '''compound adjectives and adverbs''': # To link related terms in '''compound adjectives and adverbs''': #* A hyphen can help with ease of reading (''face-to-face discussion'', ''hard-boiled egg''); a hyphen is particularly useful in long [[nominal group (language)|nominal groups]] where non-experts are part of the readership, such as describes the userbase of Sarna. #* A hyphen can help with ease of reading (''face-to-face discussion'', ''hard-boiled egg''); a hyphen is particularly useful in long [[nominal group (language)|nominal groups]] where non-experts are part of the readership, such as describes the userbase of Sarna. Line 235:
Line 141: |''Correct'': ||9 mm gap (entered as ''9&nbsp;mm gap'') |''Correct'': ||9 mm gap (entered as ''9&nbsp;mm gap'') |-valign=top |-valign=top − |''Incorrect'': ||9 millimeter gap + |''Incorrect'': ||9 millimetre gap |-valign=top |-valign=top − |''Correct'': ||9-millimeter gap + |''Correct'': ||9-millimetre gap |-valign=top |-valign=top |''Correct'': ||12-hour shift |''Correct'': ||12-hour shift Line 291:
Line 197: * The exclamation mark is used with restraint: it is an expression of surprise or emotion that is generally unsuited to a scholarly or encyclopedic register. * The exclamation mark is used with restraint: it is an expression of surprise or emotion that is generally unsuited to a scholarly or encyclopedic register. * Clusters of question marks, exclamation marks, or a combination of them are highly informal and inappropriate in Sarna articles. * Clusters of question marks, exclamation marks, or a combination of them are highly informal and inappropriate in Sarna articles. − − ===Plus signs=== − Plus signs should be used for mathematical operations; don't use them to form lists. Stone Lions + Jaguars + Ghost Bears, oh my that looks awful. ===Quotation marks=== ===Quotation marks=== Line 383:
Line 286: 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 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/>
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: | ||
| − | {{ | + | {{Policy}} |
| − | {{ | + | {{nutshell|Attempt as much as possible to the following English language guidelines when creating and editing '''BattleTechWiki''' articles.}} |
| − | + | This article details stylistic elements that all editors should incorporate to help present a uniform style for all BattleTechWiki articles. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Abbreviations== | ==Abbreviations== | ||
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]]). | ||
| − | |||
| − | |||
==Article titles== | ==Article titles== | ||
Article titles should be in the form of a singular noun, such as [[BattleMech]]. | Article titles should be in the form of a singular noun, such as [[BattleMech]]. | ||
| − | |||
==Boldface== | ==Boldface== | ||
| Line 56: | Line 24: | ||
:* Proper nouns (per standard grammatical rules) are capitalized; a few terms in BattleTech have become rather "common" yet remain proper names and are capitalized accordingly. Other terms are presented as mixed proper/common nouns and have mixed capitalization preferred when presented on Sarna. The following (living) list provides the preferred capitalization format for select terms: | :* Proper nouns (per standard grammatical rules) are capitalized; a few terms in BattleTech have become rather "common" yet remain proper names and are capitalized accordingly. Other terms are presented as mixed proper/common nouns and have mixed capitalization preferred when presented on Sarna. The following (living) list provides the preferred capitalization format for select terms: | ||
::* [https://discord.com/channels/845495550803705886/992054758753972234/993632542571901058 Gauss rifle] | ::* [https://discord.com/channels/845495550803705886/992054758753972234/993632542571901058 Gauss rifle] | ||
| − | :: | + | :* One notable exception to the above: Sarna capitalizes the proper name of military operations. |
| − | :: | + | :: ''Ex: [[Operation BIRD DOG]], [[Operation SAKKAKU]]'' |
| − | |||
| − | |||
* The families ruling the five [[Successor States]] should be referred to with capitals, i.e. House Davion, House Kurita, House Liao, House Marik, and House Steiner. | * The families ruling the five [[Successor States]] should be referred to with capitals, i.e. House Davion, House Kurita, House Liao, House Marik, and House Steiner. | ||
| − | * Clan commands are always capitalized, such as with Point, Star, Nova, Trinary, Supernova, Cluster, and | + | * Clan commands are always capitalized, such as with Point, Star, Nova, Trinary, Supernova, Cluster, Galaxy, and Touman. Clans do not have an "officer" or "enlisted" corps. They have trueborn and freeborn, and every rank is a regimented form of their "Warrior Corps". These include Point Commander, Star Commander, Star Captain, Star Colonel, and Khan, which are capitalized. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | * "Clan" should be capitalized whenever referring to the descendants of Kerensky. Clan Jade Falcon. "I am a Clan warrior." The Northwind Highlanders also use the term "clan"—in a different context—and should be capitalized only when used with a proper name: Clan McDougal. Yakuza clans are not capitalized | + | * "Clan" should be capitalized whenever referring to the descendants of Kerensky. Clan Jade Falcon. "I am a Clan warrior." The Northwind Highlanders also use the term "clan"—in a different context—and should be capitalized only when used with a proper name: Clan McDougal. Yakuza clans are not capitalized excepted when used as part of a full name: the Nogachi Clan. |
* Military commands are also capitalized: | * Military commands are also capitalized: | ||
| Line 79: | Line 40: | ||
: ''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 [[ | + | ''For the stylistic use of capitalization of certain BattleTech names, see the [[Policy:BattleTech_Style_Guide#BattleTech-specific_names|BattleTech-specific names]] section. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==English language== | ==English language== | ||
| Line 107: | Line 49: | ||
Italics have several uses. | Italics have several uses. | ||
# Sparingly for emphasis. | # Sparingly for emphasis. | ||
| − | # To indicate specific BattleMech, OmniMech, aerospace fighter, DropShip, WarShip, and JumpShip designs, such as ''Dire Wolf'', ''Avalon'', and ''Shilone''. Italics should also be used for specific names of vehicles of all types, such as ''Kerensky's Blues'' and ''Prometheus''. | + | # To indicate a specific BattleMech, OmniMech, aerospace fighter, DropShip, WarShip, and JumpShip designs, such as ''Dire Wolf'', ''Avalon'', and ''Shilone''. Italics should also be used for specific names of vehicles of all types, such as ''Kerensky's Blues'' and ''Prometheus''. |
# Non-English words, except those of Federated Suns or Lyran ranks.<ref>[[:File:Italicized ranks.png| Per Line Developer Ray Arrastia, 02Aug2022]] (screencap)</ref> | # Non-English words, except those of Federated Suns or Lyran ranks.<ref>[[:File:Italicized ranks.png| Per Line Developer Ray Arrastia, 02Aug2022]] (screencap)</ref> | ||
# Titles of books. | # Titles of books. | ||
| Line 130: | Line 72: | ||
Sometimes ''or'' is ambiguous in another way: "Wild dogs, or dingoes, inhabit this stretch of land". Are wild dogs and dingoes the same or different? For one case write: "wild dogs (dingoes) inhabit ..." (dingoes ''are'' wild dogs); for the other case write: "either wild dogs or dingoes inhabit ..." (I don't know which). | Sometimes ''or'' is ambiguous in another way: "Wild dogs, or dingoes, inhabit this stretch of land". Are wild dogs and dingoes the same or different? For one case write: "wild dogs (dingoes) inhabit ..." (dingoes ''are'' wild dogs); for the other case write: "either wild dogs or dingoes inhabit ..." (I don't know which). | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Colons=== | ===Colons=== | ||
| Line 209: | Line 121: | ||
====Other dashes==== | ====Other dashes==== | ||
These are avoided on Sarna, notably the double-hyphen (--). | These are avoided on Sarna, notably the double-hyphen (--). | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Hyphens=== | ===Hyphens=== | ||
| Line 220: | Line 127: | ||
# To link certain '''prefixes''' with their main word (''non-linear'', ''sub-section'', ''super-achiever''): | # To link certain '''prefixes''' with their main word (''non-linear'', ''sub-section'', ''super-achiever''): | ||
#: There is a clear trend, not yet complete, to join both elements in all varieties of English (''subsection''), particularly in North America (''nonlinear''). British English tends to hyphenate when the letters brought into contact are the same (''nonlinear'', ''subabdominal'', but ''non-negotiable'', ''sub-basement'') or are vowels (''intra-atomic'', ''pre-existing'', ''pre-industrial'', ''semi-intensive'', ''co-opt''), or where a word is uncommon (''co-proposed'', ''re-target'') or may be misread (''sub-era'', not ''subera''). North American English reflects the same factors, but tends strongly to close up without a hyphen when possible. Consult a good dictionary, and see [https://en.wikipedia.org/wiki/Wikipedia:ENGVAR WP:ENGVAR]. | #: There is a clear trend, not yet complete, to join both elements in all varieties of English (''subsection''), particularly in North America (''nonlinear''). British English tends to hyphenate when the letters brought into contact are the same (''nonlinear'', ''subabdominal'', but ''non-negotiable'', ''sub-basement'') or are vowels (''intra-atomic'', ''pre-existing'', ''pre-industrial'', ''semi-intensive'', ''co-opt''), or where a word is uncommon (''co-proposed'', ''re-target'') or may be misread (''sub-era'', not ''subera''). North American English reflects the same factors, but tends strongly to close up without a hyphen when possible. Consult a good dictionary, and see [https://en.wikipedia.org/wiki/Wikipedia:ENGVAR WP:ENGVAR]. | ||
| − | |||
# To link related terms in '''compound adjectives and adverbs''': | # To link related terms in '''compound adjectives and adverbs''': | ||
#* A hyphen can help with ease of reading (''face-to-face discussion'', ''hard-boiled egg''); a hyphen is particularly useful in long [[nominal group (language)|nominal groups]] where non-experts are part of the readership, such as describes the userbase of Sarna. | #* A hyphen can help with ease of reading (''face-to-face discussion'', ''hard-boiled egg''); a hyphen is particularly useful in long [[nominal group (language)|nominal groups]] where non-experts are part of the readership, such as describes the userbase of Sarna. | ||
| Line 235: | Line 141: | ||
|''Correct'': ||9 mm gap (entered as ''9&nbsp;mm gap'') | |''Correct'': ||9 mm gap (entered as ''9&nbsp;mm gap'') | ||
|-valign=top | |-valign=top | ||
| − | |''Incorrect'': ||9 | + | |''Incorrect'': ||9 millimetre gap |
|-valign=top | |-valign=top | ||
| − | |''Correct'': ||9- | + | |''Correct'': ||9-millimetre gap |
|-valign=top | |-valign=top | ||
|''Correct'': ||12-hour shift | |''Correct'': ||12-hour shift | ||
| Line 291: | Line 197: | ||
* The exclamation mark is used with restraint: it is an expression of surprise or emotion that is generally unsuited to a scholarly or encyclopedic register. | * The exclamation mark is used with restraint: it is an expression of surprise or emotion that is generally unsuited to a scholarly or encyclopedic register. | ||
* Clusters of question marks, exclamation marks, or a combination of them are highly informal and inappropriate in Sarna articles. | * Clusters of question marks, exclamation marks, or a combination of them are highly informal and inappropriate in Sarna articles. | ||
| − | |||
| − | |||
| − | |||
===Quotation marks=== | ===Quotation marks=== | ||
| Line 383: | Line 286: | ||
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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==References== | ==References== | ||
<references/> | <references/> | ||