The specification consists of three parts:

# the markup specification used to extract comments
# the formatting rules for the extracted comments
# build system behaviour

!!!The markup specification

Keywords/trigger symbols (all are followed by __space__, with one exception):

; {{!! }}      : print the text after the markup to the output, possibly
                 using variable substitution (@LEXNAME@/@RULENAME@)
; {{!!=}}      : store the source code before the markup in the variable @CODE@,
                 and print the text after the markup, possibly using
                 variable substitution (@LEXNAME@/@RULENAME@/@CODE@);
                 __code whitespace preserved verbatim__
; {{!!≈}}      : store the source code before the markup in the variable @CODE@,
                 and print the text after the markup, possibly using
                 variable substitution (@LEXNAME@/@RULENAME@/@CODE@);
                 __leading/trailing whitespace in the source code is removed, the rest squeezed__
; {{!!€fst-type:}} : Specifies the fst-type to run a test set against, must be
                 followed by the test name, and must be the first line in a
                 test set.
; {{!!€}}      : print positive test data to output
; {{!!$}}      : print negative test data to output

Variables:

; @LEXNAME@ : name of last lexc lexicon
; @RULENAME@ : name of last twol/cg3 rule
; @CODE@    : source code to the left of !!= / !!≈

The variables retain their values until they are reset (either by a new lexicon or rule name, or by a new {{!!≈}} or {{!!=}} symbol).

!!!Formatting rules for extracted comments

For all source files, the comments are formatted using jspwiki
markup [http://www.jspwiki.org/wiki/TextFormattingRules].

!!!Build system behaviour

The build system will try to generate all files listed in {{$JSP_PAGES}} in
{{$GTLANG/doc/Makefile.am}}. The jspwiki filenames are derived from the source file names according to the follwing scheme:

{{{parentdir/sourcefile.lexc => sourcefile-parentdir.jspwiki}}}

The jspwiki pages will be rebuilt whenever the corresponding source file is changed, in the standard way. Just type {{make}}, and the documentation will be rebuilt if needed.

There will also be built one large file, containing all the jspwiki documentation on one page.