Grammalecte  Hex Artifact Content

Artifact 223b361257b272282fda4e2bb9eae839db3cbc466295a5d12c5f816ca33854b4:


0000: 57 52 49 54 49 4e 47 20 52 55 4c 45 53 20 46 4f  WRITING RULES FO
0010: 52 20 47 52 41 4d 4d 41 4c 45 43 54 45 0a 0a 4e  R GRAMMALECTE..N
0020: 6f 74 65 3a 20 54 68 69 73 20 64 6f 63 75 6d 65  ote: This docume
0030: 6e 74 61 74 69 6f 6e 20 69 73 20 6f 62 73 6f 6c  ntation is obsol
0040: 65 74 65 20 72 69 67 68 74 20 6e 6f 77 2e 0a 0a  ete right now...
0050: 23 20 50 72 69 6e 63 69 70 6c 65 73 20 23 0a 0a  # Principles #..
0060: 47 72 61 6d 6d 61 6c 65 63 74 65 20 69 73 20 61  Grammalecte is a
0070: 20 62 69 2d 70 61 73 73 65 73 20 67 72 61 6d 6d   bi-passes gramm
0080: 61 72 20 63 68 65 63 6b 65 72 20 65 6e 67 69 6e  ar checker engin
0090: 65 2e 20 4f 6e 20 74 68 65 20 66 69 72 73 74 20  e. On the first 
00a0: 70 61 73 73 2c 20 74 68 65 0a 65 6e 67 69 6e 65  pass, the.engine
00b0: 20 63 68 65 63 6b 73 20 74 68 65 20 74 65 78 74   checks the text
00c0: 20 70 61 72 61 67 72 61 70 68 20 62 79 20 70 61   paragraph by pa
00d0: 72 61 67 72 61 70 68 2e 20 4f 6e 20 74 68 65 20  ragraph. On the 
00e0: 73 65 63 6f 6e 64 20 70 61 73 73 65 2c 20 74 68  second passe, th
00f0: 65 20 65 6e 67 69 6e 65 0a 63 68 65 63 6b 20 74  e engine.check t
0100: 68 65 20 74 65 78 74 20 73 65 6e 74 65 6e 63 65  he text sentence
0110: 20 62 79 20 73 65 6e 74 65 6e 63 65 2e 0a 0a 54   by sentence...T
0120: 68 65 20 63 6f 6d 6d 61 6e 64 20 74 6f 20 73 77  he command to sw
0130: 69 74 63 68 20 74 6f 20 74 68 65 20 73 65 63 6f  itch to the seco
0140: 6e 64 20 70 61 73 73 20 69 73 20 60 5b 2b 2b 5d  nd pass is `[++]
0150: 60 2e 0a 0a 49 6e 20 65 61 63 68 20 70 61 73 73  `...In each pass
0160: 2c 20 79 6f 75 20 63 61 6e 20 77 72 69 74 65 20  , you can write 
0170: 61 73 20 6d 61 6e 79 20 72 75 6c 65 73 20 61 73  as many rules as
0180: 20 79 6f 75 20 6e 65 65 64 2e 0a 0a 41 20 72 75   you need...A ru
0190: 6c 65 20 69 73 20 64 65 66 69 6e 65 64 20 62 79  le is defined by
01a0: 3a 0a 0a 2a 20 5b 6f 70 74 69 6f 6e 61 6c 5d 20  :..* [optional] 
01b0: 66 6c 61 67 73 20 e2 80 9c 4c 43 52 e2 80 9d 20  flags ...LCR... 
01c0: 66 6f 72 20 74 68 65 20 72 65 67 65 78 20 77 6f  for the regex wo
01d0: 72 64 20 62 6f 75 6e 64 61 72 69 65 73 20 61 6e  rd boundaries an
01e0: 64 20 63 61 73 65 20 73 65 6e 73 69 74 69 76 65  d case sensitive
01f0: 6e 65 73 73 0a 2a 20 61 20 72 65 67 65 78 20 70  ness.* a regex p
0200: 61 74 74 65 72 6e 20 74 72 69 67 67 65 72 0a 2a  attern trigger.*
0210: 20 61 20 6c 69 73 74 20 6f 66 20 61 63 74 69 6f   a list of actio
0220: 6e 73 20 28 63 61 6e e2 80 99 74 20 62 65 20 65  ns (can...t be e
0230: 6d 70 74 79 29 0a 2a 20 5b 6f 70 74 69 6f 6e 61  mpty).* [optiona
0240: 6c 5d 20 75 73 65 72 20 6f 70 74 69 6f 6e 20 6e  l] user option n
0250: 61 6d 65 20 66 6f 72 20 61 63 74 69 76 61 74 69  ame for activati
0260: 6e 67 2f 64 69 73 61 63 74 69 76 61 74 69 6e 67  ng/disactivating
0270: 20 74 68 65 20 72 75 6c 65 0a 2a 20 5b 6f 70 74   the rule.* [opt
0280: 69 6f 6e 61 6c 5d 20 72 75 6c 65 20 6e 61 6d 65  ional] rule name
0290: 0a 0a 54 68 65 72 65 20 69 73 20 6e 6f 20 6c 69  ..There is no li
02a0: 6d 69 74 20 74 6f 20 74 68 65 20 6e 75 6d 62 65  mit to the numbe
02b0: 72 20 6f 66 20 61 63 74 69 6f 6e 73 20 61 6e 64  r of actions and
02c0: 20 74 68 65 20 74 79 70 65 20 6f 66 20 61 63 74   the type of act
02d0: 69 6f 6e 73 20 61 20 72 75 6c 65 20 63 61 6e 0a  ions a rule can.
02e0: 6c 61 75 6e 63 68 2e 20 45 61 63 68 20 61 63 74  launch. Each act
02f0: 69 6f 6e 20 68 61 73 20 69 74 73 20 6f 77 6e 20  ion has its own 
0300: 63 6f 6e 64 69 74 69 6f 6e 20 74 6f 20 62 65 20  condition to be 
0310: 74 72 69 67 67 65 72 65 64 2e 0a 0a 54 68 65 72  triggered...Ther
0320: 65 20 61 72 65 20 74 68 72 65 65 20 6b 69 6e 64  e are three kind
0330: 20 6f 66 20 61 63 74 69 6f 6e 73 3a 0a 0a 2a 20   of actions:..* 
0340: 45 72 72 6f 72 20 77 61 72 6e 69 6e 67 2c 20 77  Error warning, w
0350: 69 74 68 20 61 20 6d 65 73 73 61 67 65 2c 20 61  ith a message, a
0360: 6e 64 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 73 75  nd optionally su
0370: 67 67 65 73 74 69 6f 6e 73 2c 20 61 6e 64 20 6f  ggestions, and o
0380: 70 74 69 6f 6e 61 6c 6c 79 20 61 6e 20 55 52 4c  ptionally an URL
0390: 0a 2a 20 54 65 78 74 20 74 72 61 6e 73 66 6f 72  .* Text transfor
03a0: 6d 61 74 69 6f 6e 2c 20 6d 6f 64 69 66 79 69 6e  mation, modifyin
03b0: 67 20 69 6e 74 65 72 6e 61 6c 6c 79 20 74 68 65  g internally the
03c0: 20 63 68 65 63 6b 65 64 20 74 65 78 74 0a 2a 20   checked text.* 
03d0: 44 69 73 61 6d 62 69 67 75 61 74 69 6f 6e 20 61  Disambiguation a
03e0: 63 74 69 6f 6e 2c 20 73 65 74 74 69 6e 67 20 74  ction, setting t
03f0: 61 67 73 20 6f 6e 20 61 20 70 6f 73 69 74 69 6f  ags on a positio
0400: 6e 0a 0a 0a 54 68 65 20 72 75 6c 65 73 20 66 69  n...The rules fi
0410: 6c 65 20 66 6f 72 20 79 6f 75 72 20 6c 61 6e 67  le for your lang
0420: 75 61 67 65 20 6d 75 73 74 20 62 65 20 6e 61 6d  uage must be nam
0430: 65 64 20 e2 80 9c 72 75 6c 65 73 2e 67 72 78 e2  ed ...rules.grx.
0440: 80 9d 2e 0a 54 68 65 20 73 65 74 74 69 6e 67 73  ....The settings
0450: 20 66 69 6c 65 20 6d 75 73 74 20 62 65 20 6e 61   file must be na
0460: 6d 65 64 20 e2 80 9c 63 6f 6e 66 69 67 2e 69 6e  med ...config.in
0470: 69 e2 80 9d 2e 0a 0a 41 6c 6c 20 74 68 65 73 65  i......All these
0480: 20 66 69 6c 65 73 20 61 72 65 20 73 69 6d 70 6c   files are simpl
0490: 65 20 75 74 66 2d 38 20 74 65 78 74 20 66 69 6c  e utf-8 text fil
04a0: 65 2e 0a 55 54 46 2d 38 20 69 73 20 6d 61 6e 64  e..UTF-8 is mand
04b0: 61 74 6f 72 79 2e 0a 0a 0a 0a 23 20 52 75 6c 65  atory.....# Rule
04c0: 20 73 79 6e 74 61 78 20 23 0a 0a 20 20 20 20 20   syntax #..     
04d0: 20 20 20 5f 5f 4c 43 52 2f 6f 70 74 69 6f 6e 28     __LCR/option(
04e0: 72 75 6c 65 6e 61 6d 65 29 5f 5f 20 20 70 61 74  rulename)__  pat
04f0: 74 65 72 6e 0a 20 20 20 20 20 20 20 20 20 20 20  tern.           
0500: 20 3c 3c 2d 20 63 6f 6e 64 69 74 69 6f 6e 20 2d   <<- condition -
0510: 3e 3e 20 65 72 72 6f 72 5f 73 75 67 67 65 73 74  >> error_suggest
0520: 69 6f 6e 73 20 20 23 20 6d 65 73 73 61 67 65 5f  ions  # message_
0530: 65 72 72 6f 72 7c 68 74 74 70 3a 2f 2f 61 77 65  error|http://awe
0540: 62 73 69 74 65 2e 6e 65 74 2e 2e 2e 0a 20 20 20  bsite.net....   
0550: 20 20 20 20 20 20 20 20 20 3c 3c 2d 20 63 6f 6e           <<- con
0560: 64 69 74 69 6f 6e 20 7e 3e 3e 20 74 65 78 74 5f  dition ~>> text_
0570: 72 65 77 72 69 74 69 6e 67 0a 20 20 20 20 20 20  rewriting.      
0580: 20 20 20 20 20 20 3c 3c 2d 20 63 6f 6e 64 69 74        <<- condit
0590: 69 6f 6e 20 3d 3e 3e 20 63 6f 6d 6d 61 6e 64 73  ion =>> commands
05a0: 5f 66 6f 72 5f 64 69 73 61 6d 62 69 67 75 61 74  _for_disambiguat
05b0: 69 6f 6e 0a 20 20 20 20 20 20 20 20 20 20 20 20  ion.            
05c0: 2e 2e 2e 0a 0a 50 61 74 74 65 72 6e 73 20 61 72  .....Patterns ar
05d0: 65 20 77 72 69 74 74 65 6e 20 77 69 74 68 20 74  e written with t
05e0: 68 65 20 50 79 74 68 6f 6e 20 73 79 6e 74 61 78  he Python syntax
05f0: 20 66 6f 72 20 72 65 67 75 6c 61 72 20 65 78 70   for regular exp
0600: 72 65 73 73 69 6f 6e 73 3a 0a 68 74 74 70 3a 2f  ressions:.http:/
0610: 2f 64 6f 63 73 2e 70 79 74 68 6f 6e 2e 6f 72 67  /docs.python.org
0620: 2f 6c 69 62 72 61 72 79 2f 72 65 2e 68 74 6d 6c  /library/re.html
0630: 0a 0a 54 68 65 72 65 20 63 61 6e 20 62 65 20 6f  ..There can be o
0640: 6e 65 20 6f 72 20 73 65 76 65 72 61 6c 20 61 63  ne or several ac
0650: 74 69 6f 6e 73 20 66 6f 72 20 65 61 63 68 20 72  tions for each r
0660: 75 6c 65 2c 20 65 78 65 63 75 74 65 64 20 74 68  ule, executed th
0670: 65 20 6f 72 64 65 72 20 74 68 65 79 20 61 72 65  e order they are
0680: 0a 77 72 69 74 74 65 6e 2e 0a 0a 43 6f 6e 64 69  .written...Condi
0690: 74 69 6f 6e 73 20 61 72 65 20 6f 70 74 69 6f 6e  tions are option
06a0: 61 6c 2c 20 69 2e 65 2e 3a 0a 0a 20 20 20 20 20  al, i.e.:..     
06b0: 20 20 20 3c 3c 2d 20 7e 3e 3e 20 72 65 70 6c 61     <<- ~>> repla
06c0: 63 65 6d 65 6e 74 0a 0a 0a 4c 43 52 20 66 6c 61  cement...LCR fla
06d0: 67 73 20 6d 65 61 6e 73 3a 0a 0a 2a 20 4c 3a 20  gs means:..* L: 
06e0: 4c 65 66 74 20 62 6f 75 6e 64 61 72 79 20 66 6f  Left boundary fo
06f0: 72 20 74 68 65 20 72 65 67 65 78 0a 2a 20 43 3a  r the regex.* C:
0700: 20 43 61 73 65 20 73 65 6e 73 69 74 69 76 65 6e   Case sensitiven
0710: 65 73 73 0a 2a 20 52 3a 20 52 69 67 68 74 20 62  ess.* R: Right b
0720: 6f 75 6e 64 61 72 79 20 66 6f 72 20 74 68 65 20  oundary for the 
0730: 72 65 67 65 78 0a 0a 4c 65 66 74 20 62 6f 75 6e  regex..Left boun
0740: 64 61 72 79 20 28 4c 29 3a 0a 0a 3e 20 20 20 60  dary (L):..>   `
0750: 5b 60 20 20 20 20 20 77 6f 72 64 20 62 6f 75 6e  [`     word boun
0760: 64 61 72 79 0a 0a 3e 20 20 20 60 3c 60 20 20 20  dary..>   `<`   
0770: 20 20 6e 6f 20 77 6f 72 64 20 62 6f 75 6e 64 61    no word bounda
0780: 72 79 0a 0a 72 69 67 68 74 20 62 6f 75 6e 64 61  ry..right bounda
0790: 72 79 20 28 52 29 3a 0a 0a 3e 20 20 20 60 5d 60  ry (R):..>   `]`
07a0: 20 20 20 20 20 77 6f 72 64 20 62 6f 75 6e 64 61       word bounda
07b0: 72 79 0a 0a 3e 20 20 20 60 3e 60 20 20 20 20 20  ry..>   `>`     
07c0: 6e 6f 20 77 6f 72 64 20 62 6f 75 6e 64 61 72 79  no word boundary
07d0: 0a 0a 43 61 73 65 20 73 65 6e 73 69 74 69 76 65  ..Case sensitive
07e0: 6e 65 73 73 20 28 43 29 3a 0a 0a 3e 20 20 20 60  ness (C):..>   `
07f0: 69 60 20 20 20 20 20 63 61 73 65 20 69 6e 73 65  i`     case inse
0800: 6e 73 69 74 69 76 65 0a 0a 3e 20 20 20 60 73 60  nsitive..>   `s`
0810: 20 20 20 20 20 63 61 73 65 20 73 65 6e 73 69 74       case sensit
0820: 69 76 65 0a 0a 3e 20 20 20 60 75 60 20 20 20 20  ive..>   `u`    
0830: 20 75 70 70 65 72 63 61 73 65 20 61 6c 6c 6f 77   uppercase allow
0840: 65 64 20 66 6f 72 20 6c 6f 77 65 72 63 61 73 65  ed for lowercase
0850: 20 63 68 61 72 61 63 74 65 72 73 0a 0a 3e 3e 20   characters..>> 
0860: 20 20 20 20 20 20 20 20 20 69 2e 65 2e 3a 20 20           i.e.:  
0870: 22 57 6f 72 64 22 20 20 62 65 63 6f 6d 65 73 20  "Word"  becomes 
0880: 20 22 57 5b 6f 4f 5d 5b 72 52 5d 5b 64 44 5d 22   "W[oO][rR][dD]"
0890: 0a 0a 45 78 61 6d 70 6c 65 73 3a 0a 0a 20 20 20  ..Examples:..   
08a0: 20 20 20 20 20 5f 5f 5b 69 5d 5f 5f 20 20 70 61       __[i]__  pa
08b0: 74 74 65 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f  ttern.        __
08c0: 3c 73 5d 5f 5f 20 20 70 61 74 74 65 72 6e 0a 20  <s]__  pattern. 
08d0: 20 20 20 20 20 20 20 5f 5f 5b 75 3e 5f 5f 20 20         __[u>__  
08e0: 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20 20 20  pattern.        
08f0: 5f 5f 3c 73 3e 5f 5f 20 20 70 61 74 74 65 72 6e  __<s>__  pattern
0900: 0a 0a 0a 55 73 65 72 20 6f 70 74 69 6f 6e 20 61  ...User option a
0910: 63 74 69 76 61 74 69 6e 67 2f 64 69 73 61 63 74  ctivating/disact
0920: 69 76 61 74 69 6e 67 20 69 73 20 70 6f 73 73 69  ivating is possi
0930: 62 6c 65 20 77 69 74 68 20 61 6e 20 6f 70 74 69  ble with an opti
0940: 6f 6e 20 6e 61 6d 65 20 70 6c 61 63 65 64 0a 6a  on name placed.j
0950: 75 73 74 20 61 66 74 65 72 20 74 68 65 20 4c 43  ust after the LC
0960: 52 20 66 6c 61 67 73 2c 20 69 2e 65 2e 3a 0a 0a  R flags, i.e.:..
0970: 20 20 20 20 20 20 20 20 5f 5f 5b 69 5d 2f 6f 70          __[i]/op
0980: 74 69 6f 6e 31 5f 5f 20 20 70 61 74 74 65 72 6e  tion1__  pattern
0990: 0a 20 20 20 20 20 20 20 20 5f 5f 5b 75 5d 2f 6f  .        __[u]/o
09a0: 70 74 69 6f 6e 32 5f 5f 20 20 70 61 74 74 65 72  ption2__  patter
09b0: 6e 0a 20 20 20 20 20 20 20 20 5f 5f 5b 73 3e 2f  n.        __[s>/
09c0: 6f 70 74 69 6f 6e 31 5f 5f 20 20 70 61 74 74 65  option1__  patte
09d0: 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f 3c 75 3e  rn.        __<u>
09e0: 2f 6f 70 74 69 6f 6e 33 5f 5f 20 20 70 61 74 74  /option3__  patt
09f0: 65 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f 3c 69  ern.        __<i
0a00: 3e 2f 6f 70 74 69 6f 6e 33 5f 5f 20 20 70 61 74  >/option3__  pat
0a10: 74 65 72 6e 0a 0a 52 75 6c 65 73 20 63 61 6e 20  tern..Rules can 
0a20: 62 65 20 6e 61 6d 65 64 3a 0a 0a 20 20 20 20 20  be named:..     
0a30: 20 20 20 5f 5f 5b 69 5d 2f 6f 70 74 69 6f 6e 31     __[i]/option1
0a40: 28 6e 61 6d 65 31 29 5f 5f 20 20 70 61 74 74 65  (name1)__  patte
0a50: 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f 5b 75 5d  rn.        __[u]
0a60: 2f 6f 70 74 69 6f 6e 32 28 6e 61 6d 65 32 29 5f  /option2(name2)_
0a70: 5f 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20  _  pattern.     
0a80: 20 20 20 5f 5f 5b 73 3e 2f 6f 70 74 69 6f 6e 31     __[s>/option1
0a90: 28 6e 61 6d 65 33 29 5f 5f 20 20 70 61 74 74 65  (name3)__  patte
0aa0: 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f 3c 75 3e  rn.        __<u>
0ab0: 28 6e 61 6d 65 34 29 5f 5f 20 20 20 20 20 20 20  (name4)__       
0ac0: 20 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20     pattern.     
0ad0: 20 20 20 5f 5f 3c 69 3e 28 6e 61 6d 65 35 29 5f     __<i>(name5)_
0ae0: 5f 20 20 20 20 20 20 20 20 20 20 70 61 74 74 65  _          patte
0af0: 72 6e 0a 0a 45 61 63 68 20 72 75 6c 65 20 6e 61  rn..Each rule na
0b00: 6d 65 20 6d 75 73 74 20 62 65 20 75 6e 69 71 75  me must be uniqu
0b10: 65 2e 0a 0a 0a 54 68 65 20 4c 43 52 20 66 6c 61  e....The LCR fla
0b20: 67 73 20 61 72 65 20 61 6c 73 6f 20 6f 70 74 69  gs are also opti
0b30: 6f 6e 61 6c 2e 20 49 66 20 79 6f 75 20 64 6f 6e  onal. If you don
0b40: e2 80 99 74 20 73 65 74 20 74 68 65 73 65 20 66  ...t set these f
0b50: 6c 61 67 73 2c 20 74 68 65 20 64 65 66 61 75 6c  lags, the defaul
0b60: 74 20 4c 43 52 0a 66 6c 61 67 73 20 77 69 6c 6c  t LCR.flags will
0b70: 20 62 65 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f   be:..        __
0b80: 5b 69 5d 5f 5f 0a 0a 45 78 61 6d 70 6c 65 2e 20  [i]__..Example. 
0b90: 52 65 70 6f 72 74 20 e2 80 9c 66 6f 6f e2 80 9d  Report ...foo...
0ba0: 20 69 6e 20 74 68 65 20 74 65 78 74 20 61 6e 64   in the text and
0bb0: 20 73 75 67 67 65 73 74 20 22 62 61 72 22 3a 0a   suggest "bar":.
0bc0: 0a 20 20 20 20 20 20 20 20 66 6f 6f 20 3c 3c 2d  .        foo <<-
0bd0: 20 2d 3e 3e 20 62 61 72 20 23 20 55 73 65 20 62   ->> bar # Use b
0be0: 61 72 20 69 6e 73 74 65 61 64 20 6f 66 20 66 6f  ar instead of fo
0bf0: 6f 2e 0a 0a 45 78 61 6d 70 6c 65 2e 20 52 65 63  o...Example. Rec
0c00: 6f 67 6e 69 7a 65 20 61 6e 64 20 73 75 67 67 65  ognize and sugge
0c10: 73 74 20 6d 69 73 73 69 6e 67 20 68 79 70 68 65  st missing hyphe
0c20: 6e 20 61 6e 64 20 72 65 77 72 69 74 65 20 69 6e  n and rewrite in
0c30: 74 65 72 6e 61 6c 6c 79 20 74 68 65 20 74 65 78  ternally the tex
0c40: 74 0a 77 69 74 68 20 74 68 65 20 68 79 70 68 65  t.with the hyphe
0c50: 6e 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f 5b 73  n:..        __[s
0c60: 5d 5f 5f 20 66 6f 6f 20 62 61 72 0a 20 20 20 20  ]__ foo bar.    
0c70: 20 20 20 20 20 20 20 20 3c 3c 2d 20 2d 3e 3e 20          <<- ->> 
0c80: 66 6f 6f 2d 62 61 72 20 23 20 4d 69 73 73 69 6e  foo-bar # Missin
0c90: 67 20 68 79 70 68 65 6e 2e 0a 20 20 20 20 20 20  g hyphen..      
0ca0: 20 20 20 20 20 20 3c 3c 2d 20 7e 3e 3e 20 66 6f        <<- ~>> fo
0cb0: 6f 2d 62 61 72 0a 0a 0a 23 23 20 53 69 6d 70 6c  o-bar...## Simpl
0cc0: 65 2d 6c 69 6e 65 20 6f 72 20 6d 75 6c 74 69 2d  e-line or multi-
0cd0: 6c 69 6e 65 20 72 75 6c 65 73 20 23 23 0a 0a 52  line rules ##..R
0ce0: 75 6c 65 73 20 63 61 6e 20 62 65 20 62 72 65 61  ules can be brea
0cf0: 6b 20 74 6f 20 6d 75 6c 74 69 70 6c 65 20 6c 69  k to multiple li
0d00: 6e 65 73 20 62 79 20 6c 65 61 64 69 6e 67 20 74  nes by leading t
0d10: 61 62 75 6c 61 74 6f 72 73 20 6f 72 20 73 70 61  abulators or spa
0d20: 63 65 73 2e 0a 59 6f 75 20 73 68 6f 75 6c 64 20  ces..You should 
0d30: 75 73 65 20 34 20 73 70 61 63 65 73 2e 0a 0a 45  use 4 spaces...E
0d40: 78 61 6d 70 6c 65 73 3a 0a 0a 20 20 20 20 20 20  xamples:..      
0d50: 20 20 5f 5f 3c 73 3e 5f 5f 20 70 61 74 74 65 72    __<s>__ patter
0d60: 6e 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c 3c  n.            <<
0d70: 2d 20 63 6f 6e 64 69 74 69 6f 6e 20 2d 3e 3e 20  - condition ->> 
0d80: 72 65 70 6c 61 63 65 6d 65 6e 74 0a 20 20 20 20  replacement.    
0d90: 20 20 20 20 20 20 20 20 23 20 6d 65 73 73 61 67          # messag
0da0: 65 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c 3c  e.            <<
0db0: 2d 20 63 6f 6e 64 69 74 69 6f 6e 20 2d 3e 3e 20  - condition ->> 
0dc0: 73 75 67 67 65 73 74 69 6f 6e 20 23 20 6d 65 73  suggestion # mes
0dd0: 73 61 67 65 0a 20 20 20 20 20 20 20 20 20 20 20  sage.           
0de0: 20 3c 3c 2d 20 63 6f 6e 64 69 74 69 6f 6e 0a 20   <<- condition. 
0df0: 20 20 20 20 20 20 20 20 20 20 20 7e 3e 3e 20 74             ~>> t
0e00: 65 78 74 5f 72 65 77 72 69 74 69 6e 67 0a 20 20  ext_rewriting.  
0e10: 20 20 20 20 20 20 20 20 20 20 3c 3c 2d 20 3d 3e            <<- =>
0e20: 3e 20 64 69 73 61 6d 62 69 67 75 61 74 69 6f 6e  > disambiguation
0e30: 0a 0a 20 20 20 20 20 20 20 20 5f 5f 3c 73 3e 5f  ..        __<s>_
0e40: 5f 20 70 61 74 74 65 72 6e 20 3c 3c 2d 20 63 6f  _ pattern <<- co
0e50: 6e 64 69 74 69 6f 6e 20 2d 3e 3e 20 72 65 70 6c  ndition ->> repl
0e60: 61 63 65 6d 65 6e 74 20 23 20 6d 65 73 73 61 67  acement # messag
0e70: 65 0a 0a 0a 23 23 20 43 6f 6d 6d 65 6e 74 73 20  e...## Comments 
0e80: 23 23 0a 0a 4c 69 6e 65 73 20 62 65 67 69 6e 6e  ##..Lines beginn
0e90: 69 6e 67 20 77 69 74 68 20 23 20 61 72 65 20 63  ing with # are c
0ea0: 6f 6d 6d 65 6e 74 73 2e 0a 0a 0a 23 23 20 45 6e  omments....## En
0eb0: 64 20 6f 66 20 66 69 6c 65 20 23 23 0a 0a 57 69  d of file ##..Wi
0ec0: 74 68 20 74 68 65 20 63 6f 6d 6d 61 6e 64 3a 0a  th the command:.
0ed0: 0a 20 20 20 20 20 20 20 20 23 45 4e 44 0a 0a 61  .        #END..a
0ee0: 74 20 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20  t the beginning 
0ef0: 6f 66 20 61 20 6c 69 6e 65 2c 20 74 68 65 20 63  of a line, the c
0f00: 6f 6d 70 69 6c 65 72 20 77 6f 6e e2 80 99 74 20  ompiler won...t 
0f10: 67 6f 20 66 75 72 74 68 65 72 2e 0a 57 68 61 74  go further..What
0f20: 65 76 65 72 20 69 73 20 77 72 69 74 74 65 6e 20  ever is written 
0f30: 61 66 74 65 72 20 77 69 6c 6c 20 62 65 20 63 6f  after will be co
0f40: 6e 73 69 64 65 72 65 64 20 61 73 20 63 6f 6d 6d  nsidered as comm
0f50: 65 6e 74 73 2e 0a 0a 0a 23 23 20 57 68 69 74 65  ents....## White
0f60: 73 70 61 63 65 73 20 61 74 20 74 68 65 20 62 6f  spaces at the bo
0f70: 72 64 65 72 20 6f 66 20 70 61 74 74 65 72 6e 73  rder of patterns
0f80: 20 6f 72 20 73 75 67 67 65 73 74 69 6f 6e 73 20   or suggestions 
0f90: 23 23 0a 0a 45 78 61 6d 70 6c 65 3a 20 52 65 63  ##..Example: Rec
0fa0: 6f 67 6e 69 7a 65 20 64 6f 75 62 6c 65 20 6f 72  ognize double or
0fb0: 20 6d 6f 72 65 20 73 70 61 63 65 73 20 61 6e 64   more spaces and
0fc0: 20 73 75 67 67 65 73 74 73 20 61 20 73 69 6e 67   suggests a sing
0fd0: 6c 65 20 73 70 61 63 65 3a 0a 0a 20 20 20 20 20  le space:..     
0fe0: 20 20 20 5f 5f 3c 73 3e 5f 5f 20 20 22 20 20 2b     __<s>__  "  +
0ff0: 22 20 3c 3c 2d 20 2d 3e 3e 20 22 20 22 20 20 20  " <<- ->> " "   
1000: 20 20 20 23 20 45 78 74 72 61 20 73 70 61 63 65     # Extra space
1010: 28 73 29 2e 0a 0a 41 53 43 49 49 20 22 20 63 68  (s)...ASCII " ch
1020: 61 72 61 63 74 65 72 73 20 70 72 6f 74 65 63 74  aracters protect
1030: 20 73 70 61 63 65 73 20 69 6e 20 74 68 65 20 70   spaces in the p
1040: 61 74 74 65 72 6e 20 61 6e 64 20 69 6e 20 74 68  attern and in th
1050: 65 20 72 65 70 6c 61 63 65 6d 65 6e 74 20 74 65  e replacement te
1060: 78 74 2e 0a 0a 0a 23 23 20 50 61 74 74 65 72 6e  xt....## Pattern
1070: 20 67 72 6f 75 70 73 20 61 6e 64 20 62 61 63 6b   groups and back
1080: 20 72 65 66 65 72 65 6e 63 65 73 20 23 23 0a 0a   references ##..
1090: 49 74 20 69 73 20 75 73 75 61 6c 6c 79 20 75 73  It is usually us
10a0: 65 66 75 6c 20 74 6f 20 72 65 74 72 69 65 76 65  eful to retrieve
10b0: 20 70 61 72 74 73 20 6f 66 20 74 68 65 20 6d 61   parts of the ma
10c0: 74 63 68 65 64 20 70 61 74 74 65 72 6e 2e 20 57  tched pattern. W
10d0: 65 20 73 69 6d 70 6c 79 20 75 73 65 0a 70 61 72  e simply use.par
10e0: 65 6e 74 68 65 73 69 73 20 69 6e 20 70 61 74 74  enthesis in patt
10f0: 65 72 6e 20 74 6f 20 67 65 74 20 67 72 6f 75 70  ern to get group
1100: 73 20 77 69 74 68 20 62 61 63 6b 20 72 65 66 65  s with back refe
1110: 72 65 6e 63 65 73 2e 0a 0a 45 78 61 6d 70 6c 65  rences...Example
1120: 2e 20 53 75 67 67 65 73 74 20 61 20 77 6f 72 64  . Suggest a word
1130: 20 77 69 74 68 20 63 6f 72 72 65 63 74 20 71 75   with correct qu
1140: 6f 74 61 74 69 6f 6e 20 6d 61 72 6b 73 3a 0a 0a  otation marks:..
1150: 20 20 20 20 20 20 20 20 5c 22 28 5c 77 2b 29 5c          \"(\w+)\
1160: 22 20 3c 3c 2d 20 2d 3e 3e 20 e2 80 9c 5c 31 e2  " <<- ->> ...\1.
1170: 80 9d 20 20 20 20 20 20 23 20 43 6f 72 72 65 63  ..      # Correc
1180: 74 20 71 75 6f 74 61 74 69 6f 6e 20 6d 61 72 6b  t quotation mark
1190: 73 2e 0a 0a 45 78 61 6d 70 6c 65 2e 20 53 75 67  s...Example. Sug
11a0: 67 65 73 74 20 74 68 65 20 6d 69 73 73 69 6e 67  gest the missing
11b0: 20 73 70 61 63 65 20 61 66 74 65 72 20 74 68 65   space after the
11c0: 20 21 2c 20 3f 20 6f 72 20 2e 20 73 69 67 6e 73   !, ? or . signs
11d0: 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f 3c 69 5d  :..        __<i]
11e0: 5f 5f 20 5c 62 28 5b 3f 21 2e 5d 29 28 5b 41 2d  __ \b([?!.])([A-
11f0: 5a 5d 2b 29 20 3c 3c 2d 20 2d 3e 3e 20 5c 31 20  Z]+) <<- ->> \1 
1200: 5c 32 20 20 20 20 20 23 20 4d 69 73 73 69 6e 67  \2     # Missing
1210: 20 73 70 61 63 65 3f 0a 0a 45 78 61 6d 70 6c 65   space?..Example
1220: 2e 20 42 61 63 6b 20 72 65 66 65 72 65 6e 63 65  . Back reference
1230: 20 69 6e 20 6d 65 73 73 61 67 65 73 2e 0a 0a 20   in messages... 
1240: 20 20 20 20 20 20 20 28 66 6f 6f 6f 29 20 62 61         (fooo) ba
1250: 72 20 3c 3c 2d 20 2d 3e 3e 20 66 6f 6f 20 20 20  r <<- ->> foo   
1260: 20 20 20 23 20 e2 80 9c 5c 31 e2 80 9d 20 73 68     # ...\1... sh
1270: 6f 75 6c 64 20 62 65 3a 0a 0a 0a 23 23 20 4e 61  ould be:...## Na
1280: 6d 65 20 64 65 66 69 6e 69 74 69 6f 6e 73 20 23  me definitions #
1290: 23 0a 0a 47 72 61 6d 6d 61 6c 65 63 74 65 20 73  #..Grammalecte s
12a0: 75 70 70 6f 72 74 73 20 6e 61 6d 65 20 64 65 66  upports name def
12b0: 69 6e 69 74 69 6f 6e 73 20 74 6f 20 73 69 6d 70  initions to simp
12c0: 6c 69 66 79 20 74 68 65 20 64 65 73 63 72 69 70  lify the descrip
12d0: 74 69 6f 6e 20 6f 66 20 74 68 65 0a 63 6f 6d 70  tion of the.comp
12e0: 6c 65 78 20 72 75 6c 65 73 2e 0a 0a 45 78 61 6d  lex rules...Exam
12f0: 70 6c 65 3a 0a 0a 20 20 20 20 20 20 20 20 44 45  ple:..        DE
1300: 46 3a 20 6e 61 6d 65 20 70 61 74 74 65 72 6e 0a  F: name pattern.
1310: 0a 55 73 61 67 65 20 69 6e 20 74 68 65 20 72 75  .Usage in the ru
1320: 6c 65 73 3a 0a 0a 20 20 20 20 20 20 20 20 28 7b  les:..        ({
1330: 6e 61 6d 65 7d 29 20 28 5c 77 2b 29 20 2d 3e 3e  name}) (\w+) ->>
1340: 20 22 5c 31 2d 5c 32 22 20 23 20 4d 69 73 73 69   "\1-\2" # Missi
1350: 6e 67 20 68 79 70 68 65 6e 3f 0a 0a 0a 23 23 20  ng hyphen?...## 
1360: 4d 75 6c 74 69 70 6c 65 20 73 75 67 67 65 73 74  Multiple suggest
1370: 69 6f 6e 73 20 23 23 0a 0a 55 73 65 20 60 7c 60  ions ##..Use `|`
1380: 20 69 6e 20 74 68 65 20 72 65 70 6c 61 63 65 6d   in the replacem
1390: 65 6e 74 20 74 65 78 74 20 74 6f 20 61 64 64 20  ent text to add 
13a0: 6d 75 6c 74 69 70 6c 65 20 73 75 67 67 65 73 74  multiple suggest
13b0: 69 6f 6e 73 3a 0a 0a 45 78 61 6d 70 6c 65 2e 20  ions:..Example. 
13c0: 46 6f 6f 2c 20 46 4f 4f 2c 20 42 61 72 20 61 6e  Foo, FOO, Bar an
13d0: 64 20 42 41 52 20 73 75 67 67 65 73 74 69 6f 6e  d BAR suggestion
13e0: 73 20 66 6f 72 20 74 68 65 20 69 6e 70 75 74 20  s for the input 
13f0: 77 6f 72 64 20 22 66 6f 6f 22 2e 0a 0a 20 20 20  word "foo"...   
1400: 20 20 20 20 20 66 6f 6f 20 3c 3c 2d 20 2d 3e 3e       foo <<- ->>
1410: 20 46 6f 6f 7c 46 4f 4f 7c 42 61 72 7c 42 41 52   Foo|FOO|Bar|BAR
1420: 20 23 20 44 69 64 20 79 6f 75 20 6d 65 61 6e 3a   # Did you mean:
1430: 0a 0a 0a 23 23 20 4e 6f 20 73 75 67 67 65 73 74  ...## No suggest
1440: 69 6f 6e 20 23 23 0a 0a 59 6f 75 20 63 61 6e 20  ion ##..You can 
1450: 64 69 73 70 6c 61 79 20 6d 65 73 73 61 67 65 20  display message 
1460: 77 69 74 68 6f 75 74 20 6d 61 6b 69 6e 67 20 73  without making s
1470: 75 67 67 65 73 74 69 6f 6e 73 2e 20 46 6f 72 20  uggestions. For 
1480: 74 68 69 73 20 70 75 72 70 6f 73 65 2c 0a 75 73  this purpose,.us
1490: 65 20 61 20 73 69 6e 67 6c 65 20 63 68 61 72 61  e a single chara
14a0: 63 74 65 72 20 5f 20 69 6e 20 74 68 65 20 73 75  cter _ in the su
14b0: 67 67 65 73 74 69 6f 6e 20 66 69 65 6c 64 2e 0a  ggestion field..
14c0: 0a 45 78 61 6d 70 6c 65 2e 20 4e 6f 20 73 75 67  .Example. No sug
14d0: 67 65 73 74 69 6f 6e 2e 0a 0a 20 20 20 20 20 20  gestion...      
14e0: 20 20 66 6f 6f 62 61 72 20 3c 3c 2d 20 2d 3e 3e    foobar <<- ->>
14f0: 20 5f 20 23 20 4d 65 73 73 61 67 65 0a 0a 0a 23   _ # Message...#
1500: 23 20 50 6f 73 69 74 69 6f 6e 69 6e 67 20 23 23  # Positioning ##
1510: 0a 0a 50 6f 73 69 74 69 6f 6e 69 6e 67 20 69 73  ..Positioning is
1520: 20 76 61 6c 69 64 20 6f 6e 6c 79 20 66 6f 72 20   valid only for 
1530: 65 72 72 6f 72 20 63 72 65 61 74 69 6f 6e 20 61  error creation a
1540: 6e 64 20 74 65 78 74 20 72 65 77 72 69 74 69 6e  nd text rewritin
1550: 67 2e 0a 0a 42 79 20 64 65 66 61 75 6c 74 2c 20  g...By default, 
1560: 74 68 65 20 66 75 6c 6c 20 70 61 74 74 65 72 6e  the full pattern
1570: 20 77 69 6c 6c 20 62 65 20 75 6e 64 65 72 6c 69   will be underli
1580: 6e 65 64 20 77 69 74 68 20 62 6c 75 65 2e 20 59  ned with blue. Y
1590: 6f 75 20 63 61 6e 20 73 68 6f 72 74 65 6e 20 74  ou can shorten t
15a0: 68 65 0a 75 6e 64 65 72 6c 69 6e 65 64 20 74 65  he.underlined te
15b0: 78 74 20 61 72 65 61 20 62 79 20 73 70 65 63 69  xt area by speci
15c0: 66 79 69 6e 67 20 61 20 62 61 63 6b 20 72 65 66  fying a back ref
15d0: 65 72 65 6e 63 65 20 67 72 6f 75 70 20 6f 66 20  erence group of 
15e0: 74 68 65 20 70 61 74 74 65 72 6e 2e 0a 49 6e 73  the pattern..Ins
15f0: 74 65 61 64 20 6f 66 20 77 72 69 74 69 6e 67 20  tead of writing 
1600: 2d 3e 3e 2c 20 77 72 69 74 65 20 2d 6e 3e 3e 20  ->>, write -n>> 
1610: 20 6e 20 62 65 69 6e 67 20 74 68 65 20 6e 75 6d   n being the num
1620: 62 65 72 20 6f 66 20 61 20 62 61 63 6b 20 72 65  ber of a back re
1630: 66 65 72 65 6e 63 65 0a 67 72 6f 75 70 2e 20 41  ference.group. A
1640: 63 74 75 61 6c 6c 79 2c 20 20 2d 3e 3e 20 20 69  ctually,  ->>  i
1650: 73 20 73 69 6d 69 6c 61 72 20 74 6f 20 20 2d 30  s similar to  -0
1660: 3e 3e 0a 0a 45 78 61 6d 70 6c 65 3a 0a 0a 20 20  >>..Example:..  
1670: 20 20 20 20 20 20 28 79 69 6e 67 29 20 61 6e 64        (ying) and
1680: 20 79 61 6e 67 20 3c 3c 2d 20 2d 31 3e 3e 20 79   yang <<- -1>> y
1690: 69 6e 20 23 20 44 69 64 20 79 6f 75 20 6d 65 61  in # Did you mea
16a0: 6e 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f 5b 73  n:..        __[s
16b0: 5d 5f 5f 20 28 4d 72 2e 29 20 5b 41 2d 5a 5d 5c  ]__ (Mr.) [A-Z]\
16c0: 77 2b 20 3c 3c 2d 20 7e 31 3e 3e 20 4d 72 0a 0a  w+ <<- ~1>> Mr..
16d0: 0a 23 23 23 20 43 6f 6d 70 61 72 69 73 6f 6e 20  .### Comparison 
16e0: 23 23 23 0a 0a 52 75 6c 65 20 41 3a 0a 0a 20 20  ###..Rule A:..  
16f0: 20 20 20 20 20 20 79 69 6e 67 20 61 6e 64 20 79        ying and y
1700: 61 6e 67 20 20 20 20 20 20 20 3c 3c 2d 20 2d 3e  ang       <<- ->
1710: 3e 20 20 20 20 20 79 69 6e 20 61 6e 64 20 79 61  >     yin and ya
1720: 6e 67 20 20 20 20 20 20 20 20 23 20 44 69 64 20  ng        # Did 
1730: 79 6f 75 20 6d 65 61 6e 3a 0a 0a 52 75 6c 65 20  you mean:..Rule 
1740: 42 3a 0a 0a 20 20 20 20 20 20 20 20 28 79 69 6e  B:..        (yin
1750: 67 29 20 61 6e 64 20 79 61 6e 67 20 20 20 20 20  g) and yang     
1760: 3c 3c 2d 20 2d 31 3e 3e 20 20 20 20 79 69 6e 20  <<- -1>>    yin 
1770: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1780: 23 20 44 69 64 20 79 6f 75 20 6d 65 61 6e 3a 0a  # Did you mean:.
1790: 0a 57 69 74 68 20 74 68 65 20 72 75 6c 65 20 41  .With the rule A
17a0: 2c 20 74 68 65 20 66 75 6c 6c 20 70 61 74 74 65  , the full patte
17b0: 72 6e 20 69 73 20 75 6e 64 65 72 6c 69 6e 65 64  rn is underlined
17c0: 3a 0a 0a 20 20 20 20 20 20 20 20 79 69 6e 67 20  :..        ying 
17d0: 61 6e 64 20 79 61 6e 67 0a 20 20 20 20 20 20 20  and yang.       
17e0: 20 5e 5e 5e 5e 5e 5e 5e 5e 5e 5e 5e 5e 5e 0a 0a   ^^^^^^^^^^^^^..
17f0: 57 69 74 68 20 74 68 65 20 72 75 6c 65 20 42 2c  With the rule B,
1800: 20 6f 6e 6c 79 20 74 68 65 20 66 69 72 73 74 20   only the first 
1810: 67 72 6f 75 70 20 69 73 20 75 6e 64 65 72 6c 69  group is underli
1820: 6e 65 64 3a 0a 0a 20 20 20 20 20 20 20 20 79 69  ned:..        yi
1830: 6e 67 20 61 6e 64 20 79 61 6e 67 0a 20 20 20 20  ng and yang.    
1840: 20 20 20 20 5e 5e 5e 5e 0a 0a 0a 23 23 20 4c 6f      ^^^^...## Lo
1850: 6e 67 65 72 20 65 78 70 6c 61 6e 61 74 69 6f 6e  nger explanation
1860: 73 20 77 69 74 68 20 55 52 4c 73 20 23 23 0a 0a  s with URLs ##..
1870: 57 61 72 6e 69 6e 67 20 6d 65 73 73 61 67 65 73  Warning messages
1880: 20 63 61 6e 20 63 6f 6e 74 61 69 6e 20 6f 70 74   can contain opt
1890: 69 6f 6e 61 6c 20 55 52 4c 20 66 6f 72 20 6c 6f  ional URL for lo
18a0: 6e 67 65 72 20 65 78 70 6c 61 6e 61 74 69 6f 6e  nger explanation
18b0: 73 2e 0a 0a 20 20 20 20 20 20 20 20 79 6f 75 72  s...        your
18c0: e2 80 99 73 0a 20 20 20 20 20 20 20 20 20 20 20  ...s.           
18d0: 20 3c 3c 2d 20 2d 3e 3e 20 79 6f 75 72 73 0a 20   <<- ->> yours. 
18e0: 20 20 20 20 20 20 20 20 20 20 20 23 20 50 6f 73             # Pos
18f0: 73 65 73 73 69 76 65 20 70 72 6f 6e 6f 75 6e 3a  sessive pronoun:
1900: 7c 68 74 74 70 3a 2f 2f 65 6e 2e 77 69 6b 69 70  |http://en.wikip
1910: 65 64 69 61 2e 6f 72 67 2f 77 69 6b 69 2f 50 6f  edia.org/wiki/Po
1920: 73 73 65 73 73 69 76 65 5f 70 72 6f 6e 6f 75 6e  ssessive_pronoun
1930: 0a 0a 0a 0a 23 20 54 65 78 74 20 72 65 77 72 69  ....# Text rewri
1940: 74 69 6e 67 20 23 0a 0a 45 78 61 6d 70 6c 65 2e  ting #..Example.
1950: 20 52 65 70 6c 61 63 69 6e 67 20 61 20 73 74 72   Replacing a str
1960: 69 6e 67 20 62 79 20 61 6e 6f 74 68 65 72 2e 0a  ing by another..
1970: 0a 20 20 20 20 20 20 20 20 4d 72 2e 20 5b 41 2d  .        Mr. [A-
1980: 5a 5d 5c 77 2b 20 3c 3c 2d 20 7e 3e 3e 20 4d 69  Z]\w+ <<- ~>> Mi
1990: 73 74 65 72 0a 0a 57 41 52 4e 49 4e 47 3a 20 54  ster..WARNING: T
19a0: 68 65 20 72 65 70 6c 61 63 69 6e 67 20 74 65 78  he replacing tex
19b0: 74 20 6d 75 73 74 20 62 65 20 73 68 6f 72 74 65  t must be shorte
19c0: 72 20 74 68 61 6e 20 74 68 65 20 72 65 70 6c 61  r than the repla
19d0: 63 65 64 20 74 65 78 74 20 6f 72 20 68 61 76 65  ced text or have
19e0: 20 74 68 65 0a 73 61 6d 65 20 6c 65 6e 67 74 68   the.same length
19f0: 2e 20 42 72 65 61 6b 69 6e 67 20 74 68 69 73 20  . Breaking this 
1a00: 72 75 6c 65 20 77 69 6c 6c 20 6d 69 73 70 6c 61  rule will mispla
1a10: 63 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 65 72 72  ce following err
1a20: 6f 72 20 72 65 70 6f 72 74 73 2e 20 59 6f 75 0a  or reports. You.
1a30: 68 61 76 65 20 74 6f 20 65 6e 73 75 72 65 20 79  have to ensure y
1a40: 6f 75 72 73 65 6c 66 20 74 68 65 20 72 75 6c 65  ourself the rule
1a50: 73 20 63 6f 6d 70 6c 79 20 77 69 74 68 20 74 68  s comply with th
1a60: 69 73 20 63 6f 6e 73 74 72 61 69 6e 74 2c 20 47  is constraint, G
1a70: 72 61 6d 6d 61 6c 65 63 74 65 0a 77 6f 6e e2 80  rammalecte.won..
1a80: 99 74 20 64 6f 20 69 74 20 66 6f 72 20 79 6f 75  .t do it for you
1a90: 2e 0a 0a 53 70 65 63 69 66 69 63 20 63 6f 6d 6d  ...Specific comm
1aa0: 61 6e 64 73 20 66 6f 72 20 74 65 78 74 20 72 65  ands for text re
1ab0: 77 72 69 74 69 6e 67 3a 0a 0a 60 7e 3e 3e 20 2a  writing:..`~>> *
1ac0: 60 0a 0a 3e 20 20 20 72 65 70 6c 61 63 65 20 62  `..>   replace b
1ad0: 79 20 77 68 69 74 65 73 70 61 63 65 73 0a 0a 60  y whitespaces..`
1ae0: 7e 3e 3e 20 40 60 0a 0a 3e 20 20 20 72 65 70 6c  ~>> @`..>   repl
1af0: 61 63 65 20 62 79 20 61 72 72 6f 62 61 73 2c 20  ace by arrobas, 
1b00: 75 73 65 66 75 6c 20 6d 6f 73 74 6c 79 20 61 74  useful mostly at
1b10: 20 66 69 72 73 74 20 70 61 73 73 2c 20 77 68 65   first pass, whe
1b20: 72 65 20 69 74 20 69 73 20 61 64 76 69 73 65 64  re it is advised
1b30: 20 74 6f 0a 3e 20 20 20 63 68 65 63 6b 20 75 73   to.>   check us
1b40: 61 67 65 20 6f 66 20 70 75 6e 63 74 75 61 74 69  age of punctuati
1b50: 6f 6e 73 20 61 6e 64 20 77 68 69 74 65 73 70 61  ons and whitespa
1b60: 63 65 73 2e 0a 3e 20 20 20 40 20 61 72 65 20 61  ces..>   @ are a
1b70: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 6d  utomatically rem
1b80: 6f 76 65 64 20 61 74 20 74 68 65 20 62 65 67 69  oved at the begi
1b90: 6e 6e 69 6e 67 20 6f 66 20 74 68 65 20 73 65 63  nning of the sec
1ba0: 6f 6e 64 20 70 61 73 73 2e 0a 0a 59 6f 75 20 63  ond pass...You c
1bb0: 61 6e 20 75 73 65 20 70 6f 73 69 74 69 6f 6e 69  an use positioni
1bc0: 6e 67 20 77 69 74 68 20 74 65 78 74 20 72 65 77  ng with text rew
1bd0: 72 69 74 69 6e 67 20 61 63 74 69 6f 6e 73 2e 0a  riting actions..
1be0: 0a 20 20 20 20 20 20 20 20 4d 72 28 2e 20 5b 41  .        Mr(. [A
1bf0: 2d 5a 5d 5c 77 2b 29 20 3c 3c 2d 20 7e 31 3e 3e  -Z]\w+) <<- ~1>>
1c00: 20 2a 0a 0a 59 6f 75 20 63 61 6e 20 61 6c 73 6f   *..You can also
1c10: 20 63 61 6c 6c 20 50 79 74 68 6f 6e 20 65 78 70   call Python exp
1c20: 72 65 73 73 69 6f 6e 73 2e 0a 0a 20 20 20 20 20  ressions...     
1c30: 20 20 20 5f 5f 5b 73 5d 5f 5f 20 4d 72 2e 20 28     __[s]__ Mr. (
1c40: 5b 61 2d 7a 5d 5c 77 2b 29 20 3c 3c 2d 20 7e 31  [a-z]\w+) <<- ~1
1c50: 3e 3e 20 3d 5c 31 2e 75 70 70 65 72 28 29 0a 0a  >> =\1.upper()..
1c60: 0a 0a 23 20 44 69 73 61 6d 62 69 67 75 61 74 69  ..# Disambiguati
1c70: 6f 6e 20 23 0a 0a 57 68 65 6e 20 47 72 61 6d 6d  on #..When Gramm
1c80: 61 6c 65 63 74 65 20 61 6e 61 6c 79 73 65 73 20  alecte analyses 
1c90: 61 20 77 6f 72 64 20 77 69 74 68 20 6d 6f 72 70  a word with morp
1ca0: 68 20 6f 72 20 6d 6f 72 70 68 65 78 2c 20 62 65  h or morphex, be
1cb0: 66 6f 72 65 20 72 65 71 75 65 73 74 69 6e 67 20  fore requesting 
1cc0: 74 68 65 0a 50 4f 53 20 74 61 67 73 20 74 6f 20  the.POS tags to 
1cd0: 74 68 65 20 64 69 63 74 69 6f 6e 61 72 79 2c 20  the dictionary, 
1ce0: 69 74 20 63 68 65 63 6b 73 20 69 66 20 74 68 65  it checks if the
1cf0: 72 65 20 69 73 20 61 20 73 74 6f 72 65 64 20 6d  re is a stored m
1d00: 61 72 6b 65 72 20 66 6f 72 20 74 68 65 0a 70 6f  arker for the.po
1d10: 73 69 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65  sition where the
1d20: 20 77 6f 72 64 20 69 73 2e 20 49 66 20 74 68 65   word is. If the
1d30: 72 65 20 69 73 20 61 20 6d 61 72 6b 65 72 2c 20  re is a marker, 
1d40: 47 72 61 6d 6d 61 6c 65 63 74 65 20 75 73 65 73  Grammalecte uses
1d50: 20 74 68 65 20 73 74 6f 72 65 64 0a 64 61 74 61   the stored.data
1d60: 20 61 6e 64 20 64 6f 6e e2 80 99 74 20 6d 61 6b   and don...t mak
1d70: 65 20 72 65 71 75 65 73 74 20 74 6f 20 74 68 65  e request to the
1d80: 20 64 69 63 74 69 6f 6e 61 72 79 2e 0a 0a 54 68   dictionary...Th
1d90: 65 20 64 69 73 61 6d 62 69 67 75 61 74 69 6f 6e  e disambiguation
1da0: 20 63 6f 6d 6d 61 6e 64 73 20 73 74 6f 72 65 20   commands store 
1db0: 50 4f 53 20 74 61 67 73 20 61 74 20 74 68 65 20  POS tags at the 
1dc0: 70 6f 73 69 74 69 6f 6e 20 6f 66 20 61 20 77 6f  position of a wo
1dd0: 72 64 2e 0a 0a 54 68 65 72 65 20 69 73 20 33 20  rd...There is 3 
1de0: 63 6f 6d 6d 61 6e 64 73 20 66 6f 72 20 64 69 73  commands for dis
1df0: 61 6d 62 69 67 75 61 74 69 6f 6e 2e 0a 0a 60 73  ambiguation...`s
1e00: 65 6c 65 63 74 28 6e 2c 20 70 61 74 74 65 72 6e  elect(n, pattern
1e10: 29 60 0a 0a 3e 20 20 20 73 74 6f 72 65 73 20 61  )`..>   stores a
1e20: 74 20 70 6f 73 69 74 69 6f 6e 20 6e 20 6f 6e 6c  t position n onl
1e30: 79 20 74 68 65 20 50 4f 53 20 74 61 67 73 20 6f  y the POS tags o
1e40: 66 20 74 68 65 20 77 6f 72 64 20 6d 61 74 63 68  f the word match
1e50: 69 6e 67 20 74 68 65 20 70 61 74 74 65 72 6e 2e  ing the pattern.
1e60: 0a 0a 60 65 78 63 6c 75 64 65 28 6e 2c 20 70 61  ..`exclude(n, pa
1e70: 74 74 65 72 6e 29 60 0a 0a 3e 20 20 20 73 74 6f  ttern)`..>   sto
1e80: 72 65 73 20 61 74 20 70 6f 73 69 74 69 6f 6e 20  res at position 
1e90: 6e 20 74 68 65 20 50 4f 53 20 74 61 67 73 20 6f  n the POS tags o
1ea0: 66 20 74 68 65 20 77 6f 72 64 2c 20 65 78 63 65  f the word, exce
1eb0: 70 74 20 74 68 6f 73 65 20 6d 61 74 63 68 69 6e  pt those matchin
1ec0: 67 20 74 68 65 0a 20 20 20 20 70 61 74 74 65 72  g the.    patter
1ed0: 6e 2e 0a 0a 60 64 65 66 69 6e 65 28 6e 2c 20 64  n...`define(n, d
1ee0: 65 66 69 6e 69 74 69 6f 6e 29 60 0a 0a 3e 20 20  efinition)`..>  
1ef0: 20 73 74 6f 72 65 73 20 61 74 20 70 6f 73 69 74   stores at posit
1f00: 69 6f 6e 20 6e 20 74 68 65 20 50 4f 53 20 74 61  ion n the POS ta
1f10: 67 73 20 69 6e 20 64 65 66 69 6e 69 74 69 6f 6e  gs in definition
1f20: 2e 0a 0a 45 78 61 6d 70 6c 65 73 3a 0a 0a 20 20  ...Examples:..  
1f30: 20 20 20 20 20 20 3d 3e 3e 20 73 65 6c 65 63 74        =>> select
1f40: 28 5c 31 2c 20 22 70 6f 3a 6e 6f 75 6e 20 69 73  (\1, "po:noun is
1f50: 3a 70 6c 22 29 0a 20 20 20 20 20 20 20 20 3d 3e  :pl").        =>
1f60: 3e 20 65 78 63 6c 75 64 65 28 5c 31 2c 20 22 70  > exclude(\1, "p
1f70: 6f 3a 76 65 72 62 22 29 0a 20 20 20 20 20 20 20  o:verb").       
1f80: 20 3d 3e 3e 20 64 65 66 69 6e 65 28 5c 31 2c 20   =>> define(\1, 
1f90: 22 70 6f 3a 61 64 76 22 29 0a 20 20 20 20 20 20  "po:adv").      
1fa0: 20 20 3d 3e 3e 20 65 78 63 6c 75 64 65 28 5c 31    =>> exclude(\1
1fb0: 2c 20 22 70 6f 3a 76 65 72 62 22 29 20 61 6e 64  , "po:verb") and
1fc0: 20 64 65 66 69 6e 65 28 5c 32 2c 20 22 70 6f 3a   define(\2, "po:
1fd0: 61 64 76 22 29 20 61 6e 64 20 73 65 6c 65 63 74  adv") and select
1fe0: 28 5c 33 2c 20 22 70 6f 3a 61 64 76 22 29 0a 0a  (\3, "po:adv")..
1ff0: 4e 6f 74 65 3a 20 73 65 6c 65 63 74 2c 20 65 78  Note: select, ex
2000: 63 6c 75 64 65 20 61 6e 64 20 64 65 66 69 6e 65  clude and define
2010: 20 41 4c 57 41 59 53 20 72 65 74 75 72 6e 20 54   ALWAYS return T
2020: 72 75 65 2e 0a 0a 49 66 20 73 65 6c 65 63 74 20  rue...If select 
2030: 61 6e 64 20 65 78 63 6c 75 64 65 20 67 65 6e 65  and exclude gene
2040: 72 61 74 65 20 61 6e 20 65 6d 70 74 79 20 6c 69  rate an empty li
2050: 73 74 2c 20 6e 6f 20 6d 61 72 6b 65 72 20 69 73  st, no marker is
2060: 20 73 65 74 2e 0a 0a 57 69 74 68 20 64 65 66 69   set...With defi
2070: 6e 65 2c 20 79 6f 75 20 63 61 6e 20 73 65 74 20  ne, you can set 
2080: 61 20 6c 69 73 74 20 6f 66 20 50 4f 53 20 74 61  a list of POS ta
2090: 67 73 2e 20 45 78 61 6d 70 6c 65 3a 0a 0a 20 20  gs. Example:..  
20a0: 20 20 20 20 20 20 64 65 66 69 6e 65 28 5c 31 2c        define(\1,
20b0: 20 22 70 6f 3a 6e 6f 6d 20 69 73 3a 70 6c 75 72   "po:nom is:plur
20c0: 7c 70 6f 3a 61 64 6a 20 69 73 3a 73 69 6e 67 7c  |po:adj is:sing|
20d0: 70 6f 3a 61 64 76 22 29 0a 0a 54 68 69 73 20 77  po:adv")..This w
20e0: 69 6c 6c 20 73 74 6f 72 65 20 61 20 6c 69 73 74  ill store a list
20f0: 20 6f 66 20 74 61 67 73 20 61 74 20 74 68 65 20   of tags at the 
2100: 70 6f 73 69 74 69 6f 6e 20 6f 66 20 74 68 65 20  position of the 
2110: 66 69 72 73 74 20 67 72 6f 75 70 3a 0a 0a 20 20  first group:..  
2120: 20 20 20 20 20 20 5b 22 70 6f 3a 6e 6f 6d 20 69        ["po:nom i
2130: 73 3a 70 6c 75 72 22 2c 20 22 70 6f 3a 61 64 6a  s:plur", "po:adj
2140: 20 69 73 3a 73 69 6e 67 22 2c 20 22 70 6f 3a 61   is:sing", "po:a
2150: 64 76 22 5d 0a 0a 0a 0a 23 20 43 6f 6e 64 69 74  dv"]....# Condit
2160: 69 6f 6e 73 20 23 0a 0a 43 6f 6e 64 69 74 69 6f  ions #..Conditio
2170: 6e 73 20 61 72 65 20 50 79 74 68 6f 6e 20 65 78  ns are Python ex
2180: 70 72 65 73 73 69 6f 6e 73 2c 20 74 68 65 79 20  pressions, they 
2190: 6d 75 73 74 20 72 65 74 75 72 6e 20 61 20 76 61  must return a va
21a0: 6c 75 65 2c 20 77 68 69 63 68 20 77 69 6c 6c 20  lue, which will 
21b0: 62 65 0a 65 76 61 6c 75 61 74 65 64 20 61 73 20  be.evaluated as 
21c0: 62 6f 6f 6c 65 61 6e 2e 20 59 6f 75 20 63 61 6e  boolean. You can
21d0: 20 75 73 65 20 74 68 65 20 75 73 75 61 6c 20 50   use the usual P
21e0: 79 74 68 6f 6e 20 73 79 6e 74 61 78 20 61 6e 64  ython syntax and
21f0: 20 6c 69 62 72 61 72 69 65 73 2e 0a 0a 59 6f 75   libraries...You
2200: 20 63 61 6e 20 63 61 6c 6c 20 70 61 74 74 65 72   can call patter
2210: 6e 20 73 75 62 67 72 6f 75 70 73 20 76 69 61 20  n subgroups via 
2220: 5c 30 2c 20 5c 31 2c 20 5c 32 e2 80 a6 0a 0a 45  \0, \1, \2.....E
2230: 78 61 6d 70 6c 65 3a 0a 0a 20 20 20 20 20 20 20  xample:..       
2240: 20 74 68 65 73 65 20 28 5c 77 2b 29 0a 20 20 20   these (\w+).   
2250: 20 20 20 20 20 20 20 20 20 3c 3c 2d 20 5c 31 20           <<- \1 
2260: 3d 3d 20 22 6d 61 6e 22 20 2d 31 3e 3e 20 6d 65  == "man" -1>> me
2270: 6e 20 20 20 20 20 20 20 20 23 20 4d 61 6e 20 69  n        # Man i
2280: 73 20 61 20 73 69 6e 67 75 6c 61 72 20 6e 6f 75  s a singular nou
2290: 6e 2e 20 55 73 65 20 74 68 65 20 70 6c 75 72 61  n. Use the plura
22a0: 6c 20 66 6f 72 6d 3a 0a 0a 59 6f 75 20 63 61 6e  l form:..You can
22b0: 20 61 6c 73 6f 20 61 70 70 6c 79 20 66 75 6e 63   also apply func
22c0: 74 69 6f 6e 73 20 74 6f 20 73 75 62 67 72 6f 75  tions to subgrou
22d0: 70 73 20 6c 69 6b 65 3a 0a 0a 20 20 20 20 20 20  ps like:..      
22e0: 20 20 5c 31 2e 73 74 61 72 74 73 77 69 74 68 28    \1.startswith(
22f0: 22 61 22 29 0a 20 20 20 20 20 20 20 20 5c 33 2e  "a").        \3.
2300: 69 73 6c 6f 77 65 72 28 29 0a 20 20 20 20 20 20  islower().      
2310: 20 20 72 65 2e 73 65 61 72 63 68 28 22 70 61 74    re.search("pat
2320: 74 65 72 6e 22 2c 20 5c 32 29 0a 0a 0a 23 23 20  tern", \2)...## 
2330: 53 74 61 6e 64 61 72 64 20 66 75 6e 63 74 69 6f  Standard functio
2340: 6e 73 20 23 23 0a 0a 60 77 6f 72 64 28 6e 29 60  ns ##..`word(n)`
2350: 0a 0a 3e 20 20 20 63 61 74 63 68 65 73 20 74 68  ..>   catches th
2360: 65 20 6e 74 68 20 6e 65 78 74 20 77 6f 72 64 20  e nth next word 
2370: 61 66 74 65 72 20 74 68 65 20 70 61 74 74 65 72  after the patter
2380: 6e 20 28 73 65 70 61 72 61 74 65 64 20 6f 6e 6c  n (separated onl
2390: 79 20 62 79 20 77 68 69 74 65 20 73 70 61 63 65  y by white space
23a0: 73 29 2e 0a 3e 20 20 20 72 65 74 75 72 6e 73 20  s)..>   returns 
23b0: 4e 6f 6e 65 20 69 66 20 6e 6f 20 77 6f 72 64 20  None if no word 
23c0: 63 61 74 63 68 65 64 0a 0a 60 77 6f 72 64 28 2d  catched..`word(-
23d0: 6e 29 60 0a 0a 3e 20 20 20 63 61 74 63 68 65 73  n)`..>   catches
23e0: 20 74 68 65 20 6e 74 68 20 6e 65 78 74 20 77 6f   the nth next wo
23f0: 72 64 20 62 65 66 6f 72 65 20 74 68 65 20 70 61  rd before the pa
2400: 74 74 65 72 6e 20 28 73 65 70 61 72 61 74 65 64  ttern (separated
2410: 20 6f 6e 6c 79 20 62 79 20 77 68 69 74 65 20 73   only by white s
2420: 70 61 63 65 73 29 2e 0a 3e 20 20 20 72 65 74 75  paces)..>   retu
2430: 72 6e 73 20 4e 6f 6e 65 20 69 66 20 6e 6f 20 77  rns None if no w
2440: 6f 72 64 20 63 61 74 63 68 65 64 0a 0a 60 61 66  ord catched..`af
2450: 74 65 72 28 72 65 67 65 78 5b 2c 20 6e 65 67 5f  ter(regex[, neg_
2460: 72 65 67 65 78 5d 29 60 0a 0a 3e 20 20 20 63 68  regex])`..>   ch
2470: 65 63 6b 73 20 69 66 20 74 68 65 20 74 65 78 74  ecks if the text
2480: 20 61 66 74 65 72 20 74 68 65 20 70 61 74 74 65   after the patte
2490: 72 6e 20 6d 61 74 63 68 65 73 20 74 68 65 20 72  rn matches the r
24a0: 65 67 65 78 2e 0a 0a 60 62 65 66 6f 72 65 28 72  egex...`before(r
24b0: 65 67 65 78 5b 2c 20 6e 65 67 5f 72 65 67 65 78  egex[, neg_regex
24c0: 5d 29 60 0a 0a 3e 20 20 20 63 68 65 63 6b 73 20  ])`..>   checks 
24d0: 69 66 20 74 68 65 20 74 65 78 74 20 62 65 66 6f  if the text befo
24e0: 72 65 20 74 68 65 20 70 61 74 74 65 72 6e 20 6d  re the pattern m
24f0: 61 74 63 68 65 73 20 74 68 65 20 72 65 67 65 78  atches the regex
2500: 2e 0a 0a 60 74 65 78 74 61 72 65 61 28 72 65 67  ...`textarea(reg
2510: 65 78 5b 2c 20 6e 65 67 5f 72 65 67 65 78 5d 29  ex[, neg_regex])
2520: 60 0a 0a 3e 20 20 20 20 63 68 65 63 6b 73 20 69  `..>    checks i
2530: 66 20 74 68 65 20 66 75 6c 6c 20 74 65 78 74 20  f the full text 
2540: 6f 66 20 74 68 65 20 63 68 65 63 6b 65 64 20 61  of the checked a
2550: 72 65 61 20 28 70 61 72 61 67 72 61 70 68 20 6f  rea (paragraph o
2560: 72 20 73 65 6e 74 65 6e 63 65 29 20 6d 61 74 63  r sentence) matc
2570: 68 65 73 20 74 68 65 20 72 65 67 65 78 2e 0a 0a  hes the regex...
2580: 60 6d 6f 72 70 68 28 6e 2c 20 72 65 67 65 78 5b  `morph(n, regex[
2590: 2c 20 73 74 72 69 63 74 3d 54 72 75 65 5d 5b 2c  , strict=True][,
25a0: 20 6e 6f 77 6f 72 64 3d 46 61 6c 73 65 5d 29 60   noword=False])`
25b0: 0a 0a 3e 20 20 20 63 68 65 63 6b 73 20 69 66 20  ..>   checks if 
25c0: 61 6c 6c 20 74 61 67 73 20 6f 66 20 74 68 65 20  all tags of the 
25d0: 77 6f 72 64 20 69 6e 20 67 72 6f 75 70 20 6e 20  word in group n 
25e0: 6d 61 74 63 68 20 74 68 65 20 72 65 67 65 78 2e  match the regex.
25f0: 0a 3e 20 20 20 69 66 20 73 74 72 69 63 74 20 3d  .>   if strict =
2600: 20 46 61 6c 73 65 2c 20 72 65 74 75 72 6e 73 20   False, returns 
2610: 54 72 75 65 20 6f 6e 6c 79 20 69 66 20 6f 6e 65  True only if one
2620: 20 6f 66 20 74 61 67 73 20 6d 61 74 63 68 65 73   of tags matches
2630: 20 74 68 65 20 72 65 67 65 78 2e 0a 3e 20 20 20   the regex..>   
2640: 69 66 20 74 68 65 72 65 20 69 73 20 6e 6f 20 77  if there is no w
2650: 6f 72 64 20 61 74 20 70 6f 73 69 74 69 6f 6e 20  ord at position 
2660: 6e 2c 20 72 65 74 75 72 6e 73 20 74 68 65 20 76  n, returns the v
2670: 61 6c 75 65 20 6f 66 20 6e 6f 77 6f 72 64 2e 0a  alue of noword..
2680: 0a 60 6d 6f 72 70 68 65 78 28 6e 2c 20 72 65 67  .`morphex(n, reg
2690: 65 78 2c 20 6e 65 67 5f 72 65 67 65 78 5b 2c 20  ex, neg_regex[, 
26a0: 6e 6f 77 6f 72 64 3d 46 61 6c 73 65 5d 29 60 0a  noword=False])`.
26b0: 0a 3e 20 20 20 63 68 65 63 6b 73 20 69 66 20 6f  .>   checks if o
26c0: 6e 65 20 6f 66 20 74 68 65 20 74 61 67 73 20 6f  ne of the tags o
26d0: 66 20 74 68 65 20 77 6f 72 64 20 69 6e 20 67 72  f the word in gr
26e0: 6f 75 70 20 6e 20 6d 61 74 63 68 20 74 68 65 20  oup n match the 
26f0: 72 65 67 65 78 20 61 6e 64 0a 3e 20 20 20 20 20  regex and.>     
2700: 20 20 20 20 20 69 66 20 6e 6f 20 74 61 67 73 20       if no tags 
2710: 6d 61 74 63 68 65 73 20 74 68 65 20 6e 65 67 5f  matches the neg_
2720: 72 65 67 65 78 2e 0a 3e 20 20 20 69 66 20 74 68  regex..>   if th
2730: 65 72 65 20 69 73 20 6e 6f 20 77 6f 72 64 20 61  ere is no word a
2740: 74 20 70 6f 73 69 74 69 6f 6e 20 6e 2c 20 72 65  t position n, re
2750: 74 75 72 6e 73 20 74 68 65 20 76 61 6c 75 65 20  turns the value 
2760: 6f 66 20 6e 6f 77 6f 72 64 2e 0a 0a 60 6f 70 74  of noword...`opt
2770: 69 6f 6e 28 6f 70 74 69 6f 6e 5f 6e 61 6d 65 29  ion(option_name)
2780: 60 0a 0a 3e 20 20 20 72 65 74 75 72 6e 73 20 54  `..>   returns T
2790: 72 75 65 20 69 66 20 6f 70 74 69 6f 6e 5f 6e 61  rue if option_na
27a0: 6d 65 20 69 73 20 61 63 74 69 76 61 74 65 64 20  me is activated 
27b0: 65 6c 73 65 20 46 61 6c 73 65 0a 0a 4e 6f 74 65  else False..Note
27c0: 3a 20 74 68 65 20 61 6e 61 6c 79 73 69 73 20 69  : the analysis i
27d0: 73 20 64 6f 6e 65 20 6f 6e 20 74 68 65 20 70 72  s done on the pr
27e0: 65 70 72 6f 63 65 73 73 65 64 20 74 65 78 74 2e  eprocessed text.
27f0: 0a 0a 0a 23 23 20 44 65 66 61 75 6c 74 20 76 61  ...## Default va
2800: 72 69 61 62 6c 65 73 20 23 23 0a 0a 60 73 43 6f  riables ##..`sCo
2810: 75 6e 74 72 79 60 0a 0a 3e 20 20 20 49 74 20 63  untry`..>   It c
2820: 6f 6e 74 61 69 6e 73 20 74 68 65 20 63 75 72 72  ontains the curr
2830: 65 6e 74 20 63 6f 75 6e 74 72 79 20 6c 6f 63 61  ent country loca
2840: 6c 65 20 6f 66 20 74 68 65 20 63 68 65 63 6b 65  le of the checke
2850: 64 20 70 61 72 61 67 72 61 70 68 2e 0a 0a 20 20  d paragraph...  
2860: 20 20 20 20 20 20 63 6f 6c 6f 75 72 20 3c 3c 2d        colour <<-
2870: 20 73 43 6f 75 6e 74 72 79 20 3d 3d 20 22 55 53   sCountry == "US
2880: 22 20 2d 3e 3e 20 63 6f 6c 6f 72 20 20 20 20 20  " ->> color     
2890: 20 20 23 20 55 73 65 20 41 6d 65 72 69 63 61 6e    # Use American
28a0: 20 45 6e 67 6c 69 73 68 20 73 70 65 6c 6c 69 6e   English spellin
28b0: 67 2e 0a 0a 0a 0a 23 20 45 78 70 72 65 73 73 69  g.....# Expressi
28c0: 6f 6e 73 20 69 6e 20 74 68 65 20 73 75 67 67 65  ons in the sugge
28d0: 73 74 69 6f 6e 73 20 23 0a 0a 53 75 67 67 65 73  stions #..Sugges
28e0: 74 69 6f 6e 73 20 28 61 6e 64 20 77 61 72 6e 69  tions (and warni
28f0: 6e 67 20 6d 65 73 73 61 67 65 73 29 20 73 74 61  ng messages) sta
2900: 72 74 65 64 20 62 79 20 61 6e 20 65 71 75 61 6c  rted by an equal
2910: 20 73 69 67 6e 20 61 72 65 20 50 79 74 68 6f 6e   sign are Python
2920: 20 73 74 72 69 6e 67 20 65 78 70 72 65 73 73 69   string expressi
2930: 6f 6e 73 0a 65 78 74 65 6e 64 65 64 20 77 69 74  ons.extended wit
2940: 68 20 70 6f 73 73 69 62 6c 65 20 62 61 63 6b 20  h possible back 
2950: 72 65 66 65 72 65 6e 63 65 73 20 61 6e 64 20 6e  references and n
2960: 61 6d 65 64 20 64 65 66 69 6e 69 74 69 6f 6e 73  amed definitions
2970: 3a 0a 0a 45 78 61 6d 70 6c 65 3a 0a 0a 20 20 20  :..Example:..   
2980: 20 20 20 20 20 66 6f 6f 5c 77 2b 20 2d 3e 3e 20       foo\w+ ->> 
2990: 3d 20 27 22 27 20 2b 20 5c 30 2e 75 70 70 65 72  = '"' + \0.upper
29a0: 28 29 20 2b 20 27 22 27 20 20 20 20 20 23 20 57  () + '"'     # W
29b0: 69 74 68 20 75 70 70 65 72 63 61 73 65 20 6c 65  ith uppercase le
29c0: 74 74 65 72 73 20 61 6e 64 20 71 75 6f 61 74 69  tters and quoati
29d0: 6f 6e 20 6d 61 72 6b 73 0a 0a 41 6c 6c 20 77 6f  on marks..All wo
29e0: 72 64 73 20 62 65 67 69 6e 6e 69 6e 67 20 77 69  rds beginning wi
29f0: 74 68 20 22 66 6f 6f 22 20 77 69 6c 6c 20 62 65  th "foo" will be
2a00: 20 72 65 63 6f 67 6e 69 7a 65 64 2c 20 61 6e 64   recognized, and
2a10: 20 74 68 65 20 73 75 67 67 65 73 74 69 6f 6e 20   the suggestion 
2a20: 69 73 0a 74 68 65 20 75 70 70 65 72 63 61 73 65  is.the uppercase
2a30: 20 66 6f 72 6d 20 6f 66 20 74 68 65 20 73 74 72   form of the str
2a40: 69 6e 67 20 77 69 74 68 20 41 53 43 49 49 20 71  ing with ASCII q
2a50: 75 6f 61 74 69 6f 6e 20 6d 61 72 6b 73 3a 20 65  uoation marks: e
2a60: 67 2e 20 66 6f 6f 6d 20 2d 3e 3e 20 22 46 4f 4f  g. foom ->> "FOO
2a70: 4d 22 2e 0a 0a 0a 0a 0a 2f 2f 2f 2f 2f 2f 2f 2f  M"......////////
2a80: 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f  ////////////////
2a90: 2f 2f 2f 2f 2f 2f 2f 2f 20 4f 4c 44 20 2f 2f 2f  //////// OLD ///
2aa0: 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f  ////////////////
2ab0: 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f 2f  ////////////////
2ac0: 2f 2f 2f 2f 0a 0a 3d 20 54 65 78 74 20 70 72 65  ////..= Text pre
2ad0: 70 72 6f 63 65 73 73 69 6e 67 20 61 6e 64 20 6d  processing and m
2ae0: 75 6c 74 69 2d 70 61 73 73 65 73 20 63 68 65 63  ulti-passes chec
2af0: 6b 69 6e 67 20 3d 0a 0a 4f 6e 20 65 61 63 68 20  king =..On each 
2b00: 70 61 73 73 2c 20 4c 69 67 68 74 70 72 6f 6f 66  pass, Lightproof
2b10: 20 75 73 65 73 20 72 75 6c 65 73 20 77 72 69 74   uses rules writ
2b20: 74 65 6e 20 69 6e 20 74 68 65 20 74 65 78 74 20  ten in the text 
2b30: 70 72 65 70 72 6f 63 65 73 73 6f 72 20 74 6f 20  preprocessor to 
2b40: 6d 6f 64 69 66 79 0a 69 6e 74 65 72 6e 61 6c 6c  modify.internall
2b50: 79 20 74 68 65 20 74 65 78 74 20 62 65 66 6f 72  y the text befor
2b60: 65 20 63 68 65 63 6b 69 6e 67 20 74 68 65 20 74  e checking the t
2b70: 65 78 74 2e 0a 0a 54 68 65 20 74 65 78 74 20 70  ext...The text p
2b80: 72 65 70 72 6f 63 65 73 73 6f 72 20 69 73 20 75  reprocessor is u
2b90: 73 65 66 75 6c 20 74 6f 20 73 69 6d 70 6c 69 66  seful to simplif
2ba0: 79 20 74 65 78 74 73 20 61 6e 64 20 77 72 69 74  y texts and writ
2bb0: 65 20 73 69 6d 70 6c 69 65 72 20 63 68 65 63 6b  e simplier check
2bc0: 69 6e 67 0a 72 75 6c 65 73 2e 0a 0a 46 6f 72 20  ing.rules...For 
2bd0: 65 78 61 6d 70 6c 65 2c 20 73 65 6e 74 65 6e 63  example, sentenc
2be0: 65 73 20 77 69 74 68 20 74 68 65 20 73 61 6d 65  es with the same
2bf0: 20 67 72 61 6d 6d 61 72 20 6d 69 73 74 61 6b 65   grammar mistake
2c00: 3a 0a 0a 20 20 20 20 20 20 20 20 54 68 65 73 65  :..        These
2c10: 20 e2 80 9c 63 61 74 73 e2 80 9d 20 61 72 65 20   ...cats... are 
2c20: 62 6c 61 63 6b 73 2e 0a 20 20 20 20 20 20 20 20  blacks..        
2c30: 54 68 65 73 65 20 63 61 74 73 20 61 72 65 20 e2  These cats are .
2c40: 80 9c 62 6c 61 63 6b 73 e2 80 9d 2e 0a 20 20 20  ..blacks.....   
2c50: 20 20 20 20 20 54 68 65 73 65 20 63 61 74 73 20       These cats 
2c60: 61 72 65 20 61 62 73 6f 6c 75 74 65 6c 79 20 62  are absolutely b
2c70: 6c 61 63 6b 73 2e 0a 20 20 20 20 20 20 20 20 54  lacks..        T
2c80: 68 65 73 65 20 73 74 75 70 69 64 20 e2 80 9c 63  hese stupid ...c
2c90: 61 74 73 e2 80 9d 20 61 72 65 20 61 6c 6c 20 62  ats... are all b
2ca0: 6c 61 63 6b 73 2e 0a 20 20 20 20 20 20 20 20 54  lacks..        T
2cb0: 68 65 73 65 20 75 6e 6b 6e 6f 77 6e 20 63 61 74  hese unknown cat
2cc0: 73 20 61 72 65 20 61 73 20 70 65 72 20 75 73 75  s are as per usu
2cd0: 61 6c 20 62 6c 61 63 6b 73 2e 0a 0a 49 6e 73 74  al blacks...Inst
2ce0: 65 61 64 20 6f 66 20 77 72 69 74 74 69 6e 67 20  ead of writting 
2cf0: 63 6f 6d 70 6c 65 78 20 72 75 6c 65 73 20 6f 72  complex rules or
2d00: 20 73 65 76 65 72 61 6c 20 72 75 6c 65 73 20 74   several rules t
2d10: 6f 20 66 69 6e 64 20 6d 69 73 74 61 6b 65 73 20  o find mistakes 
2d20: 66 6f 72 20 61 6c 6c 20 70 6f 73 73 69 62 6c 65  for all possible
2d30: 0a 63 61 73 65 73 2c 20 79 6f 75 20 63 61 6e 20  .cases, you can 
2d40: 75 73 65 20 74 68 65 20 74 65 78 74 20 70 72 65  use the text pre
2d50: 70 72 6f 63 65 73 73 6f 72 20 74 6f 20 73 69 6d  processor to sim
2d60: 70 6c 69 66 79 20 74 68 65 20 74 65 78 74 2e 0a  plify the text..
2d70: 0a 54 6f 20 72 65 6d 6f 76 65 20 74 68 65 20 63  .To remove the c
2d80: 68 61 72 73 20 e2 80 9c e2 80 9d 2c 20 77 72 69  hars ......, wri
2d90: 74 65 3a 0a 0a 20 20 20 20 20 20 20 20 5b e2 80  te:..        [..
2da0: 9c e2 80 9d 5d 20 2d 3e 3e 20 2a 0a 0a 54 68 65  ....] ->> *..The
2db0: 20 2a 20 6d 65 61 6e 73 3a 20 72 65 70 6c 61 63   * means: replac
2dc0: 65 20 74 65 78 74 20 62 79 20 77 68 69 74 65 73  e text by whites
2dd0: 70 61 63 65 73 2e 0a 0a 53 69 6d 69 6c 61 72 6c  paces...Similarl
2de0: 79 20 74 6f 20 67 72 61 6d 6d 61 72 20 72 75 6c  y to grammar rul
2df0: 65 73 2c 20 79 6f 75 20 63 61 6e 20 61 64 64 20  es, you can add 
2e00: 63 6f 6e 64 69 74 69 6f 6e 73 3a 0a 0a 20 20 20  conditions:..   
2e10: 20 20 20 20 20 5c 77 2b 6c 79 20 3c 3c 2d 20 6d       \w+ly <<- m
2e20: 6f 72 70 68 28 5c 30 2c 20 22 61 64 76 65 72 62  orph(\0, "adverb
2e30: 22 29 20 2d 3e 3e 20 2a 0a 0a 59 6f 75 20 63 61  ") ->> *..You ca
2e40: 6e 20 61 6c 73 6f 20 72 65 6d 6f 76 65 20 61 20  n also remove a 
2e50: 67 72 6f 75 70 20 72 65 66 65 72 65 6e 63 65 3a  group reference:
2e60: 0a 0a 20 20 20 20 20 20 20 20 74 68 65 73 65 20  ..        these 
2e70: 28 5c 77 2b 29 20 28 5c 77 2b 29 20 3c 3c 2d 20  (\w+) (\w+) <<- 
2e80: 6d 6f 72 70 68 28 5c 31 2c 20 22 61 64 6a 65 63  morph(\1, "adjec
2e90: 74 69 76 65 22 29 20 61 6e 64 20 6d 6f 72 70 68  tive") and morph
2ea0: 28 5c 32 2c 20 22 6e 6f 75 6e 22 29 20 2d 31 3e  (\2, "noun") -1>
2eb0: 3e 20 2a 0a 20 20 20 20 20 20 20 20 28 61 6d 7c  > *.        (am|
2ec0: 61 72 65 7c 69 73 7c 77 65 72 65 7c 77 61 73 29  are|is|were|was)
2ed0: 20 28 61 6c 6c 29 20 3c 3c 2d 20 2d 32 3e 3e 20   (all) <<- -2>> 
2ee0: 2a 0a 0a 57 69 74 68 20 74 68 65 73 65 20 72 75  *..With these ru
2ef0: 6c 65 73 2c 20 79 6f 75 20 67 65 74 20 74 68 65  les, you get the
2f00: 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 65 6e 74 65   following sente
2f10: 6e 63 65 73 3a 0a 0a 20 20 20 20 20 20 20 20 54  nces:..        T
2f20: 68 65 73 65 20 20 63 61 74 73 20 20 61 72 65 20  hese  cats  are 
2f30: 62 6c 61 63 6b 73 2e 0a 20 20 20 20 20 20 20 20  blacks..        
2f40: 54 68 65 73 65 20 63 61 74 73 20 61 72 65 20 20  These cats are  
2f50: 62 6c 61 63 6b 73 20 2e 0a 20 20 20 20 20 20 20  blacks ..       
2f60: 20 54 68 65 73 65 20 63 61 74 73 20 61 72 65 20   These cats are 
2f70: 20 20 20 20 20 20 20 20 20 20 20 62 6c 61 63 6b             black
2f80: 73 2e 0a 20 20 20 20 20 20 20 20 54 68 65 73 65  s..        These
2f90: 20 20 20 20 20 20 20 20 20 63 61 74 73 20 20 61           cats  a
2fa0: 72 65 20 20 20 20 20 62 6c 61 63 6b 73 2e 0a 20  re     blacks.. 
2fb0: 20 20 20 20 20 20 20 54 68 65 73 65 20 20 20 20         These    
2fc0: 20 20 20 20 20 63 61 74 73 20 61 72 65 20 20 20       cats are   
2fd0: 20 20 20 20 20 20 20 20 20 20 20 62 6c 61 63 6b             black
2fe0: 73 2e 0a 0a 54 68 65 73 65 20 67 72 61 6d 6d 61  s...These gramma
2ff0: 72 20 6d 69 73 74 61 6b 65 73 20 63 61 6e 20 62  r mistakes can b
3000: 65 20 64 65 74 65 63 74 65 64 20 77 69 74 68 20  e detected with 
3010: 6f 6e 65 20 73 69 6d 70 6c 65 20 72 75 6c 65 3a  one simple rule:
3020: 0a 0a 20 20 20 20 20 20 20 20 74 68 65 73 65 20  ..        these 
3030: 2b 28 5c 77 2b 29 20 2b 61 72 65 20 2b 28 5c 77  +(\w+) +are +(\w
3040: 2b 73 29 0a 20 20 20 20 20 20 20 20 20 20 20 20  +s).            
3050: 3c 3c 2d 20 6d 6f 72 70 68 28 5c 31 2c 20 22 6e  <<- morph(\1, "n
3060: 6f 75 6e 22 29 20 61 6e 64 20 6d 6f 72 70 68 28  oun") and morph(
3070: 5c 32 2c 20 22 70 6c 75 72 61 6c 22 29 0a 20 20  \2, "plural").  
3080: 20 20 20 20 20 20 20 20 20 20 2d 32 3e 3e 20 5f            -2>> _
3090: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 23 20                # 
30a0: 41 64 6a 65 63 74 69 76 65 73 20 61 72 65 20 69  Adjectives are i
30b0: 6e 76 61 72 69 61 62 6c 65 2e 0a 0a 49 6e 73 74  nvariable...Inst
30c0: 65 61 64 20 6f 66 20 72 65 70 6c 61 63 69 6e 67  ead of replacing
30d0: 20 74 65 78 74 20 77 69 74 68 20 77 68 69 74 65   text with white
30e0: 73 70 61 63 65 73 2c 20 79 6f 75 20 63 61 6e 20  spaces, you can 
30f0: 72 65 70 6c 61 63 65 20 74 65 78 74 20 77 69 74  replace text wit
3100: 68 20 40 2e 0a 0a 20 20 20 20 20 20 20 20 68 74  h @...        ht
3110: 74 70 73 3f 3a 2f 2f 5c 53 2b 20 2d 3e 3e 20 40  tps?://\S+ ->> @
3120: 0a 0a 54 68 69 73 20 69 73 20 75 73 65 66 75 6c  ..This is useful
3130: 20 69 66 20 61 74 20 66 69 72 73 74 20 70 61 73   if at first pas
3140: 73 20 79 6f 75 20 77 72 69 74 65 20 72 75 6c 65  s you write rule
3150: 73 20 74 6f 20 63 68 65 63 6b 20 73 75 63 63 65  s to check succe
3160: 73 73 69 76 65 20 77 68 69 74 65 73 70 61 63 65  ssive whitespace
3170: 73 2e 0a 40 20 61 72 65 20 61 75 74 6f 6d 61 74  s..@ are automat
3180: 69 63 61 6c 6c 79 20 72 65 6d 6f 76 65 64 20 61  ically removed a
3190: 74 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 73  t the second pas
31a0: 73 2e 0a 0a 59 6f 75 20 63 61 6e 20 61 6c 73 6f  s...You can also
31b0: 20 72 65 70 6c 61 63 65 20 61 6e 79 20 74 65 78   replace any tex
31c0: 74 20 61 73 20 79 6f 75 20 77 69 73 68 2e 0a 0a  t as you wish...
31d0: 20 20 20 20 20 20 20 20 4d 69 73 74 65 72 20 3c          Mister <
31e0: 3c 2d 20 2d 3e 3e 20 4d 72 0a 20 20 20 20 20 20  <- ->> Mr.      
31f0: 20 20 28 4d 72 73 3f 29 5b 2e 5d 20 3c 3c 2d 20    (Mrs?)[.] <<- 
3200: 2d 3e 3e 20 5c 31 0a 0a 0a 0a 57 69 74 68 20 74  ->> \1....With t
3210: 68 65 20 6d 75 6c 74 69 2d 70 61 73 73 65 73 20  he multi-passes 
3220: 63 68 65 63 6b 69 6e 67 20 61 6e 64 20 74 68 65  checking and the
3230: 20 74 65 78 74 20 70 72 65 70 72 6f 63 65 73 73   text preprocess
3240: 6f 72 2c 20 69 74 20 69 73 20 61 64 76 69 73 65  or, it is advise
3250: 64 20 74 6f 0a 72 65 6d 6f 76 65 20 6f 72 20 73  d to.remove or s
3260: 69 6d 70 6c 69 66 79 20 74 68 65 20 74 65 78 74  implify the text
3270: 20 77 68 69 63 68 20 68 61 73 20 62 65 65 6e 20   which has been 
3280: 63 68 65 63 6b 65 64 20 6f 6e 20 74 68 65 20 70  checked on the p
3290: 72 65 76 69 6f 75 73 20 70 61 73 73 2e 0a 0a 0a  revious pass....
32a0: 0a 3d 3d 20 50 61 74 74 65 72 6e 20 6d 61 74 63  .== Pattern matc
32b0: 68 69 6e 67 20 3d 3d 0a 0a 52 65 70 65 61 74 69  hing ==..Repeati
32c0: 6e 67 20 70 61 74 74 65 72 6e 20 6d 61 74 63 68  ng pattern match
32d0: 69 6e 67 20 6f 66 20 61 20 73 69 6e 67 6c 65 20  ing of a single 
32e0: 72 75 6c 65 20 63 6f 6e 74 69 6e 75 65 73 20 61  rule continues a
32f0: 66 74 65 72 20 74 68 65 20 70 72 65 76 69 6f 75  fter the previou
3300: 73 20 6d 61 74 63 68 69 6e 67 2c 20 73 6f 0a 69  s matching, so.i
3310: 6e 73 74 65 61 64 20 6f 66 20 67 65 6e 65 72 61  nstead of genera
3320: 6c 20 6d 75 6c 74 69 77 6f 72 64 20 70 61 74 74  l multiword patt
3330: 65 72 6e 73 2c 20 6c 69 6b 65 0a 0a 28 5c 77 2b  erns, like..(\w+
3340: 29 20 28 5c 77 2b 29 20 3c 3c 2d 20 73 6f 6d 65  ) (\w+) <<- some
3350: 5f 63 68 65 63 6b 28 5c 31 2c 20 5c 32 29 20 2d  _check(\1, \2) -
3360: 3e 3e 20 5c 31 2c 20 5c 32 20 23 20 66 6f 6f 0a  >> \1, \2 # foo.
3370: 0a 75 73 65 0a 0a 28 5c 77 2b 29 20 3c 3c 2d 20  .use..(\w+) <<- 
3380: 73 6f 6d 65 5f 63 68 65 63 6b 28 5c 31 2c 20 77  some_check(\1, w
3390: 6f 72 64 28 31 29 29 20 2d 3e 3e 20 5c 31 2c 20  ord(1)) ->> \1, 
33a0: 23 20 66 6f 6f 0a 0a                             # foo..