Grammalecte  Hex Artifact Content

Artifact f728cc54d97b0316acafd1ecf828633c90a43dd37daba11d9e61ad2b4da7a705:


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 61 20 64 72 61  ntation is a dra
0040: 66 74 2e 20 49 6e 66 6f 72 6d 61 74 69 6f 6e 20  ft. Information 
0050: 6d 61 79 20 62 65 20 6f 62 73 6f 6c 65 74 65 20  may be obsolete 
0060: 6f 72 20 69 6e 63 6f 6d 70 6c 65 74 65 2e 0a 0a  or incomplete...
0070: 23 20 50 72 69 6e 63 69 70 6c 65 73 20 23 0a 0a  # Principles #..
0080: 47 72 61 6d 6d 61 6c 65 63 74 65 20 69 73 20 61  Grammalecte is a
0090: 20 62 69 2d 70 61 73 73 65 73 20 67 72 61 6d 6d   bi-passes gramm
00a0: 61 72 20 63 68 65 63 6b 65 72 20 65 6e 67 69 6e  ar checker engin
00b0: 65 2e 20 4f 6e 20 74 68 65 20 66 69 72 73 74 20  e. On the first 
00c0: 70 61 73 73 2c 20 74 68 65 0a 65 6e 67 69 6e 65  pass, the.engine
00d0: 20 63 68 65 63 6b 73 20 74 68 65 20 74 65 78 74   checks the text
00e0: 20 70 61 72 61 67 72 61 70 68 20 62 79 20 70 61   paragraph by pa
00f0: 72 61 67 72 61 70 68 2e 20 4f 6e 20 74 68 65 20  ragraph. On the 
0100: 73 65 63 6f 6e 64 20 70 61 73 73 2c 20 74 68 65  second pass, the
0110: 20 65 6e 67 69 6e 65 0a 63 68 65 63 6b 20 74 68   engine.check th
0120: 65 20 74 65 78 74 20 73 65 6e 74 65 6e 63 65 20  e text sentence 
0130: 62 79 20 73 65 6e 74 65 6e 63 65 2e 0a 0a 54 68  by sentence...Th
0140: 65 20 63 6f 6d 6d 61 6e 64 20 74 6f 20 73 77 69  e command to swi
0150: 74 63 68 20 74 6f 20 74 68 65 20 73 65 63 6f 6e  tch to the secon
0160: 64 20 70 61 73 73 20 69 73 20 60 5b 2b 2b 5d 60  d pass is `[++]`
0170: 2e 0a 0a 49 6e 20 65 61 63 68 20 70 61 73 73 2c  ...In each pass,
0180: 20 79 6f 75 20 63 61 6e 20 77 72 69 74 65 20 61   you can write a
0190: 73 20 6d 61 6e 79 20 72 75 6c 65 73 20 61 73 20  s many rules as 
01a0: 79 6f 75 20 6e 65 65 64 2e 0a 0a 54 68 65 72 65  you need...There
01b0: 20 61 72 65 20 74 77 6f 20 6b 69 6e 64 73 20 6f   are two kinds o
01c0: 66 20 72 75 6c 65 73 3a 0a 0a 2a 20 72 65 67 65  f rules:..* rege
01d0: 78 20 72 75 6c 65 73 20 28 74 72 69 67 67 65 72  x rules (trigger
01e0: 65 64 20 62 79 20 61 20 72 65 67 75 6c 61 72 20  ed by a regular 
01f0: 65 78 70 72 65 73 73 69 6f 6e 29 0a 2a 20 74 6f  expression).* to
0200: 6b 65 6e 20 72 75 6c 65 73 20 28 74 72 69 67 67  ken rules (trigg
0210: 65 72 65 64 20 62 79 20 61 20 73 75 63 63 65 73  ered by a succes
0220: 73 69 6f 6e 20 6f 66 20 74 6f 6b 65 6e 73 29 0a  sion of tokens).
0230: 0a 41 20 72 65 67 65 78 20 72 75 6c 65 20 69 73  .A regex rule is
0240: 20 64 65 66 69 6e 65 64 20 62 79 3a 0a 0a 2a 20   defined by:..* 
0250: 5b 6f 70 74 69 6f 6e 61 6c 5d 20 66 6c 61 67 73  [optional] flags
0260: 20 e2 80 9c 4c 43 52 e2 80 9d 20 66 6f 72 20 74   ...LCR... for t
0270: 68 65 20 72 65 67 65 78 20 77 6f 72 64 20 62 6f  he regex word bo
0280: 75 6e 64 61 72 69 65 73 20 61 6e 64 20 63 61 73  undaries and cas
0290: 65 20 73 65 6e 73 69 74 69 76 65 6e 65 73 73 0a  e sensitiveness.
02a0: 2a 20 61 20 72 65 67 65 78 20 70 61 74 74 65 72  * a regex patter
02b0: 6e 20 74 72 69 67 67 65 72 0a 2a 20 61 20 6c 69  n trigger.* a li
02c0: 73 74 20 6f 66 20 61 63 74 69 6f 6e 73 0a 2a 20  st of actions.* 
02d0: 5b 6f 70 74 69 6f 6e 61 6c 5d 20 6f 70 74 69 6f  [optional] optio
02e0: 6e 20 6e 61 6d 65 20 28 74 68 65 20 72 75 6c 65  n name (the rule
02f0: 20 69 73 20 61 63 74 69 76 65 20 6f 6e 6c 79 20   is active only 
0300: 69 66 20 74 68 65 20 6f 70 74 69 6f 6e 20 64 65  if the option de
0310: 66 69 6e 65 64 20 62 79 20 75 73 65 72 20 6f 72  fined by user or
0320: 20 63 6f 6e 66 69 67 20 69 73 20 61 63 74 69 76   config is activ
0330: 65 29 0a 2a 20 5b 6f 70 74 69 6f 6e 61 6c 5d 20  e).* [optional] 
0340: 72 75 6c 65 20 6e 61 6d 65 20 28 6e 61 6d 65 64  rule name (named
0350: 20 72 75 6c 65 73 20 63 61 6e 20 62 65 20 64 69   rules can be di
0360: 73 61 62 6c 65 64 20 62 79 20 75 73 65 72 20 6f  sabled by user o
0370: 72 20 62 79 20 63 6f 6e 66 69 67 29 0a 0a 41 20  r by config)..A 
0380: 74 6f 6b 65 6e 20 72 75 6c 65 73 20 69 73 20 64  token rules is d
0390: 65 66 69 6e 65 64 20 62 79 3a 0a 0a 2a 20 72 75  efined by:..* ru
03a0: 6c 65 20 6e 61 6d 65 0a 2a 20 6f 6e 65 20 6f 72  le name.* one or
03b0: 20 73 65 76 65 72 61 6c 20 6c 69 73 74 73 20 6f   several lists o
03c0: 66 20 74 6f 6b 65 6e 73 20 28 74 72 69 67 67 65  f tokens (trigge
03d0: 72 73 29 0a 2a 20 61 20 6c 69 73 74 20 6f 66 20  rs).* a list of 
03e0: 61 63 74 69 6f 6e 73 20 28 74 68 65 20 61 63 74  actions (the act
03f0: 69 6f 6e 20 69 73 20 61 63 74 69 76 65 20 6f 6e  ion is active on
0400: 6c 79 20 69 66 20 74 68 65 20 6f 70 74 69 6f 6e  ly if the option
0410: 20 64 65 66 69 6e 65 64 20 62 79 20 75 73 65 72   defined by user
0420: 20 6f 72 20 63 6f 6e 66 69 67 20 69 73 20 61 63   or config is ac
0430: 74 69 76 65 29 0a 0a 54 6f 6b 65 6e 20 72 75 6c  tive)..Token rul
0440: 65 73 20 6d 75 73 74 20 62 65 20 64 65 66 69 6e  es must be defin
0450: 65 64 20 77 69 74 68 69 6e 20 61 20 67 72 61 70  ed within a grap
0460: 68 2e 0a 0a 45 61 63 68 20 67 72 61 70 68 20 69  h...Each graph i
0470: 73 20 64 65 66 69 6e 65 64 20 77 69 74 68 69 6e  s defined within
0480: 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 73 73   the second pass
0490: 20 77 69 74 68 20 74 68 65 20 63 6f 6d 6d 61 6e   with the comman
04a0: 64 3a 0a 0a 20 20 20 20 20 20 20 20 40 40 40 40  d:..        @@@@
04b0: 47 52 41 50 48 3a 20 67 72 61 70 68 5f 6e 61 6d  GRAPH: graph_nam
04c0: 65 0a 0a 41 20 67 72 61 70 68 20 65 6e 64 73 20  e..A graph ends 
04d0: 77 68 65 6e 20 61 6e 6f 74 68 65 72 20 67 72 61  when another gra
04e0: 70 68 20 69 73 20 64 65 66 69 6e 65 64 20 6f 72  ph is defined or
04f0: 20 77 68 65 6e 20 69 73 20 66 6f 75 6e 64 20 74   when is found t
0500: 68 65 20 63 6f 6d 6d 61 6e 64 3a 0a 0a 20 20 20  he command:..   
0510: 20 20 20 20 20 40 40 40 40 45 4e 44 5f 47 52 41       @@@@END_GRA
0520: 50 48 0a 0a 54 68 65 72 65 20 69 73 20 6e 6f 20  PH..There is no 
0530: 6c 69 6d 69 74 20 74 6f 20 74 68 65 20 6e 75 6d  limit to the num
0540: 62 65 72 20 6f 66 20 61 63 74 69 6f 6e 73 20 61  ber of actions a
0550: 6e 64 20 74 68 65 20 74 79 70 65 20 6f 66 20 61  nd the type of a
0560: 63 74 69 6f 6e 73 20 61 20 72 75 6c 65 20 63 61  ctions a rule ca
0570: 6e 0a 6c 61 75 6e 63 68 2e 20 45 61 63 68 20 61  n.launch. Each a
0580: 63 74 69 6f 6e 20 68 61 73 20 69 74 73 20 6f 77  ction has its ow
0590: 6e 20 63 6f 6e 64 69 74 69 6f 6e 20 74 6f 20 62  n condition to b
05a0: 65 20 74 72 69 67 67 65 72 65 64 2e 0a 0a 54 68  e triggered...Th
05b0: 65 72 65 20 61 72 65 20 73 65 76 65 72 61 6c 20  ere are several 
05c0: 6b 69 6e 64 73 20 6f 66 20 61 63 74 69 6f 6e 73  kinds of actions
05d0: 3a 0a 0a 2a 20 45 72 72 6f 72 20 77 61 72 6e 69  :..* Error warni
05e0: 6e 67 2c 20 77 69 74 68 20 61 20 6d 65 73 73 61  ng, with a messa
05f0: 67 65 2c 20 61 6e 64 20 6f 70 74 69 6f 6e 61 6c  ge, and optional
0600: 6c 79 20 73 75 67 67 65 73 74 69 6f 6e 73 2c 20  ly suggestions, 
0610: 61 6e 64 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 61  and optionally a
0620: 6e 20 55 52 4c 0a 2a 20 54 65 78 74 20 74 72 61  n URL.* Text tra
0630: 6e 73 66 6f 72 6d 61 74 69 6f 6e 2c 20 6d 6f 64  nsformation, mod
0640: 69 66 79 69 6e 67 20 69 6e 74 65 72 6e 61 6c 6c  ifying internall
0650: 79 20 74 68 65 20 63 68 65 63 6b 65 64 20 74 65  y the checked te
0660: 78 74 0a 2a 20 44 69 73 61 6d 62 69 67 75 61 74  xt.* Disambiguat
0670: 69 6f 6e 20 61 63 74 69 6f 6e 2c 20 73 65 74 74  ion action, sett
0680: 69 6e 67 20 74 61 67 73 20 6f 6e 20 61 20 70 6f  ing tags on a po
0690: 73 69 74 69 6f 6e 0a 2a 20 54 61 67 67 69 6e 67  sition.* Tagging
06a0: 0a 0a 0a 54 68 65 20 72 75 6c 65 73 20 66 69 6c  ...The rules fil
06b0: 65 20 66 6f 72 20 79 6f 75 72 20 6c 61 6e 67 75  e for your langu
06c0: 61 67 65 20 6d 75 73 74 20 62 65 20 6e 61 6d 65  age must be name
06d0: 64 20 60 72 75 6c 65 73 2e 67 72 78 60 2e 0a 54  d `rules.grx`..T
06e0: 68 65 20 73 65 74 74 69 6e 67 73 20 66 69 6c 65  he settings file
06f0: 20 6d 75 73 74 20 62 65 20 6e 61 6d 65 64 20 60   must be named `
0700: 63 6f 6e 66 69 67 2e 69 6e 69 60 2e 0a 0a 41 6c  config.ini`...Al
0710: 6c 20 74 68 65 73 65 20 66 69 6c 65 73 20 61 72  l these files ar
0720: 65 20 73 69 6d 70 6c 65 20 75 74 66 2d 38 20 74  e simple utf-8 t
0730: 65 78 74 20 66 69 6c 65 2e 0a 55 54 46 2d 38 20  ext file..UTF-8 
0740: 69 73 20 6d 61 6e 64 61 74 6f 72 79 2e 0a 0a 0a  is mandatory....
0750: 23 20 43 6f 6d 6d 65 6e 74 73 20 23 0a 0a 4c 69  # Comments #..Li
0760: 6e 65 73 20 62 65 67 69 6e 6e 69 6e 67 20 77 69  nes beginning wi
0770: 74 68 20 60 23 60 20 61 72 65 20 63 6f 6d 6d 65  th `#` are comme
0780: 6e 74 73 2e 0a 0a 0a 23 20 45 6e 64 20 6f 66 20  nts....# End of 
0790: 66 69 6c 65 20 23 0a 0a 57 69 74 68 20 74 68 65  file #..With the
07a0: 20 63 6f 6d 6d 61 6e 64 3a 0a 0a 20 20 20 20 20   command:..     
07b0: 20 20 20 23 45 4e 44 0a 0a 61 74 20 74 68 65 20     #END..at the 
07c0: 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20 61 20 6c  beginning of a l
07d0: 69 6e 65 2c 20 74 68 65 20 70 61 72 73 65 72 20  ine, the parser 
07e0: 77 6f 6e e2 80 99 74 20 67 6f 20 66 75 72 74 68  won...t go furth
07f0: 65 72 2e 0a 57 68 61 74 65 76 65 72 20 69 73 20  er..Whatever is 
0800: 77 72 69 74 74 65 6e 20 61 66 74 65 72 20 77 69  written after wi
0810: 6c 6c 20 62 65 20 63 6f 6e 73 69 64 65 72 65 64  ll be considered
0820: 20 61 73 20 63 6f 6d 6d 65 6e 74 73 2e 0a 0a 0a   as comments....
0830: 23 20 52 65 67 65 78 20 72 75 6c 65 20 73 79 6e  # Regex rule syn
0840: 74 61 78 20 23 0a 0a 20 20 20 20 20 20 20 20 5f  tax #..        _
0850: 5f 4c 43 52 2f 6f 70 74 69 6f 6e 28 72 75 6c 65  _LCR/option(rule
0860: 6e 61 6d 65 29 5f 5f 0a 20 20 20 20 20 20 20 20  name)__.        
0870: 20 20 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20      pattern.    
0880: 20 20 20 20 20 20 20 20 3c 3c 2d 20 63 6f 6e 64          <<- cond
0890: 69 74 69 6f 6e 20 2d 3e 3e 20 65 72 72 6f 72 5f  ition ->> error_
08a0: 73 75 67 67 65 73 74 69 6f 6e 73 20 20 23 20 6d  suggestions  # m
08b0: 65 73 73 61 67 65 5f 65 72 72 6f 72 7c 68 74 74  essage_error|htt
08c0: 70 3a 2f 2f 61 77 65 62 73 69 74 65 2e 6e 65 74  p://awebsite.net
08d0: 2e 2e 2e 0a 20 20 20 20 20 20 20 20 20 20 20 20  ....            
08e0: 3c 3c 2d 20 63 6f 6e 64 69 74 69 6f 6e 20 7e 3e  <<- condition ~>
08f0: 3e 20 74 65 78 74 5f 72 65 77 72 69 74 69 6e 67  > text_rewriting
0900: 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c 3c 2d  .            <<-
0910: 20 63 6f 6e 64 69 74 69 6f 6e 20 3d 3e 3e 20 63   condition =>> c
0920: 6f 6d 6d 61 6e 64 73 5f 66 6f 72 5f 64 69 73 61  ommands_for_disa
0930: 6d 62 69 67 75 61 74 69 6f 6e 0a 20 20 20 20 20  mbiguation.     
0940: 20 20 20 20 20 20 20 2e 2e 2e 0a 0a 50 61 74 74         .....Patt
0950: 65 72 6e 73 20 61 72 65 20 77 72 69 74 74 65 6e  erns are written
0960: 20 77 69 74 68 20 74 68 65 20 50 79 74 68 6f 6e   with the Python
0970: 20 73 79 6e 74 61 78 20 66 6f 72 20 72 65 67 75   syntax for regu
0980: 6c 61 72 20 65 78 70 72 65 73 73 69 6f 6e 73 3a  lar expressions:
0990: 0a 68 74 74 70 3a 2f 2f 64 6f 63 73 2e 70 79 74  .http://docs.pyt
09a0: 68 6f 6e 2e 6f 72 67 2f 6c 69 62 72 61 72 79 2f  hon.org/library/
09b0: 72 65 2e 68 74 6d 6c 0a 0a 54 68 65 72 65 20 63  re.html..There c
09c0: 61 6e 20 62 65 20 6f 6e 65 20 6f 72 20 73 65 76  an be one or sev
09d0: 65 72 61 6c 20 61 63 74 69 6f 6e 73 20 66 6f 72  eral actions for
09e0: 20 65 61 63 68 20 72 75 6c 65 2c 20 65 78 65 63   each rule, exec
09f0: 75 74 65 64 20 74 68 65 20 6f 72 64 65 72 20 74  uted the order t
0a00: 68 65 79 20 61 72 65 0a 77 72 69 74 74 65 6e 2e  hey are.written.
0a10: 0a 0a 43 6f 6e 64 69 74 69 6f 6e 73 20 61 72 65  ..Conditions are
0a20: 20 6f 70 74 69 6f 6e 61 6c 2c 20 69 2e 65 2e 3a   optional, i.e.:
0a30: 0a 0a 20 20 20 20 20 20 20 20 3c 3c 2d 20 7e 3e  ..        <<- ~>
0a40: 3e 20 72 65 70 6c 61 63 65 6d 65 6e 74 0a 0a 0a  > replacement...
0a50: 4c 43 52 20 66 6c 61 67 73 20 6d 65 61 6e 73 3a  LCR flags means:
0a60: 0a 0a 2a 20 4c 3a 20 4c 65 66 74 20 62 6f 75 6e  ..* L: Left boun
0a70: 64 61 72 79 20 66 6f 72 20 74 68 65 20 72 65 67  dary for the reg
0a80: 65 78 0a 2a 20 43 3a 20 43 61 73 65 20 73 65 6e  ex.* C: Case sen
0a90: 73 69 74 69 76 65 6e 65 73 73 0a 2a 20 52 3a 20  sitiveness.* R: 
0aa0: 52 69 67 68 74 20 62 6f 75 6e 64 61 72 79 20 66  Right boundary f
0ab0: 6f 72 20 74 68 65 20 72 65 67 65 78 0a 0a 4c 65  or the regex..Le
0ac0: 66 74 20 62 6f 75 6e 64 61 72 79 20 28 4c 29 3a  ft boundary (L):
0ad0: 0a 0a 3e 20 20 20 60 5b 60 20 20 20 20 20 77 6f  ..>   `[`     wo
0ae0: 72 64 20 62 6f 75 6e 64 61 72 79 0a 0a 3e 20 20  rd boundary..>  
0af0: 20 60 3c 60 20 20 20 20 20 6e 6f 20 77 6f 72 64   `<`     no word
0b00: 20 62 6f 75 6e 64 61 72 79 0a 0a 72 69 67 68 74   boundary..right
0b10: 20 62 6f 75 6e 64 61 72 79 20 28 52 29 3a 0a 0a   boundary (R):..
0b20: 3e 20 20 20 60 5d 60 20 20 20 20 20 77 6f 72 64  >   `]`     word
0b30: 20 62 6f 75 6e 64 61 72 79 0a 0a 3e 20 20 20 60   boundary..>   `
0b40: 3e 60 20 20 20 20 20 6e 6f 20 77 6f 72 64 20 62  >`     no word b
0b50: 6f 75 6e 64 61 72 79 0a 0a 43 61 73 65 20 73 65  oundary..Case se
0b60: 6e 73 69 74 69 76 65 6e 65 73 73 20 28 43 29 3a  nsitiveness (C):
0b70: 0a 0a 3e 20 20 20 60 69 60 20 20 20 20 20 63 61  ..>   `i`     ca
0b80: 73 65 20 69 6e 73 65 6e 73 69 74 69 76 65 0a 0a  se insensitive..
0b90: 3e 20 20 20 60 73 60 20 20 20 20 20 63 61 73 65  >   `s`     case
0ba0: 20 73 65 6e 73 69 74 69 76 65 0a 0a 3e 20 20 20   sensitive..>   
0bb0: 60 75 60 20 20 20 20 20 75 70 70 65 72 63 61 73  `u`     uppercas
0bc0: 65 20 61 6c 6c 6f 77 65 64 20 66 6f 72 20 6c 6f  e allowed for lo
0bd0: 77 65 72 63 61 73 65 20 63 68 61 72 61 63 74 65  wercase characte
0be0: 72 73 0a 0a 3e 3e 20 20 20 20 20 20 20 20 20 20  rs..>>          
0bf0: 69 2e 65 2e 3a 20 20 22 57 6f 72 64 22 20 20 62  i.e.:  "Word"  b
0c00: 65 63 6f 6d 65 73 20 20 22 57 5b 6f 4f 5d 5b 72  ecomes  "W[oO][r
0c10: 52 5d 5b 64 44 5d 22 0a 0a 45 78 61 6d 70 6c 65  R][dD]"..Example
0c20: 73 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f 5b 69  s:..        __[i
0c30: 5d 5f 5f 20 20 70 61 74 74 65 72 6e 0a 20 20 20  ]__  pattern.   
0c40: 20 20 20 20 20 5f 5f 3c 73 5d 5f 5f 20 20 70 61       __<s]__  pa
0c50: 74 74 65 72 6e 0a 20 20 20 20 20 20 20 20 5f 5f  ttern.        __
0c60: 5b 75 3e 5f 5f 20 20 70 61 74 74 65 72 6e 0a 20  [u>__  pattern. 
0c70: 20 20 20 20 20 20 20 5f 5f 3c 73 3e 5f 5f 20 20         __<s>__  
0c80: 70 61 74 74 65 72 6e 0a 0a 0a 55 73 65 72 20 6f  pattern...User o
0c90: 70 74 69 6f 6e 20 61 63 74 69 76 61 74 69 6e 67  ption activating
0ca0: 2f 64 69 73 61 63 74 69 76 61 74 69 6e 67 20 69  /disactivating i
0cb0: 73 20 70 6f 73 73 69 62 6c 65 20 77 69 74 68 20  s possible with 
0cc0: 61 6e 20 6f 70 74 69 6f 6e 20 6e 61 6d 65 20 70  an option name p
0cd0: 6c 61 63 65 64 0a 6a 75 73 74 20 61 66 74 65 72  laced.just after
0ce0: 20 74 68 65 20 4c 43 52 20 66 6c 61 67 73 2c 20   the LCR flags, 
0cf0: 69 2e 65 2e 3a 0a 0a 20 20 20 20 20 20 20 20 5f  i.e.:..        _
0d00: 5f 5b 69 5d 2f 6f 70 74 69 6f 6e 31 5f 5f 20 20  _[i]/option1__  
0d10: 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20 20 20  pattern.        
0d20: 5f 5f 5b 75 5d 2f 6f 70 74 69 6f 6e 32 5f 5f 20  __[u]/option2__ 
0d30: 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20 20   pattern.       
0d40: 20 5f 5f 5b 73 3e 2f 6f 70 74 69 6f 6e 31 5f 5f   __[s>/option1__
0d50: 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20    pattern.      
0d60: 20 20 5f 5f 3c 75 3e 2f 6f 70 74 69 6f 6e 33 5f    __<u>/option3_
0d70: 5f 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20  _  pattern.     
0d80: 20 20 20 5f 5f 3c 69 3e 2f 6f 70 74 69 6f 6e 33     __<i>/option3
0d90: 5f 5f 20 20 70 61 74 74 65 72 6e 0a 0a 52 75 6c  __  pattern..Rul
0da0: 65 73 20 63 61 6e 20 62 65 20 6e 61 6d 65 64 3a  es can be named:
0db0: 0a 0a 20 20 20 20 20 20 20 20 5f 5f 5b 69 5d 2f  ..        __[i]/
0dc0: 6f 70 74 69 6f 6e 31 28 6e 61 6d 65 31 29 5f 5f  option1(name1)__
0dd0: 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20    pattern.      
0de0: 20 20 5f 5f 5b 75 5d 2f 6f 70 74 69 6f 6e 32 28    __[u]/option2(
0df0: 6e 61 6d 65 32 29 5f 5f 20 20 70 61 74 74 65 72  name2)__  patter
0e00: 6e 0a 20 20 20 20 20 20 20 20 5f 5f 5b 73 3e 2f  n.        __[s>/
0e10: 6f 70 74 69 6f 6e 31 28 6e 61 6d 65 33 29 5f 5f  option1(name3)__
0e20: 20 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20    pattern.      
0e30: 20 20 5f 5f 3c 75 3e 28 6e 61 6d 65 34 29 5f 5f    __<u>(name4)__
0e40: 20 20 20 20 20 20 20 20 20 20 70 61 74 74 65 72            patter
0e50: 6e 0a 20 20 20 20 20 20 20 20 5f 5f 3c 69 3e 28  n.        __<i>(
0e60: 6e 61 6d 65 35 29 5f 5f 20 20 20 20 20 20 20 20  name5)__        
0e70: 20 20 70 61 74 74 65 72 6e 0a 0a 45 61 63 68 20    pattern..Each 
0e80: 72 75 6c 65 20 6e 61 6d 65 20 6d 75 73 74 20 62  rule name must b
0e90: 65 20 75 6e 69 71 75 65 2e 0a 0a 0a 54 68 65 20  e unique....The 
0ea0: 4c 43 52 20 66 6c 61 67 73 20 61 72 65 20 61 6c  LCR flags are al
0eb0: 73 6f 20 6f 70 74 69 6f 6e 61 6c 2e 20 49 66 20  so optional. If 
0ec0: 79 6f 75 20 64 6f 6e e2 80 99 74 20 73 65 74 20  you don...t set 
0ed0: 74 68 65 73 65 20 66 6c 61 67 73 2c 20 74 68 65  these flags, the
0ee0: 20 64 65 66 61 75 6c 74 20 4c 43 52 0a 66 6c 61   default LCR.fla
0ef0: 67 73 20 77 69 6c 6c 20 62 65 3a 0a 0a 20 20 20  gs will be:..   
0f00: 20 20 20 20 20 5f 5f 5b 69 5d 5f 5f 0a 0a 45 78       __[i]__..Ex
0f10: 61 6d 70 6c 65 2e 20 52 65 70 6f 72 74 20 e2 80  ample. Report ..
0f20: 9c 66 6f 6f e2 80 9d 20 69 6e 20 74 68 65 20 74  .foo... in the t
0f30: 65 78 74 20 61 6e 64 20 73 75 67 67 65 73 74 20  ext and suggest 
0f40: 22 62 61 72 22 3a 0a 0a 20 20 20 20 20 20 20 20  "bar":..        
0f50: 66 6f 6f 20 3c 3c 2d 20 2d 3e 3e 20 62 61 72 20  foo <<- ->> bar 
0f60: 23 20 55 73 65 20 62 61 72 20 69 6e 73 74 65 61  # Use bar instea
0f70: 64 20 6f 66 20 66 6f 6f 2e 0a 0a 45 78 61 6d 70  d of foo...Examp
0f80: 6c 65 2e 20 52 65 63 6f 67 6e 69 7a 65 20 61 6e  le. Recognize an
0f90: 64 20 73 75 67 67 65 73 74 20 6d 69 73 73 69 6e  d suggest missin
0fa0: 67 20 68 79 70 68 65 6e 20 61 6e 64 20 72 65 77  g hyphen and rew
0fb0: 72 69 74 65 20 69 6e 74 65 72 6e 61 6c 6c 79 20  rite internally 
0fc0: 74 68 65 20 74 65 78 74 0a 77 69 74 68 20 74 68  the text.with th
0fd0: 65 20 68 79 70 68 65 6e 3a 0a 0a 20 20 20 20 20  e hyphen:..     
0fe0: 20 20 20 5f 5f 5b 73 5d 5f 5f 20 66 6f 6f 20 62     __[s]__ foo b
0ff0: 61 72 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c  ar.            <
1000: 3c 2d 20 2d 3e 3e 20 66 6f 6f 2d 62 61 72 20 23  <- ->> foo-bar #
1010: 20 4d 69 73 73 69 6e 67 20 68 79 70 68 65 6e 2e   Missing hyphen.
1020: 0a 20 20 20 20 20 20 20 20 20 20 20 20 3c 3c 2d  .            <<-
1030: 20 7e 3e 3e 20 66 6f 6f 2d 62 61 72 0a 0a 0a 23   ~>> foo-bar...#
1040: 23 20 53 69 6d 70 6c 65 2d 6c 69 6e 65 20 6f 72  # Simple-line or
1050: 20 6d 75 6c 74 69 2d 6c 69 6e 65 20 72 75 6c 65   multi-line rule
1060: 73 20 23 23 0a 0a 52 75 6c 65 73 20 63 61 6e 20  s ##..Rules can 
1070: 62 65 20 62 72 65 61 6b 20 74 6f 20 6d 75 6c 74  be break to mult
1080: 69 70 6c 65 20 6c 69 6e 65 73 20 62 79 20 6c 65  iple lines by le
1090: 61 64 69 6e 67 20 74 61 62 75 6c 61 74 6f 72 73  ading tabulators
10a0: 20 6f 72 20 73 70 61 63 65 73 2e 0a 59 6f 75 20   or spaces..You 
10b0: 73 68 6f 75 6c 64 20 75 73 65 20 34 20 73 70 61  should use 4 spa
10c0: 63 65 73 2e 0a 0a 45 78 61 6d 70 6c 65 73 3a 0a  ces...Examples:.
10d0: 0a 20 20 20 20 20 20 20 20 5f 5f 3c 73 3e 5f 5f  .        __<s>__
10e0: 20 70 61 74 74 65 72 6e 0a 20 20 20 20 20 20 20   pattern.       
10f0: 20 20 20 20 20 3c 3c 2d 20 63 6f 6e 64 69 74 69       <<- conditi
1100: 6f 6e 20 2d 3e 3e 20 72 65 70 6c 61 63 65 6d 65  on ->> replaceme
1110: 6e 74 0a 20 20 20 20 20 20 20 20 20 20 20 20 23  nt.            #
1120: 20 6d 65 73 73 61 67 65 0a 20 20 20 20 20 20 20   message.       
1130: 20 20 20 20 20 3c 3c 2d 20 63 6f 6e 64 69 74 69       <<- conditi
1140: 6f 6e 20 2d 3e 3e 20 73 75 67 67 65 73 74 69 6f  on ->> suggestio
1150: 6e 20 23 20 6d 65 73 73 61 67 65 0a 20 20 20 20  n # message.    
1160: 20 20 20 20 20 20 20 20 3c 3c 2d 20 63 6f 6e 64          <<- cond
1170: 69 74 69 6f 6e 20 7e 3e 3e 20 74 65 78 74 5f 72  ition ~>> text_r
1180: 65 77 72 69 74 69 6e 67 0a 20 20 20 20 20 20 20  ewriting.       
1190: 20 20 20 20 20 3c 3c 2d 20 3d 3e 3e 20 64 69 73       <<- =>> dis
11a0: 61 6d 62 69 67 75 61 74 69 6f 6e 0a 0a 20 20 20  ambiguation..   
11b0: 20 20 20 20 20 5f 5f 3c 73 3e 5f 5f 20 70 61 74       __<s>__ pat
11c0: 74 65 72 6e 20 3c 3c 2d 20 63 6f 6e 64 69 74 69  tern <<- conditi
11d0: 6f 6e 20 2d 3e 3e 20 72 65 70 6c 61 63 65 6d 65  on ->> replaceme
11e0: 6e 74 20 23 20 6d 65 73 73 61 67 65 0a 0a 0a 23  nt # message...#
11f0: 23 20 57 68 69 74 65 73 70 61 63 65 73 20 61 74  # Whitespaces at
1200: 20 74 68 65 20 62 6f 72 64 65 72 20 6f 66 20 70   the border of p
1210: 61 74 74 65 72 6e 73 20 6f 72 20 73 75 67 67 65  atterns or sugge
1220: 73 74 69 6f 6e 73 20 23 23 0a 0a 45 78 61 6d 70  stions ##..Examp
1230: 6c 65 3a 20 52 65 63 6f 67 6e 69 7a 65 20 64 6f  le: Recognize do
1240: 75 62 6c 65 20 6f 72 20 6d 6f 72 65 20 73 70 61  uble or more spa
1250: 63 65 73 20 61 6e 64 20 73 75 67 67 65 73 74 73  ces and suggests
1260: 20 61 20 73 69 6e 67 6c 65 20 73 70 61 63 65 3a   a single space:
1270: 0a 0a 20 20 20 20 20 20 20 20 5f 5f 3c 73 3e 5f  ..        __<s>_
1280: 5f 20 20 22 20 20 2b 22 20 3c 3c 2d 20 2d 3e 3e  _  "  +" <<- ->>
1290: 20 22 20 22 20 20 20 20 20 20 23 20 45 78 74 72   " "      # Extr
12a0: 61 20 73 70 61 63 65 28 73 29 2e 0a 0a 43 68 61  a space(s)...Cha
12b0: 72 61 63 74 65 72 73 20 60 22 60 20 70 72 6f 74  racters `"` prot
12c0: 65 63 74 20 73 70 61 63 65 73 20 69 6e 20 74 68  ect spaces in th
12d0: 65 20 70 61 74 74 65 72 6e 20 61 6e 64 20 69 6e  e pattern and in
12e0: 20 74 68 65 20 72 65 70 6c 61 63 65 6d 65 6e 74   the replacement
12f0: 20 74 65 78 74 2e 0a 0a 0a 23 23 20 50 61 74 74   text....## Patt
1300: 65 72 6e 20 67 72 6f 75 70 73 20 61 6e 64 20 62  ern groups and b
1310: 61 63 6b 20 72 65 66 65 72 65 6e 63 65 73 20 23  ack references #
1320: 23 0a 0a 49 74 20 69 73 20 75 73 75 61 6c 6c 79  #..It is usually
1330: 20 75 73 65 66 75 6c 20 74 6f 20 72 65 74 72 69   useful to retri
1340: 65 76 65 20 70 61 72 74 73 20 6f 66 20 74 68 65  eve parts of the
1350: 20 6d 61 74 63 68 65 64 20 70 61 74 74 65 72 6e   matched pattern
1360: 2e 20 57 65 20 73 69 6d 70 6c 79 20 75 73 65 0a  . We simply use.
1370: 70 61 72 65 6e 74 68 65 73 69 73 20 69 6e 20 70  parenthesis in p
1380: 61 74 74 65 72 6e 20 74 6f 20 67 65 74 20 67 72  attern to get gr
1390: 6f 75 70 73 20 77 69 74 68 20 62 61 63 6b 20 72  oups with back r
13a0: 65 66 65 72 65 6e 63 65 73 2e 0a 0a 45 78 61 6d  eferences...Exam
13b0: 70 6c 65 2e 20 53 75 67 67 65 73 74 20 61 20 77  ple. Suggest a w
13c0: 6f 72 64 20 77 69 74 68 20 63 6f 72 72 65 63 74  ord with correct
13d0: 20 71 75 6f 74 61 74 69 6f 6e 20 6d 61 72 6b 73   quotation marks
13e0: 3a 0a 0a 20 20 20 20 20 20 20 20 5c 22 28 5c 77  :..        \"(\w
13f0: 2b 29 5c 22 20 3c 3c 2d 20 2d 3e 3e 20 e2 80 9c  +)\" <<- ->> ...
1400: 5c 31 e2 80 9d 20 20 20 20 20 20 23 20 43 6f 72  \1...      # Cor
1410: 72 65 63 74 20 71 75 6f 74 61 74 69 6f 6e 20 6d  rect quotation m
1420: 61 72 6b 73 2e 0a 0a 45 78 61 6d 70 6c 65 2e 20  arks...Example. 
1430: 53 75 67 67 65 73 74 20 74 68 65 20 6d 69 73 73  Suggest the miss
1440: 69 6e 67 20 73 70 61 63 65 20 61 66 74 65 72 20  ing space after 
1450: 74 68 65 20 21 2c 20 3f 20 6f 72 20 2e 20 73 69  the !, ? or . si
1460: 67 6e 73 3a 0a 0a 20 20 20 20 20 20 20 20 5f 5f  gns:..        __
1470: 3c 69 5d 5f 5f 20 5c 62 28 5b 3f 21 2e 5d 29 28  <i]__ \b([?!.])(
1480: 5b 41 2d 5a 5d 2b 29 20 3c 3c 2d 20 2d 3e 3e 20  [A-Z]+) <<- ->> 
1490: 5c 31 20 5c 32 20 20 20 20 20 23 20 4d 69 73 73  \1 \2     # Miss
14a0: 69 6e 67 20 73 70 61 63 65 3f 0a 0a 45 78 61 6d  ing space?..Exam
14b0: 70 6c 65 2e 20 42 61 63 6b 20 72 65 66 65 72 65  ple. Back refere
14c0: 6e 63 65 20 69 6e 20 6d 65 73 73 61 67 65 73 2e  nce in messages.
14d0: 0a 0a 20 20 20 20 20 20 20 20 28 66 6f 6f 6f 29  ..        (fooo)
14e0: 20 62 61 72 20 3c 3c 2d 20 2d 3e 3e 20 66 6f 6f   bar <<- ->> foo
14f0: 20 20 20 20 20 20 23 20 e2 80 9c 5c 31 e2 80 9d        # ...\1...
1500: 20 73 68 6f 75 6c 64 20 62 65 3a 0a 0a 0a 23 23   should be:...##
1510: 20 50 61 74 74 65 72 6e 20 6d 61 74 63 68 69 6e   Pattern matchin
1520: 67 20 23 23 0a 0a 52 65 70 65 61 74 69 6e 67 20  g ##..Repeating 
1530: 70 61 74 74 65 72 6e 20 6d 61 74 63 68 69 6e 67  pattern matching
1540: 20 6f 66 20 61 20 73 69 6e 67 6c 65 20 72 75 6c   of a single rul
1550: 65 20 63 6f 6e 74 69 6e 75 65 73 20 61 66 74 65  e continues afte
1560: 72 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 6d  r the previous m
1570: 61 74 63 68 69 6e 67 2c 20 73 6f 0a 69 6e 73 74  atching, so.inst
1580: 65 61 64 20 6f 66 20 67 65 6e 65 72 61 6c 20 6d  ead of general m
1590: 75 6c 74 69 77 6f 72 64 20 70 61 74 74 65 72 6e  ultiword pattern
15a0: 73 2c 20 6c 69 6b 65 0a 0a 20 20 20 20 20 20 20  s, like..       
15b0: 20 28 5c 77 2b 29 20 28 5c 77 2b 29 20 3c 3c 2d   (\w+) (\w+) <<-
15c0: 20 73 6f 6d 65 5f 63 68 65 63 6b 28 5c 31 2c 20   some_check(\1, 
15d0: 5c 32 29 20 2d 3e 3e 20 5c 31 2c 20 5c 32 20 23  \2) ->> \1, \2 #
15e0: 20 66 6f 6f 0a 0a 75 73 65 0a 0a 20 20 20 20 20   foo..use..     
15f0: 20 20 20 28 5c 77 2b 29 20 3c 3c 2d 20 73 6f 6d     (\w+) <<- som
1600: 65 5f 63 68 65 63 6b 28 5c 31 2c 20 77 6f 72 64  e_check(\1, word
1610: 28 31 29 29 20 2d 3e 3e 20 5c 31 2c 20 23 20 66  (1)) ->> \1, # f
1620: 6f 6f 0a 0a 0a 23 23 20 4e 61 6d 65 20 64 65 66  oo...## Name def
1630: 69 6e 69 74 69 6f 6e 73 20 23 23 0a 0a 47 72 61  initions ##..Gra
1640: 6d 6d 61 6c 65 63 74 65 20 73 75 70 70 6f 72 74  mmalecte support
1650: 73 20 6e 61 6d 65 20 64 65 66 69 6e 69 74 69 6f  s name definitio
1660: 6e 73 20 74 6f 20 73 69 6d 70 6c 69 66 79 20 74  ns to simplify t
1670: 68 65 20 64 65 73 63 72 69 70 74 69 6f 6e 20 6f  he description o
1680: 66 20 74 68 65 0a 63 6f 6d 70 6c 65 78 20 72 75  f the.complex ru
1690: 6c 65 73 2e 0a 0a 45 78 61 6d 70 6c 65 3a 0a 0a  les...Example:..
16a0: 20 20 20 20 20 20 20 20 44 45 46 3a 20 6e 61 6d          DEF: nam
16b0: 65 20 70 61 74 74 65 72 6e 0a 0a 55 73 61 67 65  e pattern..Usage
16c0: 20 69 6e 20 74 68 65 20 72 75 6c 65 73 3a 0a 0a   in the rules:..
16d0: 20 20 20 20 20 20 20 20 28 7b 6e 61 6d 65 7d 29          ({name})
16e0: 20 28 5c 77 2b 29 20 2d 3e 3e 20 22 5c 31 2d 5c   (\w+) ->> "\1-\
16f0: 32 22 20 23 20 4d 69 73 73 69 6e 67 20 68 79 70  2" # Missing hyp
1700: 68 65 6e 3f 0a 0a 0a 23 23 20 4d 75 6c 74 69 70  hen?...## Multip
1710: 6c 65 20 73 75 67 67 65 73 74 69 6f 6e 73 20 23  le suggestions #
1720: 23 0a 0a 55 73 65 20 60 7c 60 20 69 6e 20 74 68  #..Use `|` in th
1730: 65 20 72 65 70 6c 61 63 65 6d 65 6e 74 20 74 65  e replacement te
1740: 78 74 20 74 6f 20 61 64 64 20 6d 75 6c 74 69 70  xt to add multip
1750: 6c 65 20 73 75 67 67 65 73 74 69 6f 6e 73 3a 0a  le suggestions:.
1760: 0a 45 78 61 6d 70 6c 65 2e 20 46 6f 6f 2c 20 46  .Example. Foo, F
1770: 4f 4f 2c 20 42 61 72 20 61 6e 64 20 42 41 52 20  OO, Bar and BAR 
1780: 73 75 67 67 65 73 74 69 6f 6e 73 20 66 6f 72 20  suggestions for 
1790: 74 68 65 20 69 6e 70 75 74 20 77 6f 72 64 20 22  the input word "
17a0: 66 6f 6f 22 2e 0a 0a 20 20 20 20 20 20 20 20 66  foo"...        f
17b0: 6f 6f 20 3c 3c 2d 20 2d 3e 3e 20 46 6f 6f 7c 46  oo <<- ->> Foo|F
17c0: 4f 4f 7c 42 61 72 7c 42 41 52 20 23 20 44 69 64  OO|Bar|BAR # Did
17d0: 20 79 6f 75 20 6d 65 61 6e 3a 0a 0a 0a 23 23 20   you mean:...## 
17e0: 4e 6f 20 73 75 67 67 65 73 74 69 6f 6e 20 23 23  No suggestion ##
17f0: 0a 0a 59 6f 75 20 63 61 6e 20 64 69 73 70 6c 61  ..You can displa
1800: 79 20 6d 65 73 73 61 67 65 20 77 69 74 68 6f 75  y message withou
1810: 74 20 6d 61 6b 69 6e 67 20 73 75 67 67 65 73 74  t making suggest
1820: 69 6f 6e 73 2e 20 46 6f 72 20 74 68 69 73 20 70  ions. For this p
1830: 75 72 70 6f 73 65 2c 0a 75 73 65 20 61 20 73 69  urpose,.use a si
1840: 6e 67 6c 65 20 63 68 61 72 61 63 74 65 72 20 5f  ngle character _
1850: 20 69 6e 20 74 68 65 20 73 75 67 67 65 73 74 69   in the suggesti
1860: 6f 6e 20 66 69 65 6c 64 2e 0a 0a 45 78 61 6d 70  on field...Examp
1870: 6c 65 2e 20 4e 6f 20 73 75 67 67 65 73 74 69 6f  le. No suggestio
1880: 6e 2e 0a 0a 20 20 20 20 20 20 20 20 66 6f 6f 62  n...        foob
1890: 61 72 20 3c 3c 2d 20 2d 3e 3e 20 5f 20 23 20 4d  ar <<- ->> _ # M
18a0: 65 73 73 61 67 65 0a 0a 0a 23 23 20 50 6f 73 69  essage...## Posi
18b0: 74 69 6f 6e 69 6e 67 20 23 23 0a 0a 50 6f 73 69  tioning ##..Posi
18c0: 74 69 6f 6e 69 6e 67 20 69 73 20 76 61 6c 69 64  tioning is valid
18d0: 20 6f 6e 6c 79 20 66 6f 72 20 65 72 72 6f 72 20   only for error 
18e0: 63 72 65 61 74 69 6f 6e 20 61 6e 64 20 74 65 78  creation and tex
18f0: 74 20 72 65 77 72 69 74 69 6e 67 2e 0a 0a 42 79  t rewriting...By
1900: 20 64 65 66 61 75 6c 74 2c 20 74 68 65 20 66 75   default, the fu
1910: 6c 6c 20 70 61 74 74 65 72 6e 20 77 69 6c 6c 20  ll pattern will 
1920: 62 65 20 75 6e 64 65 72 6c 69 6e 65 64 20 77 69  be underlined wi
1930: 74 68 20 62 6c 75 65 2e 20 59 6f 75 20 63 61 6e  th blue. You can
1940: 20 73 68 6f 72 74 65 6e 20 74 68 65 0a 75 6e 64   shorten the.und
1950: 65 72 6c 69 6e 65 64 20 74 65 78 74 20 61 72 65  erlined text are
1960: 61 20 62 79 20 73 70 65 63 69 66 79 69 6e 67 20  a by specifying 
1970: 61 20 62 61 63 6b 20 72 65 66 65 72 65 6e 63 65  a back reference
1980: 20 67 72 6f 75 70 20 6f 66 20 74 68 65 20 70 61   group of the pa
1990: 74 74 65 72 6e 2e 0a 49 6e 73 74 65 61 64 20 6f  ttern..Instead o
19a0: 66 20 77 72 69 74 69 6e 67 20 2d 3e 3e 2c 20 77  f writing ->>, w
19b0: 72 69 74 65 20 2d 6e 3e 3e 20 20 6e 20 62 65 69  rite -n>>  n bei
19c0: 6e 67 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ng the number of
19d0: 20 61 20 62 61 63 6b 20 72 65 66 65 72 65 6e 63   a back referenc
19e0: 65 0a 67 72 6f 75 70 2e 20 41 63 74 75 61 6c 6c  e.group. Actuall
19f0: 79 2c 20 20 2d 3e 3e 20 20 69 73 20 73 69 6d 69  y,  ->>  is simi
1a00: 6c 61 72 20 74 6f 20 20 2d 30 3e 3e 0a 0a 45 78  lar to  -0>>..Ex
1a10: 61 6d 70 6c 65 3a 0a 0a 20 20 20 20 20 20 20 20  ample:..        
1a20: 28 79 69 6e 67 29 20 61 6e 64 20 79 61 6e 67 20  (ying) and yang 
1a30: 3c 3c 2d 20 2d 31 3e 3e 20 79 69 6e 20 23 20 44  <<- -1>> yin # D
1a40: 69 64 20 79 6f 75 20 6d 65 61 6e 3a 0a 0a 20 20  id you mean:..  
1a50: 20 20 20 20 20 20 5f 5f 5b 73 5d 5f 5f 20 28 4d        __[s]__ (M
1a60: 72 2e 29 20 5b 41 2d 5a 5d 5c 77 2b 20 3c 3c 2d  r.) [A-Z]\w+ <<-
1a70: 20 7e 31 3e 3e 20 4d 72 0a 0a 0a 23 23 23 20 43   ~1>> Mr...### C
1a80: 6f 6d 70 61 72 69 73 6f 6e 20 23 23 23 0a 0a 52  omparison ###..R
1a90: 75 6c 65 20 41 3a 0a 0a 20 20 20 20 20 20 20 20  ule A:..        
1aa0: 79 69 6e 67 20 61 6e 64 20 79 61 6e 67 20 20 20  ying and yang   
1ab0: 20 20 20 20 3c 3c 2d 20 2d 3e 3e 20 20 20 20 20      <<- ->>     
1ac0: 79 69 6e 20 61 6e 64 20 79 61 6e 67 20 20 20 20  yin and yang    
1ad0: 20 20 20 20 23 20 44 69 64 20 79 6f 75 20 6d 65      # Did you me
1ae0: 61 6e 3a 0a 0a 52 75 6c 65 20 42 3a 0a 0a 20 20  an:..Rule B:..  
1af0: 20 20 20 20 20 20 28 79 69 6e 67 29 20 61 6e 64        (ying) and
1b00: 20 79 61 6e 67 20 20 20 20 20 3c 3c 2d 20 2d 31   yang     <<- -1
1b10: 3e 3e 20 20 20 20 79 69 6e 20 20 20 20 20 20 20  >>    yin       
1b20: 20 20 20 20 20 20 20 20 20 20 23 20 44 69 64 20            # Did 
1b30: 79 6f 75 20 6d 65 61 6e 3a 0a 0a 57 69 74 68 20  you mean:..With 
1b40: 74 68 65 20 72 75 6c 65 20 41 2c 20 74 68 65 20  the rule A, the 
1b50: 66 75 6c 6c 20 70 61 74 74 65 72 6e 20 69 73 20  full pattern is 
1b60: 75 6e 64 65 72 6c 69 6e 65 64 3a 0a 0a 20 20 20  underlined:..   
1b70: 20 20 20 20 20 79 69 6e 67 20 61 6e 64 20 79 61       ying and ya
1b80: 6e 67 0a 20 20 20 20 20 20 20 20 5e 5e 5e 5e 5e  ng.        ^^^^^
1b90: 5e 5e 5e 5e 5e 5e 5e 5e 0a 0a 57 69 74 68 20 74  ^^^^^^^^..With t
1ba0: 68 65 20 72 75 6c 65 20 42 2c 20 6f 6e 6c 79 20  he rule B, only 
1bb0: 74 68 65 20 66 69 72 73 74 20 67 72 6f 75 70 20  the first group 
1bc0: 69 73 20 75 6e 64 65 72 6c 69 6e 65 64 3a 0a 0a  is underlined:..
1bd0: 20 20 20 20 20 20 20 20 79 69 6e 67 20 61 6e 64          ying and
1be0: 20 79 61 6e 67 0a 20 20 20 20 20 20 20 20 5e 5e   yang.        ^^
1bf0: 5e 5e 0a 0a 0a 23 23 20 4c 6f 6e 67 65 72 20 65  ^^...## Longer e
1c00: 78 70 6c 61 6e 61 74 69 6f 6e 73 20 77 69 74 68  xplanations with
1c10: 20 55 52 4c 73 20 23 23 0a 0a 57 61 72 6e 69 6e   URLs ##..Warnin
1c20: 67 20 6d 65 73 73 61 67 65 73 20 63 61 6e 20 63  g messages can c
1c30: 6f 6e 74 61 69 6e 20 6f 70 74 69 6f 6e 61 6c 20  ontain optional 
1c40: 55 52 4c 20 66 6f 72 20 6c 6f 6e 67 65 72 20 65  URL for longer e
1c50: 78 70 6c 61 6e 61 74 69 6f 6e 73 2e 0a 0a 20 20  xplanations...  
1c60: 20 20 20 20 20 20 79 6f 75 72 e2 80 99 73 0a 20        your...s. 
1c70: 20 20 20 20 20 20 20 20 20 20 20 3c 3c 2d 20 2d             <<- -
1c80: 3e 3e 20 79 6f 75 72 73 0a 20 20 20 20 20 20 20  >> yours.       
1c90: 20 20 20 20 20 23 20 50 6f 73 73 65 73 73 69 76       # Possessiv
1ca0: 65 20 70 72 6f 6e 6f 75 6e 3a 7c 68 74 74 70 3a  e pronoun:|http:
1cb0: 2f 2f 65 6e 2e 77 69 6b 69 70 65 64 69 61 2e 6f  //en.wikipedia.o
1cc0: 72 67 2f 77 69 6b 69 2f 50 6f 73 73 65 73 73 69  rg/wiki/Possessi
1cd0: 76 65 5f 70 72 6f 6e 6f 75 6e 0a 0a 0a 0a 23 20  ve_pronoun....# 
1ce0: 54 65 78 74 20 72 65 77 72 69 74 69 6e 67 20 23  Text rewriting #
1cf0: 0a 0a 45 78 61 6d 70 6c 65 2e 20 52 65 70 6c 61  ..Example. Repla
1d00: 63 69 6e 67 20 61 20 73 74 72 69 6e 67 20 62 79  cing a string by
1d10: 20 61 6e 6f 74 68 65 72 2e 0a 0a 20 20 20 20 20   another...     
1d20: 20 20 20 4d 72 2e 20 5b 41 2d 5a 5d 5c 77 2b 20     Mr. [A-Z]\w+ 
1d30: 3c 3c 2d 20 7e 3e 3e 20 4d 69 73 74 65 72 0a 0a  <<- ~>> Mister..
1d40: 57 41 52 4e 49 4e 47 3a 20 54 68 65 20 72 65 70  WARNING: The rep
1d50: 6c 61 63 69 6e 67 20 74 65 78 74 20 6d 75 73 74  lacing text must
1d60: 20 62 65 20 73 68 6f 72 74 65 72 20 74 68 61 6e   be shorter than
1d70: 20 74 68 65 20 72 65 70 6c 61 63 65 64 20 74 65   the replaced te
1d80: 78 74 20 6f 72 20 68 61 76 65 20 74 68 65 0a 73  xt or have the.s
1d90: 61 6d 65 20 6c 65 6e 67 74 68 2e 20 42 72 65 61  ame length. Brea
1da0: 6b 69 6e 67 20 74 68 69 73 20 72 75 6c 65 20 77  king this rule w
1db0: 69 6c 6c 20 6d 69 73 70 6c 61 63 65 20 66 6f 6c  ill misplace fol
1dc0: 6c 6f 77 69 6e 67 20 65 72 72 6f 72 20 72 65 70  lowing error rep
1dd0: 6f 72 74 73 2e 20 59 6f 75 0a 68 61 76 65 20 74  orts. You.have t
1de0: 6f 20 65 6e 73 75 72 65 20 79 6f 75 72 73 65 6c  o ensure yoursel
1df0: 66 20 74 68 65 20 72 75 6c 65 73 20 63 6f 6d 70  f the rules comp
1e00: 6c 79 20 77 69 74 68 20 74 68 69 73 20 63 6f 6e  ly with this con
1e10: 73 74 72 61 69 6e 74 2c 20 47 72 61 6d 6d 61 6c  straint, Grammal
1e20: 65 63 74 65 0a 77 6f 6e e2 80 99 74 20 64 6f 20  ecte.won...t do 
1e30: 69 74 20 66 6f 72 20 79 6f 75 2e 0a 0a 53 70 65  it for you...Spe
1e40: 63 69 66 69 63 20 63 6f 6d 6d 61 6e 64 73 20 66  cific commands f
1e50: 6f 72 20 74 65 78 74 20 72 65 77 72 69 74 69 6e  or text rewritin
1e60: 67 3a 0a 0a 60 7e 3e 3e 20 2a 60 0a 0a 3e 20 20  g:..`~>> *`..>  
1e70: 20 72 65 70 6c 61 63 65 20 62 79 20 77 68 69 74   replace by whit
1e80: 65 73 70 61 63 65 73 0a 0a 60 7e 3e 3e 20 40 60  espaces..`~>> @`
1e90: 0a 0a 3e 20 20 20 72 65 70 6c 61 63 65 20 62 79  ..>   replace by
1ea0: 20 61 72 72 6f 62 61 73 2c 20 75 73 65 66 75 6c   arrobas, useful
1eb0: 20 6d 6f 73 74 6c 79 20 61 74 20 66 69 72 73 74   mostly at first
1ec0: 20 70 61 73 73 2c 20 77 68 65 72 65 20 69 74 20   pass, where it 
1ed0: 69 73 20 61 64 76 69 73 65 64 20 74 6f 0a 3e 20  is advised to.> 
1ee0: 20 20 63 68 65 63 6b 20 75 73 61 67 65 20 6f 66    check usage of
1ef0: 20 70 75 6e 63 74 75 61 74 69 6f 6e 73 20 61 6e   punctuations an
1f00: 64 20 77 68 69 74 65 73 70 61 63 65 73 2e 0a 3e  d whitespaces..>
1f10: 20 20 20 40 20 61 72 65 20 61 75 74 6f 6d 61 74     @ are automat
1f20: 69 63 61 6c 6c 79 20 72 65 6d 6f 76 65 64 20 61  ically removed a
1f30: 74 20 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20  t the beginning 
1f40: 6f 66 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61  of the second pa
1f50: 73 73 2e 0a 0a 59 6f 75 20 63 61 6e 20 75 73 65  ss...You can use
1f60: 20 70 6f 73 69 74 69 6f 6e 69 6e 67 20 77 69 74   positioning wit
1f70: 68 20 74 65 78 74 20 72 65 77 72 69 74 69 6e 67  h text rewriting
1f80: 20 61 63 74 69 6f 6e 73 2e 0a 0a 20 20 20 20 20   actions...     
1f90: 20 20 20 4d 72 28 2e 20 5b 41 2d 5a 5d 5c 77 2b     Mr(. [A-Z]\w+
1fa0: 29 20 3c 3c 2d 20 7e 31 3e 3e 20 2a 0a 0a 59 6f  ) <<- ~1>> *..Yo
1fb0: 75 20 63 61 6e 20 61 6c 73 6f 20 63 61 6c 6c 20  u can also call 
1fc0: 50 79 74 68 6f 6e 20 65 78 70 72 65 73 73 69 6f  Python expressio
1fd0: 6e 73 2e 0a 0a 20 20 20 20 20 20 20 20 5f 5f 5b  ns...        __[
1fe0: 73 5d 5f 5f 20 4d 72 2e 20 28 5b 61 2d 7a 5d 5c  s]__ Mr. ([a-z]\
1ff0: 77 2b 29 20 3c 3c 2d 20 7e 31 3e 3e 20 3d 5c 31  w+) <<- ~1>> =\1
2000: 2e 75 70 70 65 72 28 29 0a 0a 0a 23 20 54 65 78  .upper()...# Tex
2010: 74 20 70 72 65 70 72 6f 63 65 73 73 69 6e 67 20  t preprocessing 
2020: 61 6e 64 20 6d 75 6c 74 69 2d 70 61 73 73 65 73  and multi-passes
2030: 20 63 68 65 63 6b 69 6e 67 20 23 0a 0a 4f 6e 20   checking #..On 
2040: 65 61 63 68 20 70 61 73 73 2c 20 4c 69 67 68 74  each pass, Light
2050: 70 72 6f 6f 66 20 75 73 65 73 20 72 75 6c 65 73  proof uses rules
2060: 20 77 72 69 74 74 65 6e 20 69 6e 20 74 68 65 20   written in the 
2070: 74 65 78 74 20 70 72 65 70 72 6f 63 65 73 73 6f  text preprocesso
2080: 72 20 74 6f 20 6d 6f 64 69 66 79 0a 69 6e 74 65  r to modify.inte
2090: 72 6e 61 6c 6c 79 20 74 68 65 20 74 65 78 74 20  rnally the text 
20a0: 62 65 66 6f 72 65 20 63 68 65 63 6b 69 6e 67 20  before checking 
20b0: 74 68 65 20 74 65 78 74 2e 0a 0a 54 68 65 20 74  the text...The t
20c0: 65 78 74 20 70 72 65 70 72 6f 63 65 73 73 6f 72  ext preprocessor
20d0: 20 69 73 20 75 73 65 66 75 6c 20 74 6f 20 73 69   is useful to si
20e0: 6d 70 6c 69 66 79 20 74 65 78 74 73 20 61 6e 64  mplify texts and
20f0: 20 77 72 69 74 65 20 73 69 6d 70 6c 69 65 72 20   write simplier 
2100: 63 68 65 63 6b 69 6e 67 0a 72 75 6c 65 73 2e 0a  checking.rules..
2110: 0a 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 73 65  .For example, se
2120: 6e 74 65 6e 63 65 73 20 77 69 74 68 20 74 68 65  ntences with the
2130: 20 73 61 6d 65 20 67 72 61 6d 6d 61 72 20 6d 69   same grammar mi
2140: 73 74 61 6b 65 3a 0a 0a 20 20 20 20 20 20 20 20  stake:..        
2150: 54 68 65 73 65 20 e2 80 9c 63 61 74 73 e2 80 9d  These ...cats...
2160: 20 61 72 65 20 62 6c 61 63 6b 2e 0a 20 20 20 20   are black..    
2170: 20 20 20 20 54 68 65 73 65 20 63 61 74 73 20 61      These cats a
2180: 72 65 20 e2 80 9c 62 6c 61 63 6b e2 80 9d 2e 0a  re ...black.....
2190: 20 20 20 20 20 20 20 20 54 68 65 73 65 20 63 61          These ca
21a0: 74 73 20 61 72 65 20 61 62 73 6f 6c 75 74 65 6c  ts are absolutel
21b0: 79 20 62 6c 61 63 6b 2e 0a 20 20 20 20 20 20 20  y black..       
21c0: 20 54 68 65 73 65 20 73 74 75 70 69 64 20 e2 80   These stupid ..
21d0: 9c 63 61 74 73 e2 80 9d 20 61 72 65 20 61 6c 6c  .cats... are all
21e0: 20 62 6c 61 63 6b 2e 0a 20 20 20 20 20 20 20 20   black..        
21f0: 54 68 65 73 65 20 75 6e 6b 6e 6f 77 6e 20 63 61  These unknown ca
2200: 74 73 20 61 72 65 20 61 73 20 70 65 72 20 75 73  ts are as per us
2210: 75 61 6c 20 62 6c 61 63 6b 2e 0a 0a 49 6e 73 74  ual black...Inst
2220: 65 61 64 20 6f 66 20 77 72 69 74 74 69 6e 67 20  ead of writting 
2230: 63 6f 6d 70 6c 65 78 20 72 75 6c 65 73 20 6f 72  complex rules or
2240: 20 73 65 76 65 72 61 6c 20 72 75 6c 65 73 20 74   several rules t
2250: 6f 20 66 69 6e 64 20 6d 69 73 74 61 6b 65 73 20  o find mistakes 
2260: 66 6f 72 20 61 6c 6c 20 70 6f 73 73 69 62 6c 65  for all possible
2270: 0a 63 61 73 65 73 2c 20 79 6f 75 20 63 61 6e 20  .cases, you can 
2280: 75 73 65 20 74 68 65 20 74 65 78 74 20 70 72 65  use the text pre
2290: 70 72 6f 63 65 73 73 6f 72 20 74 6f 20 73 69 6d  processor to sim
22a0: 70 6c 69 66 79 20 74 68 65 20 74 65 78 74 2e 0a  plify the text..
22b0: 0a 54 6f 20 72 65 6d 6f 76 65 20 74 68 65 20 63  .To remove the c
22c0: 68 61 72 73 20 e2 80 9c e2 80 9d 2c 20 77 72 69  hars ......, wri
22d0: 74 65 3a 0a 0a 20 20 20 20 20 20 20 20 5b e2 80  te:..        [..
22e0: 9c e2 80 9d 5d 20 2d 3e 3e 20 2a 0a 0a 54 68 65  ....] ->> *..The
22f0: 20 2a 20 6d 65 61 6e 73 3a 20 72 65 70 6c 61 63   * means: replac
2300: 65 20 74 65 78 74 20 62 79 20 77 68 69 74 65 73  e text by whites
2310: 70 61 63 65 73 2e 0a 0a 53 69 6d 69 6c 61 72 6c  paces...Similarl
2320: 79 20 74 6f 20 67 72 61 6d 6d 61 72 20 72 75 6c  y to grammar rul
2330: 65 73 2c 20 79 6f 75 20 63 61 6e 20 61 64 64 20  es, you can add 
2340: 63 6f 6e 64 69 74 69 6f 6e 73 3a 0a 0a 20 20 20  conditions:..   
2350: 20 20 20 20 20 5c 77 2b 6c 79 20 3c 3c 2d 20 6d       \w+ly <<- m
2360: 6f 72 70 68 28 5c 30 2c 20 22 61 64 76 65 72 62  orph(\0, "adverb
2370: 22 29 20 2d 3e 3e 20 2a 0a 0a 59 6f 75 20 63 61  ") ->> *..You ca
2380: 6e 20 61 6c 73 6f 20 72 65 6d 6f 76 65 20 61 20  n also remove a 
2390: 67 72 6f 75 70 20 72 65 66 65 72 65 6e 63 65 3a  group reference:
23a0: 0a 0a 20 20 20 20 20 20 20 20 74 68 65 73 65 20  ..        these 
23b0: 28 5c 77 2b 29 20 28 5c 77 2b 29 20 3c 3c 2d 20  (\w+) (\w+) <<- 
23c0: 6d 6f 72 70 68 28 5c 31 2c 20 22 61 64 6a 65 63  morph(\1, "adjec
23d0: 74 69 76 65 22 29 20 61 6e 64 20 6d 6f 72 70 68  tive") and morph
23e0: 28 5c 32 2c 20 22 6e 6f 75 6e 22 29 20 2d 31 3e  (\2, "noun") -1>
23f0: 3e 20 2a 0a 20 20 20 20 20 20 20 20 28 61 6d 7c  > *.        (am|
2400: 61 72 65 7c 69 73 7c 77 65 72 65 7c 77 61 73 29  are|is|were|was)
2410: 20 28 61 6c 6c 29 20 3c 3c 2d 20 2d 32 3e 3e 20   (all) <<- -2>> 
2420: 2a 0a 0a 57 69 74 68 20 74 68 65 73 65 20 72 75  *..With these ru
2430: 6c 65 73 2c 20 79 6f 75 20 67 65 74 20 74 68 65  les, you get the
2440: 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 65 6e 74 65   following sente
2450: 6e 63 65 73 3a 0a 0a 20 20 20 20 20 20 20 20 54  nces:..        T
2460: 68 65 73 65 20 20 63 61 74 73 20 20 61 72 65 20  hese  cats  are 
2470: 62 6c 61 63 6b 2e 0a 20 20 20 20 20 20 20 20 54  black..        T
2480: 68 65 73 65 20 63 61 74 73 20 61 72 65 20 20 62  hese cats are  b
2490: 6c 61 63 6b 20 2e 0a 20 20 20 20 20 20 20 20 54  lack ..        T
24a0: 68 65 73 65 20 63 61 74 73 20 61 72 65 20 20 20  hese cats are   
24b0: 20 20 20 20 20 20 20 20 20 62 6c 61 63 6b 2e 0a           black..
24c0: 20 20 20 20 20 20 20 20 54 68 65 73 65 20 20 20          These   
24d0: 20 20 20 20 20 20 63 61 74 73 20 20 61 72 65 20        cats  are 
24e0: 20 20 20 20 62 6c 61 63 6b 2e 0a 20 20 20 20 20      black..     
24f0: 20 20 20 54 68 65 73 65 20 20 20 20 20 20 20 20     These        
2500: 20 63 61 74 73 20 61 72 65 20 20 20 20 20 20 20   cats are       
2510: 20 20 20 20 20 20 20 62 6c 61 63 6b 2e 0a 0a 54         black...T
2520: 68 65 73 65 20 67 72 61 6d 6d 61 72 20 6d 69 73  hese grammar mis
2530: 74 61 6b 65 73 20 63 61 6e 20 62 65 20 64 65 74  takes can be det
2540: 65 63 74 65 64 20 77 69 74 68 20 6f 6e 65 20 73  ected with one s
2550: 69 6d 70 6c 65 20 72 75 6c 65 3a 0a 0a 20 20 20  imple rule:..   
2560: 20 20 20 20 20 74 68 65 73 65 20 2b 28 5c 77 2b       these +(\w+
2570: 29 20 2b 61 72 65 20 2b 28 5c 77 2b 73 29 0a 20  ) +are +(\w+s). 
2580: 20 20 20 20 20 20 20 20 20 20 20 3c 3c 2d 20 6d             <<- m
2590: 6f 72 70 68 28 5c 31 2c 20 22 6e 6f 75 6e 22 29  orph(\1, "noun")
25a0: 20 61 6e 64 20 6d 6f 72 70 68 28 5c 32 2c 20 22   and morph(\2, "
25b0: 70 6c 75 72 61 6c 22 29 0a 20 20 20 20 20 20 20  plural").       
25c0: 20 20 20 20 20 2d 32 3e 3e 20 5f 20 20 20 20 20       -2>> _     
25d0: 20 20 20 20 20 20 20 20 20 23 20 41 64 6a 65 63           # Adjec
25e0: 74 69 76 65 73 20 61 72 65 20 69 6e 76 61 72 69  tives are invari
25f0: 61 62 6c 65 2e 0a 0a 49 6e 73 74 65 61 64 20 6f  able...Instead o
2600: 66 20 72 65 70 6c 61 63 69 6e 67 20 74 65 78 74  f replacing text
2610: 20 77 69 74 68 20 77 68 69 74 65 73 70 61 63 65   with whitespace
2620: 73 2c 20 79 6f 75 20 63 61 6e 20 72 65 70 6c 61  s, you can repla
2630: 63 65 20 74 65 78 74 20 77 69 74 68 20 40 2e 0a  ce text with @..
2640: 0a 20 20 20 20 20 20 20 20 68 74 74 70 73 3f 3a  .        https?:
2650: 2f 2f 5c 53 2b 20 2d 3e 3e 20 40 0a 0a 54 68 69  //\S+ ->> @..Thi
2660: 73 20 69 73 20 75 73 65 66 75 6c 20 69 66 20 61  s is useful if a
2670: 74 20 66 69 72 73 74 20 70 61 73 73 20 79 6f 75  t first pass you
2680: 20 77 72 69 74 65 20 72 75 6c 65 73 20 74 6f 20   write rules to 
2690: 63 68 65 63 6b 20 73 75 63 63 65 73 73 69 76 65  check successive
26a0: 20 77 68 69 74 65 73 70 61 63 65 73 2e 0a 40 20   whitespaces..@ 
26b0: 61 72 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  are automaticall
26c0: 79 20 72 65 6d 6f 76 65 64 20 61 74 20 74 68 65  y removed at the
26d0: 20 73 65 63 6f 6e 64 20 70 61 73 73 2e 0a 0a 59   second pass...Y
26e0: 6f 75 20 63 61 6e 20 61 6c 73 6f 20 72 65 70 6c  ou can also repl
26f0: 61 63 65 20 61 6e 79 20 74 65 78 74 20 61 73 20  ace any text as 
2700: 79 6f 75 20 77 69 73 68 2e 0a 0a 20 20 20 20 20  you wish...     
2710: 20 20 20 4d 69 73 74 65 72 20 3c 3c 2d 20 2d 3e     Mister <<- ->
2720: 3e 20 4d 72 0a 20 20 20 20 20 20 20 20 28 4d 72  > Mr.        (Mr
2730: 73 3f 29 5b 2e 5d 20 3c 3c 2d 20 2d 3e 3e 20 5c  s?)[.] <<- ->> \
2740: 31 0a 0a 0a 23 20 44 69 73 61 6d 62 69 67 75 61  1...# Disambigua
2750: 74 69 6f 6e 20 23 0a 0a 57 68 65 6e 20 47 72 61  tion #..When Gra
2760: 6d 6d 61 6c 65 63 74 65 20 61 6e 61 6c 79 73 65  mmalecte analyse
2770: 73 20 61 20 77 6f 72 64 20 77 69 74 68 20 6d 6f  s a word with mo
2780: 72 70 68 2c 20 62 65 66 6f 72 65 20 72 65 71 75  rph, before requ
2790: 65 73 74 69 6e 67 20 74 68 65 0a 50 4f 53 20 74  esting the.POS t
27a0: 61 67 73 20 74 6f 20 74 68 65 20 64 69 63 74 69  ags to the dicti
27b0: 6f 6e 61 72 79 2c 20 69 74 20 63 68 65 63 6b 73  onary, it checks
27c0: 20 69 66 20 74 68 65 72 65 20 69 73 20 61 20 73   if there is a s
27d0: 74 6f 72 65 64 20 6d 61 72 6b 65 72 20 66 6f 72  tored marker for
27e0: 20 74 68 65 0a 70 6f 73 69 74 69 6f 6e 20 77 68   the.position wh
27f0: 65 72 65 20 74 68 65 20 77 6f 72 64 20 69 73 2e  ere the word is.
2800: 20 49 66 20 74 68 65 72 65 20 69 73 20 61 20 6d   If there is a m
2810: 61 72 6b 65 72 2c 20 47 72 61 6d 6d 61 6c 65 63  arker, Grammalec
2820: 74 65 20 75 73 65 73 20 74 68 65 20 73 74 6f 72  te uses the stor
2830: 65 64 0a 64 61 74 61 20 61 6e 64 20 64 6f 6e e2  ed.data and don.
2840: 80 99 74 20 6d 61 6b 65 20 72 65 71 75 65 73 74  ..t make request
2850: 20 74 6f 20 74 68 65 20 64 69 63 74 69 6f 6e 61   to the dictiona
2860: 72 79 2e 0a 0a 54 68 65 20 64 69 73 61 6d 62 69  ry...The disambi
2870: 67 75 61 74 69 6f 6e 20 63 6f 6d 6d 61 6e 64 73  guation commands
2880: 20 73 74 6f 72 65 20 50 4f 53 20 74 61 67 73 20   store POS tags 
2890: 61 74 20 74 68 65 20 70 6f 73 69 74 69 6f 6e 20  at the position 
28a0: 6f 66 20 61 20 77 6f 72 64 2e 0a 0a 54 68 65 72  of a word...Ther
28b0: 65 20 69 73 20 33 20 63 6f 6d 6d 61 6e 64 73 20  e is 3 commands 
28c0: 66 6f 72 20 64 69 73 61 6d 62 69 67 75 61 74 69  for disambiguati
28d0: 6f 6e 2e 0a 0a 60 73 65 6c 65 63 74 28 6e 2c 20  on...`select(n, 
28e0: 70 61 74 74 65 72 6e 29 60 0a 0a 3e 20 20 20 73  pattern)`..>   s
28f0: 74 6f 72 65 73 20 61 74 20 70 6f 73 69 74 69 6f  tores at positio
2900: 6e 20 6e 20 6f 6e 6c 79 20 74 68 65 20 50 4f 53  n n only the POS
2910: 20 74 61 67 73 20 6f 66 20 74 68 65 20 77 6f 72   tags of the wor
2920: 64 20 6d 61 74 63 68 69 6e 67 20 74 68 65 20 70  d matching the p
2930: 61 74 74 65 72 6e 2e 0a 0a 60 65 78 63 6c 75 64  attern...`exclud
2940: 65 28 6e 2c 20 70 61 74 74 65 72 6e 29 60 0a 0a  e(n, pattern)`..
2950: 3e 20 20 20 73 74 6f 72 65 73 20 61 74 20 70 6f  >   stores at po
2960: 73 69 74 69 6f 6e 20 6e 20 74 68 65 20 50 4f 53  sition n the POS
2970: 20 74 61 67 73 20 6f 66 20 74 68 65 20 77 6f 72   tags of the wor
2980: 64 2c 20 65 78 63 65 70 74 20 74 68 6f 73 65 20  d, except those 
2990: 6d 61 74 63 68 69 6e 67 20 74 68 65 0a 20 20 20  matching the.   
29a0: 20 70 61 74 74 65 72 6e 2e 0a 0a 60 64 65 66 69   pattern...`defi
29b0: 6e 65 28 6e 2c 20 5b 64 65 66 69 6e 69 74 69 6f  ne(n, [definitio
29c0: 6e 73 5d 29 60 0a 0a 3e 20 20 20 73 74 6f 72 65  ns])`..>   store
29d0: 73 20 61 74 20 70 6f 73 69 74 69 6f 6e 20 6e 20  s at position n 
29e0: 74 68 65 20 50 4f 53 20 74 61 67 73 20 69 6e 20  the POS tags in 
29f0: 64 65 66 69 6e 69 74 69 6f 6e 73 20 28 61 20 6c  definitions (a l
2a00: 69 73 74 20 6f 66 20 73 74 72 69 6e 67 73 29 2e  ist of strings).
2a10: 0a 0a 45 78 61 6d 70 6c 65 73 3a 0a 0a 20 20 20  ..Examples:..   
2a20: 20 20 20 20 20 3d 3e 3e 20 73 65 6c 65 63 74 28       =>> select(
2a30: 5c 31 2c 20 22 70 6f 3a 6e 6f 75 6e 20 69 73 3a  \1, "po:noun is:
2a40: 70 6c 22 29 0a 20 20 20 20 20 20 20 20 3d 3e 3e  pl").        =>>
2a50: 20 65 78 63 6c 75 64 65 28 5c 31 2c 20 22 70 6f   exclude(\1, "po
2a60: 3a 76 65 72 62 22 29 0a 20 20 20 20 20 20 20 20  :verb").        
2a70: 3d 3e 3e 20 64 65 66 69 6e 65 28 5c 31 2c 20 5b  =>> define(\1, [
2a80: 22 70 6f 3a 61 64 76 22 5d 29 0a 20 20 20 20 20  "po:adv"]).     
2a90: 20 20 20 3d 3e 3e 20 65 78 63 6c 75 64 65 28 5c     =>> exclude(\
2aa0: 31 2c 20 22 70 6f 3a 76 65 72 62 22 29 20 61 6e  1, "po:verb") an
2ab0: 64 20 64 65 66 69 6e 65 28 5c 32 2c 20 5b 22 70  d define(\2, ["p
2ac0: 6f 3a 61 64 76 22 5d 29 20 61 6e 64 20 73 65 6c  o:adv"]) and sel
2ad0: 65 63 74 28 5c 33 2c 20 22 70 6f 3a 61 64 76 22  ect(\3, "po:adv"
2ae0: 29 0a 0a 4e 6f 74 65 3a 20 73 65 6c 65 63 74 2c  )..Note: select,
2af0: 20 65 78 63 6c 75 64 65 20 61 6e 64 20 64 65 66   exclude and def
2b00: 69 6e 65 20 41 4c 57 41 59 53 20 72 65 74 75 72  ine ALWAYS retur
2b10: 6e 20 54 72 75 65 2e 0a 0a 49 66 20 73 65 6c 65  n True...If sele
2b20: 63 74 20 61 6e 64 20 65 78 63 6c 75 64 65 20 67  ct and exclude g
2b30: 65 6e 65 72 61 74 65 20 61 6e 20 65 6d 70 74 79  enerate an empty
2b40: 20 6c 69 73 74 2c 20 6e 6f 20 6d 61 72 6b 65 72   list, no marker
2b50: 20 69 73 20 73 65 74 2e 0a 0a 57 69 74 68 20 64   is set...With d
2b60: 65 66 69 6e 65 2c 20 79 6f 75 20 6d 75 73 74 20  efine, you must 
2b70: 73 65 74 20 61 20 6c 69 73 74 20 6f 66 20 50 4f  set a list of PO
2b80: 53 20 74 61 67 73 2e 20 45 78 61 6d 70 6c 65 3a  S tags. Example:
2b90: 0a 0a 20 20 20 20 20 20 20 20 64 65 66 69 6e 65  ..        define
2ba0: 28 5c 31 2c 20 5b 22 70 6f 3a 6e 6f 6d 20 69 73  (\1, ["po:nom is
2bb0: 3a 70 6c 75 72 22 2c 20 22 70 6f 3a 61 64 6a 20  :plur", "po:adj 
2bc0: 69 73 3a 73 69 6e 67 22 2c 20 22 70 6f 3a 61 64  is:sing", "po:ad
2bd0: 76 22 5d 29 0a 0a 0a 23 20 43 6f 6e 64 69 74 69  v"])...# Conditi
2be0: 6f 6e 73 20 23 0a 0a 43 6f 6e 64 69 74 69 6f 6e  ons #..Condition
2bf0: 73 20 61 72 65 20 50 79 74 68 6f 6e 20 65 78 70  s are Python exp
2c00: 72 65 73 73 69 6f 6e 73 2c 20 74 68 65 79 20 6d  ressions, they m
2c10: 75 73 74 20 72 65 74 75 72 6e 20 61 20 76 61 6c  ust return a val
2c20: 75 65 2c 20 77 68 69 63 68 20 77 69 6c 6c 20 62  ue, which will b
2c30: 65 0a 65 76 61 6c 75 61 74 65 64 20 61 73 20 62  e.evaluated as b
2c40: 6f 6f 6c 65 61 6e 2e 20 59 6f 75 20 63 61 6e 20  oolean. You can 
2c50: 75 73 65 20 74 68 65 20 75 73 75 61 6c 20 50 79  use the usual Py
2c60: 74 68 6f 6e 20 73 79 6e 74 61 78 20 61 6e 64 20  thon syntax and 
2c70: 6c 69 62 72 61 72 69 65 73 2e 0a 0a 59 6f 75 20  libraries...You 
2c80: 63 61 6e 20 63 61 6c 6c 20 70 61 74 74 65 72 6e  can call pattern
2c90: 20 73 75 62 67 72 6f 75 70 73 20 76 69 61 20 5c   subgroups via \
2ca0: 30 2c 20 5c 31 2c 20 5c 32 e2 80 a6 0a 0a 45 78  0, \1, \2.....Ex
2cb0: 61 6d 70 6c 65 3a 0a 0a 20 20 20 20 20 20 20 20  ample:..        
2cc0: 74 68 65 73 65 20 28 5c 77 2b 29 0a 20 20 20 20  these (\w+).    
2cd0: 20 20 20 20 20 20 20 20 3c 3c 2d 20 5c 31 20 3d          <<- \1 =
2ce0: 3d 20 22 6d 61 6e 22 20 2d 31 3e 3e 20 6d 65 6e  = "man" -1>> men
2cf0: 20 20 20 20 20 20 20 20 23 20 4d 61 6e 20 69 73          # Man is
2d00: 20 61 20 73 69 6e 67 75 6c 61 72 20 6e 6f 75 6e   a singular noun
2d10: 2e 20 55 73 65 20 74 68 65 20 70 6c 75 72 61 6c  . Use the plural
2d20: 20 66 6f 72 6d 3a 0a 0a 59 6f 75 20 63 61 6e 20   form:..You can 
2d30: 61 6c 73 6f 20 61 70 70 6c 79 20 66 75 6e 63 74  also apply funct
2d40: 69 6f 6e 73 20 74 6f 20 73 75 62 67 72 6f 75 70  ions to subgroup
2d50: 73 20 6c 69 6b 65 3a 0a 0a 20 20 20 20 20 20 20  s like:..       
2d60: 20 5c 31 2e 73 74 61 72 74 73 77 69 74 68 28 22   \1.startswith("
2d70: 61 22 29 0a 20 20 20 20 20 20 20 20 5c 33 2e 69  a").        \3.i
2d80: 73 6c 6f 77 65 72 28 29 0a 20 20 20 20 20 20 20  slower().       
2d90: 20 72 65 2e 73 65 61 72 63 68 28 22 70 61 74 74   re.search("patt
2da0: 65 72 6e 22 2c 20 5c 32 29 0a 0a 0a 23 23 20 53  ern", \2)...## S
2db0: 74 61 6e 64 61 72 64 20 66 75 6e 63 74 69 6f 6e  tandard function
2dc0: 73 20 23 23 0a 0a 60 77 6f 72 64 28 6e 29 60 0a  s ##..`word(n)`.
2dd0: 0a 3e 20 20 20 63 61 74 63 68 65 73 20 74 68 65  .>   catches the
2de0: 20 6e 74 68 20 6e 65 78 74 20 77 6f 72 64 20 61   nth next word a
2df0: 66 74 65 72 20 74 68 65 20 70 61 74 74 65 72 6e  fter the pattern
2e00: 20 28 73 65 70 61 72 61 74 65 64 20 6f 6e 6c 79   (separated only
2e10: 20 62 79 20 77 68 69 74 65 20 73 70 61 63 65 73   by white spaces
2e20: 29 2e 0a 3e 20 20 20 72 65 74 75 72 6e 73 20 4e  )..>   returns N
2e30: 6f 6e 65 20 69 66 20 6e 6f 20 77 6f 72 64 20 63  one if no word c
2e40: 61 74 63 68 65 64 0a 0a 60 77 6f 72 64 28 2d 6e  atched..`word(-n
2e50: 29 60 0a 0a 3e 20 20 20 63 61 74 63 68 65 73 20  )`..>   catches 
2e60: 74 68 65 20 6e 74 68 20 6e 65 78 74 20 77 6f 72  the nth next wor
2e70: 64 20 62 65 66 6f 72 65 20 74 68 65 20 70 61 74  d before the pat
2e80: 74 65 72 6e 20 28 73 65 70 61 72 61 74 65 64 20  tern (separated 
2e90: 6f 6e 6c 79 20 62 79 20 77 68 69 74 65 20 73 70  only by white sp
2ea0: 61 63 65 73 29 2e 0a 3e 20 20 20 72 65 74 75 72  aces)..>   retur
2eb0: 6e 73 20 4e 6f 6e 65 20 69 66 20 6e 6f 20 77 6f  ns None if no wo
2ec0: 72 64 20 63 61 74 63 68 65 64 0a 0a 60 61 66 74  rd catched..`aft
2ed0: 65 72 28 72 65 67 65 78 5b 2c 20 6e 65 67 5f 72  er(regex[, neg_r
2ee0: 65 67 65 78 5d 29 60 0a 0a 3e 20 20 20 63 68 65  egex])`..>   che
2ef0: 63 6b 73 20 69 66 20 74 68 65 20 74 65 78 74 20  cks if the text 
2f00: 61 66 74 65 72 20 74 68 65 20 70 61 74 74 65 72  after the patter
2f10: 6e 20 6d 61 74 63 68 65 73 20 74 68 65 20 72 65  n matches the re
2f20: 67 65 78 2e 0a 0a 60 62 65 66 6f 72 65 28 72 65  gex...`before(re
2f30: 67 65 78 5b 2c 20 6e 65 67 5f 72 65 67 65 78 5d  gex[, neg_regex]
2f40: 29 60 0a 0a 3e 20 20 20 63 68 65 63 6b 73 20 69  )`..>   checks i
2f50: 66 20 74 68 65 20 74 65 78 74 20 62 65 66 6f 72  f the text befor
2f60: 65 20 74 68 65 20 70 61 74 74 65 72 6e 20 6d 61  e the pattern ma
2f70: 74 63 68 65 73 20 74 68 65 20 72 65 67 65 78 2e  tches the regex.
2f80: 0a 0a 60 74 65 78 74 61 72 65 61 28 72 65 67 65  ..`textarea(rege
2f90: 78 5b 2c 20 6e 65 67 5f 72 65 67 65 78 5d 29 60  x[, neg_regex])`
2fa0: 0a 0a 3e 20 20 20 20 63 68 65 63 6b 73 20 69 66  ..>    checks if
2fb0: 20 74 68 65 20 66 75 6c 6c 20 74 65 78 74 20 6f   the full text o
2fc0: 66 20 74 68 65 20 63 68 65 63 6b 65 64 20 61 72  f the checked ar
2fd0: 65 61 20 28 70 61 72 61 67 72 61 70 68 20 6f 72  ea (paragraph or
2fe0: 20 73 65 6e 74 65 6e 63 65 29 20 6d 61 74 63 68   sentence) match
2ff0: 65 73 20 74 68 65 20 72 65 67 65 78 2e 0a 0a 60  es the regex...`
3000: 6d 6f 72 70 68 28 6e 2c 20 72 65 67 65 78 5b 2c  morph(n, regex[,
3010: 20 6e 65 67 5f 72 65 67 65 78 5d 5b 2c 20 6e 6f   neg_regex][, no
3020: 5f 77 6f 72 64 3d 46 61 6c 73 65 5d 29 60 0a 0a  _word=False])`..
3030: 3e 20 20 20 63 68 65 63 6b 73 20 69 66 20 61 6c  >   checks if al
3040: 6c 20 74 61 67 73 20 6f 66 20 74 68 65 20 77 6f  l tags of the wo
3050: 72 64 20 69 6e 20 67 72 6f 75 70 20 6e 20 6d 61  rd in group n ma
3060: 74 63 68 20 74 68 65 20 72 65 67 65 78 2e 0a 3e  tch the regex..>
3070: 20 20 20 69 66 20 6e 65 67 5f 72 65 67 65 78 20     if neg_regex 
3080: 3d 20 22 2a 22 2c 20 72 65 74 75 72 6e 73 20 54  = "*", returns T
3090: 72 75 65 20 6f 6e 6c 79 20 69 66 20 61 6c 6c 20  rue only if all 
30a0: 6d 6f 72 70 68 6f 6c 6f 67 69 65 73 20 6d 61 74  morphologies mat
30b0: 63 68 20 74 68 65 20 72 65 67 65 78 2e 0a 3e 20  ch the regex..> 
30c0: 20 20 69 66 20 74 68 65 72 65 20 69 73 20 6e 6f    if there is no
30d0: 20 77 6f 72 64 20 61 74 20 70 6f 73 69 74 69 6f   word at positio
30e0: 6e 20 6e 2c 20 72 65 74 75 72 6e 73 20 74 68 65  n n, returns the
30f0: 20 76 61 6c 75 65 20 6f 66 20 6e 6f 5f 77 6f 72   value of no_wor
3100: 64 2e 0a 0a 60 61 6e 61 6c 79 73 65 28 6e 2c 20  d...`analyse(n, 
3110: 72 65 67 65 78 5b 2c 20 6e 65 67 5f 72 65 67 65  regex[, neg_rege
3120: 78 5d 5b 2c 20 6e 6f 5f 77 6f 72 64 3d 46 61 6c  x][, no_word=Fal
3130: 73 65 5d 29 60 0a 0a 3e 20 20 20 63 68 65 63 6b  se])`..>   check
3140: 73 20 69 66 20 61 6c 6c 20 74 61 67 73 20 6f 66  s if all tags of
3150: 20 74 68 65 20 77 6f 72 64 20 69 6e 20 67 72 6f   the word in gro
3160: 75 70 20 6e 20 6d 61 74 63 68 20 74 68 65 20 72  up n match the r
3170: 65 67 65 78 2e 0a 3e 20 20 20 69 66 20 6e 65 67  egex..>   if neg
3180: 5f 72 65 67 65 78 20 3d 20 22 2a 22 2c 20 72 65  _regex = "*", re
3190: 74 75 72 6e 73 20 54 72 75 65 20 6f 6e 6c 79 20  turns True only 
31a0: 69 66 20 61 6c 6c 20 6d 6f 72 70 68 6f 6c 6f 67  if all morpholog
31b0: 69 65 73 20 6d 61 74 63 68 20 74 68 65 20 72 65  ies match the re
31c0: 67 65 78 2e 0a 3e 20 20 20 69 66 20 74 68 65 72  gex..>   if ther
31d0: 65 20 69 73 20 6e 6f 20 77 6f 72 64 20 61 74 20  e is no word at 
31e0: 70 6f 73 69 74 69 6f 6e 20 6e 2c 20 72 65 74 75  position n, retu
31f0: 72 6e 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66  rns the value of
3200: 20 6e 6f 5f 77 6f 72 64 2e 0a 0a 0a 60 6f 70 74   no_word....`opt
3210: 69 6f 6e 28 6f 70 74 69 6f 6e 5f 6e 61 6d 65 29  ion(option_name)
3220: 60 0a 0a 3e 20 20 20 72 65 74 75 72 6e 73 20 54  `..>   returns T
3230: 72 75 65 20 69 66 20 6f 70 74 69 6f 6e 5f 6e 61  rue if option_na
3240: 6d 65 20 69 73 20 61 63 74 69 76 61 74 65 64 20  me is activated 
3250: 65 6c 73 65 20 46 61 6c 73 65 0a 0a 4e 6f 74 65  else False..Note
3260: 3a 20 74 68 65 20 61 6e 61 6c 79 73 69 73 20 69  : the analysis i
3270: 73 20 64 6f 6e 65 20 6f 6e 20 74 68 65 20 70 72  s done on the pr
3280: 65 70 72 6f 63 65 73 73 65 64 20 74 65 78 74 2e  eprocessed text.
3290: 0a 0a 0a 23 20 44 65 66 61 75 6c 74 20 76 61 72  ...# Default var
32a0: 69 61 62 6c 65 73 20 23 0a 0a 60 73 43 6f 75 6e  iables #..`sCoun
32b0: 74 72 79 60 0a 0a 3e 20 20 20 49 74 20 63 6f 6e  try`..>   It con
32c0: 74 61 69 6e 73 20 74 68 65 20 63 75 72 72 65 6e  tains the curren
32d0: 74 20 63 6f 75 6e 74 72 79 20 6c 6f 63 61 6c 65  t country locale
32e0: 20 6f 66 20 74 68 65 20 63 68 65 63 6b 65 64 20   of the checked 
32f0: 70 61 72 61 67 72 61 70 68 2e 0a 0a 20 20 20 20  paragraph...    
3300: 20 20 20 20 63 6f 6c 6f 75 72 20 3c 3c 2d 20 73      colour <<- s
3310: 43 6f 75 6e 74 72 79 20 3d 3d 20 22 55 53 22 20  Country == "US" 
3320: 2d 3e 3e 20 63 6f 6c 6f 72 20 20 20 20 20 20 20  ->> color       
3330: 23 20 55 73 65 20 41 6d 65 72 69 63 61 6e 20 45  # Use American E
3340: 6e 67 6c 69 73 68 20 73 70 65 6c 6c 69 6e 67 2e  nglish spelling.
3350: 0a 0a 0a 0a 23 20 45 78 70 72 65 73 73 69 6f 6e  ....# Expression
3360: 73 20 69 6e 20 74 68 65 20 73 75 67 67 65 73 74  s in the suggest
3370: 69 6f 6e 73 20 23 0a 0a 53 75 67 67 65 73 74 69  ions #..Suggesti
3380: 6f 6e 73 20 73 74 61 72 74 65 64 20 62 79 20 61  ons started by a
3390: 6e 20 65 71 75 61 6c 20 73 69 67 6e 20 61 72 65  n equal sign are
33a0: 20 50 79 74 68 6f 6e 20 73 74 72 69 6e 67 20 65   Python string e
33b0: 78 70 72 65 73 73 69 6f 6e 73 0a 65 78 74 65 6e  xpressions.exten
33c0: 64 65 64 20 77 69 74 68 20 70 6f 73 73 69 62 6c  ded with possibl
33d0: 65 20 62 61 63 6b 20 72 65 66 65 72 65 6e 63 65  e back reference
33e0: 73 20 61 6e 64 20 6e 61 6d 65 64 20 64 65 66 69  s and named defi
33f0: 6e 69 74 69 6f 6e 73 3a 0a 0a 45 78 61 6d 70 6c  nitions:..Exampl
3400: 65 3a 0a 0a 20 20 20 20 20 20 20 20 3c 3c 2d 20  e:..        <<- 
3410: 2d 3e 3e 20 3d 20 27 22 27 20 2b 20 5c 31 2e 75  ->> = '"' + \1.u
3420: 70 70 65 72 28 29 20 2b 20 27 22 27 20 20 20 20  pper() + '"'    
3430: 20 23 20 57 69 74 68 20 75 70 70 65 72 63 61 73   # With uppercas
3440: 65 20 6c 65 74 74 65 72 73 20 61 6e 64 20 71 75  e letters and qu
3450: 6f 74 61 74 69 6f 6e 20 6d 61 72 6b 73 0a 0a 0a  otation marks...
3460: 23 20 54 6f 6b 65 6e 20 72 75 6c 65 73 0a 0a 54  # Token rules..T
3470: 6f 6b 65 6e 20 72 75 6c 65 73 20 6d 75 73 74 20  oken rules must 
3480: 62 65 20 64 65 66 69 6e 65 64 20 77 69 74 68 69  be defined withi
3490: 6e 20 61 20 67 72 61 70 68 2e 0a 0a 23 23 20 54  n a graph...## T
34a0: 6f 6b 65 6e 73 0a 0a 54 6f 6b 65 6e 73 20 63 61  okens..Tokens ca
34b0: 6e 20 62 65 20 64 65 66 69 6e 65 64 20 69 6e 20  n be defined in 
34c0: 73 65 76 65 72 61 6c 20 77 61 79 73 3a 0a 0a 2a  several ways:..*
34d0: 20 56 61 6c 75 65 20 28 6d 65 61 6e 69 6e 67 20   Value (meaning 
34e0: 74 68 65 20 74 65 78 74 20 6f 66 20 74 68 65 20  the text of the 
34f0: 74 6f 6b 65 6e 29 2e 20 45 78 61 6d 70 6c 65 73  token). Examples
3500: 3a 20 60 77 6f 72 64 60 2c 20 60 3c 73 74 61 72  : `word`, `<star
3510: 74 3e 60 2c 20 60 3c 65 6e 64 3e 60 2c 20 60 2c  t>`, `<end>`, `,
3520: 60 2e 0a 2a 20 4c 65 6d 6d 61 3a 20 60 3e 6c 65  `..* Lemma: `>le
3530: 6d 6d 61 60 2e 0a 2a 20 52 65 67 65 78 3a 20 60  mma`..* Regex: `
3540: 7e 70 61 74 74 65 72 6e 60 2c 20 60 7e 70 61 74  ~pattern`, `~pat
3550: 74 65 72 6e c2 ac 61 6e 74 69 70 61 74 74 65 72  tern..antipatter
3560: 6e 60 2e 0a 2a 20 52 65 67 65 78 20 6f 6e 20 6d  n`..* Regex on m
3570: 6f 72 70 68 6f 6c 6f 67 69 65 73 3a 20 60 40 70  orphologies: `@p
3580: 61 74 74 65 72 6e 60 2c 20 60 40 70 61 74 74 65  attern`, `@patte
3590: 72 6e c2 ac 61 6e 74 69 70 61 74 74 65 72 6e 60  rn..antipattern`
35a0: 2e 0a 2a 20 54 61 67 73 3a 20 60 2f 74 61 67 60  ..* Tags: `/tag`
35b0: 2e 0a 2a 20 4d 65 74 61 74 61 67 73 3a 20 2a 4e  ..* Metatags: *N
35c0: 41 4d 45 2e 20 45 78 61 6d 70 6c 65 73 3a 20 60  AME. Examples: `
35d0: 2a 57 4f 52 44 60 2c 20 60 2a 4e 55 4d 60 2c 20  *WORD`, `*NUM`, 
35e0: 60 2a 53 49 47 4e 60 2c 20 65 74 63 2e 0a 0a 53  `*SIGN`, etc...S
35f0: 65 6c 65 63 74 69 6f 6e 20 6f 66 20 74 6f 6b 65  election of toke
3600: 6e 73 3a 20 60 5b 74 6f 6b 65 6e 31 7c 74 6f 6b  ns: `[token1|tok
3610: 65 6e 32 7c 3e 6c 65 6d 6d 61 31 7c 3e 6c 65 6d  en2|>lemma1|>lem
3620: 6d 61 32 7c 7e 70 61 74 74 65 72 6e 31 7c 40 70  ma2|~pattern1|@p
3630: 61 74 74 65 72 6e 31 7c e2 80 a6 5d 60 0a 0a 43  attern1|...]`..C
3640: 6f 6e 64 69 74 69 6f 6e 61 6c 20 74 6f 6b 65 6e  onditional token
3650: 3a 20 60 3f 74 6f 6b 65 6e c2 bf 60 0a 0a 43 6f  : `?token..`..Co
3660: 6e 64 69 74 69 6f 6e 61 6c 20 73 65 6c 65 63 74  nditional select
3670: 69 6f 6e 20 6f 66 20 74 6f 6b 65 6e 3a 20 60 3f  ion of token: `?
3680: 5b 74 6f 6b 65 6e 31 7c 74 6f 6b 65 6e 32 7c e2  [token1|token2|.
3690: 80 a6 5d c2 bf 60 0a 0a 23 23 20 54 6f 6b 65 6e  ..]..`..## Token
36a0: 20 72 65 66 65 72 65 6e 63 65 73 0a 0a 50 6f 73   references..Pos
36b0: 69 74 69 76 65 20 72 65 66 65 72 65 6e 63 65 73  itive references
36c0: 20 61 72 65 20 64 65 66 69 6e 65 64 20 62 79 20   are defined by 
36d0: 61 20 70 6f 73 69 74 69 76 65 20 69 6e 74 65 67  a positive integ
36e0: 65 72 20 60 3e 3d 20 31 60 2e 20 45 78 61 6d 70  er `>= 1`. Examp
36f0: 6c 65 73 3a 20 5c 31 2c 20 5c 32 2c 20 5c 33 2c  les: \1, \2, \3,
3700: 20 65 74 63 2e 0a 49 66 20 74 68 65 72 65 20 69   etc..If there i
3710: 73 20 61 74 20 6c 65 61 73 74 20 6f 6e 65 20 74  s at least one t
3720: 6f 6b 65 6e 20 73 65 74 20 62 65 74 77 65 65 6e  oken set between
3730: 20 70 61 72 65 6e 74 68 65 73 69 73 2c 20 74 68   parenthesis, th
3740: 65 73 65 20 6e 75 6d 62 65 72 73 20 72 65 66 65  ese numbers refe
3750: 72 20 74 6f 20 74 6f 6b 65 6e 73 20 62 65 74 77  r to tokens betw
3760: 65 65 6e 20 70 61 72 65 6e 74 68 65 73 69 73 2c  een parenthesis,
3770: 20 69 67 6e 6f 72 69 6e 67 20 61 6c 6c 20 6f 74   ignoring all ot
3780: 68 65 72 73 2e 0a 49 66 20 74 68 65 72 65 20 69  hers..If there i
3790: 73 20 6e 6f 20 74 6f 6b 65 6e 20 62 65 74 77 65  s no token betwe
37a0: 65 6e 20 70 61 72 65 6e 74 68 65 73 69 73 2c 20  en parenthesis, 
37b0: 74 68 65 73 65 20 6e 75 6d 62 65 72 73 20 72 65  these numbers re
37c0: 66 65 72 20 74 6f 20 74 6f 6b 65 6e 73 20 66 6f  fer to tokens fo
37d0: 75 6e 64 20 69 6e 20 6f 72 64 65 72 20 64 65 66  und in order def
37e0: 69 6e 65 64 20 62 79 20 74 68 65 20 72 75 6c 65  ined by the rule
37f0: 20 74 72 69 67 67 65 72 65 64 2e 0a 0a 4e 65 67   triggered...Neg
3800: 61 74 69 76 65 20 72 65 66 65 72 65 6e 63 65 73  ative references
3810: 20 61 72 65 20 64 65 66 69 6e 65 64 20 62 79 20   are defined by 
3820: 61 20 6e 65 67 61 74 69 76 65 20 69 6e 74 65 67  a negative integ
3830: 65 72 20 60 3c 3d 20 2d 31 60 2e 20 45 78 61 6d  er `<= -1`. Exam
3840: 70 6c 65 73 3a 20 5c 2d 31 2c 20 5c 2d 32 2c 20  ples: \-1, \-2, 
3850: 5c 2d 33 2c 20 65 74 63 2e 0a 54 68 65 73 65 20  \-3, etc..These 
3860: 6e 75 6d 62 65 72 73 20 72 65 66 65 72 20 74 6f  numbers refer to
3870: 20 74 68 65 20 74 6f 6b 65 6e 73 20 62 65 67 69   the tokens begi
3880: 6e 6e 69 6e 67 20 62 79 20 74 68 65 20 6c 61 73  nning by the las
3890: 74 20 6f 6e 65 20 66 6f 75 6e 64 20 62 79 20 74  t one found by t
38a0: 68 65 20 72 75 6c 65 20 74 72 69 67 67 65 72 65  he rule triggere
38b0: 64 2e 0a 0a 45 78 61 6d 70 6c 65 73 3a 0a 0a 20  d...Examples:.. 
38c0: 20 20 20 20 20 20 20 74 6f 6b 65 6e 73 3a 20 20         tokens:  
38d0: 20 20 20 20 20 20 20 20 20 20 20 61 6c 70 68 61             alpha
38e0: 20 20 20 20 20 20 20 62 65 74 61 20 20 20 20 20         beta     
38f0: 20 20 20 67 61 6d 6d 61 20 20 20 20 20 20 20 64     gamma       d
3900: 65 6c 74 61 20 20 20 20 20 20 20 65 70 73 69 6c  elta       epsil
3910: 6f 6e 0a 20 20 20 20 20 20 20 20 70 6f 73 69 74  on.        posit
3920: 69 76 65 20 72 65 66 73 3a 20 20 20 20 20 20 31  ive refs:      1
3930: 20 20 20 20 20 20 20 20 20 20 20 32 20 20 20 20             2    
3940: 20 20 20 20 20 20 20 33 20 20 20 20 20 20 20 20         3        
3950: 20 20 20 34 20 20 20 20 20 20 20 20 20 20 20 35     4           5
3960: 0a 20 20 20 20 20 20 20 20 6e 65 67 61 74 69 76  .        negativ
3970: 65 20 72 65 66 73 3a 20 20 20 20 20 20 2d 35 20  e refs:      -5 
3980: 20 20 20 20 20 20 20 20 20 2d 34 20 20 20 20 20           -4     
3990: 20 20 20 20 20 2d 33 20 20 20 20 20 20 20 20 20       -3         
39a0: 20 2d 32 20 20 20 20 20 20 20 20 20 20 2d 31 0a   -2          -1.
39b0: 0a 20 20 20 20 20 20 20 20 74 6f 6b 65 6e 73 3a  .        tokens:
39c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 61 6c 70               alp
39d0: 68 61 20 20 20 20 20 20 20 28 62 65 74 61 29 20  ha       (beta) 
39e0: 20 20 20 20 20 67 61 6d 6d 61 20 20 20 20 20 20       gamma      
39f0: 20 28 64 65 6c 74 61 29 20 20 20 20 20 65 70 73   (delta)     eps
3a00: 69 6c 6f 6e 0a 20 20 20 20 20 20 20 20 70 6f 73  ilon.        pos
3a10: 69 74 69 76 65 20 72 65 66 73 3a 20 20 20 20 20  itive refs:     
3a20: 20 20 20 20 20 20 20 20 20 20 20 20 20 31 20 20               1  
3a30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
3a40: 20 20 20 20 20 32 0a 20 20 20 20 20 20 20 20 6e       2.        n
3a50: 65 67 61 74 69 76 65 20 72 65 66 73 3a 20 20 20  egative refs:   
3a60: 20 20 20 2d 35 20 20 20 20 20 20 20 20 20 20 2d     -5          -
3a70: 34 20 20 20 20 20 20 20 20 20 20 2d 33 20 20 20  4          -3   
3a80: 20 20 20 20 20 20 20 2d 32 20 20 20 20 20 20 20         -2       
3a90: 20 20 20 2d 31 0a 0a 20 20 20 20 20 20 20 20 74     -1..        t
3aa0: 6f 6b 65 6e 73 3a 20 20 20 20 20 20 20 20 20 20  okens:          
3ab0: 20 20 20 61 6c 70 68 61 20 20 20 20 20 20 20 28     alpha       (
3ac0: 62 65 74 61 29 20 20 20 20 20 20 3f 67 61 6d 6d  beta)      ?gamm
3ad0: 61 c2 bf 20 20 20 20 20 28 64 65 6c 74 61 29 20  a..     (delta) 
3ae0: 20 20 20 20 65 70 73 69 6c 6f 6e 0a 20 20 20 20      epsilon.    
3af0: 20 20 20 20 70 6f 73 69 74 69 76 65 20 72 65 66      positive ref
3b00: 73 3a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  s:              
3b10: 20 20 20 20 31 20 20 20 20 20 20 20 20 20 20 20      1           
3b20: 20 20 20 20 20 20 20 20 20 20 20 20 32 0a 20 20              2.  
3b30: 20 20 20 20 20 20 6e 65 67 61 74 69 76 65 20 72        negative r
3b40: 65 66 73 3a 20 20 20 20 20 20 28 2d 34 2f 2d 35  efs:      (-4/-5
3b50: 29 20 20 20 20 20 28 2d 33 2f 2d 34 29 20 20 20  )     (-3/-4)   
3b60: 20 20 28 2d 33 2f 6e 6f 6e 65 29 20 20 20 2d 32    (-3/none)   -2
3b70: 20 20 20 20 20 20 20 20 20 20 2d 31 0a 0a                  -1..