GitHub/gf-core
1
0
Fork 1
mirror of https://github.com/GrammaticalFramework/gf-core.git synced 2026-04-09 04:59:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

updating documentation

Browse Source
This commit is contained in:
aarne
2005-12-01 20:31:25 +00:00
parent 13855da238
commit 9fcef260a1
2 changed files with 337 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

275
doc/gf-bibliography.html
View File

@@ -10,24 +10,158 @@
</center>
This Bibliography is under construction: new items are to be
added soon.
<h3>Publications on GF</h3>
In reverse temporal order:
M. Dymetman, V. Lux, and A. Ranta,
"XML and multilingual document authoring: converging trends",
Proceedings of the The 18th International Conference
on Computational Linguistics (COLING 2000), pp. 243-249,
Saarbruecken, 2000.
Available in
<A NAME="tex2html6"
HREF="../../articles/coling2000.ps.gz">gzipped postscript</A>.
<p>
D. A. Burke and K. Johannisson.
"Translating Formal Software Specifications to Natural Language / A Grammar-Based Approach".
In Logical Aspects of Computational Linguistics (LACL 2005), ed. by P. Blace, E. Stabler,
J. Busquets and R. Moot, Springer LNAI 3402, pp. 51-66, 2005.
<br>
<i>Relates GF not only with XML but also with definite clause grammars</i>.
<i>A paper explaining how a multilingual GF grammar is completed with Natural Language
Generation techniques to improve text quality.</i>
<p>
Bj&ouml;rn Bringert, Robin Cooper, Peter Ljungl&ouml;f, Aarne Ranta,
<a href="publ/mm-grammars-dialor/mm-grammars-dialor.pdf">Multimodal Dialogue System Grammars</a>
[<a href="publ/mm-grammars-dialor/mm-grammars-dialor-abstract.txt">abstract</a>,
<a href="publ/mm-grammars-dialor/mm-grammars-dialor.pdf">paper (pdf)</a>,
<a href="publ/mm-grammars-dialor/mm-grammars-dialor.ps">paper (ps)</a>,
<a href="publ/mm-grammars-dialor/mm-grammars-dialor.bib">bibtex</a>,
<a href="publ/mm-grammars-dialor/mm-grammars-dialor-slides.pdf">slides (pdf)</a>],
in Proceedings of
<a href="http://dialor05.loria.fr/">DIALOR'05</a>,
Ninth Workshop on the Semantics
and Pragmatics of Dialogue, Nancy, France, June 9-11, 2005.
<br>
<i>
Shows how mouse clicks can be integrated in GF grammars
alongside with speech input.
</i>
<p>
<a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a>,
<a href="http://www.cs.chalmers.se/~krijo/thesis/thesisA4.pdf">
Formal and Informal Software Specifications</a>.
PhD thesis, Computer Science, Göteborg University, 2005.
<p>
A. Ranta,
"Modular Grammar Engineering in GF".
Available in
<A
HREF="http://www.cs.chalmers.se/~aarne/articles/ar-multieng.pdf">
pdf</A>. A later version to appear in
<i>Research in Language and Computation</i>, 2005.
<br>
<i>Argues for library-based software engineering methods in grammar writing and introduces
the module system of GF.</i>
<p>
P. Ljunglöf.
<a href="http://www.cs.chalmers.se/~peb/pubs/p04-PhD-thesis.pdf">
Expressivity and Complexity of the Grammatical Framework</a>.
PhD thesis, Computer Science, Göteborg University, 2004.
<br>
<i>Language-theoretical study of GF and its parsing problem.</i>
<p>
A. Ranta,
"Grammatical Framework. A Type-Theoretical Grammar Formalism".
Article appeared in <i>The Journal of Functional Programming</i>, vol. 14:2. 2004, pp. 145-189.
Earlier version
available in
<a href="http://www.cs.chalmers.se/~aarne/articles/gf-jfp.ps.gz">
gzipped postscript</A>.
<br>
<i>Theoretical paper explaining the GF formalism and its
implementation. Aimed to be the standard reference on GF, but doesn't
cover the module system.
</i>
<p>
A. Ranta,
"Computational Semantics in Type Theory".
<i>Mathematics and Social Sciences</i>, 165:31-57, 2004
An earlier version appeared as
course material for graduate course in computational linguistics,
Gothenburg University, 2001.
Available in
<A HREF="http://www.cs.chalmers.se/~aarne/articles/compsem.ps.gz">
gzipped postscript</A>.
<br>
<i> Shows how PTQ-style grammars are implemented in GF and extends
this to type-theoretical grammars for anaphoric expressions.</i>
<p>
H. Hammarström and A. Ranta.
Cardinal Numerals Revisited in GF. Workshop on Numerals in the World's Languages.
Dept. of Linguistics Max Planck Institute for Evolutionary Anthropology, Leipzig,
Germany, 2004.
<br>
<i>
An overview of the numeral grammar project.
</i>
<p>
A. Ranta. Grammatical Framework Tutorial. In A. Beckmann and
N. Preining, editors, ESSLLI 2003 Course Material I, volume V of Collegium Logicum,
pages 1-86. Kurt Gödel Society, 2004.
<br>
<i>
A revised version of the on-line GF tutorial.
</i>
<p>
J. Khegai and A. Ranta. "Building and using a Russian Resource Grammar in GF".
In Intelligent Text Processing and Computational Linguistics (CICLing-2004),
Seoul, Korea. LNCS, pages 38-41. Springer, 2004.
<br>
<i>An introduction to the GF resource grammar project, with Russian as prime example.
</i>
<p>
A. Ranta and R. Cooper,
"Dialogue Systems as Proof Editors".
<i>Journal of Logic, Language and Information</i>, 13:225-240, 2004.
An earlier version appeared in
IJCAR/ICoS-3, Siena, June 2001.
Available in
<A NAME="tex2html8"
HREF="http://www.cs.chalmers.se/~aarne/articles/dialogue3.ps.gz">
gzipped postscript</A>.
<p>
J. Khegai, B. Nordström, and A. Ranta.
"Multilingual Syntax Editing in GF",
In
<i>Intelligent Text Processing and Computational Linguistics
(CICLing-2003)</i>,
ed. by A. Gelbukh,
Springer LNCS 2588, pp. 453-464.
Available in
<a
href="http://www.cs.chalmers.se/~aarne/articles/mexico.ps.gz">gzipped postscript</a>.
<br>
<i>
Explains how the GF GUI is used in syntax editing and discusses
how new grammars are created.
</i>
<p>
@@ -47,6 +181,20 @@ specifications in OCL and English. Carries out in full
the work proposed in the position paper (Hähnle & Ranta 2001).</i>
<p>
K. Johannisson and A.Ranta,
"Formal Verification of Multilingual Instructions",
Proceedings of the
Joint Winter Meeting 2001 of the Departments of
Computer Science and Computer Engineering,
Chalmers University of Technology and Göteborg University.
Available in
<A HREF="../../articles/aarne+krijo.ps.gz">gzipped postscript</A>.
<br>
<i>Instructions for an alarm system in four languages, verified in the
proof editor Alfa.</i>
<p>
R. Hähnle and A. Ranta,
@@ -73,6 +221,13 @@ postscript</A>.
<p>
A. Ranta. "Bescherelle bricolé",
<A HREF="../../GF2.0/doc/BeschBric.ps.gz">gzipped postscript</A>, 2001.
<br>
<i>A machine-generated book on French conjugation implemented in GF.</i>
<p>
T. Hallgren and A. Ranta, "An Extensible Proof Text Editor".
M. Parigot & A. Voronkov (eds),
Logic for Programming and Automated Reasoning (LPAR'2000),
@@ -86,35 +241,17 @@ Available in
<p>
K. Johannisson and A.Ranta,
"Formal Verification of Multilingual Instructions",
Proceedings of the
Joint Winter Meeting 2001 of the Departments of
Computer Science and Computer Engineering,
Chalmers University of Technology and Göteborg University.
M. Dymetman, V. Lux, and A. Ranta,
"XML and multilingual document authoring: converging trends",
Proceedings of the The 18th International Conference
on Computational Linguistics (COLING 2000), pp. 243-249,
Saarbruecken, 2000.
Available in
<A HREF="../../articles/aarne+krijo.ps.gz">gzipped postscript</A>.
<br>
<i>Instructions for an alarm system in four languages, verified in the
proof editor Alfa.</i>
<A NAME="tex2html6"
HREF="../../articles/coling2000.ps.gz">gzipped postscript</A>.
<p>
J. Khegai, B. Nordström, and A. Ranta.
"Multilingual Syntax Editing in GF",
In
<i>Intelligent Text Processing and Computational Linguistics
(CICLing-2003)</i>,
ed. by A. Gelbukh,
Springer LNCS 2588, pp. 453-464.
Available in
<a
href="http://www.cs.chalmers.se/~aarne/articles/mexico.ps.gz">gzipped postscript</a>.
<br>
<i>
Explains how the GF GUI is used in syntax editing and discusses
how new grammars are created.
</i>
<i>Relates GF not only with XML but also with definite clause grammars</i>.
<p>
@@ -133,71 +270,17 @@ P. M&#228;enp&#228;&#228; and A. Ranta.
<p>
A. Ranta,
"Grammatical Framework. A Type-Theoretical Grammar Formalism".
Manuscript, 2002.
Available in
<a href="http://www.cs.chalmers.se/~aarne/articles/gf-jfp.ps.gz">
gzipped postscript</A>.
Article appeared in <i>The Journal of Functional Programming</i>, vol. 14:2. 2004, pp. 145-189.
<br>
<i>Theoretical paper explaining the GF formalism and its
implementation. Aimed to be the work of reference on GF.
</i>
<p>
A. Ranta,
"Computational Semantics in Type Theory".
Course material for graduate course in computational linguistics,
Gothenburg University, 2001.
Available in
<A HREF="http://www.cs.chalmers.se/~aarne/articles/compsem.ps.gz">
gzipped postscript</A>.
<br>
<i> Shows how PTQ-style grammars are implemented in GF and extends
this to type-theoretical grammars for anaphoric expressions.</i>
A later version appeared in
<i>Mathematics and Social Sciences</i>, 165:31-57, 2004
<p>
A. Ranta and R. Cooper,
"Dialogue Systems as Proof Editors".
IJCAR/ICoS-3, Siena, June 2001.
Available in
<A NAME="tex2html8"
HREF="http://www.cs.chalmers.se/~aarne/articles/dialogue3.ps.gz">
gzipped postscript</A>. A later version appeared in
<i>Journal of Logic, Language and Information</i>, 13:225-240, 2004
<p>
A. Ranta,
"Modular Grammar Engineering in GF".
Available in
<A
HREF="http://www.cs.chalmers.se/~aarne/articles/ar-multieng.pdf">
pdf</A>. A later version to appear in
<i>Research in Language and Computation</i>, 2005.
<br>
<i>Argues for library-based software engineering methods in grammar writing and introduces
the module system of GF.</i>
<p>
A. Ranta. "Bescherelle bricolé",
<A HREF="../../GF2.0/doc/BeschBric.ps.gz">gzipped postscript</A>, 2001.
<br>
<i>A machine-generated book on French conjugation implemented in GF.</i>
<p>
<h3>Background for GF</h3>
In alphabetical order:
<p>
L. Magnusson.
<i>The Implementation of ALF - a Proof Editor based on Martin-Löf's
Monomorphic Type Theory with Explicit Substitutions</i>.

175
doc/gf-manual.html
View File

@@ -10,10 +10,11 @@
<a href="http://www.cs.chalmers.se/~aarne">
Aarne Ranta</a>,
May 17, 2005, for GF Version 2.2
December 1, 2005, for (forthcoming) GF Version 2.4
<p>
Forth version: May 17, 2005, for GF Version 2.2.<br>
Third version: June 25, 2003, for GF Version 1.2.<br>
Second version: June 17, 2002, for GF Version 1.0.<br>
First version: April 19, 2002.
@@ -147,9 +148,16 @@ All flags to the command <tt>i</tt> are recognized.
<h2>Library path</h2>
<h2>Library and grammar paths</h2>
(Not available in Version 2.2 for the moment - sorry.)
Environment variables and path wild cards.
<ul>
<li> <tt>GF_LIB_PATH</tt> gives the location of <tt>GF/lib</tt>
<li> <tt>GF_GRAMMAR_PATH</tt> gives a list of directories appended
to the explicitly given path
<li> <tt>DIR/*</tt> is expanded to the union of all subdirectories
of <tt>DIR</tt>
</ul>
<h3>Command line syntax</h3>
@@ -213,8 +221,13 @@ If Readline is not available,
a command line consisting of an integer <tt>n</tt>
repeats a command <tt>n</tt> lines back in the history.
For instance, 0 repeats the last command, 1 the second-last, etc.
This functionality usually doesn't work in Windows.
<p>
From GF version 2.4: to <b>interrupt</b> the execution of a command,
you can type [Control]-c, and it no longer terminates the GF session.
This functionality doesn't work in Windows.
<h3>Options and flags</h3>
@@ -255,15 +268,26 @@ one must know their dependence on and their effects to an
<ul>
<li> main abstract syntax (if any) - pointer to a compiled module
<li> main concrete syntax (if any) - pointer to a compiled module
<li> a list of pointers to other concrete syntaxes, for the same abstract
<li> a list of other concrete syntaxes, for the same abstract
<li> a list of other abstract syntaxes
<li> a list of all concrete syntaxes for all abstract syntaxes
<li> a list of compiled modules
<li> a list of source modules
<li> values of flags.
<li> global options
<li> a list of transfer modules
</ul>
Normally, the main concrete syntax is the last-imported one.
The name of this is the
value of the flag <tt>-lang</tt>, which can be reset by the
<tt>sf</tt> command.
<pre>
i StoneageEng.gf -- main concrete is StoneageEng
i StoneageSwe.gf -- main concrete is StoneageSwe
sf -lang=StoneageEng -- main concrete is StoneageEng
po -- show the current environment
cm LangSwe -- change main concrete and abstract
e -- empty the environment
</pre>
@@ -305,6 +329,17 @@ input for a command, so the pipe breaks there.
The following is a copy of the current <tt>HelpFile</tt>.
<pre>
-- GF help file updated for GF 2.4, 1/12/2005.
-- *: Commands and options marked with * are not yet implemented.
--
-- Each command has a long and a short name, options, and zero or more
-- arguments. Commands are sorted by functionality. The short name is
-- given first.
-- Type "h -all" for full help file, "h <CommandName>" for full help on a command.
-- commands that change the state
i, import: i File
Reads a grammar from File and compiles it into a GF runtime grammar.
Files "include"d in File are read recursively, nubbing repetitions.
@@ -315,8 +350,10 @@ i, import: i File
.gfc canonical GF
.gfr precompiled GF resource
.gfcm multilingual canonical GF
.gfe example-based grammar files (only with the -ex option)
.ebnf Extended BNF format
.cf Context-free (BNF) format
.trc TransferCore format
options:
-old old: parse in GF<2.0 format (not necessary)
-v verbose: give lots of messages
@@ -328,6 +365,8 @@ i, import: i File
-cflexer build an optimized parser with separate lexer trie
-noemit do not emit code (default with old grammar format)
-o do emit code (default with new grammar format)
-ex preprocess .gfe files if needed
-prob read probabilities from top grammar file (format --# prob Fun Double)
flags:
-abs set the name used for abstract syntax (with -old option)
-cnc set the name used for concrete syntax (with -old option)
@@ -335,6 +374,8 @@ i, import: i File
-path use the (colon-separated) search path to find modules
-optimize select an optimization to override file-defined flags
-conversion select parsing method (values strict|nondet)
-probs read probabilities from file (format (--# prob) Fun Double)
-noparse read nonparsable functions from file (format --# noparse Funs)
examples:
i English.gf -- ordinary import of Concrete
i -retain german/ParadigmsGer.gf -- import of Resource to test
@@ -355,6 +396,26 @@ sf, set_flags: sf Flag*
s, strip: s
Prune the state by removing source and resource modules.
dc, define_command Name Anything
Add a new defined command. The Name must star with '%'. Later,
if 'Name X' is used, it is replaced by Anything where #1 is replaced
by X.
Restrictions: Currently at most one argument is possible, and a defined
command cannot appear in a pipe.
To see what definitions are in scope, use help -defs.
examples:
dc %tnp p -cat=NP -lang=Eng #1 | l -lang=Swe -- translate NPs
%tnp "this man" -- translate and parse
dt, define_term Name Tree
Add a constant for a tree. The constant can later be called by
prefixing it with '$'.
Restriction: These terms are not yet usable as a subterm.
To see what definitions are in scope, use help -defs.
examples:
p -cat=NP "this man" | dt tm -- define tm as parse result
l -all $tm -- linearize tm in all forms
-- commands that give information about the state
pg, print_grammar: pg
@@ -380,7 +441,6 @@ pm, print_multigrammar: pm
options:
-utf8 apply UTF8 encoding to the tokens in the grammar
-utf8id apply UTF8 encoding to the identifiers in the grammar
-graph print module dependency graph in 'dot' format
examples:
pm | wf Letter.gfcm -- print the grammar into the file Letter.gfcm
pm -printer=graph | wf D.dot -- then do 'dot -Tps D.dot > D.ps'
@@ -437,24 +497,40 @@ p, parse: p String
Shows all Trees returned for String by the actual
grammar (overridden by the -lang flag), in the category S (overridden
by the -cat flag).
options:
options for batch input:
-lines parse each line of input separately, ignoring empty lines
-all as -lines, but also parse empty lines
-prob rank results by probability
-cut stop after first lexing result leading to parser success
options for selecting parsing method:
(default)parse using an overgenerating CFG
-cfg parse using a much less overgenerating CFG
-mcfg parse using an even less overgenerating MCFG
Note: the first time parsing with -cfg or -mcfg might take a long time
options that only work for the default parsing method:
-n non-strict: tolerates morphological errors
-ign ignore unknown words when parsing
-raw return context-free terms in raw form
-v verbose: give more information if parsing fails
-new use an experimental method (GF 2.0; sometimes very good)
-lines parse each line of input separately, ignoring empty lines
-all as -lines, but also parse empty lines
flags:
-cat parse in this category
-lang parse in this grammar
-lexer filter input through this lexer
-parser use this context-free parsing method
-parser use this parsing strategy
-number return this many results at most
examples:
p -cat=S -new "jag är gammal" -- parse an S with the new method
p -cat=S -mcfg "jag är gammal" -- parse an S with the MCFG
rf examples.txt | p -lines -- parse each non-empty line of the file
at, apply_transfer: at (Module.Fun | Fun)
Transfer a term using Fun from Module, or the topmost transfer
module. Transfer modules are given in the .trc format. They are
shown by the 'po' command.
flags:
-lang typecheck the result in this lang instead of default lang
examples:
p -lang=Cncdecimal "123" | at num2bin | l -- convert dec to bin
tt, test_tokenizer: tt String
Show the token list sent to the parser when String is parsed.
HINT: can be useful when debugging the parser.
@@ -463,6 +539,14 @@ tt, test_tokenizer: tt String
examples:
tt -lexer=codelit "2*(x + 3)" -- a favourite lexer for program code
g, grep: g String1 String2
Grep the String1 in the String2. String2 is read line by line,
and only those lines that contain String1 are returned.
flags:
-v return those lines that do not contain String1.
examples:
pg -printer=cf | grep "mother" -- show cf rules with word mother
cc, compute_concrete: cc Term
Compute a term by concrete syntax definitions. Uses the topmost
resource module (the last in listing by command po) to resolve
@@ -503,6 +587,9 @@ gr, generate_random: gr Tree?
Generates a random Tree of a given category. If a Tree
argument is given, the command completes the Tree with values to
the metavariables in the tree.
options:
-prob use probabilities (works for nondep types only)
-cf use a very fast method (works for nondep types only)
flags:
-cat generate in this category
-lang use the abstract syntax of this grammar
@@ -522,6 +609,7 @@ gt, generate_trees: gt Tree?
-metas also return trees that include metavariables
flags:
-depth generate to this depth (default 3)
-atoms take this number of atomic rules of each category (default unlimited)
-alts take this number of alternatives at each branch (default unlimited)
-cat generate in this category
-lang use the abstract syntax of this grammar
@@ -575,6 +663,19 @@ wt, wrap_tree: wt Fun
flags:
-c compute the resulting new tree to normal form
vt, visualize_tree: vt Tree
Shows the abstract syntax tree via dot and gv (via temporary files
grphtmp.dot, grphtmp.ps).
flags:
-c show categories only (no functions)
-f show functions only (no categories)
-g show as graph (sharing uses of the same function)
-o just generate the .dot file
examples:
p "hello world" | vt -o | wf my.dot ;; ! open -a GraphViz my.dot
-- This writes the parse tree into my.dot and opens the .dot file
-- with another application without generating .ps.
-- subshells
es, editing_session: es
@@ -685,7 +786,8 @@ h, help: h Command?
Displays the paragraph concerning the command from this help file.
Without the argument, shows the first lines of all paragraphs.
options
-all show the whole help file
-all show the whole help file
-defs show user-defined commands and terms
examples:
h print_grammar -- show all information on the pg command
@@ -698,6 +800,12 @@ q, quit: q
example:
! ls
?, system_command: ? String
Issues a system command that receives its arguments from GF pipe
and returns a value to GF.
example:
h | ? 'wc -l' | p -cat=Num
-- Flags. The availability of flags is defined separately for each command.
@@ -736,22 +844,34 @@ q, quit: q
-lexer=codelit like code, but treat unknown words as string literals
-lexer=textlit like text, but treat unknown words as string literals
-lexer=codeC use a C-like lexer
-lexer=ignore like literals, but ignore unknown words
-lexer=subseqs like ignore, but then try all subsequences from longest
-number, the maximum number of generated items in a list.
The default is unlimited.
-optimize, optimization on generated code.
The default is share for concrete, none for resource modules.
Each of the flags can have the suffix _subs, which performs
common subexpression elimination after the main optimization.
Thus, -optimize=all_subs is the most aggressive one.
-optimize=share share common branches in tables
-optimize=parametrize first try parametrize then do share with the rest
-optimize=values represent tables as courses-of-values
-optimize=all first try parametrize then do values with the rest
-optimize=none no optimization
-parser, Context-free parsing algorithm. Under construction.
The default is a chart parser via context-free approximation.
-parser, parsing strategy. The default is chart. If -cfg or -mcfg are
selected, only bottomup and topdown are recognized.
-parser=chart bottom-up chart parsing
-parser=bottomup a more up to date bottom-up strategy
-parser=topdown top-down strategy
-parser=old an old bottom-up chart parser
-printer, format in which the grammar is printed. The default is gfc.
-printer, format in which the grammar is printed. The default is
gfc. Those marked with M are (only) available for pm, the rest
for pg.
-printer=gfc GFC grammar
-printer=gf GF grammar
-printer=old old GF grammar
@@ -767,6 +887,27 @@ q, quit: q
-printer=fullform full-form lexicon, short format
*-printer=xml XML: DTD for the pg command, object for st
-printer=old old GF: file readable by GF 1.2
-printer=stat show some statistics of generated GFC
-printer=probs show probabilities of all functions
-printer=gsl Nuance GSL speech recognition grammar
-printer=jsgf Java Speech Grammar Format
-printer=srgs_xml SRGS XML format
-printer=srgs_xml_prob SRGS XML format, with weights
-printer=slf a finite automaton in the HTK SLF format
-printer=slf_graphviz the same automaton as in SLF, but in Graphviz format
-printer=fa_graphviz a finite automaton with labelled edges
-printer=regular a regular grammar in a simple BNF
-printer=unpar a gfc grammar with parameters eliminated
-printer=functiongraph abstract syntax functions in 'dot' format
-printer=typegraph abstract syntax categories in 'dot' format
-printer=transfer Transfer language datatype (.tr file format)
-printer=gfcm M gfcm file (default for pm)
-printer=header M gfcm file with header (for GF embedded in Java)
-printer=graph M module dependency graph in 'dot' (graphviz) format
-printer=missing M the missing linearizations of each concrete
-printer=gfc-prolog M gfc in prolog format (also pg)
-printer=mcfg-prolog M mcfg in prolog format (also pg)
-printer=cfg-prolog M cfg in prolog format (also pg)
-startcat, like -cat, but used in grammars (to avoid clash with keyword cat)
@@ -788,7 +929,7 @@ q, quit: q
-unlexer=concat remove all spaces
-unlexer=bind like identity, but bind at "&+"
-- *: Commands and options marked with * are not yet implemented.
-- *: Commands and options marked with * are currently not implemented.
</pre>