Changes between Version 78 and Version 79 of EnglishStyleGuide


Ignore:
Timestamp:
Aug 16, 2020, 2:02:05 PM (4 years ago)
Author:
Nescio
Comment:

indentation

Legend:

Unmodified
Added
Removed
Modified
  • EnglishStyleGuide

    v78 v79  
    3434||practice (noun and verb)         ||practice (noun), practise (verb) ||practice (noun), practise (verb) ||
    3535
    36 * The -ize/-ise, -izer/-iser, and -ization/-isation differences only apply to words where the ending is not part of the root. Some words always end in -ise in all varieties of English. These are: advertise, advise, apprise, arise, chastise, circumcise, comprise, compromise, demise, despise, devise, disguise, enterprise, excise, exercise, franchise, guise, improvise, incise, merchandise, mortise, premise, reprise, revise, supervise, surmise, surprise, televise, as well as all words ending in -wise.
    37 * Likewise, there are a number of words that always end in -ize in all varieties of English. These include: assize, baize, capsize, downsize, maize, prize, resize, seize, size.
    38 * Check what you type: e.g. the verb to pron''ou''nce is always spelled with ''ou'', but the noun pron''u''nciation is spelled with only ''u''.
    39 * If unsure about the correct spelling, consult a dictionary, e.g. https://www.lexico.com/
    40 * Oxford spelling is used by many international organizations (e.g. ISO, NATO, UN, WTO, WWF) and some academic publications (notably Oxford University Press and Cambridge University Press, whilst the University of Oxford and the University of Cambridge use British spelling).
     36 * Oxford spelling is used by many international organizations (e.g. ISO, NATO, UN, WTO, WWF) and some academic publications (notably Oxford University Press and Cambridge University Press, whilst the University of Oxford and the University of Cambridge use British spelling).
     37 * The -ize/-ise, -izer/-iser, and -ization/-isation differences only apply to words where the ending is not part of the root.
     38   * Some words always end in -ise in all varieties of English. These are: advertise, advise, apprise, arise, chastise, circumcise, comprise, compromise, demise, despise, devise, disguise, enterprise, excise, exercise, franchise, guise, improvise, incise, merchandise, mortise, premise, reprise, revise, supervise, surmise, surprise, televise, as well as all words ending in -wise.
     39   * Likewise, there are a number of words that always end in -ize in all varieties of English. These include: assize, baize, capsize, downsize, maize, prize, resize, seize, size.
     40 * Check what you type: e.g. the verb to pron''ou''nce is always spelled with ''ou'', but the noun pron''u''nciation is spelled with only ''u''.
     41 * If unsure about the correct spelling, consult a dictionary, e.g. https://www.lexico.com/
    4142
    4243=== Calender years
     
    178179||``                                   ||||                                  ||||                                      ||
    179180
    180 Notes:[[br]]
     181Notes:
     182
    181183¹ The meaning in code is reserved from the display text. For example, if code says `RepeatTime value × 0.5` (subtract 50%) then the speed will be twice as fast, which should be displayed as +100% (value ÷ 0.5).
    182184
     
    224226Auras are JSON files located inside `simulation/data/auras/`. Auras are temporary, their effects disappear when the aura entity is lost.
    225227The shared format for the `auraDescription` is: **"[player] [class] [change] [attributes] [requirements]"**:
    226 * **[player]**: if and only if an `affectedPlayers` entry is specified; by default auras affect only their own player. Other options are ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/components/Player.js Player.js]):
    227   * `Ally`: player is our ally → Allied and Own
    228   * `ExclusiveAlly`: player is our ally excluding ourself → Allied
    229   * `MutualAlly`: player is our ally, and we are its ally → Allied and Own
    230   * `ExclusiveMutualAlly`: player is our ally, and we are its ally, excluding ourself → Allied
    231   * `Enemy`: player is our enemy → Enemy
    232 * **[class]**: the affected class(es), e.g.:
    233   * `"Citizen Infantry"` → Citizen Infantry
    234   * `"Siege", "Structure"` → Structures and Siege Engines
    235 * **[change]**: the actual modifications, e.g.:
    236   * `"replace": 0` → have 0
    237   * `"multiply": 1.1` → +10%
    238   * `"multiply": 0.85` → −15%
    239   * `"add": 1` → +1
    240   * `"add": -25` → −25
    241 * **[attributes]**: the modified stats; see [[EnglishStyleGuide#Stats | above]]
    242 * **[requirements]**: if and only if a `requiredTechnology` is set; specifies the `genericName` of the required technology; e.g.:
    243   * `"pop_wonder"` → (requires the “Glorious Expansion” technology)
     228 * **[player]**: if and only if an `affectedPlayers` entry is specified; by default auras affect only their own player. Other options are ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/components/Player.js Player.js]):
     229   * `Ally`: player is our ally → Allied and Own
     230   * `ExclusiveAlly`: player is our ally excluding ourself → Allied
     231   * `MutualAlly`: player is our ally, and we are its ally → Allied and Own
     232   * `ExclusiveMutualAlly`: player is our ally, and we are its ally, excluding ourself → Allied
     233   * `Enemy`: player is our enemy → Enemy
     234 * **[class]**: the affected class(es), e.g.:
     235   * `"Citizen Infantry"` → Citizen Infantry
     236   * `"Siege", "Structure"` → Structures and Siege Engines
     237 * **[change]**: the actual modifications, e.g.:
     238   * `"replace": 0` → have 0
     239   * `"multiply": 1.1` → +10%
     240   * `"multiply": 0.85` → −15%
     241   * `"add": 1` → +1
     242   * `"add": -25` → −25
     243 * **[attributes]**: the modified stats; see [[EnglishStyleGuide#Stats | above]]
     244 * **[requirements]**: if and only if a `requiredTechnology` is set; specifies the `genericName` of the required technology; e.g.:
     245   * `"pop_wonder"` → (requires the “Glorious Expansion” technology)
    244246 
    245247The exact format depends on the aura `type` (see [https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/components/Auras.js Auras.js]):
     
    253255=== Technologies
    254256Technologies are JSON files located inside `simulation/data/technologies/`. All technologies are global and irreversible. Please follow the **"[player] [class] [change] [attributes]"** format (see auras [[EnglishStyleGuide#Auras | above]], without [requirements]), e.g.:
    255 * `"tooltip": "Siege Engines +2 hack armor.",` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/technologies/siege_armor.json siege armor])
     257 * `"tooltip": "Siege Engines +2 hack armor.",` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/technologies/siege_armor.json siege armor])
    256258
    257259=== Templates
    258260Entity templates are XML files located inside `simulation/templates/`. They can have a <Tooltip> string inside the <Identity> node, to summarize what makes them unique. Be brief and precise. A few examples:
    259 * Resource supplier: `<Tooltip>Catch fish for food.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_gaia_fish.xml fish])
    260 * Structures: `<Tooltip>Construct Siege Engines and research Siege Engine technologies.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_structure_military_workshop.xml workshop])
    261 * Units: `<Tooltip>Garrison units for transport and to increase firepower.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_unit_siege_tower.xml siege tower])
     261 * Resource supplier: `<Tooltip>Catch fish for food.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_gaia_fish.xml fish])
     262 * Structures: `<Tooltip>Construct Siege Engines and research Siege Engine technologies.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_structure_military_workshop.xml workshop])
     263 * Units: `<Tooltip>Garrison units for transport and to increase firepower.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_unit_siege_tower.xml siege tower])
    262264
    263265
     
    266268=== Capitalization
    267269Use [https://en.wikipedia.org/wiki/Letter_case#Title_case title case] for:
    268 * button captions
    269 * entity classes
    270 * entity and technology names (generic and specific names)
    271 * key names
    272 * proper names
     270 * button captions;
     271 * entity classes;
     272 * entity and technology names (generic and specific names);
     273 * key names;
     274 * proper names.
    273275
    274276Never use full capitalization.
     
    280282
    281283=== Punctuation and spacing
    282 * A serial comma is used when listing three or more items. E.g. “Available to Britons, Gauls, and Iberians.” or “Capture, Melee, or Ranged.” and not “Britons, Gauls and Iberians.” or “Capture, Melee or Ranged.”
    283 * Only use one space, not two, after a full stop to end a sentence.
    284 * Do not use spaces before “large” characters (e.g. ?, !, :, %).
    285 * There are three options for parenthetical remarks:
    286   * parentheses (which have spaces on the outside, but not on the inside) are preferred;
    287   * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better;
    288   * em-dashes—which have spaces neither inside nor outside—are better avoided.
    289 * Use “English-style” quotation marks, not « French-style » or „German-style“ (nor the other »German-style«).
    290 * Please read the articles listed at https://www.lexico.com/grammar/punctuation
     284 * A serial comma is used when listing three or more items. E.g. “Available to Britons, Gauls, and Iberians.” or “Capture, Melee, or Ranged.” and not “Britons, Gauls and Iberians.” or “Capture, Melee or Ranged.”
     285 * Only use one space, not two, after a full stop to end a sentence.
     286 * Do not use spaces before “large” characters (e.g. ?, !, :, %).
     287 * There are three options for parenthetical remarks:
     288   * parentheses (which have spaces on the outside, but not on the inside) are preferred;
     289   * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better;
     290   * em-dashes—which have spaces neither inside nor outside—are better avoided.
     291 * Use “English-style” quotation marks, not « French-style » or „German-style“ (nor the other »German-style«).
     292 * Please read the articles listed at https://www.lexico.com/grammar/punctuation
    291293
    292294
     
    309311
    310312== External links
    311 
    312 * [https://ec.europa.eu/info/sites/info/files/styleguide_english_dgt_en.pdf European Union English style guide (pdf)]
    313 * https://www.transifex.com/wildfire-games/0ad/
     313 * [https://ec.europa.eu/info/sites/info/files/styleguide_english_dgt_en.pdf European Union English style guide (pdf)]
     314 * https://www.transifex.com/wildfire-games/0ad/