summaryrefslogtreecommitdiff
path: root/doc/gf-quickstart.html
diff options
context:
space:
mode:
authoraarne <unknown>2005-05-20 15:57:11 +0000
committeraarne <unknown>2005-05-20 15:57:11 +0000
commitf6a921cf6c722bf4c401cfd7aa3847eb71c310d4 (patch)
treea00eef3fe92848160bd0b2a866e46f55e4123b29 /doc/gf-quickstart.html
parent06469bd953edbf57e0913bb303c74c3717849b2a (diff)
more quick start
Diffstat (limited to 'doc/gf-quickstart.html')
-rw-r--r--doc/gf-quickstart.html94
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/gf-quickstart.html b/doc/gf-quickstart.html
new file mode 100644
index 000000000..9f51974d3
--- /dev/null
+++ b/doc/gf-quickstart.html
@@ -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>