skripte/lua/MANIFEST

   1 # Verzeichnis `skripte/lua`
   2
   3 ## Vorwort
   4
   5 Selbstdokumentierende Lua-Module und Hilfsdateien zur Arbeit mit der
   6 Wortliste.
   7
   8 Die Module in diesem Verzeichnis sind im [LuaDoc][luadoc]-Format
   9 dokumentiert.  Die API-Dokumentation kann mit
  10
  11     luadoc -d API *.lua
  12
  13 erstellt werden.
  14
  15 Die Module in diesem Verzeichnis ermöglichen u. a. das Prüfen bestimmter
  16 Ausdrücke (Wörter, Datensätze) auf Wohlgeformtheit.  Die Prüfung erfolgt
  17 mit Hilfe des Lua-Moduls [LPEG][lpeg], welches
  18 [Parsing Expression Grammars][peg] (PEG) implementiert, eine Alternative
  19 zu kontextfreien Grammatiken.  Dem Quellkode der entsprechenden Module
  20 in diesem Verzeichnis kann daher eine formale Beschreibung von
  21 zulässigen Wörtern und Datensätzen in der Wortliste entnommen werden.
  22
  23 [luadoc]: http://keplerproject.github.com/luadoc/
  24 [lpeg]: http://www.inf.puc-rio.br/~roberto/lpeg/
  25 [peg]: http://bford.info/packrat/
  26
  27
  28 ## Module
  29
  30 ### `helper_records.lua`
  31
  32 Dieses Modul stellt die folgende Funktionalität zur Manipulation der
  33 Wortliste bereit:
  34
  35 * Prüfen einer Datei auf Wohlgeformtheit,
  36 * Prüfen von Datensätzen auf Wohlgeformtheit,
  37 * Zerlegen von Datensätzen,
  38
  39 Wird von anderen Lua-Skripten eingebunden.
  40
  41
  42 ### `helper_words.lua`
  43
  44 Dieses Modul stellt die folgende Funktionalität zur Manipulation der
  45 Wortliste bereit:
  46
  47 * Prüfen von Wörtern auf Wohlgeformtheit,
  48 * Normalisieren von Wörtern (Übertragen in ein für [Patgen][patgen] geeignetes Format):
  49   `Lei-nen==be[t=tu-/{tt/tt=t}u.]ches` &emsp;&rarr;&emsp; `Lei-nen-bettuches`,
  50
  51 Wird von anderen Lua-Skripten eingebunden.
  52
  53 [patgen]: http://tug.org/docs/liang/
  54
  55
  56
  57 ## Sonstige Dateien
  58
  59 ### `wortliste.ausnahmen`
  60
  61 Diese Datei enthält Datensätze der Datei `wortliste` mit bekannten
  62 „Fehlern“.  Die Datensätze dieser Datei werden von der Prüfung aller
  63 Wörter auf Wohlgeformtheit ausgenommen.  Es wird lediglich die
  64 Wohlgeformtheit des entsprechenden Datensatzes geprüft.
  65
  66
  67
  68 <!--
  69 %%% Local Variables:
  70 %%% coding: utf-8
  71 %%% mode: markdown
  72 %%% End:
  73 -->