GitHub/gf-core
1
0
Fork 1
mirror of https://github.com/GrammaticalFramework/gf-core.git synced 2026-05-20 16:42:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

more quick start

Browse Source
This commit is contained in:
aarne
2005-05-20 15:57:11 +00:00
parent 06469bd953
commit f6a921cf6c
3 changed files with 101 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
doc/gf-quickstart.html Normal file
View File

@@ -0,0 +1,94 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html><head><title>GF Quickstart</title></head>
<body bgcolor="#ffffff" text="#000000">
<center>
<img src="gf-logo.gif">
<p>
Aarne Ranta
<p>
20 May, 2005
</center>
<h1>Grammatical Framework Quick Start</h1>
This Quick Start shows two examples of how GF can be used.
We assume that you have downloaded and installed GF, so that
the command <tt>gf</tt> works for you.
<h2>Translation and generation</h2>
When you have downloaded and installed GF:
<ol>
<li> Copy the files
<a href="doc/tutorial/Paleolithic.gf"><tt>Paleolithic.gf</tt></a>,
<a href="doc/tutorial/PaleolithicEng.gf"><tt>PaleolithicEng.gf</tt></a>, and
<a href="doc/tutorial/PaleolithicIta.gf"><tt>PaleolithicIta.gf</tt></a>.
<li> Start GF with the command
<pre>
gf PaleolithicIta.gf PaleolithicEng.gf
</pre>
<li> <b>Translation</b>. Try your first translation by giving the GF command
<pre>
t PaleolithicEng PaleolithicIta "the boy eats the snake"
</pre>
<li> <b>Generation</b>. Random-generate sentences in two languages:
<pre>
gr | l -multi
</pre>
<li> <b>Grammar development</b>. Add words to the <tt>Paleolithic</tt>
grammars and try the above commands again. For instance, add the following lines:
<pre>
Black : A ; -- in Paleolithic.gf
Black = {s = "black"} ; -- in PaleolithicEng.gf
Black = {s = "nero"} ; -- in PaleolithicIta.gf
</pre>
and start GF again with the same command. Now you can even translate
<i>the boy eats the black snake</i>.
</ol>
To lear more on GF commands and
grammar development, go to the
<a href="doc/tutorial/01-gf-tutorial2.html">New Grammarian's Tutorial</a>.
<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>
jgf 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="../../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>

BIN
doc/quick-editor.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 107 KiB

41
index.html
View File

@@ -171,35 +171,8 @@ To get GF, go to the
<h2>Quick start</h2> <h2>Quick start</h2>
When you have downloaded and installed GF: When you have downloaded and installed GF, you can try one of the
<a href="doc/gf-quickstart.html">quick start examples</a>.
<ol>
<li> Copy the files
<a href="doc/tutorial/Paleolithic.gf"><tt>Paleolithic.gf</tt></a>,
<a href="doc/tutorial/PaleolithicEng.gf"><tt>PaleolithicEng.gf</tt></a>, and
<a href="doc/tutorial/PaleolithicIta.gf"><tt>PaleolithicIta.gf</tt></a>.
<li> Start GF with the command
<pre>
gf PaleolithicIta.gf PaleolithicEng.gf
</pre>
<li> <b>Translation</b>. Try your first translation by giving the GF command
<pre>
t PaleolithicEng PaleolithicIta "the boy eats the snake"
</pre>
<li> <b>Generation</b>. Random-generate sentences in two languages:
<pre>
gr | l -multi
</pre>
<li> <b>Grammar development</b>. Add words to the <tt>Paleolithic</tt>
grammars and try the above commands again.
</ol>
To lear more on grammar development (and other aspects), go to the
<a href="doc/tutorial/01-gf-tutorial2.html">New Grammarian's Tutorial</a>.
@@ -231,10 +204,6 @@ Embedded GF Interpreter</a>.
</p><h2>Documents</h2> </p><h2>Documents</h2>
<li>
<a href="../GF2.0/doc/javaGUImanual/javaGUImanual.htm">User's tutorial</a>
on editing in the Java interface.
<li> <li>
<a href="doc/tutorial/01-gf-tutorial2.html">New Grammarian's Tutorial</a>, <a href="doc/tutorial/01-gf-tutorial2.html">New Grammarian's Tutorial</a>,
@@ -245,9 +214,13 @@ More up-to-date but ess detailed than the next one.
<a href="../GF2.0/Tutorial/gf-tutorial.html">Old Grammarian's Tutorial</a> <a href="../GF2.0/Tutorial/gf-tutorial.html">Old Grammarian's Tutorial</a>
on writing GF grammars, with exercises. on writing GF grammars, with exercises.
<li>
<a href="../GF2.0/doc/javaGUImanual/javaGUImanual.htm">Editor User Manual</a>
on editing in the Java interface.
</li><li> </li><li>
<a href="../GF2.0/doc/short/01-gf-short.html"> <a href="../GF2.0/doc/short/01-gf-short.html">
GF in 25 Minutes</a> for programmers. GF in 25 Minutes</a> - overview for programmer audience.
</li><li> </li><li>
<a href="http://www.cs.chalmers.se/~aarne/articles/gf-jfp.ps.gz">Grammatical Framework: A Type-Theoretical <a href="http://www.cs.chalmers.se/~aarne/articles/gf-jfp.ps.gz">Grammatical Framework: A Type-Theoretical