Changes between Version 102 and Version 103 of EnglishStyleGuide


Ignore:
Timestamp:
Mar 15, 2021, 5:00:20 AM (3 years ago)
Author:
Langbart
Comment:

Reverted to version 99.

Legend:

Unmodified
Added
Removed
Modified

  • EnglishStyleGuide

    v102 v103  
    1 [[TOC]] ''For specific (i.e. non-English) name strings, see wiki:SpecificNames.'' ''For translations into other languages, see [wiki:Localization#AdditionalInstructionsforLanguageTeams wiki:Localization].''
     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].''
    24
    35This guide provides some ground rules to write user-facing texts for '''0 A.D.'''
    46
    5 == Orthography ==
    6 === Common mistakes ===
     7
     8== Orthography
     9=== Common mistakes
    710Always check what you type!
    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 
     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.
    1617See also https://www.lexico.com/grammar/common-misspellings
    1718
    18 === English spelling ===
     19=== English spelling
    1920Use American English spelling.
    2021
    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 ||
     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        ||
    2728||analyze\\analyzing\\analyzable ||analyse\\analysing\\analysable ||analyse\\analysing\\analysable ||
    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 ||
     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        ||
    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 === Dates and times ===
    62 '''Anno Domini (AD) and Before Christ (BC)'''
    63 
    64 The 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.
    65 
    66 The letters AD come before the year number (AD 2000), whereas BC follows it (347 BC). Also check there is always a single space between the year and BC/ AD.
    67 
    68 ||= =||=Anno Domini =||=Before Christ =||
    69 || Syntax || AD YYYY || YYYY BC ||
    70 ||good ||AD 420 || 420 BC ||
    71 ||bad ||A.D., CE, C.E. || B.C., BCE, B.C.E. ||
    72 
    73 '''Dates'''
    74 
    75 The following options ensure that there is no confusion between readers from different nations. A leading zero is only allowed in the ISO format. Be consistent and use the same format.
    76 
    77 ||= =||='''American''' format =||='''British''' format =||='''British''' abbreviated =||=ISO format =||
    78 ||Syntax || Month DD, YYYY || DD Month YY || DD/Mth/YY ||YYYY-MM-DD ||
    79 || good || April 4, 2021 || 4 April 2021 || 4/Apr/21 || 2021-04-04 ||
    80 || bad || April 04, 2021 || 04 April 2021 || 04/Apr/21 || 2021-4-4 ||
    81 
    82 '''Times'''
    83 
    84 Be consistent and use the same format.
    85 
    86 ||= =||=24-hour system =||= 12-hour system =||
    87 ||Syntax || hh.mm || hh.mm a.m./ p.m. ||
    88 || good || 4.30 || 4.30 a.m. ||
    89 || bad || 04:30 || 4:30 am ||
    90 || full hour[[BR]]good || 14.00 || 2 p.m.[[BR]]2 o’clock ||
    91 || full hour [[BR]]bad || 14:30 || 2.00 pm[[BR]]2.00 o’clock ||
    92 
    93 === Dynastic factions ===
    94 ||='''singular:''' =||='''plural:''' =||='''adjective:''' =||
    95 || ''founder of dynasty'' || ''members of dynasty'' || ''belonging to dynasty'' ||
    96 ||Achaemenes ||Achaemenids ||Achaemenid ||
    97 ||Maurya ||Mauryas ||Mauryan ||
    98 ||Ptolemy ||Ptolemies ||Ptolemaic ||
    99 ||Seleucus ||Seleucids ||Seleucid ||
    100 
    101 === Greek and Latin ===
    102 Greek words and proper names are Latinized everywhere, except in the specific name.
    103 
    104 ||='''Latinized''' =||='''Greek''' =||
    105 ||Aeschylus ||Aiskhulos ||
    106 ||Darius ||Dareios ||
    107 ||Plato ||Platōn ||
    108 ||Seleucus I ||Seleukos A' ||
    109 ||Thucydides ||Thoukudidēs ||
     61=== Calender years
     62The name of the game is '''0 A.D.''', which includes dots, for stylistic reasons.
     63However, 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.    ||
     68
     69Also check there is always a single space between the year and BC/AD.
     70
     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
     82Greek 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                           ||
    11090
    11191Also, use the English form if there is one.
    11292
    113 ||='''English''' =||='''Latin''' =||='''Greek''' =||
     93||='''English'''     =||='''Latin'''    =||='''Greek'''      =||
    11494||Alexander the Great ||Alexander Magnus ||Alexandros ho Megas ||
    115 ||Aristotle ||Aristoteles ||Aristotelēs ||
    116 ||Athens ||Athenae ||Athēnai ||
    117 ||Homer ||Homerus ||Homēros ||
    118 ||Livy ||Livius || ||
    119 ||Mark Antony ||Marcus Antonius || ||
    120 ||Ovid ||Ovidius || ||
    121 ||Plutarch ||Plutarchus ||Ploutarchos ||
    122 ||Ptolemy ||Ptolemaeus ||Ptolemaios ||
    123 ||Syracuse ||Syracusae ||Surakousai ||
    124 ||Virgil ||Vergilius || ||
    125 ||='''English''' =||='''Latin''' =||='''Greek''' =||
    126 ||Cataphract || ||Kataphraktos ||
    127 ||Hoplite || ||Hoplitēs ||
    128 ||Legionary ||Legionarius || ||
    129 ||Penteconter || ||Pentēkontoros ||
    130 ||Quadrireme ||Quadriremis ||Tetrērēs ||
    131 ||Quinquereme ||Quinqueremis ||Pentērēs ||
    132 ||Theatre ||Theatrum ||Theatron ||
    133 ||Trireme ||Triremis ||Triērēs ||
    134 
    135 == Terminology ==
    136 In 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.
    137 
    138 An 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.
     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
     117In texts that the user needs to understand, such as menu entries, help
     118tooltips, and similar, you must be consistent with the vocabulary that you use.
     119
     120An object should always be referred to using the same word everywhere in the
     121game, and an action should always be referred to using the same verb.
     122For example, if there is a unit type called ‘Female Citizen’, always refer to it
     123as such, do not also use alternative forms such as ‘females’, ‘women’, and so
     124on. Even in the same paragraph or sentence, you should use the same term.
    139125
    140126Always 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”.
    … …  
    144130For specific words that you should use or avoid in 0 A.D. gameplay texts, see the tables below.
    145131
    146 === Actions ===
    147 ||='''good''' =||='''bad''' =||
    148 ||build (structures) ||construct, make ||
    149 ||collect (treasures) ||gather ||
    150 ||construct (ships, siege weapons) ||build, produce, train ||
    151 ||gather (resources) ||collect, get ||
    152 ||research (technologies) || ||
    153 ||train (human units) ||build, construct, recruit, produce ||
    154 
    155 === Cursor vs Mouse ===
     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
    156145Mind the difference between the cursor (virtual) and the mouse (physical).
    157146
    158 === GUI ===
    159 ||='''good''' =||='''bad''' =||
    160 ||icon ||image, picture, portrait, sprite, thumbnail ||
    161 ||window ||dialog(ue) ||
    162 
    163 === Stats ===
    164 ||='''code''' =||||='''good''' =||||='''bad''' =||
    165 ||`Attack/Capture/Capture` ||||capture attack strength ||||capture rate, capture value ||
    166 ||`Attack/Capture/MaxRange` ||||capture attack range ||||capture range ||
    167 ||`Attack/Capture/RepeatTime` ||||capture attack speed¹ ||||capture rate, capture time ||
    168 ||`Attack/Melee/Damage/Crush` ||||melee attack crush damage ||||crush, crush attack, crush strength ||
    169 ||`Attack/Melee/MaxRange` ||||attack range ||||range, melee range ||
    170 ||`Attack/Melee/RepeatTime` ||||melee attack speed¹ ||||melee attack repeat time ||
    171 ||`Attack/Ranged/ElevationBonus` ||||elevation bonus |||| ||
    172 ||`Attack/Ranged/MinRange` ||||minimum attack range ||||min attack range, minimum range ||
    173 ||`Attack/Ranged/RepeatTime` ||||ranged attack speed¹ ||||ranged attack repeat time ||
    174 ||`Builder/Rate` ||||build rate ||||builder rate, building rate ||
    175 ||`Capturable/CapturePoints` ||||capture points |||| ||
    176 ||`Cost/BuildTime` || ''structures''\\''ships, siege''\\''animals''\\''other units'' || build time\\construction time\\breeding time\\training time |||| building time, production time, recruitment time ||
    177 ||`Cost/Population` ||||population cost |||| ||
    178 ||`Cost/PopulationBonus` ||||population bonus |||| ||
    179 ||`Cost/Resources/food` ||||food cost |||| ||
    180 ||`Cost/Resources/wood` ||||wood cost ||||timber cost ||
    181 ||`Cost/Resources/stone` ||||stone cost |||| ||
    182 ||`Cost/Resources/metal` ||||metal cost ||||iron cost ||
    183 ||`GarrisonHolder/BuffHeal` ||||garrison heal rate |||| ||
    184 ||`GarrisonHolder/Max` ||||garrison capacity |||| ||
    185 ||`Heal/Health` ||||healing strength ||||HP, heal value ||
    186 ||`Heal/Range` ||||healing range ||||heal range ||
    187 ||`Heal/Rate` ||||healing time ||||heal rate, healing speed ||
    188 ||`Health/IdleRegenRate` || idle ||health regeneration rate ||||regeneration, regen rate, regen speed ||
    189 ||`Health/Max` ||||health ||||health points, hitpoints, HP ||
    190 ||`Health/RegenRate` ||||health regeneration rate ||||regeneration, regen rate, regen speed ||
    191 ||`Loot/xp` || grant ||experience loot |||| ||
    192 ||`Looter/xp` || gain ||experience loot |||| ||
    193 || `ProductionQueue/TechCostMultiplier/food` || technologies require ||food |||| ||
    194 ||`Promotion/RequiredXp` ||||promotion experience |||| ||
    195 ||`ResourceGatherer/BaseSpeed` ||||gather speed ||||gather rate, work speed ||
    196 ||`ResourceGatherer/Capacities/food` ||||food capacity ||||carry capacity, foot load ||
    197 ||`ResourceGatherer/MaxDistance` ||||gather distance |||| ||
    198 ||`ResourceGatherer/Rates/food.fish` ||||fish gather rate |||| ||
    199 ||`ResourceGatherer/Rates/food.fruit` ||||fruit gather rate |||| ||
    200 ||`ResourceGatherer/Rates/food.grain` ||||grain gather rate |||| ||
    201 ||`ResourceGatherer/Rates/food.meat` ||||meat gather rate |||| ||
    202 ||`ResourceGatherer/Rates/metal.ore` ||||metal gather rate |||| ||
    203 ||`ResourceGatherer/Rates/metal.ruins` |||| |||| ||
    204 ||`ResourceGatherer/Rates/stone.rock` ||||stone gather rate |||| ||
    205 ||`ResourceGatherer/Rates/stone.ruins` |||| |||| ||
    206 ||`ResourceGatherer/Rates/treasure` |||| |||| ||
    207 ||`ResourceGatherer/Rates/wood.rock` ||||wood gather rate |||| ||
    208 ||`ResourceGatherer/Rates/wood.ruins` |||| |||| ||
    209 ||`ResourceTrickle/Interval` ||||resource trickle time |||| ||
    210 ||`ResourceTrickle/Rates/food` ||||food trickle rate |||| ||
    211 ||`UnitMotion/WalkSpeed` ||||movement speed ||||speed, velocity, walk speed ||
    212 ||`Vision/Range` ||||vision range ||||line of sight, LOS, vision ||
    213 || |||| |||| ||
     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||``                                   ||||                                  ||||                                      ||
    214207
    215208Notes:
    … …  
    217210¹ 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).
    218211
    219 === Structures ===
    220 ||='''good''' =||='''bad''' =||
    221 ||Structure ||Building ||
    222 ||Arsenal ||Armoury, Foundry, Siege Workshop, Workshop ||
    223 ||Civic Center ||Civic Centre, Civil Center, Civil Centre ||
    224 ||Dock ||Harbour, Pier, Port, Quay, Shipyard, Wharf ||
    225 ||Farmstead ||Farmhouse, Granary, Mill ||
    226 ||Fortress ||Castle, Citadel, Fort, Stronghold ||
    227 ||Forge ||Armoury, Blacksmith, Smithy ||
    228 ||House ||Dwelling, Home, Hut, Shack ||
    229 ||Storehouse ||Drop Site, Mining Camp, Storage Pit ||
    230 
    231 === Units ===
    232 ||='''good''' =||='''bad''' =||
    233 ||Cavalry ||Cavalry Soldier, Horse, Horseman ||
    234 ||Champion || ||
    235 ||Champion Cavalry ||Cavalry Champion ||
    236 ||Champion Cavalry Spearman ||Cavalry Spearman Champion, Champion Spear Cavalry ||
    237 ||Champion Infantry ||Infantry Champion ||
    238 ||Champion Infantry Archer ||Infantry Archer Champion, Champion Archer Infantry ||
    239 || Champion Spearman (both cavalry and infantry) ||Spearman Champion ||
    240 || Citizen (cavalry or infantry, female or male) ||Worker, Villager, Subject, Slave, Servant, Serf, Peasant, Labourer, Gatherer, Builder ||
    241 ||Citizen Cavalry ||Cavalry Citizen-Soldier, Citizen-Cavalry, Citizen-Cavalry Unit ||
    242 ||Citizen Infantry ||Infantry Citizen, Infantry Citizen Soldier, Infantry Citizen-Soldier ||
    243 ||Citizen Soldier (cavalry or infantry) ||Citizen-Soldier, Soldier Citizen ||
    244 ||Female Citizen ||Female, Female Worker, Woman ||
    245 ||Infantry ||Infantry Soldier, Footman ||
    246 ||Melee Cavalry ||Cavalry Melee Soldier, Heavy Cavalry ||
    247 ||Melee Infantry ||Heavy Infantry ||
    248 ||Ranged Cavalry ||Cavalry Ranged Soldier, Cavalry Skirmisher, Skirmisher Cavalry ||
    249 ||Ranged Infantry ||Light Infantry, Infantry Skirmisher, Skirmisher Infantry, Skirmisher ||
    250 ||Ship ||Boat, Craft, Vessel ||
    251 ||Siege Engine ||Siege Weapon, Siege ||
    252 
    253 == Tooltips ==
     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
    254251In general, start with a capital, end each statement with a full stop, and capitalize classes.
    255252
    256 === Auras ===
    257 Auras 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]"**:
    258 
    259  * **[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]):
     253=== Auras
     254Auras are JSON files located inside `simulation/data/auras/`. Auras are temporary, their effects disappear when the aura entity is lost.
     255The 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]): 
    260257   * `Ally`: player is our ally → Allied and Own
    261258   * `ExclusiveAlly`: player is our ally excluding ourself → Allied
    … …  
    272269   * `"add": 1` → +1
    273270   * `"add": -25` → −25
    274  * **[attributes]**: the modified stats; see [[wiki:EnglishStyleGuide#Stats | above]]
     271 * **[attributes]**: the modified stats; see [[EnglishStyleGuide#Stats | above]]
    275272 * **[requirements]**: if and only if a `requiredTechnology` is set; specifies the `genericName` of the required technology; e.g.:
    276273   * `"pop_wonder"` → (requires the “Glorious Expansion” technology)
    277 
    278   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]                  ):
    279 
    280 ||='''type''' =||='''format''' =||= '''examples''' =||
    281 ||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]) ||
    282 ||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]) ||
    283 ||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]) ||
    284 ||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]) ||
    285 ||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]) ||
    286 
    287 === Technologies ===
    288 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 [[wiki:EnglishStyleGuide#Auras | above]], without [requirements]), e.g.:
    289 
     274 
     275The 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
     284Technologies 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.:
    290285 * `"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])
    291286
    292 === Templates ===
     287=== Templates
    293288Entity 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:
    294 
    295289 * 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])
    296290 * 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])
    297291 * 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])
    298292
    299 == Typography ==
    300 === Capitalization ===
     293
     294== Typography
     295
     296=== Capitalization
    301297Use [https://en.wikipedia.org/wiki/Letter_case#Title_case title case] for:
    302 
    303298 * button captions;
    304299 * entity classes;
    … …  
    306301 * key names;
    307302 * proper names.
    308 
    309303For everything else, don't capitalize:
    310 
    311304 * cardinal directions (north, east, south, west), unless part of a name;
    312305 * resource types (food, wood, stone, metal);
    … …  
    317310And never use full capitalization (e.g. THIS).
    318311
    319 ||='''good''' =||='''bad''' =||
     312||='''good'''                   =||='''bad'''                    =||
    320313||Click the Citizen Soldier icon ||Click the CITIZEN SOLDIER icon ||
    321 ||Hold Shift and click ||Hold shift and click ||
    322 
    323 === Punctuation and spacing ===
     314||Hold Shift and click           ||Hold shift and click           ||
     315
     316
     317=== Punctuation and spacing
    324318 * 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.”
    325319 * Only use one space, not two, after a full stop to end a sentence.
    326320 * Do not use spaces before “large” characters (e.g. ?, !, :, %).
    327  * There are three options for parenthetical remarks:
     321 * There are three options for parenthetical remarks: 
    328322   * parentheses (which have spaces on the outside, but not on the inside) are preferred;
    329    * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better;
     323   * en-dashes – which have spaces both inside and outside – can also be used occasionally if it looks better; 
    330324   * em-dashes—which have spaces neither inside nor outside—are better avoided.
    331325 * Use “English-style” quotation marks, not « French-style » or „German-style“ (nor the other »German-style«).
    332326 * Please read the articles listed at https://www.lexico.com/grammar/punctuation
    333327
    334 === Unicode ===
     328
     329=== Unicode
    335330We 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.
    336331
    337 ||='''good''' =||='''bad''' =||='''usage''' =||
    338 ||… (U+2026, ellipsis) ||... (three full stops) ||intentional omission ||
    339 ||• (U+2022, bullet) ||- (hyphen) ||itemization ||
    340 ||– (U+2013, en-dash) ||- (hyphen), -- (two hyphens) ||range of values (500–1 BC), oppositions (Greco–Persian wars) ||
    341 ||— (U+2014, em-dash) ||- (hyphen), --- (three hyphens) ||attribution of a quote source ||
    342 ||− (U+2212, minus) ||- (hyphen) ||subtraction, negative values (−20% training time) ||
    343 ||× (U+00D7, times) ||x (X) ||multiplication ||
    344 ||“ (U+201C) ||" (programmer's quote) ||start of a quotation ||
    345 ||” (U+201D) ||" (programmer's quote) ||end of a quotation ||
    346 ||‘ (U+2018) ||' (apostrophe) ||start of a quotation inside a quotation ||
    347 ||’ (U+2019) ||' (apostrophe) ||end of a quotation inside a quotation ||
     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                        ||
    348343
    349344Use the ordinary hyphen or hyphen-minus (-) for:
    350 
    351345 * hyphenation;
    352346 * compounds (Greco-Bactrian kingdom);
    … …  
    354348 * vowel separation (de-escalate);
    355349 * to distinguish between [https://en.wikipedia.org/wiki/Hyphen#Varied_meanings varied meanings].
    356 
    357350For more examples, see https://www.lexico.com/grammar/hyphen
    358351
    359 == External links ==
     352== External links
    360353 * [https://ec.europa.eu/info/sites/info/files/styleguide_english_dgt_en.pdf European Union English style guide (pdf)]
    361354 * https://www.transifex.com/wildfire-games/0ad/