msyds/gf-core
1
0
Fork 0
forked from GitHub/gf-core
Code Pull Requests Activity

some doc for release

Browse Source
This commit is contained in:
aarne
2005-05-17 16:16:59 +00:00
parent 8abf80dc4d
commit f592002e7d
4 changed files with 937 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/gf-index.html
View File

@@ -9,14 +9,10 @@
<h1>Grammatical Framework</h1>
<h2>Version 2.1</h2>
<h2>Version 2.2</h2>
November 8, 2004.
May 17, 2005.
<p>
<b>Version 2.2 scheduled to be released May 16, 2005!</b> See
<a href="doc/gf2.2-highlights.html">highlights</a>.
</center>
@@ -25,11 +21,19 @@ November 8, 2004.
</p><h2>News</h2>
<i>May 12, 2005</i>. Version 2.2 released. See
<a href="doc/gf2.2-highlights.html">highlights</a>.
Download from
<a href="http://sourceforge.net/project/showfiles.php?group_id=132285">SourceForge</a>.
<p>
<i>May 12, 2005</i>. GF now has a mailing list, to which you can register
<a href="https://lists.sourceforge.net/lists/listinfo/gf-tools-users">here</a>.
GF also has a project page on SourceForge,
<a
href="https://sourceforge.net/projects/gf-tools">https://sourceforge.net/projects/gf-tools</a>,
href="https://sourceforge.net/projects/gf-tools">
https://sourceforge.net/projects/gf-tools</a>,
but this page does not yet have much content.
<p>
@@ -68,7 +72,7 @@ Expressivity and Complexity of the Grammatical Framework</a>.
<i>November 8, 2004</i>. GF 2.1 released.
Here are the <a
href="doc/gf2-highlights.html">highlights</a>.
Software available on the <a href="download/gf-download.html">Download
Software available on the <a href="download/gf-download.html">GF 2.1 Download
Page</a>.
<p>
Main novelties in 2.1:
@@ -160,7 +164,7 @@ but they can also be useful for language training.
GF is available precompiled for
several platforms: Linux, Mac OS X, Microsoft Windows, and Sun OS.
For more information, see the <a href="download/gf-download.html">Download Page</a>.
For more information, see the <a href="http://sourceforge.net/project/showfiles.php?group_id=132285">Download Page</a> (at SourceForge).
<h2>Source code</h2>
@@ -176,8 +180,7 @@ The platform-independent graphical user interface is written in
</p><p>
The <a href="download/gf-download.html">Download Page</a>
gives links to source and binary packages, as well as
The <a href="http://sourceforge.net/project/showfiles.php?group_id=132285">Download Page</a> (at SourceForge) gives links to source and binary packages, as well as
information on compiler requirements.
@@ -190,9 +193,15 @@ Highlights</a> of Version 2.0 for the main differences.
<li>
<a href="doc/javaGUImanual/javaGUImanual.htm">User's tutorial</a>
on editing in the Java interface.
<li>
<a href="tutorial/gf-tutorial2.html">New Grammarian's Tutorial</a>,
based on the module system (unfinished).
More up-to-date but ess detailed than the next one.
</li><li>
<a href="Tutorial/gf-tutorial.html">Grammarian's tutorial</a>
<a href="Tutorial/gf-tutorial.html">Grammarian's Tutorial</a>
on writing GF grammars, with exercises.
</li><li>
@@ -203,11 +212,15 @@ GF in 25 Minutes</a> for programmers.
<a href="http://www.cs.chalmers.se/~aarne/articles/gf-jfp.ps.gz">Grammatical Framework: A Type-Theoretical
Grammar Formalism</a> (ps.gz). Theoretical paper on GF by A. Ranta, appeared
in <i>The Journal of Functional Programming</i>, vol. 14:2. 2004, pp. 145-189.
Also serves as language document.
<li> <a href="gf-modules.html">Module system document</a>, complements the
previous paper by a description of the module system.
</li><li>
<a href="doc/gf-manual.html">
User Manual</a> explaining the GF user interfaces and command language.
User Manual</a> explaining the GF user interfaces and command language (slightly
outdated).
</li><li>
<a href="doc/DocGF.pdf">
@@ -219,8 +232,8 @@ Highlights</a> of Version 2.1 and 2.0 (in comparison with version 1.2).
</li><li>
<a href="http://www.cs.chalmers.se/~aarne/slides/gf-rocquencourt.pdf">Slides on GF theory and
implementation</a> given
<a href="http://www.cs.chalmers.se/~aarne/slides/gf-rocquencourt.pdf">
Slides on GF theory and implementation</a> given
at INRIA Rocquencourt in December 2003.
</li><li>
@@ -243,6 +256,7 @@ publications on GF, as well as background literature.
</li></ul>
<h2>Projects and events</h2>
<a href="http://www.talk-project.org">TALK</a> = Tools for Ambient Linguistic

869
doc/gf-manual.html Normal file
View File

@@ -0,0 +1,869 @@
<html>
<body bgcolor="#FFFFFF" text="#000000" >
<center>
<IMG SRC="gf-logo.gif">
<h1>Grammatical Framework User Manual</h1>
</center>
<a href="http://www.cs.chalmers.se/~aarne">
Aarne Ranta</a>,
May 17, 2005, for GF Version 2.2
<p>
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.
<p>
This document describes
the command language available for the user of GF.
The GF grammar language is described in other documents.
<p>
There is a separate
<a href="javaGUImanual/javaGUImanual.htm">GF Java GUI Manual</a>.
<h2>Levels of commands</h2>
<b>GF commands</b> appear on three levels:
<ol>
<li> <b>top-level shell commands</b>,
used for calling GF from Unix/Windows/Mac.
<li> <b>internal shell commands</b>,
available in the shell entered by the top-level shell command <tt>gf</tt>.
<li> <b>internal subshell commands</b>,
such as the editor commands,
entered by certain internal shell commands.
</ol>
By the <b>GF command language</b> we mean the internal shell
commands, which the most part of this document is about;
the sections describing the other levels are much shorter.
<h2>Top-level shell commands</h2>
The compiled GF program is invoked by a command that has the syntax
<pre>
gf Option* File*
</pre>
The files should contain GF
grammars, each of which is <b>imported</b> in the environment in which
GF starts, in the same way as if GF were first started and
the import command <tt>i</tt> then executed for each of the files.
The currently available options are:
<ul>
<li> <tt>-java</tt>, which enters directly an editor session designed
for communicating with and external java GUI (see <tt>jgf</tt> below).
</ul>
<p>
Like any program in Unix, GF can be used in a pipeline or
a redirection. For instance,
<pre>
echo "h" | gf
</pre>
starts GF and executes the help command.
<pre>
gf &lt;script
</pre>
starts GF and executes the commands in the file <tt>script</tt>.
<p>
The Java GUI is started with the command
<pre>
jgf File+
</pre>
which executes a simple shell script. The effect is to start
GF, import each grammar in the files, and enter the
Editor subshell (see below), with which the GUI then communicates.
<p>
If a compiled version of GF is not available, GF can be started within
the Haskell interpreter GHCI, by the command
<pre>
make ghci
</pre>
in the GF source directory, followed by ":l GF" in GHCI.
Unfortunately, the standard binary of the light-weight Hugs interpreter
has insufficient code space for GF.
<h2>Batch mode</h2>
A simple protocol has been defined to run GF in batch mode, e.g. from another
program. The command line syntax is
<pre>
gf -batch (-s) (-[flag])*
</pre>
It reads standard input, which is typically directed from a
script file containing GF commands.
Every command read by GF, GF's reply, and
the whole run, are enclosed in XML tags:
<ul>
<li> tag <tt>gfcommand</tt> encloses a command in the script
<li> tag <tt>gfreply</tt> encloses GF's reply to a command
<li> tag <tt>gfbatch</tt> encloses the whole run of the script
</ul>
The DTD is the following:
<pre>
&lt;!ELEMENT gfbatch ((gfcommand, gfreply)*) >
&lt;!ELEMENT gfcommand (#PCDATA) >
&lt;!ELEMENT gfreply (#PCDATA) >
</pre>
The optional <tt>+s</tt> (silence) flag turns off showing
commands and the XML structure of the run; it is moreove sent
as a global flag to the environment in which the run is
performed, together with the other flags appearing in the
command line.
<p>
Another version of the batch mode is the compiler. Thus
<pre>
gf -make -s file.gf
</pre>
silently compiles the file <tt>file.gf</tt> (as well as
all other files that it depends on).
All flags to the command <tt>i</tt> are recognized.
<h2>Library path</h2>
(Not available in Version 2.2 for the moment - sorry.)
<h3>Command line syntax</h3>
The syntax of the individual commands is described in later sections.
The general structure of a command line is defined by the following
grammar:
<pre>
CommandLine ::= Pipeline (";;" Pipeline)*
Pipeline ::= Command
| Command Arg ("|" Command)*
Command ::= CommandId (Option | Flag)* Arg*
Arg ::= QuotedString | Tree | File | Lang | Int
</pre>
Several commands can be collected on one line, separated by a double
semicolon. The effect is that each of the commands is executed;
the same effect is achieved in a script by putting the commands on
consecutive lines. Thus
<pre>
i LangEng.gf ;; p -cat=AP "black or green" ;; q
</pre>
is equivalent to
<pre>
i LangEng.gf
p -cat=AP "black or green"
q
</pre>
The one-line variant is handy to use as an argument of the <tt>echo</tt>
command in Unix, to define simple shell scripts using GF.
<p>
A <b>pipeline</b> consists of a first command with an argument,
producing a result which is sent as argument to the next command.
For example,
<pre>
gr -cat=Phrase | l | sa
</pre>
generates a random Phrase, linearizes it, and speaks aloud the
resulting string. No result is seen in the output, but the
phrase is heard spoken.
<p>
The <b>trace</b> option <tt>-tr</tt> can be used to show intermediate
results in a pipeline:
<pre>
rf -tr bible.txt | p -lang=Eng -cat=Text | l -lang=Chi
</pre>
reads a string from the file <tt>bible.txt</tt> (displaying the result),
parses it as an English text (without displaying the parse tree),
and linearizes the tree into Chinese (displaying the result, as the
last command in a pipeline always does).
<p>
The Unix <b>Readline</b> facility makes arrow keys, file name completions,
etc, available in the GF shell, but only in the GHC-compiled variant.
For instance, the up-arrow goes backwards in the command history.
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.
<h3>Options and flags</h3>
An <b>option</b> consist of a hyphen and an option identifier, e.g.
<pre>
-retain
</pre>
What options belong to what commands is explained below.
<p>
A <b>flag</b> consists of a hyphen, a flag identifier, an equality sign,
and a value identifier, e.g.
<pre>
-lang=Eng
</pre>
What flags belong to what commands is explained below.
In addition to command lines, flags can be set globally with the
<tt>sf</tt> command (see below), as well as
in grammars, using a <tt>flags</tt> directive, e.g.
<pre>
flags lexer=code ; startcat=Exp ;
</pre>
either first in a file or immediately after an <tt>include</tt> directive.
In case of conflicts arising from this, the descending order of priority is:
command line, grammar, global.
The global state is initialized by <b>default values</b> to
all available flags.
<h3>Environment</h3>
To understand the semantics of commands in a GF session,
one must know their dependence on and their effects to an
<b>environment</b>. The environment consists of
<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 compiled modules
<li> a list of source modules
<li> values of flags.
</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.
<h3>Command arguments</h3>
Unlike Unix, where command arguments and values are strings,
GF uses a primitive type system, distinguishing between
<ul>
<li> strings,
<li> (lists of) terms (= syntax trees),
<li> names of languages,
<li> names of files,
<li> integers,
<li> void values (e.g. the result of speaking aloud a string),
<li> error values.
</ul>
A pipeline is only meaningful among strings and terms, and
only if the
argument type of a command matches with the value type of the
preceding one. For instance,
<pre>
p "hello world" | l -lang=Swe
</pre>
sends a list of terms (the parsing result) to the linearizer,
which expects terms, so that the types match. But
<pre>
p "hello world" | p -lang=Swe
</pre>
tries to parse arguments which are already terms, and this is a
type error. An error value is also displayed as a string
(an error message), but this string is never a meaningful
input for a command, so the pipe breaks there.
<h3>Descriptions with the individual commands</h3>
The following is a copy of the current <tt>HelpFile</tt>.
<pre>
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.
If a grammar with the same language name is already in the state,
it is overwritten - but only if compilation succeeds.
The grammar parser depends on the file name suffix:
.gf normal GF source
.gfc canonical GF
.gfr precompiled GF resource
.gfcm multilingual canonical GF
.ebnf Extended BNF format
.cf Context-free (BNF) format
options:
-old old: parse in GF<2.0 format (not necessary)
-v verbose: give lots of messages
-s silent: don't give error messages
-src source: ignore precompiled gfc and gfr files
-retain retain operations: read resource modules (needed in comm cc)
-nocf don't build context-free grammar (thus no parser)
-nocheckcirc don't eliminate circular rules from CF
-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)
flags:
-abs set the name used for abstract syntax (with -old option)
-cnc set the name used for concrete syntax (with -old option)
-res set the name used for resource (with -old option)
-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)
examples:
i English.gf -- ordinary import of Concrete
i -retain german/ParadigmsGer.gf -- import of Resource to test
* rl, remove_language: rl Language
Takes away the language from the state.
e, empty: e
Takes away all languages and resets all global flags.
sf, set_flags: sf Flag*
The values of the Flags are set for Language. If no language
is specified, the flags are set globally.
examples:
sf -nocpu -- stop showing CPU time
sf -lang=Swe -- make Swe the default concrete
s, strip: s
Prune the state by removing source and resource modules.
-- commands that give information about the state
pg, print_grammar: pg
Prints the actual grammar (overridden by the -lang=X flag).
The -printer=X flag sets the format in which the grammar is
written.
N.B. since grammars are compiled when imported, this command
generally does not show the grammar in the same format as the
source. In particular, the -printer=latex is not supported.
Use the command tg -printer=latex File to print the source
grammar in LaTeX.
options:
-utf8 apply UTF8-encoding to the grammar
flags:
-printer
-lang
examples:
pg -printer=cf -- show the context-free skeleton
pm, print_multigrammar: pm
Prints the current multilingual grammar in .gfcm form.
(Automatically executes the strip command (s) before doing this.)
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'
vg, visualize_graph: vg
Show the dependency graph of multilingual grammar via dot and gv.
po, print_options: po
Print what modules there are in the state. Also
prints those flag values in the current state that differ from defaults.
pl, print_languages: pl
Prints the names of currently available languages.
pi, print_info: pi Ident
Prints information on the identifier.
-- commands that execute and show the session history
eh, execute_history: eh File
Executes commands in the file.
ph, print_history; ph
Prints the commands issued during the GF session.
The result is readable by the eh command.
examples:
ph | wf foo.hist" -- save the history into a file
-- linearization, parsing, translation, and computation
l, linearize: l PattList? Tree
Shows all linearization forms of Tree by the actual grammar
(which is overridden by the -lang flag).
The pattern list has the form [P, ... ,Q] where P,...,Q follow GF
syntax for patterns. All those forms are generated that match with the
pattern list. Too short lists are filled with variables in the end.
Only the -table flag is available if a pattern list is specified.
HINT: see GF language specification for the syntax of Pattern and Term.
You can also copy and past parsing results.
options:
-table show parameters
-struct bracketed form
-record record, i.e. explicit GF concrete syntax term
-all show all forms and variants
-multi linearize to all languages (the other options don't work)
flags:
-lang linearize in this grammar
-number give this number of forms at most
-unlexer filter output through unlexer
examples:
l -lang=Swe -table -- show full inflection table in Swe
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:
-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
-number return this many results at most
examples:
p -cat=S -new "jag är gammal" -- parse an S with the new method
rf examples.txt | p -lines -- parse each non-empty line of the file
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.
flags:
-lexer use this lexer
examples:
tt -lexer=codelit "2*(x + 3)" -- a favourite lexer for program code
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
constant names.
N.B. You need the flag -retain when importing the grammar, if you want
the oper definitions to be retained after compilation; otherwise this
command does not expand oper constants.
N.B.' The resulting Term is not a term in the sense of abstract syntax,
and hence not a valid input to a Tree-demanding command.
flags:
-res use another module than the topmost one
examples:
cc -res=ParadigmsFin (nLukko "hyppy") -- inflect "hyppy" with nLukko
so, show_operations: so Type
Show oper operations with the given value type. Uses the topmost
resource module to resolve constant names.
N.B. You need the flag -retain when importing the grammar, if you want
the oper definitions to be retained after compilation; otherwise this
command does not find any oper constants.
N.B.' The value type may not be defined in a supermodule of the
topmost resource. In that case, use appropriate qualified name.
flags:
-res use another module than the topmost one
examples:
so -res=ParadigmsFin ResourceFin.N -- show N-paradigms in ParadigmsFin
t, translate: t Lang Lang String
Parses String in Lang1 and linearizes the resulting Trees in Lang2.
flags:
-cat
-lexer
-parser
examples:
t Eng Swe -cat=S "every number is even or odd"
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.
flags:
-cat generate in this category
-lang use the abstract syntax of this grammar
-number generate this number of trees (not impl. with Tree argument)
-depth use this number of search steps at most
examples:
gr -cat=Query -- generate in category Query
gr (PredVP ? (NegVG ?)) -- generate a random tree of this form
gr -cat=S -tr | l -- gererate and linearize
gt, generate_trees: gt Tree?
Generates all trees up to a given depth. If the depth is large,
a small -alts is recommended. If a Tree argument is given, the
command completes the Tree with values to the metavariables in
the tree.
options:
-metas also return trees that include metavariables
flags:
-depth generate to this depth (default 3)
-alts take this number of alternatives at each branch (default unlimited)
-cat generate in this category
-lang use the abstract syntax of this grammar
-number generate (at most) this number of trees
examples:
gt -depth=10 -cat=NP -- generate all NP's to depth 10
gt (PredVP ? (NegVG ?)) -- generate all trees of this form
gt -cat=S -tr | l -- gererate and linearize
ma, morphologically_analyse: ma String
Runs morphological analysis on each word in String and displays
the results line by line.
options:
-short show analyses in bracketed words, instead of separate lines
flags:
-lang
examples:
wf Bible.txt | ma -short | wf Bible.tagged -- analyse the Bible
-- elementary generation of Strings and Trees
ps, put_string: ps String
Returns its argument String, like Unix echo.
HINT. The strength of ps comes from the possibility to receive the
argument from a pipeline, and altering it by the -filter flag.
flags:
-filter filter the result through this string processor
-length cut the string after this number of characters
examples:
gr -cat=Letter | l | ps -filter=text -- random letter as text
pt, put_tree: pt Tree
Returns its argument Tree, like a specialized Unix echo.
HINT. The strength of pt comes from the possibility to receive
the argument from a pipeline, and altering it by the -transform flag.
flags:
-transform transform the result by this term processor
-number generate this number of terms at most
examples:
p "zero is even" | pt -transform=solve -- solve ?'s in parse result
* st, show_tree: st Tree
Prints the tree as a string. Unlike pt, this command cannot be
used in a pipe to produce a tree, since its output is a string.
flags:
-printer show the tree in a special format (-printer=xml supported)
wt, wrap_tree: wt Fun
Wraps the tree as the sole argument of Fun.
flags:
-c compute the resulting new tree to normal form
-- subshells
es, editing_session: es
Opens an interactive editing session.
N.B. Exit from a Fudget session is to the Unix shell, not to GF.
options:
-f Fudget GUI (necessary for Unicode; only available in X Window System)
ts, translation_session: ts
Translates input lines from any of the actual languages to all other ones.
To exit, type a full stop (.) alone on a line.
N.B. Exit from a Fudget session is to the Unix shell, not to GF.
HINT: Set -parser and -lexer locally in each grammar.
options:
-f Fudget GUI (necessary for Unicode; only available in X Windows)
-lang prepend translation results with language names
flags:
-cat the parser category
examples:
ts -cat=Numeral -lang -- translate numerals, show language names
tq, translation_quiz: tq Lang Lang
Random-generates translation exercises from Lang1 to Lang2,
keeping score of success.
To interrupt, type a full stop (.) alone on a line.
HINT: Set -parser and -lexer locally in each grammar.
flags:
-cat
examples:
tq -cat=NP TestResourceEng TestResourceSwe -- quiz for NPs
tl, translation_list: tl Lang Lang
Random-generates a list of ten translation exercises from Lang1
to Lang2. The number can be changed by a flag.
HINT: use wf to save the exercises in a file.
flags:
-cat
-number
examples:
tl -cat=NP TestResourceEng TestResourceSwe -- quiz list for NPs
mq, morphology_quiz: mq
Random-generates morphological exercises,
keeping score of success.
To interrupt, type a full stop (.) alone on a line.
HINT: use printname judgements in your grammar to
produce nice expressions for desired forms.
flags:
-cat
-lang
examples:
mq -cat=N -lang=TestResourceSwe -- quiz for Swedish nouns
ml, morphology_list: ml
Random-generates a list of ten morphological exercises,
keeping score of success. The number can be changed with a flag.
HINT: use wf to save the exercises in a file.
flags:
-cat
-lang
-number
examples:
ml -cat=N -lang=TestResourceSwe -- quiz list for Swedish nouns
-- IO related commands
rf, read_file: rf File
Returns the contents of File as a String; error if File does not exist.
wf, write_file: wf File String
Writes String into File; File is created if it does not exist.
N.B. the command overwrites File without a warning.
af, append_file: af File
Writes String into the end of File; File is created if it does not exist.
* tg, transform_grammar: tg File
Reads File, parses as a grammar,
but instead of compiling further, prints it.
The environment is not changed. When parsing the grammar, the same file
name suffixes are supported as in the i command.
HINT: use this command to print the grammar in
another format (the -printer flag); pipe it to wf to save this format.
flags:
-printer (only -printer=latex supported currently)
* cl, convert_latex: cl File
Reads File, which is expected to be in LaTeX form.
Three environments are treated in special ways:
\begGF - \end{verbatim}, which contains GF judgements,
\begTGF - \end{verbatim}, which contains a GF expression (displayed)
\begInTGF - \end{verbatim}, which contains a GF expressions (inlined).
Moreover, certain macros should be included in the file; you can
get those macros by applying 'tg -printer=latex foo.gf' to any grammar
foo.gf. Notice that the same File can be imported as a GF grammar,
consisting of all the judgements in \begGF environments.
HINT: pipe with 'wf Foo.tex' to generate a new Latex file.
sa, speak_aloud: sa String
Uses the Flite speech generator to produce speech for String.
Works for American English spelling.
examples:
h | sa -- listen to the list of commands
gr -cat=S | l | sa -- generate a random sentence and speak it aloud
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
examples:
h print_grammar -- show all information on the pg command
q, quit: q
Exits GF.
HINT: you can use 'ph | wf history' to save your session.
!, system_command: ! String
Issues a system command. No value is returned to GF.
example:
! ls
-- Flags. The availability of flags is defined separately for each command.
-cat, category in which parsing is performed.
The default is S.
-depth, the search depth in e.g. random generation.
The default depends on application.
-filter, operation performed on a string. The default is identity.
-filter=identity no change
-filter=erase erase the text
-filter=take100 show the first 100 characters
-filter=length show the length of the string
-filter=text format as text (punctuation, capitalization)
-filter=code format as code (spacing, indentation)
-lang, grammar used when executing a grammar-dependent command.
The default is the last-imported grammar.
-language, voice used by Festival as its --language flag in the sa command.
The default is system-dependent.
-length, the maximum number of characters shown of a string.
The default is unlimited.
-lexer, tokenization transforming a string into lexical units for a parser.
The default is words.
-lexer=words tokens are separated by spaces or newlines
-lexer=literals like words, but GF integer and string literals recognized
-lexer=vars like words, but "x","x_...","$...$" as vars, "?..." as meta
-lexer=chars each character is a token
-lexer=code use Haskell's lex
-lexer=codevars like code, but treat unknown words as variables, ?? as meta
-lexer=text with conventions on punctuation and capital letters
-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
-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.
-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.
-printer, format in which the grammar is printed. The default is gfc.
-printer=gfc GFC grammar
-printer=gf GF grammar
-printer=old old GF grammar
-printer=cf context-free grammar, with profiles
-printer=bnf context-free grammar, without profiles
-printer=lbnf labelled context-free grammar for BNF Converter
-printer=plbnf grammar for BNF Converter, with precedence levels
*-printer=happy source file for Happy parser generator (use lbnf!)
-printer=srg speech recognition grammar
-printer=haskell abstract syntax in Haskell, with transl to/from GF
-printer=morpho full-form lexicon, long format
*-printer=latex LaTeX file (for the tg command)
-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
-startcat, like -cat, but used in grammars (to avoid clash with keyword cat)
-transform, transformation performed on a syntax tree. The default is identity.
-transform=identity no change
-transform=compute compute by using definitions in the grammar
-transform=typecheck return the term only if it is type-correct
-transform=solve solve metavariables as derived refinements
-transform=context solve metavariables by unique refinements as variables
-transform=delete replace the term by metavariable
-unlexer, untokenization transforming linearization output into a string.
The default is unwords.
-unlexer=unwords space-separated token list (like unwords)
-unlexer=text format as text: punctuation, capitals, paragraph <p>
-unlexer=code format as code (spacing, indentation)
-unlexer=textlit like text, but remove string literal quotes
-unlexer=codelit like code, but remove string literal quotes
-unlexer=concat remove all spaces
-unlexer=bind like identity, but bind at "&+"
-- *: Commands and options marked with * are not yet implemented.
</pre>
<h2>Commands in subshells</h2>
<h3>The interactive editor</h3>
The command <tt>es</tt> (edit session) opens a subshell, where editing is
commenced by selecting a new category, which initializes a syntax tree
with a metavariable. Editing has its own <b>state</b>, expressed by a Tree
Zipper, where the <b>current subtree</b> is marked by a star <tt>*</tt>.
A subtree that is a <b>metavariable</b> (of form <tt>?n</tt>) is
a <b>subgoal</b>.
<p>
There are currently three interfaces to the editor: a line-based GF subshell,
a Fudget GUI, and a Java GUI. They all use the same abstract command language,
the difference being that the subshell has a string syntax for each command,
whereas the GUIs mostly use menus and buttons to issue commands.
There is a separate
<a href="javaGUImanual/javaGUImanual.htm">GF Java GUI Manual</a>.
<p>
The command syntax for the string-based editor is the following:
<p>
Start/finish editing:
<ul>
<li> <tt>n Cat</tt> start new goal of type Cat
<li> <tt>t Tree</tt> start editing with Tree
<li> <tt>q</tt> quit the editor
</ul>
Navigation (change current subtree):
<ul>
<li> <tt>&lt;&lt;</tt> go to previous metavariable
<li> <tt>&lt; Int</tt> go Int steps back in the tree
<li> <tt>'</tt> go to the top of the tree
<li> <tt>> Int</tt> go Int steps ahead in the tree
<li> <tt>>></tt> go to next metavariable
</ul>
Refinement and wrapping (of current subtree):
<ul>
<li> <tt>r (Fun | Var)</tt> refine with function Fun or variable Var
<li> <tt>w Fun Int</tt> wrap subterm by Fun into its argument place Int
<li> <tt>s Int</tt> select candidate nr. Int (result of ambiguous parsing)
<li> <tt>x Var Var</tt> change (alpha convert) bound variable Var1 to Var2
<li> <tt>d</tt> delete subtree
<li> <tt>g Tree</tt> refine current subgoal with Tree
<li> <tt>p String</tt> parse String as refinement of current subgoal
<li> <tt>a</tt> aleatory: find random refinement
<li> <tt>u</tt> undo: go back in refinement history
<li> <tt>c Transform</tt> apply Transform (one of the -transform values) to subtree
<li> <tt>f Filter</tt> apply Filter
(one of the -filter values) to linearization output
</ul>
Information and display:
<ul>
<li> <tt>m</tt> show refinement/wrapping menu
<li> <tt>v</tt> toggle the pretty-printer view (Tree or grammar)
<li> <tt>h</tt> show command help
</ul>
<h3>Translate, parse, and teach yourself sessions</h3>
The system expects a string which it then tries to parse. A string consisting
of a dot (.) serves as exit command. The graphical translation session has a
Quit button.
</body>
</html>

38
doc/tutorial/gf-tutorial2.html
View File

@@ -1059,6 +1059,42 @@ programming languages are syntactic sugar for table selections:
<!-- NEW -->
<h4>Morphological analysis and morphology quiz</h4>
Even though in GF morphology
is mostly seen as an auxiliary of syntax, a morphology once defined
can be used on its own right. The command <tt>morpho_analyse = ma</tt>
can be used to read a text and return for each word the analyses that
it has in the current concrete syntax.
<pre>
> rf bible.txt | morpho_analyse
</pre>
Similarly to translation exercises, morphological exercises can
be generated, by the command <tt>morpho_quiz = mq</tt>. Usually,
the category is set to be something else than <tt>S</tt>. For instance,
<pre>
> i lib/resource/french/VerbsFre.gf
> morpho_quiz -cat=V
Welcome to GF Morphology Quiz.
...
réapparaître : VFin VCondit Pl P2
réapparaitriez
> No, not réapparaitriez, but
réapparaîtriez
Score 0/1
</pre>
Finally, a list of morphological exercises and save it in a
file for later use, by the command <tt>translation_list = tl</tt>
<pre>
> translation_list -number=25 PaleolithicEng PaleolithicIta
</pre>
The number flag gives the number of sentences generated.
<!-- NEW -->
<h4>Parametric vs. inherent features, agreement</h4>
@@ -1170,7 +1206,7 @@ the adjectival paradigm in which the two singular forms are the same, can be def
<h2>Topics still to be written</h2>
Morpho quiz
Discontinuous constituents
<p>

2
src/HelpFile
View File

@@ -1,4 +1,4 @@
-- GF help file updated for GF 2.0, 24/3/2004.
-- GF help file updated for GF 2.2, 17/5/2005.
-- *: Commands and options marked with * are not yet implemented.
--
-- Each command has a long and a short name, options, and zero or more