Changes between Version 99 and Version 100 of EnglishStyleGuide


Ignore:
Timestamp:
Feb 23, 2021, 6:18:01 PM (3 years ago)
Author:
Langbart
Comment:

behaviour

Legend:

Unmodified
Added
Removed
Modified

  • EnglishStyleGuide

    v99 v100  
    1 [[TOC]]
    2 ''For specific (i.e. non-English) name strings, see wiki:SpecificNames.''
    3 ''For translations into other languages, see [wiki:Localization#AdditionalInstructionsforLanguageTeams wiki:Localization].''
     1[[TOC]] ''For specific (i.e. non-English) name strings, see wiki:SpecificNames.'' ''For translations into other languages, see [wiki:Localization#AdditionalInstructionsforLanguageTeams wiki:Localization].''
    42
    53This guide provides some ground rules to write user-facing texts for '''0 A.D.'''
    64
    7 
    8 == Orthography
    9 === Common mistakes
     5== Orthography ==
     6=== Common mistakes ===
    107Always check what you type!
    11 * There is only one ''t'' in ''eighteen''.
    12 * While ''four'' and ''fourteen'' are written with ''ou'', there is no ''u'' in ''forty'', only an ''o''.
    13 * The verbs to ''an-'', ''de-'', and ''pronounce'' are always spelled with ''ou'', as are the nouns ''an-'', ''de-'', and ''pronouncement'', whereas the nouns ''an-'', ''de-'', and ''pronunciation'' are spelled with only ''u''.
    14 * Although the word ''full'' ends with double ''ll'', adjectives ending in ''[https://www.lexico.com/definition/-ful -ful]'' (e.g. ''forgetful'', ''resourceful'', ''useful'') have only one final ''l''.
    15 * Words such as ''developer'' and ''exceptional'' are written with one ''p'' or ''n'', respectively (unlike in French).
    16 * The verbs ''[https://www.lexico.com/definition/loose loose]'' and ''[https://www.lexico.com/definition/lose lose]'' have very different meanings.
     8
     9 * There is only one ''t'' in ''eighteen''.
     10 * While ''four'' and ''fourteen'' are written with ''ou'', there is no ''u'' in ''forty'', only an ''o''.
     11 * The verbs to ''an-'', ''de-'', and ''pronounce'' are always spelled with ''ou'', as are the nouns ''an-'', ''de-'', and ''pronouncement'', whereas the nouns ''an-'', ''de-'', and ''pronunciation'' are spelled with only ''u''.
     12 * Although the word ''full'' ends with double ''ll'', adjectives ending in ''[https://www.lexico.com/definition/-ful -ful]'' (e.g. ''forgetful'', ''resourceful'', ''useful'') have only one final ''l''.
     13 * Words such as ''developer'' and ''exceptional'' are written with one ''p'' or ''n'', respectively (unlike in French).
     14 * The verbs ''[https://www.lexico.com/definition/loose loose]'' and ''[https://www.lexico.com/definition/lose lose]'' have very different meanings.
     15
    1716See also https://www.lexico.com/grammar/common-misspellings
    1817
    19 === English spelling
     18=== English spelling ===
    2019Use American English spelling.
    2120
    22 ||='''American'''                     =||='''Oxford'''                       =||='''British'''                      =||
    23 ||advice (noun)\\advise (verb)     ||advice (noun)\\advise (verb)     ||advice (noun)\\advise (verb)    ||
    24 ||license (noun and verb)              ||licence (noun)\\license (verb)   ||licence (noun and verb)              ||
    25 ||practice (noun and verb)             ||practice (noun)\\practise (verb) ||practice (noun)\\practise (verb) ||
    26 ||='''American''' =||='''Oxford'''   =||='''British''' =||
    27 ||analysis         ||analysis         ||analysis        ||
     21||='''American''' =||='''Oxford''' =||='''British''' =||
     22||advice (noun)\\advise (verb) ||advice (noun)\\advise (verb) ||advice (noun)\\advise (verb) ||
     23||license (noun and verb) ||licence (noun)\\license (verb) ||licence (noun and verb) ||
     24||practice (noun and verb) ||practice (noun)\\practise (verb) ||practice (noun)\\practise (verb) ||
     25||='''American''' =||='''Oxford''' =||='''British''' =||
     26||analysis ||analysis ||analysis ||
    2827||analyze\\analyzing\\analyzable ||analyse\\analysing\\analysable ||analyse\\analysing\\analysable ||
    29 ||archeology       ||archaeology      ||archaeology      ||
    30 ||artifact         ||artefact         ||artefact         ||
    31 ||center           ||centre           ||centre           ||
    32 ||civilization *   ||civilization *   ||civilisation *   ||
    33 ||color            ||colour           ||colour           ||
    34 ||defense          ||defence          ||defence          ||
    35 ||dialog           ||dialogue         ||dialogue         ||
    36 ||enroll           ||enrol            ||enrol            ||
    37 ||fertilizer *     ||fertilizer *     ||fertiliser *     ||
    38 ||gray             ||grey             ||grey             ||
    39 ||itemize *        ||itemize *        ||itemise *        ||
    40 ||jailor           ||jailer           ||gaoler           ||
    41 ||maneuver         ||manoeuvre        ||manoeuvre        ||
    42 ||northeast(ern)   ||north-east(ern)  ||north-east(ern)  ||
    43 ||plow             ||plough           ||plough           ||
    44 ||setup (noun)\\set up (verb)  ||set-up (noun)\\set up (verb) ||set-up (noun)\\set up (verb) ||
    45 ||skeptic          ||sceptic          ||sceptic          ||
    46 ||traveled\\traveling\\traveler    ||travelled\\travelling\\traveller ||travelled\\travelling\\traveller ||
    47 ||='''American''' =||=               =||='''British'''  =||
    48 ||corn             ||                 ||maize            ||
    49 ||counterclockwise ||                 ||anticlockwise    ||
    50 ||eggplant         ||                 ||aubergine        ||
    51 ||fall             ||                 ||autumn           ||
    52 ||sidewalk         ||                 ||pavement         ||
    53 ||zucchini         ||                 ||courgette        ||
     28||archeology ||archaeology ||archaeology ||
     29||artifact ||artefact ||artefact ||
     30|| behavior || behaviour || behaviour ||
     31||center ||centre ||centre ||
     32||civilization * ||civilization * ||civilisation * ||
     33||color ||colour ||colour ||
     34||defense ||defence ||defence ||
     35||dialog ||dialogue ||dialogue ||
     36||enroll ||enrol ||enrol ||
     37||fertilizer * ||fertilizer * ||fertiliser * ||
     38||gray ||grey ||grey ||
     39||itemize * ||itemize * ||itemise * ||
     40||jailor ||jailer ||gaoler ||
     41||maneuver ||manoeuvre ||manoeuvre ||
     42||northeast(ern) ||north-east(ern) ||north-east(ern) ||
     43||plow ||plough ||plough ||
     44||setup (noun)\\set up (verb) ||set-up (noun)\\set up (verb) ||set-up (noun)\\set up (verb) ||
     45||skeptic ||sceptic ||sceptic ||
     46||traveled\\traveling\\traveler ||travelled\\travelling\\traveller ||travelled\\travelling\\traveller ||
     47||='''American''' =||= =||='''British''' =||
     48||corn || ||maize ||
     49||counterclockwise || ||anticlockwise ||
     50||eggplant || ||aubergine ||
     51||fall || ||autumn ||
     52||sidewalk || ||pavement ||
     53||zucchini || ||courgette ||
    5454
    5555 * 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, whereas the University of Oxford and the University of Cambridge use British spelling).
    56  * The -ize/-ise, -izer/-iser, and -ization/-isation differences only apply to words where the ending is not part of the root. 
     56 * The -ize/-ise, -izer/-iser, and -ization/-isation differences only apply to words where the ending is not part of the root.
    5757   * 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.
    5858   * 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.
    5959 * If unsure about the correct spelling, consult a dictionary, e.g. https://www.lexico.com/
    6060
    61 === Calender years
    62 The name of the game is '''0 A.D.''', which includes dots, for stylistic reasons.
    63 However, dots are not used when writing down years. E.g. Augustus was emperor of Rome from 27 BC until AD 14.
    64 
    65 ||='''good''' =||='''bad'''       =||
    66 ||BC           ||B.C., BCE, B.C.E. ||
    67 ||AD           ||A.D., CE, C.E.    ||
     61=== Calender years ===
     62The name of the game is '''0 A.D.''', which includes dots, for stylistic reasons. However, dots are not used when writing down years. E.g. Augustus was emperor of Rome from 27 BC until AD 14.
     63
     64||='''good''' =||='''bad''' =||
     65||BC ||B.C., BCE, B.C.E. ||
     66||AD ||A.D., CE, C.E. ||
    6867
    6968Also check there is always a single space between the year and BC/AD.
    7069
    71 === Dynastic factions
    72 
    73 ||='''singular:'''     =||='''plural:'''       =||='''adjective:'''      =||
    74 ||''founder of dynasty''||''members of dynasty''||''belonging to dynasty''||
    75 ||Achaemenes            ||Achaemenids           ||Achaemenid              ||
    76 ||Maurya                ||Mauryas               ||Mauryan                 ||
    77 ||Ptolemy               ||Ptolemies             ||Ptolemaic               ||
    78 ||Seleucus              ||Seleucids             ||Seleucid                ||
    79 
    80 
    81 === Greek and Latin
    82 Greek words and proper names are Latinized everywhere, except in the specific name.
    83 
    84 ||='''Latinized'''   =||='''Greek'''                         =||
    85 ||Aeschylus           ||Aiskhulos                             ||
    86 ||Darius              ||Dareios                               ||
    87 ||Plato               ||Platōn                                ||
    88 ||Seleucus I          ||Seleukos A'                           ||
    89 ||Thucydides          ||Thoukudidēs                           ||
     70=== Dynastic factions ===
     71||='''singular:''' =||='''plural:''' =||='''adjective:''' =||
     72|| ''founder of dynasty'' || ''members of dynasty'' || ''belonging to dynasty'' ||
     73||Achaemenes ||Achaemenids ||Achaemenid ||
     74||Maurya ||Mauryas ||Mauryan ||
     75||Ptolemy ||Ptolemies ||Ptolemaic ||
     76||Seleucus ||Seleucids ||Seleucid ||
     77
     78=== Greek and Latin ===
     79Greek words and proper names are Latinized everywhere, except in the specific name.
     80
     81||='''Latinized''' =||='''Greek''' =||
     82||Aeschylus ||Aiskhulos ||
     83||Darius ||Dareios ||
     84||Plato ||Platōn ||
     85||Seleucus I ||Seleukos A' ||
     86||Thucydides ||Thoukudidēs ||
    9087
    9188Also, use the English form if there is one.
    9289
    93 ||='''English'''     =||='''Latin'''    =||='''Greek'''      =||
     90||='''English''' =||='''Latin''' =||='''Greek''' =||
    9491||Alexander the Great ||Alexander Magnus ||Alexandros ho Megas ||
    95 ||Aristotle           ||Aristoteles      ||Aristotelēs         ||
    96 ||Athens              ||Athenae          ||Athēnai             ||
    97 ||Homer               ||Homerus          ||Homēros             ||
    98 ||Livy                ||Livius           ||                    ||
    99 ||Mark Antony         ||Marcus Antonius  ||                    ||
    100 ||Ovid                ||Ovidius          ||                    ||
    101 ||Plutarch            ||Plutarchus       ||Ploutarchos         ||
    102 ||Ptolemy             ||Ptolemaeus       ||Ptolemaios          ||
    103 ||Syracuse            ||Syracusae        ||Surakousai          ||
    104 ||Virgil              ||Vergilius        ||                    ||
    105 ||='''English'''     =||='''Latin'''    =||='''Greek'''       =||
    106 ||Cataphract          ||                 ||Kataphraktos        ||
    107 ||Hoplite             ||                 ||Hoplitēs            ||
    108 ||Legionary           ||Legionarius      ||                    ||
    109 ||Penteconter         ||                 ||Pentēkontoros       ||
    110 ||Quadrireme          ||Quadriremis      ||Tetrērēs            ||
    111 ||Quinquereme         ||Quinqueremis     ||Pentērēs            ||
    112 ||Theatre             ||Theatrum         ||Theatron            ||
    113 ||Trireme             ||Triremis         ||Triērēs             ||
    114 
    115 
    116 == Terminology
    117 In texts that the user needs to understand, such as menu entries, help
    118 tooltips, and similar, you must be consistent with the vocabulary that you use.
    119 
    120 An object should always be referred to using the same word everywhere in the
    121 game, and an action should always be referred to using the same verb.
    122 For example, if there is a unit type called ‘Female Citizen’, always refer to it
    123 as such, do not also use alternative forms such as ‘females’, ‘women’, and so
    124 on. Even in the same paragraph or sentence, you should use the same term.
     92||Aristotle ||Aristoteles ||Aristotelēs ||
     93||Athens ||Athenae ||Athēnai ||
     94||Homer ||Homerus ||Homēros ||
     95||Livy ||Livius || ||
     96||Mark Antony ||Marcus Antonius || ||
     97||Ovid ||Ovidius || ||
     98||Plutarch ||Plutarchus ||Ploutarchos ||
     99||Ptolemy ||Ptolemaeus ||Ptolemaios ||
     100||Syracuse ||Syracusae ||Surakousai ||
     101||Virgil ||Vergilius || ||
     102||='''English''' =||='''Latin''' =||='''Greek''' =||
     103||Cataphract || ||Kataphraktos ||
     104||Hoplite || ||Hoplitēs ||
     105||Legionary ||Legionarius || ||
     106||Penteconter || ||Pentēkontoros ||
     107||Quadrireme ||Quadriremis ||Tetrērēs ||
     108||Quinquereme ||Quinqueremis ||Pentērēs ||
     109||Theatre ||Theatrum ||Theatron ||
     110||Trireme ||Triremis ||Triērēs ||
     111
     112== Terminology ==
     113In texts that the user needs to understand, such as menu entries, help tooltips, and similar, you must be consistent with the vocabulary that you use.
     114
     115An object should always be referred to using the same word everywhere in the game, and an action should always be referred to using the same verb. For example, if there is a unit type called ‘Female Citizen’, always refer to it as such, do not also use alternative forms such as ‘females’, ‘women’, and so on. Even in the same paragraph or sentence, you should use the same term.
    125116
    126117Always be precise. E.g. if a technology multiplies the melee attack damage of cavalry by 1.2, the tooltip should be “Cavalry +20% melee attack damage”, not “Melee Cavalry +20% attack damage”.
    … …  
    130121For specific words that you should use or avoid in 0 A.D. gameplay texts, see the tables below.
    131122
    132 
    133 === Actions
    134 
    135 ||='''good'''                     =||='''bad'''                        =||
    136 ||build (structures)               ||construct, make                    ||
    137 ||collect (treasures)              ||gather                             ||
    138 ||construct (ships, siege weapons) ||build, produce, train              ||
    139 ||gather (resources)               ||collect, get                       ||
    140 ||research (technologies)          ||                                   ||
    141 ||train (human units)              ||build, construct, recruit, produce ||
    142 
    143 
    144 === Cursor vs Mouse
     123=== Actions ===
     124||='''good''' =||='''bad''' =||
     125||build (structures) ||construct, make ||
     126||collect (treasures) ||gather ||
     127||construct (ships, siege weapons) ||build, produce, train ||
     128||gather (resources) ||collect, get ||
     129||research (technologies) || ||
     130||train (human units) ||build, construct, recruit, produce ||
     131
     132=== Cursor vs Mouse ===
    145133Mind the difference between the cursor (virtual) and the mouse (physical).
    146134
    147 
    148 === GUI
    149 
    150 ||='''good''' =||='''bad'''                                 =||
    151 ||icon         ||image, picture, portrait, sprite, thumbnail ||
    152 ||window       ||dialog(ue)                                  ||
    153 
    154 
    155 === Stats
    156 
    157 ||='''code'''                         =||||='''good'''                      =||||='''bad'''                           =||
    158 ||`Attack/Capture/Capture`             ||||capture attack strength           ||||capture rate, capture value            ||
    159 ||`Attack/Capture/MaxRange`            ||||capture attack range              ||||capture range                         ||
    160 ||`Attack/Capture/RepeatTime`          ||||capture attack speed¹             ||||capture rate, capture time            ||
    161 ||`Attack/Melee/Damage/Crush`          ||||melee attack crush damage         ||||crush, crush attack, crush strength   ||
    162 ||`Attack/Melee/MaxRange`              ||||attack range                      ||||range, melee range                    ||
    163 ||`Attack/Melee/RepeatTime`            ||||melee attack speed¹               ||||melee attack repeat time              ||
    164 ||`Attack/Ranged/ElevationBonus`       ||||elevation bonus                   ||||                                      ||
    165 ||`Attack/Ranged/MinRange`             ||||minimum attack range              ||||min attack range, minimum range       ||
    166 ||`Attack/Ranged/RepeatTime`           ||||ranged attack speed¹              ||||ranged attack repeat time             ||
    167 ||`Builder/Rate`                       ||||build rate                        ||||builder rate, building rate           ||
    168 ||`Capturable/CapturePoints`           ||||capture points                    ||||                                      ||
    169 ||`Cost/BuildTime` ||''structures''\\''ships, siege''\\''animals''\\''other units''||build time\\construction time\\breeding time\\training time||||building time, production time, recruitment time||
    170 ||`Cost/Population`                    ||||population cost                   ||||                                      ||
    171 ||`Cost/PopulationBonus`               ||||population bonus                  ||||                                      ||
    172 ||`Cost/Resources/food`                ||||food cost                         ||||                                      ||
    173 ||`Cost/Resources/wood`                ||||wood cost                         ||||timber cost                           ||
    174 ||`Cost/Resources/stone`               ||||stone cost                        ||||                                      ||
    175 ||`Cost/Resources/metal`               ||||metal cost                        ||||iron cost                             ||
    176 ||`GarrisonHolder/BuffHeal`            ||||garrison heal rate                ||||                                      || 
    177 ||`GarrisonHolder/Max`                 ||||garrison capacity                 ||||                                      || 
    178 ||`Heal/Health`                        ||||healing strength                  ||||HP, heal value                        ||
    179 ||`Heal/Range`                         ||||healing range                     ||||heal range                            ||
    180 ||`Heal/Rate`                          ||||healing time                      ||||heal rate, healing speed              ||
    181 ||`Health/IdleRegenRate`               ||idle||health regeneration rate      ||||regeneration, regen rate, regen speed ||
    182 ||`Health/Max`                         ||||health                            ||||health points, hitpoints, HP          ||
    183 ||`Health/RegenRate`                   ||||health regeneration rate          ||||regeneration, regen rate, regen speed ||
    184 ||`Loot/xp`                            ||grant||experience loot              ||||                                      ||
    185 ||`Looter/xp`                          ||gain||experience loot               ||||                                      ||
    186 ||`ProductionQueue/TechCostMultiplier/food`||technologies require||food      ||||                                      ||
    187 ||`Promotion/RequiredXp`               ||||promotion experience              ||||                                      ||
    188 ||`ResourceGatherer/BaseSpeed`         ||||gather speed                      ||||gather rate, work speed               ||
    189 ||`ResourceGatherer/Capacities/food`   ||||food capacity                     ||||carry capacity, foot load             ||
    190 ||`ResourceGatherer/MaxDistance`       ||||gather distance                   ||||                                      ||
    191 ||`ResourceGatherer/Rates/food.fish`   ||||fish gather rate                  ||||                                      ||
    192 ||`ResourceGatherer/Rates/food.fruit`  ||||fruit gather rate                 ||||                                      ||
    193 ||`ResourceGatherer/Rates/food.grain`  ||||grain gather rate                 ||||                                      ||
    194 ||`ResourceGatherer/Rates/food.meat`   ||||meat gather rate                  ||||                                      ||
    195 ||`ResourceGatherer/Rates/metal.ore`   ||||metal gather rate                 ||||                                      ||
    196 ||`ResourceGatherer/Rates/metal.ruins` ||||                                  ||||                                      ||
    197 ||`ResourceGatherer/Rates/stone.rock`  ||||stone gather rate                 ||||                                      ||
    198 ||`ResourceGatherer/Rates/stone.ruins` ||||                                  ||||                                      ||
    199 ||`ResourceGatherer/Rates/treasure`    ||||                                  ||||                                      ||
    200 ||`ResourceGatherer/Rates/wood.rock`   ||||wood gather rate                  ||||                                      ||
    201 ||`ResourceGatherer/Rates/wood.ruins`  ||||                                  ||||                                      ||
    202 ||`ResourceTrickle/Interval`           ||||resource trickle time             ||||                                      ||
    203 ||`ResourceTrickle/Rates/food`         ||||food trickle rate                 ||||                                      ||
    204 ||`UnitMotion/WalkSpeed`               ||||movement speed                    ||||speed, velocity, walk speed          ||
    205 ||`Vision/Range`                       ||||vision range                      ||||line of sight, LOS, vision            ||
    206 ||``                                   ||||                                  ||||                                      ||
     135=== GUI ===
     136||='''good''' =||='''bad''' =||
     137||icon ||image, picture, portrait, sprite, thumbnail ||
     138||window ||dialog(ue) ||
     139
     140=== Stats ===
     141||='''code''' =||||='''good''' =||||='''bad''' =||
     142||`Attack/Capture/Capture` ||||capture attack strength ||||capture rate, capture value ||
     143||`Attack/Capture/MaxRange` ||||capture attack range ||||capture range ||
     144||`Attack/Capture/RepeatTime` ||||capture attack speed¹ ||||capture rate, capture time ||
     145||`Attack/Melee/Damage/Crush` ||||melee attack crush damage ||||crush, crush attack, crush strength ||
     146||`Attack/Melee/MaxRange` ||||attack range ||||range, melee range ||
     147||`Attack/Melee/RepeatTime` ||||melee attack speed¹ ||||melee attack repeat time ||
     148||`Attack/Ranged/ElevationBonus` ||||elevation bonus |||| ||
     149||`Attack/Ranged/MinRange` ||||minimum attack range ||||min attack range, minimum range ||
     150||`Attack/Ranged/RepeatTime` ||||ranged attack speed¹ ||||ranged attack repeat time ||
     151||`Builder/Rate` ||||build rate ||||builder rate, building rate ||
     152||`Capturable/CapturePoints` ||||capture points |||| ||
     153||`Cost/BuildTime` || ''structures''\\''ships, siege''\\''animals''\\''other units'' || build time\\construction time\\breeding time\\training time |||| building time, production time, recruitment time ||
     154||`Cost/Population` ||||population cost |||| ||
     155||`Cost/PopulationBonus` ||||population bonus |||| ||
     156||`Cost/Resources/food` ||||food cost |||| ||
     157||`Cost/Resources/wood` ||||wood cost ||||timber cost ||
     158||`Cost/Resources/stone` ||||stone cost |||| ||
     159||`Cost/Resources/metal` ||||metal cost ||||iron cost ||
     160||`GarrisonHolder/BuffHeal` ||||garrison heal rate |||| ||
     161||`GarrisonHolder/Max` ||||garrison capacity |||| ||
     162||`Heal/Health` ||||healing strength ||||HP, heal value ||
     163||`Heal/Range` ||||healing range ||||heal range ||
     164||`Heal/Rate` ||||healing time ||||heal rate, healing speed ||
     165||`Health/IdleRegenRate` || idle ||health regeneration rate ||||regeneration, regen rate, regen speed ||
     166||`Health/Max` ||||health ||||health points, hitpoints, HP ||
     167||`Health/RegenRate` ||||health regeneration rate ||||regeneration, regen rate, regen speed ||
     168||`Loot/xp` || grant ||experience loot |||| ||
     169||`Looter/xp` || gain ||experience loot |||| ||
     170|| `ProductionQueue/TechCostMultiplier/food` || technologies require ||food |||| ||
     171||`Promotion/RequiredXp` ||||promotion experience |||| ||
     172||`ResourceGatherer/BaseSpeed` ||||gather speed ||||gather rate, work speed ||
     173||`ResourceGatherer/Capacities/food` ||||food capacity ||||carry capacity, foot load ||
     174||`ResourceGatherer/MaxDistance` ||||gather distance |||| ||
     175||`ResourceGatherer/Rates/food.fish` ||||fish gather rate |||| ||
     176||`ResourceGatherer/Rates/food.fruit` ||||fruit gather rate |||| ||
     177||`ResourceGatherer/Rates/food.grain` ||||grain gather rate |||| ||
     178||`ResourceGatherer/Rates/food.meat` ||||meat gather rate |||| ||
     179||`ResourceGatherer/Rates/metal.ore` ||||metal gather rate |||| ||
     180||`ResourceGatherer/Rates/metal.ruins` |||| |||| ||
     181||`ResourceGatherer/Rates/stone.rock` ||||stone gather rate |||| ||
     182||`ResourceGatherer/Rates/stone.ruins` |||| |||| ||
     183||`ResourceGatherer/Rates/treasure` |||| |||| ||
     184||`ResourceGatherer/Rates/wood.rock` ||||wood gather rate |||| ||
     185||`ResourceGatherer/Rates/wood.ruins` |||| |||| ||
     186||`ResourceTrickle/Interval` ||||resource trickle time |||| ||
     187||`ResourceTrickle/Rates/food` ||||food trickle rate |||| ||
     188||`UnitMotion/WalkSpeed` ||||movement speed ||||speed, velocity, walk speed ||
     189||`Vision/Range` ||||vision range ||||line of sight, LOS, vision ||
     190|| |||| |||| ||
    207191
    208192Notes:
    … …  
    210194¹ 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).
    211195
    212 === Structures
    213 
    214 ||='''good''' =||='''bad'''                                =||
    215 ||Structure    ||Building                                   ||
    216 ||Arsenal      ||Armoury, Foundry, Siege Workshop, Workshop ||
    217 ||Civic Center ||Civic Centre, Civil Center, Civil Centre   ||
    218 ||Dock         ||Harbour, Pier, Port, Quay, Shipyard, Wharf ||
    219 ||Farmstead    ||Farmhouse, Granary, Mill                   ||
    220 ||Fortress     ||Castle, Citadel, Fort, Stronghold          ||
    221 ||Forge        ||Armoury, Blacksmith, Smithy                ||
    222 ||House        ||Dwelling, Home, Hut, Shack                 ||
    223 ||Storehouse   ||Drop Site, Mining Camp, Storage Pit        ||
    224 
    225 
    226 === Units
    227 
    228 ||='''good'''                                 =||='''bad'''                                                          =||
    229 ||Cavalry                                      ||Cavalry Soldier, Horse, Horseman                                     ||
    230 ||Champion                                     ||                                                                     ||
    231 ||Champion Cavalry                             ||Cavalry Champion                                                     ||
    232 ||Champion Cavalry Spearman                    ||Cavalry Spearman Champion, Champion Spear Cavalry                    ||
    233 ||Champion Infantry                            ||Infantry Champion                                                    ||
    234 ||Champion Infantry Archer                     ||Infantry Archer Champion, Champion Archer Infantry                   ||
    235 ||Champion Spearman (both cavalry and infantry)||Spearman Champion                                                    ||
    236 ||Citizen (cavalry or infantry, female or male)||Worker, Villager, Subject, Slave, Servant, Serf, Peasant, Labourer, Gatherer, Builder ||
    237 ||Citizen Cavalry                              ||Cavalry Citizen-Soldier, Citizen-Cavalry, Citizen-Cavalry Unit       ||
    238 ||Citizen Infantry                             ||Infantry Citizen, Infantry Citizen Soldier, Infantry Citizen-Soldier ||
    239 ||Citizen Soldier (cavalry or infantry)        ||Citizen-Soldier, Soldier Citizen                                     ||
    240 ||Female Citizen                               ||Female, Female Worker, Woman                                         ||
    241 ||Infantry                                     ||Infantry Soldier, Footman                                            ||
    242 ||Melee Cavalry                                ||Cavalry Melee Soldier, Heavy Cavalry                                 ||
    243 ||Melee Infantry                               ||Heavy Infantry                                                       ||
    244 ||Ranged Cavalry                               ||Cavalry Ranged Soldier, Cavalry Skirmisher, Skirmisher Cavalry       ||
    245 ||Ranged Infantry                              ||Light Infantry, Infantry Skirmisher, Skirmisher Infantry, Skirmisher ||
    246 ||Ship                                         ||Boat, Craft, Vessel                                                  ||
    247 ||Siege Engine                                 ||Siege Weapon, Siege                                                  ||
    248 
    249 
    250 == Tooltips
     196=== Structures ===
     197||='''good''' =||='''bad''' =||
     198||Structure ||Building ||
     199||Arsenal ||Armoury, Foundry, Siege Workshop, Workshop ||
     200||Civic Center ||Civic Centre, Civil Center, Civil Centre ||
     201||Dock ||Harbour, Pier, Port, Quay, Shipyard, Wharf ||
     202||Farmstead ||Farmhouse, Granary, Mill ||
     203||Fortress ||Castle, Citadel, Fort, Stronghold ||
     204||Forge ||Armoury, Blacksmith, Smithy ||
     205||House ||Dwelling, Home, Hut, Shack ||
     206||Storehouse ||Drop Site, Mining Camp, Storage Pit ||
     207
     208=== Units ===
     209||='''good''' =||='''bad''' =||
     210||Cavalry ||Cavalry Soldier, Horse, Horseman ||
     211||Champion || ||
     212||Champion Cavalry ||Cavalry Champion ||
     213||Champion Cavalry Spearman ||Cavalry Spearman Champion, Champion Spear Cavalry ||
     214||Champion Infantry ||Infantry Champion ||
     215||Champion Infantry Archer ||Infantry Archer Champion, Champion Archer Infantry ||
     216|| Champion Spearman (both cavalry and infantry) ||Spearman Champion ||
     217|| Citizen (cavalry or infantry, female or male) ||Worker, Villager, Subject, Slave, Servant, Serf, Peasant, Labourer, Gatherer, Builder ||
     218||Citizen Cavalry ||Cavalry Citizen-Soldier, Citizen-Cavalry, Citizen-Cavalry Unit ||
     219||Citizen Infantry ||Infantry Citizen, Infantry Citizen Soldier, Infantry Citizen-Soldier ||
     220||Citizen Soldier (cavalry or infantry) ||Citizen-Soldier, Soldier Citizen ||
     221||Female Citizen ||Female, Female Worker, Woman ||
     222||Infantry ||Infantry Soldier, Footman ||
     223||Melee Cavalry ||Cavalry Melee Soldier, Heavy Cavalry ||
     224||Melee Infantry ||Heavy Infantry ||
     225||Ranged Cavalry ||Cavalry Ranged Soldier, Cavalry Skirmisher, Skirmisher Cavalry ||
     226||Ranged Infantry ||Light Infantry, Infantry Skirmisher, Skirmisher Infantry, Skirmisher ||
     227||Ship ||Boat, Craft, Vessel ||
     228||Siege Engine ||Siege Weapon, Siege ||
     229
     230== Tooltips ==
    251231In general, start with a capital, end each statement with a full stop, and capitalize classes.
    252232
    253 === Auras
    254 Auras are JSON files located inside `simulation/data/auras/`. Auras are temporary, their effects disappear when the aura entity is lost.
    255 The shared format for the `auraDescription` is: **"[player] [class] [change] [attributes] [requirements]"**:
    256  * **[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]): 
     233=== Auras ===
     234Auras are JSON files located inside `simulation/data/auras/`. Auras are temporary, their effects disappear when the aura entity is lost.  The shared format for the `auraDescription` is: **"[player] [class] [change] [attributes] [requirements]"**:
     235
     236 * **[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]):
    257237   * `Ally`: player is our ally → Allied and Own
    258238   * `ExclusiveAlly`: player is our ally excluding ourself → Allied
    … …  
    269249   * `"add": 1` → +1
    270250   * `"add": -25` → −25
    271  * **[attributes]**: the modified stats; see [[EnglishStyleGuide#Stats | above]]
     251 * **[attributes]**: the modified stats; see [[wiki:EnglishStyleGuide#Stats | above]]
    272252 * **[requirements]**: if and only if a `requiredTechnology` is set; specifies the `genericName` of the required technology; e.g.:
    273253   * `"pop_wonder"` → (requires the “Glorious Expansion” technology)
    274  
    275 The 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]):
    276 ||='''type'''    =||='''format'''                                                                =||='''examples'''=||
    277 ||formation       ||[player] [class] in his formation [change] [attributes] [requirements]        ||Soldiers in his formation +3 armor and +15% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_iphicrates_1.json ref])||
    278 ||garrison        ||[player] [class] he is garrisoned in [change] [attributes] [requirements]||Ship he is garrisoned in −30% batch training time and +50% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_themistocles_1.json ref])||
    279 ||garrisonedUnits ||Garrisoned [player] [class] [change] [attributes] [requirements]              ||Garrisoned Siege Engines +3 health regeneration rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/arsenal_repair.json ref])\\Garrisoned Soldiers +3 armor and +20 vision range. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/wall_garrisoned.json ref])||
    280 ||global          ||[player] [class] [change] [attributes] [requirements]                         ||Allied Structures −20% technology research time. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/teambonuses/gaul_player_teambonus.json ref])\\Temples −25% stone cost and +2 garrison heal rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_pericles_2.json ref])\\+40 maximum population limit (requires the “Glorious Expansion” technology). ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/wonder_pop_2.json ref])||
    281 ||range           ||[player] [class] [change] [attributes] [requirements]                         ||Workers +25% grain gather rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/rotary_mill.json ref])\\Own and Allied Soldiers and Siege Engines +1 capture attack strength, +20% melee and ranged attack damage. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/cart_hero_hannibal.json ref])\\Champions +2 capture attack strength, +20% melee and ranged attack damage, +10% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/brit_hero_boudicca.json ref])||
    282 
    283 === Technologies
    284 Technologies 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.:
     254
     255 The 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]):
     256
     257||='''type''' =||='''format''' =||= '''examples''' =||
     258||formation ||[player] [class] in his formation [change] [attributes] [requirements] || Soldiers in his formation +3 armor and +15% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_iphicrates_1.json ref]) ||
     259||garrison || [player] [class] he is garrisoned in [change] [attributes] [requirements] || Ship he is garrisoned in −30% batch training time and +50% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_themistocles_1.json ref]) ||
     260||garrisonedUnits ||Garrisoned [player] [class] [change] [attributes] [requirements] || Garrisoned Siege Engines +3 health regeneration rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/arsenal_repair.json ref])\\Garrisoned Soldiers +3 armor and +20 vision range. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/wall_garrisoned.json ref]) ||
     261||global ||[player] [class] [change] [attributes] [requirements] || Allied Structures −20% technology research time. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/teambonuses/gaul_player_teambonus.json ref])\\Temples −25% stone cost and +2 garrison heal rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/athen_hero_pericles_2.json ref])\\+40 maximum population limit (requires the “Glorious Expansion” technology). ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/wonder_pop_2.json ref]) ||
     262||range ||[player] [class] [change] [attributes] [requirements] || Workers +25% grain gather rate. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/structures/rotary_mill.json ref])\\Own and Allied Soldiers and Siege Engines +1 capture attack strength, +20% melee and ranged attack damage. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/cart_hero_hannibal.json ref])\\Champions +2 capture attack strength, +20% melee and ranged attack damage, +10% movement speed. ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/auras/units/heroes/brit_hero_boudicca.json ref]) ||
     263
     264=== Technologies ===
     265Technologies are JSON files located inside `simulation/data/technologies/`. All technologies are global and irreversible. Please follow the **"[player] [class] [change] [attributes]"** format (see auras [[wiki:EnglishStyleGuide#Auras | above]], without [requirements]), e.g.:
     266
    285267 * `"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])
    286268
    287 === Templates
     269=== Templates ===
    288270Entity 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:
     271
    289272 * 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])
    290273 * 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_arsenal.xml arsenal])
    291274 * 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])
    292275
    293 
    294 == Typography
    295 
    296 === Capitalization
     276== Typography ==
     277=== Capitalization ===
    297278Use [https://en.wikipedia.org/wiki/Letter_case#Title_case title case] for:
     279
    298280 * button captions;
    299281 * entity classes;
    … …  
    301283 * key names;
    302284 * proper names.
     285
    303286For everything else, don't capitalize:
     287
    304288 * cardinal directions (north, east, south, west), unless part of a name;
    305289 * resource types (food, wood, stone, metal);
    … …  
    310294And never use full capitalization (e.g. THIS).
    311295
    312 ||='''good'''                   =||='''bad'''                    =||
     296||='''good''' =||='''bad''' =||
    313297||Click the Citizen Soldier icon ||Click the CITIZEN SOLDIER icon ||
    314 ||Hold Shift and click           ||Hold shift and click           ||
    315 
    316 
    317 === Punctuation and spacing
     298||Hold Shift and click ||Hold shift and click ||
     299
     300=== Punctuation and spacing ===
    318301 * 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.”
    319302 * Only use one space, not two, after a full stop to end a sentence.
    320303 * Do not use spaces before “large” characters (e.g. ?, !, :, %).
    321  * There are three options for parenthetical remarks: 
     304 * There are three options for parenthetical remarks:
    322305   * parentheses (which have spaces on the outside, but not on the inside) are preferred;
    323    * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better; 
     306   * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better;
    324307   * em-dashes—which have spaces neither inside nor outside—are better avoided.
    325308 * Use “English-style” quotation marks, not « French-style » or „German-style“ (nor the other »German-style«).
    326309 * Please read the articles listed at https://www.lexico.com/grammar/punctuation
    327310
    328 
    329 === Unicode
     311=== Unicode ===
    330312We have a somewhat complete Unicode support, do not limit yourself to ASCII and learn how to use [https://en.wikipedia.org/wiki/Unicode_input Unicode input] in your system.
    331313
    332 ||='''good'''         =||='''bad'''                     =||='''usage'''                                                =||
    333 ||… (U+2026, ellipsis) ||... (three full stops)          ||intentional omission                                        ||
    334 ||• (U+2022, bullet)   ||- (hyphen)                      ||itemization                                                  ||
    335 ||– (U+2013, en-dash)  ||- (hyphen), -- (two hyphens)    ||range of values (500–1 BC), oppositions (Greco–Persian wars) ||
    336 ||— (U+2014, em-dash)  ||- (hyphen), --- (three hyphens) ||attribution of a quote source                                ||
    337 ||− (U+2212, minus)    ||- (hyphen)                      ||subtraction, negative values (−20% training time)            ||
    338 ||× (U+00D7, times)    ||x (X)                           ||multiplication                                              ||
    339 ||“ (U+201C)           ||" (programmer's quote)          ||start of a quotation                                        ||
    340 ||” (U+201D)           ||" (programmer's quote)          ||end of a quotation                                          ||
    341 ||‘ (U+2018)           ||' (apostrophe)                  ||start of a quotation inside a quotation                      ||
    342 ||’ (U+2019)           ||' (apostrophe)                  ||end of a quotation inside a quotation                        ||
     314||='''good''' =||='''bad''' =||='''usage''' =||
     315||… (U+2026, ellipsis) ||... (three full stops) ||intentional omission ||
     316||• (U+2022, bullet) ||- (hyphen) ||itemization ||
     317||– (U+2013, en-dash) ||- (hyphen), -- (two hyphens) ||range of values (500–1 BC), oppositions (Greco–Persian wars) ||
     318||— (U+2014, em-dash) ||- (hyphen), --- (three hyphens) ||attribution of a quote source ||
     319||− (U+2212, minus) ||- (hyphen) ||subtraction, negative values (−20% training time) ||
     320||× (U+00D7, times) ||x (X) ||multiplication ||
     321||“ (U+201C) ||" (programmer's quote) ||start of a quotation ||
     322||” (U+201D) ||" (programmer's quote) ||end of a quotation ||
     323||‘ (U+2018) ||' (apostrophe) ||start of a quotation inside a quotation ||
     324||’ (U+2019) ||' (apostrophe) ||end of a quotation inside a quotation ||
    343325
    344326Use the ordinary hyphen or hyphen-minus (-) for:
     327
    345328 * hyphenation;
    346329 * compounds (Greco-Bactrian kingdom);
    … …  
    348331 * vowel separation (de-escalate);
    349332 * to distinguish between [https://en.wikipedia.org/wiki/Hyphen#Varied_meanings varied meanings].
     333
    350334For more examples, see https://www.lexico.com/grammar/hyphen
    351335
    352 == External links
     336== External links ==
    353337 * [https://ec.europa.eu/info/sites/info/files/styleguide_english_dgt_en.pdf European Union English style guide (pdf)]
    354338 * https://www.transifex.com/wildfire-games/0ad/