@chaffjs/lang-en 0.28.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/dist/browser/wink-modules.d.ts +4 -0
  2. package/dist/browser/wink-modules.d.ts.map +1 -1
  3. package/dist/browser/wink-modules.js +5 -2
  4. package/dist/browser/wink-modules.js.map +1 -1
  5. package/dist/currency-amounts.d.ts +14 -0
  6. package/dist/currency-amounts.d.ts.map +1 -0
  7. package/dist/currency-amounts.js +38 -0
  8. package/dist/currency-amounts.js.map +1 -0
  9. package/dist/lexicons.d.ts.map +1 -1
  10. package/dist/lexicons.js +3 -0
  11. package/dist/lexicons.js.map +1 -1
  12. package/dist/pos.d.ts.map +1 -1
  13. package/dist/pos.js +21 -5
  14. package/dist/pos.js.map +1 -1
  15. package/dist/proper-noun.d.ts +11 -0
  16. package/dist/proper-noun.d.ts.map +1 -1
  17. package/dist/proper-noun.js +31 -0
  18. package/dist/proper-noun.js.map +1 -1
  19. package/dist/structure.d.ts.map +1 -1
  20. package/dist/structure.js +26 -14
  21. package/dist/structure.js.map +1 -1
  22. package/dist/unit-case.d.ts +4 -0
  23. package/dist/unit-case.d.ts.map +1 -0
  24. package/dist/unit-case.js +11 -0
  25. package/dist/unit-case.js.map +1 -0
  26. package/dist/wink-modules.d.ts +5 -0
  27. package/dist/wink-modules.d.ts.map +1 -1
  28. package/dist/wink-modules.js +5 -0
  29. package/dist/wink-modules.js.map +1 -1
  30. package/lexicons/age-reference-label.yaml +11 -0
  31. package/lexicons/age-time-mark.yaml +8 -0
  32. package/lexicons/annual-holidays-label.yaml +19 -0
  33. package/lexicons/annual-holidays-word.yaml +28 -0
  34. package/lexicons/annual-pay-label.yaml +24 -0
  35. package/lexicons/annual-pay-word.yaml +52 -0
  36. package/lexicons/any-year-marker.yaml +21 -0
  37. package/lexicons/balance-column.yaml +27 -0
  38. package/lexicons/benefit-limit-word.yaml +16 -0
  39. package/lexicons/birth-date-label.yaml +8 -0
  40. package/lexicons/bmi-term.yaml +12 -0
  41. package/lexicons/bmi-unit.yaml +6 -0
  42. package/lexicons/change-column.yaml +28 -0
  43. package/lexicons/closing-balance-label.yaml +35 -0
  44. package/lexicons/cumulative-table.yaml +35 -0
  45. package/lexicons/currency-column.yaml +13 -0
  46. package/lexicons/date-deadline-mark.yaml +11 -0
  47. package/lexicons/dated-column-label.yaml +17 -0
  48. package/lexicons/dated-pair-label.yaml +210 -0
  49. package/lexicons/dated-span-label.yaml +12 -0
  50. package/lexicons/deductible-basis.yaml +26 -0
  51. package/lexicons/deductible-word.yaml +11 -0
  52. package/lexicons/discount-rate-label.yaml +35 -0
  53. package/lexicons/email-sentence-end.yaml +8 -0
  54. package/lexicons/event-bill-word.yaml +9 -0
  55. package/lexicons/event-due-word.yaml +7 -0
  56. package/lexicons/event-payment-deadline-word.yaml +12 -0
  57. package/lexicons/event-payment-word.yaml +7 -0
  58. package/lexicons/event-start-label.yaml +10 -0
  59. package/lexicons/event-ticket-word.yaml +8 -0
  60. package/lexicons/event-trip-word.yaml +13 -0
  61. package/lexicons/fact-age-joiner.yaml +8 -0
  62. package/lexicons/fact-age-limit.yaml +9 -0
  63. package/lexicons/fact-age-mark.yaml +13 -0
  64. package/lexicons/fact-amount-condition.yaml +15 -0
  65. package/lexicons/fact-count-column.yaml +10 -0
  66. package/lexicons/fact-count-counter.yaml +11 -0
  67. package/lexicons/fact-count-not-whole.yaml +19 -0
  68. package/lexicons/fact-count-restating.yaml +8 -0
  69. package/lexicons/fact-count-separate-rows.yaml +7 -0
  70. package/lexicons/fact-count-whole.yaml +11 -0
  71. package/lexicons/fact-document-term.yaml +39 -0
  72. package/lexicons/fact-label-qualifier.yaml +10 -0
  73. package/lexicons/fact-quantity-period.yaml +7 -0
  74. package/lexicons/fact-quantity-self.yaml +9 -0
  75. package/lexicons/fact-quantity-verb.yaml +8 -0
  76. package/lexicons/fact-rate-base.yaml +15 -0
  77. package/lexicons/fact-rate-joiner.yaml +16 -0
  78. package/lexicons/fact-rate-kind.yaml +9 -0
  79. package/lexicons/fact-rate-period.yaml +14 -0
  80. package/lexicons/fact-reading-clause.yaml +10 -0
  81. package/lexicons/fact-reading-gauge.yaml +13 -0
  82. package/lexicons/fact-reading-verb.yaml +9 -0
  83. package/lexicons/fact-term-self.yaml +12 -0
  84. package/lexicons/fact-term-start.yaml +7 -0
  85. package/lexicons/fact-term-verb.yaml +9 -0
  86. package/lexicons/formula-amount-word.yaml +13 -0
  87. package/lexicons/gpa-label.yaml +19 -0
  88. package/lexicons/grade-point.yaml +40 -0
  89. package/lexicons/heading-number-label.yaml +2 -6
  90. package/lexicons/installment-label.yaml +47 -0
  91. package/lexicons/installment-word.yaml +70 -0
  92. package/lexicons/interest-label.yaml +33 -0
  93. package/lexicons/item-name-column.yaml +10 -0
  94. package/lexicons/lab-result-column.yaml +23 -0
  95. package/lexicons/label-product-word.yaml +36 -0
  96. package/lexicons/line-amount-column.yaml +4 -0
  97. package/lexicons/meter-event.yaml +22 -0
  98. package/lexicons/meter-reading-label.yaml +26 -0
  99. package/lexicons/meter-unit.yaml +16 -0
  100. package/lexicons/net-amount-label.yaml +66 -0
  101. package/lexicons/net-amount-period.yaml +19 -0
  102. package/lexicons/net-gross-weight-column.yaml +23 -0
  103. package/lexicons/number-name-word.yaml +49 -0
  104. package/lexicons/order-quantity-column.yaml +33 -0
  105. package/lexicons/overnight-work-mark.yaml +13 -0
  106. package/lexicons/pack-count-column.yaml +13 -0
  107. package/lexicons/pack-price-column.yaml +12 -0
  108. package/lexicons/per-unit-mark.yaml +6 -0
  109. package/lexicons/period-label.yaml +7 -0
  110. package/lexicons/period-multiple-label.yaml +16 -0
  111. package/lexicons/period-multiple-word.yaml +28 -0
  112. package/lexicons/period-part-after.yaml +11 -0
  113. package/lexicons/period-part-length-verb.yaml +9 -0
  114. package/lexicons/period-part-marker.yaml +11 -0
  115. package/lexicons/period-part-range.yaml +9 -0
  116. package/lexicons/period-part-unnamed.yaml +16 -0
  117. package/lexicons/period-part-word.yaml +7 -0
  118. package/lexicons/person-label.yaml +26 -0
  119. package/lexicons/phone-label.yaml +10 -0
  120. package/lexicons/points-earned-column.yaml +18 -0
  121. package/lexicons/points-rate-joiner.yaml +8 -0
  122. package/lexicons/points-unit.yaml +10 -0
  123. package/lexicons/quantity-column.yaml +27 -0
  124. package/lexicons/quantity-range-word.yaml +1 -1
  125. package/lexicons/range-label.yaml +10 -0
  126. package/lexicons/range-start-end.yaml +29 -0
  127. package/lexicons/rate-unit.yaml +19 -0
  128. package/lexicons/ratio-label.yaml +14 -0
  129. package/lexicons/ratio-term.yaml +18 -0
  130. package/lexicons/reference-bound-mark.yaml +12 -0
  131. package/lexicons/reference-column-heading.yaml +10 -0
  132. package/lexicons/reference-column.yaml +18 -0
  133. package/lexicons/reference-flag.yaml +20 -0
  134. package/lexicons/reference-label.yaml +151 -0
  135. package/lexicons/reference-unit-column.yaml +8 -0
  136. package/lexicons/reference-unit.yaml +81 -0
  137. package/lexicons/reporting-comparison.yaml +29 -0
  138. package/lexicons/reporting-current.yaml +14 -0
  139. package/lexicons/reporting-forecast.yaml +25 -0
  140. package/lexicons/reporting-period-frame.yaml +27 -0
  141. package/lexicons/reporting-period-line.yaml +11 -0
  142. package/lexicons/reporting-results-word.yaml +9 -0
  143. package/lexicons/reporting-year-frame.yaml +10 -0
  144. package/lexicons/request-offer.yaml +12 -0
  145. package/lexicons/revision-column.yaml +17 -0
  146. package/lexicons/revision-direction.yaml +29 -0
  147. package/lexicons/serial-label.yaml +13 -0
  148. package/lexicons/service-charge-label.yaml +6 -0
  149. package/lexicons/share-amount-label.yaml +20 -0
  150. package/lexicons/share-column-rate-header.yaml +21 -0
  151. package/lexicons/shift-column.yaml +23 -0
  152. package/lexicons/summed-counter.yaml +45 -0
  153. package/lexicons/table-scale-unit.yaml +17 -0
  154. package/lexicons/table-unit-caption.yaml +7 -0
  155. package/lexicons/tax-price-column.yaml +28 -0
  156. package/lexicons/tier-label.yaml +31 -0
  157. package/lexicons/tier-unit.yaml +9 -0
  158. package/lexicons/timed-pair-label.yaml +54 -0
  159. package/lexicons/total-label-qualifier.yaml +12 -5
  160. package/lexicons/total-label.yaml +4 -2
  161. package/lexicons/total-noun-listed.yaml +9 -0
  162. package/lexicons/total-noun-qualifier.yaml +10 -0
  163. package/lexicons/total-noun-unsummed.yaml +9 -0
  164. package/lexicons/total-period-qualifier.yaml +17 -0
  165. package/lexicons/transcript-column.yaml +23 -0
  166. package/lexicons/unit-area.yaml +10 -0
  167. package/lexicons/unit-concentration.yaml +71 -0
  168. package/lexicons/unit-price-column.yaml +33 -0
  169. package/lexicons/unit-volume.yaml +4 -0
  170. package/lexicons/use-amount-word.yaml +11 -0
  171. package/lexicons/variance-column.yaml +22 -0
  172. package/lexicons/weekly-days-off.yaml +23 -0
  173. package/lexicons/year-span-joiner.yaml +12 -0
  174. package/package.json +2 -2
  175. package/src/browser/wink-modules.ts +6 -2
  176. package/src/browser/wink.d.ts +11 -1
  177. package/src/currency-amounts.ts +51 -0
  178. package/src/lexicons.ts +4 -0
  179. package/src/pos.ts +27 -5
  180. package/src/proper-noun.ts +45 -0
  181. package/src/structure.ts +33 -15
  182. package/src/unit-case.ts +14 -0
  183. package/src/wink-modules.ts +6 -0
@@ -0,0 +1,8 @@
1
+ # Marks saying when an age applies (elapsed-years-mismatch): "(age 57 at examination)" is counted on the date labelled with the same group (Examination date).
2
+ id: age-time-mark
3
+ language: en
4
+ entries:
5
+ - { pattern: at examination, group: exam }
6
+ - { pattern: at exam, group: exam }
7
+ - { pattern: at collection, group: exam }
8
+ - { pattern: at report, group: report }
@@ -0,0 +1,19 @@
1
+ # The labels of a job posting's annual days off (annual-holidays-mismatch): every day off in a year. before is a label
2
+ # the count follows ("Annual days off: 125 days"); after follows the count and holds the word of a day ("125 days off a
3
+ # year"). "Annual holidays", "annual leave" and "holiday entitlement" are left out: in British usage they are paid leave
4
+ # (25 days a year), not every day off, and two days off every week does not bound them.
5
+ id: annual-holidays-label
6
+ language: en
7
+ entries:
8
+ - { pattern: Annual days off, position: before }
9
+ - { pattern: Days off per year, position: before }
10
+ - { pattern: Days off a year, position: before }
11
+ - { pattern: Days off each year, position: before }
12
+ - { pattern: Total days off, position: before }
13
+ - { pattern: Total days off per year, position: before }
14
+ - { pattern: Total days off a year, position: before }
15
+ - { pattern: days off a year, position: after }
16
+ - { pattern: days off per year, position: after }
17
+ - { pattern: days off each year, position: after }
18
+ - { pattern: days off annually, position: after }
19
+ - { pattern: days off in a year, position: after }
@@ -0,0 +1,28 @@
1
+ # The words of annual-holidays-mismatch. link may stand between a label and its count ("Annual days off are 125 days").
2
+ # day is the word of a day after a count. negation negates a weekly phrase earlier in its sentence ("does not offer two
3
+ # days off every week"). exception, after a weekly phrase on its line, makes an exception to it ("except in peak season",
4
+ # "some Saturdays worked"). With either, the posting is not compared. open leaves a count open ("from 120 days", "120+ days").
5
+ id: annual-holidays-word
6
+ language: en
7
+ entries:
8
+ - { pattern: is, group: link }
9
+ - { pattern: are, group: link }
10
+ - { pattern: of, group: link }
11
+ - { pattern: day, group: day }
12
+ - { pattern: days, group: day }
13
+ - { pattern: not, group: negation, position: before }
14
+ - { pattern: never, group: negation, position: before }
15
+ - { pattern: no, group: negation, position: before }
16
+ - { pattern: without, group: negation, position: before }
17
+ - { pattern: "doesn't", group: negation, position: before }
18
+ - { pattern: "don't", group: negation, position: before }
19
+ - { pattern: "isn't", group: negation, position: before }
20
+ - { pattern: except, group: exception }
21
+ - { pattern: excluding, group: exception }
22
+ - { pattern: other than, group: exception }
23
+ - { pattern: apart from, group: exception }
24
+ - { pattern: worked, group: exception }
25
+ - { pattern: on duty, group: exception }
26
+ - { pattern: from, group: open, position: before }
27
+ - { pattern: "+", group: open, position: after }
28
+ - { pattern: or more, group: open, position: after }
@@ -0,0 +1,24 @@
1
+ # The pay labels of a job posting (annual-pay-mismatch). example is an example annual pay, compared with twelve months of
2
+ # the monthly pay plus the bonus months; a bare "Annual pay" is left out so an average or a past pay is not read. salary
3
+ # is an annual salary; a document with one is not compared, since its monthly pay may be the salary over 12, 14 or 16.
4
+ # monthly is a monthly pay; pay is read as monthly only with a per-month word beside it ("$4,500 a month"); bonus is a bonus.
5
+ id: annual-pay-label
6
+ language: en
7
+ entries:
8
+ - { pattern: Example annual pay, group: example }
9
+ - { pattern: Sample annual pay, group: example }
10
+ - { pattern: Expected annual pay, group: example }
11
+ - { pattern: Estimated annual pay, group: example }
12
+ - { pattern: Example annual income, group: example }
13
+ - { pattern: Expected annual income, group: example }
14
+ - { pattern: Annual salary, group: salary }
15
+ - { pattern: Monthly salary, group: monthly }
16
+ - { pattern: Monthly pay, group: monthly }
17
+ - { pattern: Monthly base salary, group: monthly }
18
+ - { pattern: Monthly base pay, group: monthly }
19
+ - { pattern: Salary, group: pay }
20
+ - { pattern: Pay, group: pay }
21
+ - { pattern: Base salary, group: pay }
22
+ - { pattern: Base pay, group: pay }
23
+ - { pattern: Bonus, group: bonus }
24
+ - { pattern: Bonuses, group: bonus }
@@ -0,0 +1,52 @@
1
+ # The words of annual-pay-mismatch. link may stand between a label and its amount ("monthly salary of $4,800"). per-month
2
+ # makes a pay label monthly. none says there is no bonus, after the label ("Bonus: none") or before it ("No bonus"). each
3
+ # makes a bonus count per payment and extra says another bonus is paid besides; neither bonus is read. times says a bonus
4
+ # is paid more than once a year; then the months are read only when a total word calls them the year's total. include says a pay
5
+ # holds overtime or allowances; on an annual line or a note beside it, the document is not compared. open leaves an
6
+ # amount's range open ("from $70,000", "$70,000+").
7
+ id: annual-pay-word
8
+ language: en
9
+ entries:
10
+ - { pattern: is, group: link }
11
+ - { pattern: of, group: link }
12
+ - { pattern: at, group: link }
13
+ - { pattern: a month, group: per-month }
14
+ - { pattern: per month, group: per-month }
15
+ - { pattern: monthly, group: per-month }
16
+ - { pattern: /month, group: per-month }
17
+ - { pattern: /mo, group: per-month }
18
+ - { pattern: none, group: none, position: after }
19
+ - { pattern: not paid, group: none, position: after }
20
+ - { pattern: no, group: none, position: before }
21
+ - { pattern: each, group: each }
22
+ - { pattern: per payment, group: each }
23
+ - { pattern: per occasion, group: each }
24
+ - { pattern: additional, group: extra }
25
+ - { pattern: separately, group: extra }
26
+ - { pattern: twice, group: times }
27
+ - { pattern: two times, group: times }
28
+ - { pattern: three times, group: times }
29
+ - { pattern: 2 times, group: times }
30
+ - { pattern: 3 times, group: times }
31
+ - { pattern: semi-annual, group: times }
32
+ - { pattern: semiannual, group: times }
33
+ - { pattern: biannual, group: times }
34
+ - { pattern: quarterly, group: times }
35
+ - { pattern: summer, group: times }
36
+ - { pattern: winter, group: times }
37
+ - { pattern: in total, group: total }
38
+ - { pattern: total, group: total }
39
+ - { pattern: combined, group: total }
40
+ - { pattern: overtime, group: include }
41
+ - { pattern: allowance, group: include }
42
+ - { pattern: allowances, group: include }
43
+ - { pattern: incentive, group: include }
44
+ - { pattern: incentives, group: include }
45
+ - { pattern: commission, group: include }
46
+ - { pattern: commissions, group: include }
47
+ - { pattern: tips, group: include }
48
+ - { pattern: from, group: open, position: before }
49
+ - { pattern: starting at, group: open, position: before }
50
+ - { pattern: "+", group: open, position: after }
51
+ - { pattern: and up, group: open, position: after }
52
+ - { pattern: and above, group: open, position: after }
@@ -0,0 +1,21 @@
1
+ # Words that make a yearless date no date of one year. date-without-year does not report a date they cover: "every year on
2
+ # April 1" is a day that comes round each year, and "for example, a request received on April 1" is a date in an example.
3
+ # A word without a group covers the rest of its sentence (not past a closing bracket), and the list a line ending in it
4
+ # introduces ("for example:"). group: adjacent covers only the date just after it ("each December 31"). group: label
5
+ # covers the dates in the bracket after it ("New Year holidays (December 29 to January 3)").
6
+ id: any-year-marker
7
+ language: en
8
+ entries:
9
+ - pattern: for example
10
+ - pattern: for instance
11
+ - pattern: e.g.
12
+ - pattern: every year
13
+ - pattern: each year
14
+ - pattern: each
15
+ group: adjacent
16
+ - pattern: every
17
+ group: adjacent
18
+ - pattern: New Year holidays
19
+ group: label
20
+ - pattern: year-end holidays
21
+ group: label
@@ -0,0 +1,27 @@
1
+ # Headings that say what a column of a running-balance table holds (running-balance-mismatch): a repayment schedule, an
2
+ # account statement, a stock card. group: balance is the running balance, principal and payment what a loan row takes off,
3
+ # interest the part of a payment that is not principal, in and out what came in and went out, sequence the row number, and
4
+ # date a date column ("Payment date" is not a payment). date, sequence and balance are looked at first, so "Balance after
5
+ # payment" is the balance and "Outstanding principal" is not the principal.
6
+ id: balance-column
7
+ language: en
8
+ entries:
9
+ - { pattern: date, group: date }
10
+ - { pattern: no., group: sequence }
11
+ - { pattern: "#", group: sequence }
12
+ - { pattern: balance, group: balance }
13
+ - { pattern: outstanding, group: balance }
14
+ - { pattern: on hand, group: balance }
15
+ - { pattern: interest, group: interest }
16
+ - { pattern: fee, group: interest }
17
+ - { pattern: principal, group: principal }
18
+ - { pattern: deposit, group: in }
19
+ - { pattern: deposits, group: in }
20
+ - { pattern: received, group: in }
21
+ - { pattern: withdrawal, group: out }
22
+ - { pattern: withdrawals, group: out }
23
+ - { pattern: issued, group: out }
24
+ - { pattern: payment, group: payment }
25
+ - { pattern: repayment, group: payment }
26
+ - { pattern: installment, group: payment }
27
+ - { pattern: amount paid, group: payment }
@@ -0,0 +1,16 @@
1
+ # The words for the most paid for a benefit (deductible-exceeds-limit), written before the amount. group not: phrases
2
+ # where one of them qualifies the deductible instead ("maximum excess").
3
+ id: benefit-limit-word
4
+ language: en
5
+ entries:
6
+ - { pattern: the most we pay }
7
+ - { pattern: the most we will pay }
8
+ - { pattern: the most we'll pay }
9
+ - { pattern: maximum }
10
+ - { pattern: limit }
11
+ - { pattern: limited to }
12
+ - { pattern: up to }
13
+ - { pattern: maximum excess, group: not }
14
+ - { pattern: maximum deductible, group: not }
15
+ - { pattern: excess limit, group: not }
16
+ - { pattern: deductible limit, group: not }
@@ -0,0 +1,8 @@
1
+ # Labels of a date of birth (elapsed-years-mismatch). The full date after the label is paired with the age on the same line ("(age 57)").
2
+ id: birth-date-label
3
+ language: en
4
+ entries:
5
+ - pattern: date of birth
6
+ - pattern: birth date
7
+ - pattern: dob
8
+ - pattern: born
@@ -0,0 +1,12 @@
1
+ # Names of a height, a weight and a BMI (bmi-mismatch). group is height, weight or bmi. A table row label or the name of a
2
+ # "name: value" line is read when it is only this word (a unit in brackets aside). When one section has one of each, the
3
+ # BMI is compared with the weight divided by the square of the height.
4
+ id: bmi-term
5
+ language: en
6
+ entries:
7
+ - { pattern: Height, group: height }
8
+ - { pattern: Weight, group: weight }
9
+ - { pattern: Body weight, group: weight }
10
+ - { pattern: BMI, group: bmi }
11
+ - { pattern: Body mass index, group: bmi }
12
+ - { pattern: Body-mass index, group: bmi }
@@ -0,0 +1,6 @@
1
+ # Units of a BMI (bmi-mismatch). A BMI value may have nothing after it, or only one of these.
2
+ id: bmi-unit
3
+ language: en
4
+ entries:
5
+ - pattern: "kg/m²"
6
+ - pattern: "kg/m2"
@@ -0,0 +1,28 @@
1
+ # Headings that say what a column of a prior / current / change table holds (change-rate-mismatch). group: base is the
2
+ # earlier value, current the later one, rate a rate of change (a percentage even without %), change a change that is a rate
3
+ # only when its cells carry %. Rate words are looked at first, so "change vs prior year" is not the earlier value.
4
+ id: change-column
5
+ language: en
6
+ entries:
7
+ - { pattern: yoy, group: rate }
8
+ - { pattern: y/y, group: rate }
9
+ - { pattern: year-on-year, group: rate }
10
+ - { pattern: year over year, group: rate }
11
+ - { pattern: "% change", group: rate }
12
+ - { pattern: change (%), group: rate }
13
+ - { pattern: change %, group: rate }
14
+ - { pattern: growth, group: change }
15
+ - { pattern: change, group: change }
16
+ - { pattern: prior year, group: base }
17
+ - { pattern: previous year, group: base }
18
+ - { pattern: last year, group: base }
19
+ - { pattern: prior period, group: base }
20
+ - { pattern: previous period, group: base }
21
+ - { pattern: prior quarter, group: base }
22
+ - { pattern: previous quarter, group: base }
23
+ - { pattern: a year earlier, group: base }
24
+ - { pattern: current year, group: current }
25
+ - { pattern: this year, group: current }
26
+ - { pattern: current period, group: current }
27
+ - { pattern: current quarter, group: current }
28
+ - { pattern: this quarter, group: current }
@@ -0,0 +1,35 @@
1
+ # Names of the amounts a statement's balance links (closing-balance-mismatch). group is opening (the balance at the start
2
+ # of the period), inflow (the total paid in), outflow (the total paid out) or closing (the balance at the end). When one
3
+ # table or one section has one word each of the four, each with an amount, the closing balance is compared with opening
4
+ # + inflow - outflow. A table heading, row label or line label that is only this word (a unit in brackets aside) is read.
5
+ # Previous balance and New balance stand with Points earned and Points used: a card statement uses them for an amount owed,
6
+ # which credits reduce, but no word here names a card's payments or purchases, and points are not compared with dollars.
7
+ # Credits and Debits alone are left out for the same reason: on a card or loan statement credits lower the balance.
8
+ # Deposit and Withdrawal alone are the columns of a transaction table, which running-balance-mismatch reads row by row.
9
+ id: closing-balance-label
10
+ language: en
11
+ entries:
12
+ - { pattern: Opening balance, group: opening }
13
+ - { pattern: Beginning balance, group: opening }
14
+ - { pattern: Starting balance, group: opening }
15
+ - { pattern: Balance brought forward, group: opening }
16
+ - { pattern: Balance at the end of last month, group: opening }
17
+ - { pattern: Previous balance, group: opening }
18
+ - { pattern: Total deposits, group: inflow }
19
+ - { pattern: Deposits and credits, group: inflow }
20
+ - { pattern: Deposits and other credits, group: inflow }
21
+ - { pattern: Points earned, group: inflow }
22
+ - { pattern: Points earned this month, group: inflow }
23
+ - { pattern: "Add: income for the year", group: inflow }
24
+ - { pattern: Total withdrawals, group: outflow }
25
+ - { pattern: Withdrawals and debits, group: outflow }
26
+ - { pattern: Withdrawals and other debits, group: outflow }
27
+ - { pattern: Points used, group: outflow }
28
+ - { pattern: Points used this month, group: outflow }
29
+ - { pattern: Points redeemed, group: outflow }
30
+ - { pattern: "Less: expenditure for the year", group: outflow }
31
+ - { pattern: Closing balance, group: closing }
32
+ - { pattern: Ending balance, group: closing }
33
+ - { pattern: Balance carried forward, group: closing }
34
+ - { pattern: Balance at the end of this month, group: closing }
35
+ - { pattern: New balance, group: closing }
@@ -0,0 +1,35 @@
1
+ # Headings and row labels of a table with a this-period column and a cumulative one (cumulative-below-current): a payslip,
2
+ # a monthly sales report, a budget report. group: current is this period's column, cumulative the running total's, and prior
3
+ # a column up to an earlier period ("Prior YTD" does not hold this period, so it is not compared). prior, level, cumulative and
4
+ # current are looked at in that order, so "Prior YTD" is prior and "Current YTD" is cumulative.
5
+ # level is a word for a figure not summed over periods (an average, a rate, a balance): a row it labels is not compared,
6
+ # and a column it heads ("Current balance") is neither column.
7
+ id: cumulative-table
8
+ language: en
9
+ entries:
10
+ - { pattern: this month, group: current }
11
+ - { pattern: this period, group: current }
12
+ - { pattern: this pay period, group: current }
13
+ - { pattern: this quarter, group: current }
14
+ - { pattern: current, group: current }
15
+ - { pattern: year to date, group: cumulative }
16
+ - { pattern: year-to-date, group: cumulative }
17
+ - { pattern: ytd, group: cumulative }
18
+ - { pattern: to date, group: cumulative }
19
+ - { pattern: cumulative, group: cumulative }
20
+ - { pattern: running total, group: cumulative }
21
+ - { pattern: prior, group: prior }
22
+ - { pattern: previous, group: prior }
23
+ - { pattern: last month, group: prior }
24
+ - { pattern: last year, group: prior }
25
+ - { pattern: last period, group: prior }
26
+ - { pattern: brought forward, group: prior }
27
+ - { pattern: average, group: level }
28
+ - { pattern: rate, group: level }
29
+ - { pattern: ratio, group: level }
30
+ - { pattern: margin, group: level }
31
+ - { pattern: balance, group: level }
32
+ - { pattern: price, group: level }
33
+ - { pattern: per, group: level }
34
+ - { pattern: headcount, group: level }
35
+ - { pattern: remaining, group: level }
@@ -0,0 +1,13 @@
1
+ # Heading words of a column that make a table one that names or converts currencies (currency-column-mix). A table with a
2
+ # column of currencies or of exchange rates holds amounts in several currencies on purpose, so a column of it is not reported.
3
+ # Latin words are matched as whole words.
4
+ id: currency-column
5
+ language: en
6
+ entries:
7
+ - pattern: currency
8
+ - pattern: currencies
9
+ - pattern: exchange rate
10
+ - pattern: FX
11
+ - pattern: converted
12
+ - pattern: conversion
13
+ - pattern: equivalent
@@ -0,0 +1,11 @@
1
+ # Words that make a date a deadline ("by September 18", "no later than Sept 18"); position says on which side of the date
2
+ # the word stands. A date with one is a reply-by or a deadline for something after the period, not a dated item inside
3
+ # it, so date-outside-period does not compare it in running text. "until" is not here: "stay until October 17" ends a
4
+ # stay inside the period; nor is "before" alone: "Before May 7, arrive in Osaka" is a plan, not a reply-by date.
5
+ id: date-deadline-mark
6
+ language: en
7
+ entries:
8
+ - { pattern: by, position: before }
9
+ - { pattern: no later than, position: before }
10
+ - { pattern: not later than, position: before }
11
+ - { pattern: on or before, position: before }
@@ -0,0 +1,17 @@
1
+ # Column words read only in a table's header, for dates that must come in order. group and position as in dated-pair-label.
2
+ # A table whose header has a column of each side of a pair (these words or dated-pair-label's) is read row by row, and a
3
+ # row's after-column date before its before-column date is pointed out (due-before-issue). Not read at the head of a line:
4
+ # a bare "Date" is paired only within one row of one table.
5
+ id: dated-column-label
6
+ language: en
7
+ entries:
8
+ # A points statement: points expire after the day they were earned (the purchase, the stay).
9
+ - { pattern: "Date", group: points, position: before }
10
+ - { pattern: "Stay date", group: points, position: before }
11
+ - { pattern: "Earned", group: points, position: before }
12
+ - { pattern: "Expires", group: points, position: after }
13
+ - { pattern: "Expiry", group: points, position: after }
14
+ - { pattern: "Expiration date", group: points, position: after }
15
+ # Words saying the table is about points: read only when another header column contains one. A table with only a
16
+ # Date and an Expiration date column may be a claims log or a ticket list.
17
+ - { pattern: "Point", group: points }
@@ -12,3 +12,213 @@ entries:
12
12
  - { pattern: "Move-in date", group: listing, position: after }
13
13
  - { pattern: "Move-in", group: listing, position: after }
14
14
  - { pattern: "Move in", group: listing, position: after }
15
+ # A bare "Posted" heads blog and release-note dates too, so it pairs only with an application deadline, never with
16
+ # "Available". A bare "Closing date" is left out: a sale or a reporting period closes too.
17
+ - { pattern: "Posted on", group: job, position: before }
18
+ - { pattern: "Posted", group: job, position: before }
19
+ - { pattern: "Date posted", group: job, position: before }
20
+ - { pattern: "Application deadline", group: job, position: after }
21
+ - { pattern: "Apply by", group: job, position: after }
22
+ - { pattern: "Application closing date", group: job, position: after }
23
+ # An earnings release: the earnings call and the release come after the end of the period they report. A reporting
24
+ # period line states a period and is compared by its end (dated-span-label). A bare "Release date" is left out: a
25
+ # product or a campaign is announced before its period ends. A bare "Conference call" is left out too: a project
26
+ # report's calls fall inside its reporting period.
27
+ - { pattern: "Reporting period", group: earnings, position: before }
28
+ - { pattern: "Period covered", group: earnings, position: before }
29
+ - { pattern: "Earnings call", group: earnings, position: after }
30
+ - { pattern: "Earnings conference call", group: earnings, position: after }
31
+ - { pattern: "Results briefing", group: earnings, position: after }
32
+ - { pattern: "Earnings release date", group: earnings, position: after }
33
+ - { pattern: "Results release date", group: earnings, position: after }
34
+ # A medical or lab report: the results are reported after the examination or the sample. A bare "Issue date" is left
35
+ # out: an admission ticket, a lab order or a notice is issued before the test or collection date it names.
36
+ - { pattern: "Examination date", group: checkup-report, position: before }
37
+ - { pattern: "Test date", group: checkup-report, position: before }
38
+ - { pattern: "Collection date", group: checkup-report, position: before }
39
+ - { pattern: "Date collected", group: checkup-report, position: before }
40
+ - { pattern: "Report date", group: checkup-report, position: after }
41
+ - { pattern: "Date reported", group: checkup-report, position: after }
42
+ # A product warranty: the registration deadline comes after the purchase.
43
+ - { pattern: "Purchase date", group: warranty, position: before }
44
+ - { pattern: "Date of purchase", group: warranty, position: before }
45
+ - { pattern: "Registration deadline", group: warranty, position: after }
46
+ - { pattern: "Product registration deadline", group: warranty, position: after }
47
+ - { pattern: "Register by", group: warranty, position: after }
48
+ # A recall or exchange notice: the deadline for replacement or refund requests comes after the notice date. A bare
49
+ # "Requests accepted until" or "Deadline for requests" is left out: a notice that a window has closed states the
50
+ # deadline that has passed.
51
+ - { pattern: "Notice date", group: recall, position: before }
52
+ - { pattern: "Date of notice", group: recall, position: before }
53
+ - { pattern: "Replacement requests accepted until", group: recall, position: after }
54
+ - { pattern: "Refund requests accepted until", group: recall, position: after }
55
+ - { pattern: "Exchange deadline", group: recall, position: after }
56
+ # A loan or an installment plan: the first payment comes after the contract is signed.
57
+ - { pattern: "Contract date", group: loan, position: before }
58
+ - { pattern: "Agreement date", group: loan, position: before }
59
+ - { pattern: "Date of contract", group: loan, position: before }
60
+ - { pattern: "First payment date", group: loan, position: after }
61
+ - { pattern: "First payment due", group: loan, position: after }
62
+ - { pattern: "First payment due date", group: loan, position: after }
63
+ - { pattern: "First installment due", group: loan, position: after }
64
+ - { pattern: "First installment due date", group: loan, position: after }
65
+ - { pattern: "First installment date", group: loan, position: after }
66
+ # A price list, a coupon, a licence or a policy: the end of the validity does not come before its start. "Valid until"
67
+ # and "Expires" are in due-date-label too, where they are compared with the issue date; each pair is compared on its own.
68
+ - { pattern: "Valid from", group: validity, position: before }
69
+ - { pattern: "Effective date", group: validity, position: before }
70
+ - { pattern: "Effective from", group: validity, position: before }
71
+ - { pattern: "Valid until", group: validity, position: after }
72
+ - { pattern: "Valid to", group: validity, position: after }
73
+ - { pattern: "Expiry date", group: validity, position: after }
74
+ - { pattern: "Expires", group: validity, position: after }
75
+ # A bank or card statement whose period is written as two lines: the period does not end before it starts.
76
+ - { pattern: "Period start", group: statement-period, position: before }
77
+ - { pattern: "Statement period start", group: statement-period, position: before }
78
+ - { pattern: "Period end", group: statement-period, position: after }
79
+ - { pattern: "Statement period end", group: statement-period, position: after }
80
+ # A hotel booking: check-out does not come before check-in. A same-day check-out (a day use) is not reported.
81
+ - { pattern: "Check-in", group: stay, position: before }
82
+ - { pattern: "Check-in date", group: stay, position: before }
83
+ - { pattern: "Check-out", group: stay, position: after }
84
+ - { pattern: "Check-out date", group: stay, position: after }
85
+ # A rental: the return does not come before the pick-up. A bare "Return" is left out: an order's return window or a
86
+ # return policy row is not the rental's drop-off.
87
+ - { pattern: "Pick-up", group: rental, position: before }
88
+ - { pattern: "Pick-up date", group: rental, position: before }
89
+ - { pattern: "Drop-off", group: rental, position: after }
90
+ - { pattern: "Drop-off date", group: rental, position: after }
91
+ - { pattern: "Return date", group: rental, position: after }
92
+ # Free cancellation ends before the stay or the rental starts. Check-in and Pick-up are in stay and rental too; each
93
+ # group is compared on its own.
94
+ - { pattern: "Free cancellation until", group: cancel, position: before }
95
+ - { pattern: "Cancel by", group: cancel, position: before }
96
+ - { pattern: "Check-in", group: cancel, position: after }
97
+ - { pattern: "Check-in date", group: cancel, position: after }
98
+ - { pattern: "Pick-up", group: cancel, position: after }
99
+ - { pattern: "Pick-up date", group: cancel, position: after }
100
+ # A payslip: the pay date comes after the end of the pay period. The pay period line states a period and is compared
101
+ # by its end (dated-span-label).
102
+ - { pattern: "Pay period", group: payroll, position: before }
103
+ - { pattern: "Pay date", group: payroll, position: after }
104
+ # A trip or an expense report: the return does not come before the departure. A same-day return (a day trip) is not
105
+ # reported. "Return date" is left out: a guide's return date for forms or a passport comes before the departure.
106
+ - { pattern: "Departure", group: trip, position: before }
107
+ - { pattern: "Departure date", group: trip, position: before }
108
+ - { pattern: "Return", group: trip, position: after }
109
+ # A purchase order or a delivery note: the delivery does not come before the order. A purchase order's delivery date is
110
+ # the one requested, and it comes after the order too. A bare "Due date" is left out: it is an invoice's payment due
111
+ # date as well (due-date-label).
112
+ - { pattern: "Order date", group: order, position: before }
113
+ - { pattern: "Date of order", group: order, position: before }
114
+ - { pattern: "Date ordered", group: order, position: before }
115
+ - { pattern: "PO date", group: order, position: before }
116
+ - { pattern: "Purchase order date", group: order, position: before }
117
+ - { pattern: "Delivery date", group: order, position: after }
118
+ - { pattern: "Requested delivery date", group: order, position: after }
119
+ - { pattern: "Delivered on", group: order, position: after }
120
+ - { pattern: "Date delivered", group: order, position: after }
121
+ # An academic transcript or a certificate of graduation or completion: graduation and completion come after enrolment,
122
+ # and the certificate is issued after them. The three are read as two pairs: enrolment with graduation or completion,
123
+ # and graduation or completion with the issue date. The enrolment date is not paired with the issue date.
124
+ - { pattern: "Date of enrolment", group: transcript, position: before }
125
+ - { pattern: "Enrolment date", group: transcript, position: before }
126
+ - { pattern: "Date of admission", group: transcript, position: before }
127
+ - { pattern: "Date of graduation", group: transcript, position: after }
128
+ - { pattern: "Graduation date", group: transcript, position: after }
129
+ - { pattern: "Date of completion", group: transcript, position: after }
130
+ - { pattern: "Date of graduation", group: transcript-issue, position: before }
131
+ - { pattern: "Graduation date", group: transcript-issue, position: before }
132
+ - { pattern: "Date of completion", group: transcript-issue, position: before }
133
+ - { pattern: "Date of issue", group: transcript-issue, position: after }
134
+ - { pattern: "Issue date", group: transcript-issue, position: after }
135
+ # An insurance or benefit claim: the claim does not come before the incident, the loss, the injury it claims for.
136
+ - { pattern: "Date of incident", group: incident, position: before }
137
+ - { pattern: "Date of loss", group: incident, position: before }
138
+ - { pattern: "Incident date", group: incident, position: before }
139
+ - { pattern: "Date of injury", group: incident, position: before }
140
+ - { pattern: "Date of claim", group: incident, position: after }
141
+ - { pattern: "Claim date", group: incident, position: after }
142
+ # An annual earnings and tax withholding statement is issued once the tax year has ended or, for a leaver, after the
143
+ # leaving date. "Period covered" is left out: an invoice billed in advance is issued at the start of the period it covers.
144
+ - { pattern: "Tax year", group: tax-statement, position: before }
145
+ - { pattern: "Leaving date", group: tax-statement, position: before }
146
+ - { pattern: "Date of leaving", group: tax-statement, position: before }
147
+ - { pattern: "Issue date", group: tax-statement, position: after }
148
+ - { pattern: "Date of issue", group: tax-statement, position: after }
149
+ # A packing list or a commercial invoice: the goods do not arrive before they are shipped. An estimated date (Estimated
150
+ # arrival, ETA) is only ever the later side. The invoice date is left out: an invoice is dated before or after shipment.
151
+ - { pattern: "On-board date", group: shipping, position: before }
152
+ - { pattern: "Shipment date", group: shipping, position: before }
153
+ - { pattern: "Arrival date", group: shipping, position: after }
154
+ - { pattern: "Estimated arrival", group: shipping, position: after }
155
+ - { pattern: "ETA", group: shipping, position: after }
156
+ # An itemized medical bill or receipt is not issued before the visit it bills.
157
+ - { pattern: "Date of visit", group: medical-visit, position: before }
158
+ - { pattern: "Date issued", group: medical-visit, position: after }
159
+ # A hospital stay: the discharge does not come before the admission. A same-day discharge is not reported. "Date of
160
+ # admission" is in transcript too (a school's); each group is compared on its own.
161
+ - { pattern: "Date of admission", group: hospital-stay, position: before }
162
+ - { pattern: "Date of discharge", group: hospital-stay, position: after }
163
+ # A tenancy's deposit settlement or termination papers: the move-out does not come before the move-in, and notice is
164
+ # given before the move-out. "Move-in date" is in listing and "Notice date" in recall too; each group is compared on its
165
+ # own. Move-in and notice are two groups: in one, a move-out date written once is compared with the first move-in only.
166
+ # A planned date (Planned move-out date) is only ever the later side; a planned move-in date is left out.
167
+ - { pattern: "Move-in date", group: tenancy, position: before }
168
+ - { pattern: "Move-out date", group: tenancy, position: after }
169
+ - { pattern: "Planned move-out date", group: tenancy, position: after }
170
+ - { pattern: "Notice date", group: tenancy-notice, position: before }
171
+ - { pattern: "Date of notice", group: tenancy-notice, position: before }
172
+ - { pattern: "Move-out date", group: tenancy-notice, position: after }
173
+ - { pattern: "Planned move-out date", group: tenancy-notice, position: after }
174
+ # A car's service record or inspection report: the next inspection or service comes after the service date. "Last
175
+ # inspection date" is left out: the last inspection comes before this service.
176
+ - { pattern: "Service date", group: vehicle-service, position: before }
177
+ - { pattern: "Date of service", group: vehicle-service, position: before }
178
+ - { pattern: "Next inspection", group: vehicle-service, position: after }
179
+ - { pattern: "Next inspection due", group: vehicle-service, position: after }
180
+ - { pattern: "Next service due", group: vehicle-service, position: after }
181
+ # A construction or renovation quote, contract or schedule: the work is completed and handed over after it starts. A bare
182
+ # "Start date" pairs only with a completion date (construction-start): it heads a new hire's first day too, and a
183
+ # handover to or from them can come before it. "Date of completion" stays in transcript.
184
+ - { pattern: "Work start", group: construction, position: before }
185
+ - { pattern: "Construction start", group: construction, position: before }
186
+ - { pattern: "Completion date", group: construction, position: after }
187
+ - { pattern: "Expected completion", group: construction, position: after }
188
+ - { pattern: "Handover date", group: construction, position: after }
189
+ - { pattern: "Start date", group: construction-start, position: before }
190
+ - { pattern: "Completion date", group: construction-start, position: after }
191
+ - { pattern: "Expected completion", group: construction-start, position: after }
192
+ # A phone, utility or service contract's term: the service does not end before it starts. A same-day end (one day of
193
+ # service) is not reported. A bare "Start date" and "End date" are left out: a project plan or a timesheet uses them too.
194
+ - { pattern: "Service start date", group: service-period, position: before }
195
+ - { pattern: "Start of service", group: service-period, position: before }
196
+ - { pattern: "Contract start date", group: service-period, position: before }
197
+ - { pattern: "Service end date", group: service-period, position: after }
198
+ - { pattern: "End of service", group: service-period, position: after }
199
+ - { pattern: "Contract end date", group: service-period, position: after }
200
+ # A treasurer's report or an income and expenditure statement: the accounts are audited once the financial year has
201
+ # ended. The year is a period, compared by its last day. Approval and report dates are left out: a budget is approved
202
+ # before its year begins, and an interim report is dated inside the year.
203
+ - { pattern: "Fiscal year", group: fiscal-audit, position: before }
204
+ - { pattern: "Financial year", group: fiscal-audit, position: before }
205
+ - { pattern: "Audited", group: fiscal-audit, position: after }
206
+ - { pattern: "Date audited", group: fiscal-audit, position: after }
207
+ - { pattern: "Audit date", group: fiscal-audit, position: after }
208
+ - { pattern: "Date of audit", group: fiscal-audit, position: after }
209
+ # A property sale's settlement statement: settlement, closing and possession come after the contract. Contract date and
210
+ # Date of contract are in loan too; each group is compared on its own. "Completion date" is left out: construction keeps
211
+ # it away from a contract date.
212
+ - { pattern: "Contract date", group: sale, position: before }
213
+ - { pattern: "Date of contract", group: sale, position: before }
214
+ - { pattern: "Settlement date", group: sale, position: after }
215
+ - { pattern: "Closing date", group: sale, position: after }
216
+ - { pattern: "Possession date", group: sale, position: after }
217
+ # A banquet or meeting room quote is accepted before the event, so it is not valid past the event date. The event's
218
+ # words make the pair: an invoice's or a coupon's validity sits beside no event date. A table is read only when a
219
+ # header column names the quote.
220
+ - { pattern: "Valid until", group: quote-validity, position: before }
221
+ - { pattern: "Quote valid until", group: quote-validity, position: before }
222
+ - { pattern: "Event date", group: quote-validity, position: after }
223
+ - { pattern: "Date of event", group: quote-validity, position: after }
224
+ - { pattern: "Quote", group: quote-validity }
@@ -0,0 +1,12 @@
1
+ # The dated-pair-label words whose line states a period rather than one date ("Reporting period: April 1, 2025 to
2
+ # March 31, 2026"). due-before-issue compares the period's end as the pair's earlier date; a period written without a
3
+ # year is not compared.
4
+ id: dated-span-label
5
+ language: en
6
+ entries:
7
+ - pattern: Reporting period
8
+ - pattern: Period covered
9
+ - pattern: Pay period
10
+ - pattern: Tax year
11
+ - pattern: Fiscal year
12
+ - pattern: Financial year
@@ -0,0 +1,26 @@
1
+ # What a deductible or a limit is stated for (deductible-exceeds-limit). group names the basis; amounts on the same basis
2
+ # are compared. weight orders the bases that nest: a claim holds one item or more, so an excess per claim is compared with
3
+ # a limit per item. A basis with no weight (a day, a year) is compared only with itself.
4
+ id: deductible-basis
5
+ language: en
6
+ entries:
7
+ - { pattern: a claim, group: claim, weight: 2 }
8
+ - { pattern: per claim, group: claim, weight: 2 }
9
+ - { pattern: each claim, group: claim, weight: 2 }
10
+ - { pattern: a visit, group: claim, weight: 2 }
11
+ - { pattern: per visit, group: claim, weight: 2 }
12
+ - { pattern: each visit, group: claim, weight: 2 }
13
+ - { pattern: an incident, group: claim, weight: 2 }
14
+ - { pattern: per incident, group: claim, weight: 2 }
15
+ - { pattern: each incident, group: claim, weight: 2 }
16
+ - { pattern: an item, group: item, weight: 1 }
17
+ - { pattern: a single item, group: item, weight: 1 }
18
+ - { pattern: per item, group: item, weight: 1 }
19
+ - { pattern: each item, group: item, weight: 1 }
20
+ - { pattern: per article, group: item, weight: 1 }
21
+ - { pattern: a day, group: day }
22
+ - { pattern: per day, group: day }
23
+ - { pattern: each day, group: day }
24
+ - { pattern: a year, group: year }
25
+ - { pattern: per year, group: year }
26
+ - { pattern: each year, group: year }