moved parts of doc to deprecated/doc

This commit is contained in:
aarne
2010-12-22 14:08:42 +00:00
parent fb722fe8e2
commit ce15ec7b78
46 changed files with 84 additions and 659 deletions

View File

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 102 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 129 KiB

After

Width:  |  Height:  |  Size: 129 KiB

View File

Before

Width:  |  Height:  |  Size: 439 KiB

After

Width:  |  Height:  |  Size: 439 KiB

View File

Before

Width:  |  Height:  |  Size: 1.8 MiB

After

Width:  |  Height:  |  Size: 1.8 MiB

View File

@@ -13,12 +13,13 @@
</center> </center>
Most of the code is by The current developers and maintainers are
<a "http://www.chalmers.se/cse/EN/organization/divisions/computing-science/people/angelov-krasimir">Krasimir Angelov</a>, <a href="http://www.chalmers.se/cse/EN/organization/divisions/computing-science/people/angelov-krasimir">Krasimir Angelov</a>,
<a href="http://www.cs.chalmers.se/~bringert">Björn Bringert</a>, <a href="http://www.cs.chalmers.se/~hallgren">Thomas Hallgren</a>,
and and
<a href="http://www.cs.chalmers.se/~aarne">Aarne Ranta</a>. Bug reports should be <a href="http://www.cse.chalmers.se/~aarne">Aarne Ranta</a>. Bug reports should be
posted via the <a href="http://trac.haskell.org/gf/">GF bug tracker</a>. posted via the
<a href="http://code.google.com/p/grammatical-framework/issues/list">GF bug tracker</a>.
<p> <p>
@@ -27,19 +28,23 @@ Also the following people have contributed code to some of the versions:
<p> <p>
Håkan Burden (Chalmers) Grégoire Détrez (University of Gothenburg)
<br>
Ramona Enache (University of Gothenburg)
<br>
<a href="http://www.cse.chalmers.se/alumni/bringert">Björn Bringert</a> (University of Gothenburg)
<br>
Håkan Burden (University of Gothenburg)
<br> <br>
Hans-Joachim Daniels (Karlsruhe) Hans-Joachim Daniels (Karlsruhe)
<br> <br>
<a href="http://www.cs.chalmers.se/~markus">Markus Forsberg</a> (Chalmers) <a href="http://www.cs.chalmers.se/~markus">Markus Forsberg</a> (Chalmers)
<br> <br>
<a href="http://www.cs.chalmers.se/~hallgren">Thomas Hallgren</a> (Chalmers) <a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a> (University of Gothenburg)
<br> <br>
<a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a> (Chalmers) <a href="http://www.cs.chalmers.se/~janna">Janna Khegai</a> (Chalmers)
<br> <br>
<a href="http://www.cs.chalmers.se/~janna">Janna Khegai</a> (Chalmers) <a href="http://www.cs.chalmers.se/~peb">Peter Ljunglöf</a> (University of Gothenburg)
<br>
<a href="http://www.cs.chalmers.se/~peb">Peter Ljunglöf</a> (Chalmers)
<br> <br>
Petri Mäenpää (Nokia) Petri Mäenpää (Nokia)

View File

@@ -9,7 +9,7 @@
<p> <p>
Aarne Ranta Aarne Ranta
<p> <p>
3 September, 2007 22 December 2010 (3 September, 2007)
<p> <p>
@@ -20,7 +20,7 @@ Aarne Ranta
This Quick Start shows two examples of how GF can be used. This Quick Start shows two examples of how GF can be used.
We assume that you have downloaded and installed GF, so that We assume that you have downloaded and installed GF, so that
the command <tt>gf</tt> works for you. See download and install the command <tt>gf</tt> works for you. See download and install
instructions <a href="http://digitalgrammars.com/gf/download/">here</a>. instructions <a href="../download/index.html">here</a>.
@@ -61,39 +61,11 @@ and start GF again with the same command. Now you can even translate
<i>this bread is very Italian</i>. <i>this bread is very Italian</i>.
</ol> </ol>
To lear more on GF commands and To lear more on GF commands and
grammar development, go to the grammar development, go to the one of the tutorials:
<a href="tutorial/gf-tutorial2.html">New Grammarian's Tutorial</a>. <ul>
<li> <a href="tutorial/gf-tutorial.html">GF Tutorial</a>: older, more programmer-oriented
<li> <a href="gf-lrec-2010.pdf">GF Resource Tutorial</a>: newer, more linguist-oriented
</ul>
<h2>Multilingual authoring</h2>
This demo also requires the GUI package, which makes the command
<tt>jgf</tt> work for you.
<ol>
<li> Download the file <a href="../examples/letter/Letter.gfcm"><tt>Letter.gfcm</tt></a>.
<li> Start the GF editor by the command
<pre>
gfeditor Letter.gfcm
</pre>
<li> When the editor window is open, select "Letter" from the "New" menu.
<li> Push the button "Random" in the lower end of the window.
<li> Move the pointer to some place in the text, e.g. to the first word (in any
of the languages), and click. The first word should now be highlighted and
a number of alternatives appear in the lower window part (a similar situation
is shown in the picture below).
<li> Double-click at some of the alternatives marked "ch ..." and observe how
the text changes in each of the languages.
</ol>
See the <a href="http://www.cs.chalmers.se/~aarne/GF2.0/doc/javaGUImanual/javaGUImanual.htm">Editor User Manual</a>
for more information on how to use the
editor. To change the grammars, you should not edit <tt>Letter.gfcm</tt>,
which is low-level code generated by the GF grammar compiler. Instead, you
can edit the files in <tt>examples/letter</tt> in the GF grammar package,
and compile by using the script <tt>mkLetter.gfs</tt> in the same package.
<p>
<img src="quick-editor.gif">
</body></html> </body></html>

View File

@@ -106,7 +106,7 @@ This document is not an introduction to GF; such introduction can be
found in the GF tutorial available on line on the GF web page, found in the GF tutorial available on line on the GF web page,
</P> </P>
<P> <P>
<A HREF="http://digitalgrammars.com/gf"><CODE>digitalgrammars.com/gf</CODE></A> <A HREF="http://grammaticalframework.org"><CODE>grammaticalframework.org</CODE></A>
</P> </P>
<P> <P>
This manual covers only the language, not the GF compiler or This manual covers only the language, not the GF compiler or

View File

@@ -13,28 +13,20 @@
<h1>Grammatical Framework Documents</h1> <h1>Grammatical Framework Documents</h1>
</center> </center>
<b>Top-3 documents</b>:
<a href="gf-tutorial.html">Tutorial</a> <b>Top-5 documents</b>:
|
<a href="gf-refman.html">ReferenceManual</a>
|
<a href="../lib/resource/doc/synopsis.html">LibrarySynopsis</a>
<h2>Tutorials</h2>
<a href="gf-quickstart.html">Quick start instruction</a>. <a href="gf-quickstart.html">Quick start instruction</a>.
<p>
<a href="gf-tutorial.html">GF Tutorial</a>, <a href="tutorial/gf-tutorial.html">Old Tutorial</a>, application-oriented.
Now up-to-date for GF version 2.9. Covers all of GF.
<a href="gf-lrec-2010.pdf">New Tutorial</a>, linguistics-oriented.
<a href="gf-refman.html">ReferenceManual</a>.
<a href="../lib/resource/doc/synopsis.html">LibrarySynopsis</a>.
@@ -49,144 +41,13 @@ in a summary format.
<a href="gf-refman.html">GF Reference Manual</a>. A full-scale reference <a href="gf-refman.html">GF Reference Manual</a>. A full-scale reference
manual of the GF language. manual of the GF language.
<p>
<a href="gf-manual.html">
User Manual</a> explaining the GF user interfaces and command language (slightly
outdated).
<p>
<a href="../../GF2.0/doc/javaGUImanual/javaGUImanual.htm">Editor User Manual</a>
on editing in the Java interface.
<p>
<a href="gf-compiler.png">Chart of GF grammar compiler phases</a>.
<h2>Grammar library documentation</h2> <h2>Publications</h2>
<a href="gf-tutorial.html#chapfive">Resource Grammar Tutorial Chapter</a>.
<p>
<a href="../lib/resource/doc/synopsis.html">Resource Grammar Synopsis</a>
for library users. With APIs and use examples.
<p>
<a href="../lib/resource/doc/Resource-HOWTO.html">
Resource Grammar HOWTO</a>
for library authors.
<h2>Embedding GF grammars in computer programs</h2>
<a href="gf-tutorial.html#chapeight">Embedded Grammar Tutorial Chapter</a>.
<p>
<a href="http://www.cs.chalmers.se/~bringert/gf/gf-java.html">
Embedded GF Interpreter</a> manual for using GF grammars in Java programs.
<p>
<a href="http://www.cs.chalmers.se/~aarne/GF/src/GF/GFCC/API.hs">
Embedded GF API</a> for using GF grammars in Haskell programs.
<p>
<a href="http://www.ling.gu.se/~peb/index.cgi/Software">
MCFG/GF library for Prolog</a>,
for using GF grammars in Prolog programs.
<h2>Theoretical studies</h2>
<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. A later
version appeared
in <i>The Journal of Functional Programming</i>, vol. 14:2. 2004, pp. 145-189.
The standard reference on GF.
<p>
<a href="http://www.ling.gu.se/~peb/pubs/Ljunglof-2004a.pdf">
Expressivity and Complexity of the Grammatical Framework</a>,
PhD Thesis by
<a href="http://www.ling.gu.se/~peb">Peter Ljunglöf</a>.
<h2>Introductory talks</h2>
<a href="http://www.cs.chalmers.se/~aarne/GF2.0/doc/short/gf-short.html">
GF in 25 Minutes</a> - overview for computer science audience.
<p>
<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.
<p>
<a
href="http://www.cs.chalmers.se/~aarne/slides/webalt-2005.pdf">
Slides on example-based grammar writing</a> and a short introduction
to GF grammars.
<p>
<a
href="http://www.cs.chalmers.se/~aarne/course-langtech/lectures/lectures.html">
Course notes on Natural Language Technology</a>, includes
slides on using GF.
<h2>Examples and applications</h2>
<a href="http://www.cs.chalmers.se/~krijo/thesis/thesisA4.pdf">
Formal and Informal Software Specifications</a>,
PhD Thesis by
<a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a>.
<p>
<a href="http://www.dtek.chalmers.se/~d00bring/publ/exjobb/embedded-grammars.pdf">
Embedded grammars</a>,
Master's thesis by
<a href="http://www.cs.chalmers.se/~bringert/">Björn Bringert</a>
<p>
<a
href="http://www.cs.chalmers.se/~bringert/misc/tramdemo.avi">Demo film</a>
of a multimodal dialogue system built with embedded grammars.
<p>
<a href="gfcc.pdf">
GFCC</a> (pdf):
report on a compiler from a fragment of C to JVM, written in GF.
<h2>More</h2>
<a href="gf-bibliography.html"> <a href="gf-bibliography.html">
Bibliography</a>: Bibliography</a>: more publications on GF, as well as background literature.
more publications on GF, as well as background literature.
</body></html> </body></html>

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 4.1 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
Grammatical Framework Tutorial Grammatical Framework Tutorial
Aarne Ranta Aarne Ranta
Version 3.1.2, November 2008 December 2010 (November 2008)
% NOTE: this is a txt2tags file. % NOTE: this is a txt2tags file.
@@ -626,7 +626,7 @@ You can chop this tutorial into a set of slides by the command
``` ```
where the program ``htmls`` is distributed with GF (see below), in where the program ``htmls`` is distributed with GF (see below), in
[``GF/src/tools/Htmls.hs`` http://digitalgrammars.com/gf/src/tools/Htmls.hs] [``GF/src/tools/Htmls.hs`` http://grammaticalframework.org/src/tools/Htmls.hs]
The slides will appear as a set of files beginning with ``01-gf-tutorial.htmls``. The slides will appear as a set of files beginning with ``01-gf-tutorial.htmls``.
@@ -700,7 +700,7 @@ In general, a GF grammar is **multilingual**:
Open-source free software, downloaded via the GF Homepage: Open-source free software, downloaded via the GF Homepage:
[``digitalgrammars.com/gf`` http://digitalgrammars.com/gf/] [``grammaticalframework.org`` http://grammaticalframework.org/]
There you find There you find
- binaries for Linux, Mac OS X, and Windows - binaries for Linux, Mac OS X, and Windows
@@ -709,11 +709,11 @@ There you find
Many examples in this tutorial are Many examples in this tutorial are
[online http://digitalgrammars.com/gf/examples/tutorial]. [online http://grammaticalframework.org/examples/tutorial].
Normally you don't have to compile GF yourself. Normally you don't have to compile GF yourself.
But, if you do want to compile GF from source follow the But, if you do want to compile GF from source follow the
instructions in the [Developers Guide gf-developers.html]. instructions in the [Developers Guide ../gf-developers.html].
#NEW #NEW
@@ -2453,7 +2453,7 @@ can be used to read a text and return for each word its analyses
``` ```
The command ``morpho_quiz = mq`` generates inflection exercises. The command ``morpho_quiz = mq`` generates inflection exercises.
``` ```
% gf -path=alltenses:prelude $GF_LIB_PATH/alltenses/IrregFre.gfc % gf -path=alltenses:prelude $GF_LIB_PATH/alltenses/IrregFre.gfo
> morpho_quiz -cat=V > morpho_quiz -cat=V
@@ -2970,7 +2970,7 @@ Language-specific and language-independent parts - roughly,
Full API documentation on-line: the **resource synopsis**, Full API documentation on-line: the **resource synopsis**,
[``digitalgrammars.com/gf/lib/resource/doc/synopsis.html`` http://digitalgrammars.com/gf/lib/resource/doc/synopsis.html] [``grammaticalframework.org/lib/resource/doc/synopsis.html`` http://grammaticalframework.org/lib/doc/synopsis.html]
#NEW #NEW
@@ -4530,10 +4530,10 @@ This facility is based on several components:
The portable format is called PGF, "Portable Grammar Format". The portable format is called PGF, "Portable Grammar Format".
This format is produced by the GF batch compiler ``gfc``, This format is produced by the GF batch compiler ``gf``,
executable from the operative system shell: executable from the operative system shell:
``` ```
% gfc --make SOURCE.gf % gf --make SOURCE.gf
``` ```
PGF is the recommended format in PGF is the recommended format in
which final grammar products are distributed, because they which final grammar products are distributed, because they
@@ -4605,12 +4605,12 @@ For this, you need the Haskell compiler [GHC http://www.haskell.org/ghc].
#NEW #NEW
===Producing GFCC for the translator=== ===Producing PGF for the translator===
Then produce a GFCC file. For instance, the ``Food`` grammar set can be Then produce a PGF file. For instance, the ``Food`` grammar set can be
compiled as follows: compiled as follows:
``` ```
% gfc --make FoodEng.gf FoodIta.gf % gf --make FoodEng.gf FoodIta.gf
``` ```
This produces the file ``Food.pgf`` (its name comes from the abstract syntax). This produces the file ``Food.pgf`` (its name comes from the abstract syntax).
@@ -4714,11 +4714,11 @@ abstract Query = {
To make it easy to define a transfer function, we export the To make it easy to define a transfer function, we export the
abstract syntax to a system of Haskell datatypes: abstract syntax to a system of Haskell datatypes:
``` ```
% gfc --output-format=haskell Query.pgf % gf --output-format=haskell Query.pgf
``` ```
It is also possible to produce the Haskell file together with GFCC, by It is also possible to produce the Haskell file together with PGF, by
``` ```
% gfc --make --output-format=haskell QueryEng.gf % gf --make --output-format=haskell QueryEng.gf
``` ```
The result is a file named ``Query.hs``, containing a The result is a file named ``Query.hs``, containing a
module named ``Query``. module named ``Query``.
@@ -4871,7 +4871,7 @@ translate tr gr s = case parseAllLang gr (startCat gr) s of
To automate the production of the system, we write a ``Makefile`` as follows: To automate the production of the system, we write a ``Makefile`` as follows:
``` ```
all: all:
gfc --make --output-format=haskell QueryEng gf --make --output-format=haskell QueryEng
ghc --make -o ./math TransferLoop.hs ghc --make -o ./math TransferLoop.hs
strip math strip math
``` ```
@@ -4928,7 +4928,7 @@ program compiled from GF grammars as run on an iPhone.
JavaScript is one of the output formats of the GF batch compiler. Thus the following JavaScript is one of the output formats of the GF batch compiler. Thus the following
command generates a JavaScript file from two ``Food`` grammars. command generates a JavaScript file from two ``Food`` grammars.
``` ```
% gfc --make --output-format=js FoodEng.gf FoodIta.gf % gf --make --output-format=js FoodEng.gf FoodIta.gf
``` ```
The name of the generated file is ``Food.js``, derived from the top-most abstract The name of the generated file is ``Food.js``, derived from the top-most abstract
syntax name. This file contains the multilingual grammar as a JavaScript object. syntax name. This file contains the multilingual grammar as a JavaScript object.
@@ -4944,7 +4944,7 @@ some other JavaScript and HTML files; these files can be used
as templates for building applications. as templates for building applications.
An example of usage is An example of usage is
[``translator.html`` ../lib/javascript/translator.html], [``translator.html`` http://grammaticalframework.org:41296],
which is in fact initialized with which is in fact initialized with
a pointer to the Food grammar, so that it provides translation between the English a pointer to the Food grammar, so that it provides translation between the English
and Italian grammars: and Italian grammars:
@@ -4969,12 +4969,12 @@ The standard way of using GF in speech recognition is by building
GF supports several formats, including GF supports several formats, including
GSL, the formatused in the [Nuance speech recognizer www.nuance.com]. GSL, the formatused in the [Nuance speech recognizer www.nuance.com].
GSL is produced from GF by running ``gfc`` with the flag GSL is produced from GF by running ``gf`` with the flag
``--output-format=gsl``. ``--output-format=gsl``.
Example: GSL generated from ``FoodsEng.gf``. Example: GSL generated from ``FoodsEng.gf``.
``` ```
% gfc --make --output-format=gsl FoodsEng.gf % gf --make --output-format=gsl FoodsEng.gf
% more FoodsEng.gsl % more FoodsEng.gsl
;GSL2.0 ;GSL2.0
@@ -5017,6 +5017,6 @@ Other formats available via the ``--output-format`` flag include:
| ``slf`` | finite automaton in the HTK SLF format | ``slf`` | finite automaton in the HTK SLF format
| ``slf_sub`` | finite automaton with sub-automata in HTK SLF | ``slf_sub`` | finite automaton with sub-automata in HTK SLF
All currently available formats can be seen with ``gfc --help``. All currently available formats can be seen with ``gf --help``.

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

View File

@@ -26,11 +26,13 @@ April 2010
| <A HREF="download/index.html">Download</A> | <A HREF="download/index.html">Download</A>
| <A HREF="lib/doc/synopsis.html">Libraries</A> | <A HREF="lib/doc/synopsis.html">Libraries</A>
| <A HREF="doc/gf-refman.html">Reference</A> | <A HREF="doc/gf-refman.html">Reference</A>
| <A HREF="doc/gf-tutorial.html">Tutorial</A> | <A HREF="doc/tutorial/gf-tutorial.html">Tutorial</A>
| <A HREF="doc/gf-quickstart.html">QuickStart</A>
| <A HREF="http://groups.google.com/group/gf-dev">UserGroup</A>
] ]
</font> </font>
<P> <P>
[ <A HREF="http://code.google.com/p/grammatical-framework/wiki/SideBar?tm=6">Developers</A> [ <A HREF="http://code.google.com/p/grammatical-framework/wiki/SideBar?tm=6">ForDevelopers</A>
| <A HREF="doc/gf-people.html">People</A> | <A HREF="doc/gf-people.html">People</A>
| <A HREF="doc/gf-bibliography.html">Publications</A> | <A HREF="doc/gf-bibliography.html">Publications</A>
| <A HREF="doc/gf-reference.html">QuickRefCard</A> | <A HREF="doc/gf-reference.html">QuickRefCard</A>
@@ -139,7 +141,7 @@ fifty scientific publications (see <A HREF="doc/gf-bibliography.html">GF publica
</P> </P>
<H2>Programming in GF</H2> <H2>Programming in GF</H2>
<P> <P>
GF is easy to learn by following the <A HREF="doc/gf-tutorial.html">tutorial</A>. GF is easy to learn by following the <A HREF="doc/tutorial/gf-tutorial.html">tutorial</A>.
You can write your first translator in 15 minutes. You can write your first translator in 15 minutes.
</P> </P>
<P> <P>