forked from GitHub/gf-core
Documentation fixes
+ Rename some txt2tags file from .txt to .t2t and remove abandoned .txt files. + Add program update_html that finds all .t2t documents and updates the corresponding .html file. It can be invoked with 'make html'. + Add style to some .html documents
This commit is contained in:
hallgren
2
Makefile
2
Makefile
@@ -25,3 +25,5 @@ gf:
|
|||||||
runghc Setup.hs build rgl-none
|
runghc Setup.hs build rgl-none
|
||||||
strip dist/build/gf/gf
|
strip dist/build/gf/gf
|
||||||
|
|
||||||
|
html::
|
||||||
|
bash bin/update_html
|
||||||
11
bin/update_html
Normal file
11
bin/update_html
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
### This script finds all .t2t (txt2tags) files and updates the corresponding
|
||||||
|
### .html file, if it is out-of-date.
|
||||||
|
|
||||||
|
find . -name '*.t2t' | while read t2t ; do
|
||||||
|
html="${t2t%.t2t}.html"
|
||||||
|
if [ "$t2t" -nt "$html" ] ; then
|
||||||
|
txt2tags -thtml "$t2t"
|
||||||
|
fi
|
||||||
|
done
|
||||||
@@ -1,7 +1,9 @@
|
|||||||
|
|
||||||
body { background-color: #f2f2f2; }
|
body { background-color: #f2f2f2; }
|
||||||
|
|
||||||
|
|
||||||
h1,h2,h3 { font-family: sans-serif; }
|
h1,h2,h3 { font-family: sans-serif; }
|
||||||
|
h1 { text-align: center; }
|
||||||
h2 { border-bottom: 2px solid black; clear: right; }
|
h2 { border-bottom: 2px solid black; clear: right; }
|
||||||
|
|
||||||
div.center { text-align: center; }
|
div.center { text-align: center; }
|
||||||
|
|||||||
@@ -2,9 +2,11 @@
|
|||||||
<HTML>
|
<HTML>
|
||||||
<HEAD>
|
<HEAD>
|
||||||
<TITLE>Grammatical Framework Demos</TITLE>
|
<TITLE>Grammatical Framework Demos</TITLE>
|
||||||
</HEAD><BODY BGCOLOR="white" TEXT="black">
|
<link rel=stylesheet href="../css/style.css">
|
||||||
<CENTER><H1>Grammatical Framework Demos</H1>
|
</HEAD>
|
||||||
</CENTER>
|
|
||||||
|
<BODY>
|
||||||
|
<H1><IMG SRC="../doc/Logos/gf0.png" alt="">Grammatical Framework Demos</H1>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="http://www.grammaticalframework.org/demos/phrasebook/">Tourist
|
<a href="http://www.grammaticalframework.org/demos/phrasebook/">Tourist
|
||||||
@@ -67,6 +69,3 @@ the <A HREF="../lib/doc/synopsis.html">GF resource library</A>
|
|||||||
<A HREF="../old-lib/resource/doc/resdemo.html">Random library examples</A>
|
<A HREF="../old-lib/resource/doc/resdemo.html">Random library examples</A>
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<!-- html code *NOT* generated by txt2tags 2.4 (http://txt2tags.sf.net) -->
|
|
||||||
<!-- cmdline: txt2tags -thtml index.txt -->
|
|
||||||
|
|||||||
11
doc/Makefile
11
doc/Makefile
@@ -21,14 +21,3 @@ Logos/gf00.png: Logos/gf00.svg Makefile
|
|||||||
|
|
||||||
Logos/gf0.png: Logos/gf0.svg Makefile
|
Logos/gf0.png: Logos/gf0.svg Makefile
|
||||||
convert -background 'rgba(255,255,255,0)' -size 320x240 -depth 8 $< $@
|
convert -background 'rgba(255,255,255,0)' -size 320x240 -depth 8 $< $@
|
||||||
|
|
||||||
### Updating automatically generated HTML files
|
|
||||||
|
|
||||||
GENERATED_HTML=gf-developers.html
|
|
||||||
|
|
||||||
%.html: %.txt
|
|
||||||
txt2tags $<
|
|
||||||
|
|
||||||
generated_html:: $(GENERATED_HTML)
|
|
||||||
|
|
||||||
gf-developers.html: gf-developers.txt
|
|
||||||
|
|||||||
@@ -2,9 +2,10 @@
|
|||||||
|
|
||||||
<head>
|
<head>
|
||||||
<title>GF People</title>
|
<title>GF People</title>
|
||||||
|
<link rel=stylesheet href="../css/style.css">
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body bgcolor="#FFFFFF" text="#000000" >
|
<body>
|
||||||
|
|
||||||
<center>
|
<center>
|
||||||
<IMG SRC="Logos/gf0.png">
|
<IMG SRC="Logos/gf0.png">
|
||||||
@@ -15,9 +16,9 @@
|
|||||||
|
|
||||||
The current developers and maintainers are
|
The current developers and maintainers are
|
||||||
<a href="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/~hallgren">Thomas Hallgren</a>,
|
<a href="http://www.cse.chalmers.se/~hallgren/">Thomas Hallgren</a>,
|
||||||
and
|
and
|
||||||
<a href="http://www.cse.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
|
posted via the
|
||||||
<a href="http://code.google.com/p/grammatical-framework/issues/list">GF bug tracker</a>.
|
<a href="http://code.google.com/p/grammatical-framework/issues/list">GF bug tracker</a>.
|
||||||
|
|
||||||
@@ -26,29 +27,28 @@ posted via the
|
|||||||
|
|
||||||
Also the following people have contributed code to some of the versions:
|
Also the following people have contributed code to some of the versions:
|
||||||
|
|
||||||
<p>
|
<dl>
|
||||||
|
|
||||||
Grégoire Détrez (University of Gothenburg)
|
<dt>Grégoire Détrez (University of Gothenburg)
|
||||||
<br>
|
<dt>Ramona Enache (University of Gothenburg)
|
||||||
Ramona Enache (University of Gothenburg)
|
<dt>
|
||||||
<br>
|
|
||||||
<a href="http://www.cse.chalmers.se/alumni/bringert">Björn Bringert</a> (University of Gothenburg)
|
<a href="http://www.cse.chalmers.se/alumni/bringert">Björn Bringert</a> (University of Gothenburg)
|
||||||
<br>
|
<dt>
|
||||||
Håkan Burden (University of Gothenburg)
|
Håkan Burden (University of Gothenburg)
|
||||||
<br>
|
<dt>
|
||||||
Hans-Joachim Daniels (Karlsruhe)
|
Hans-Joachim Daniels (Karlsruhe)
|
||||||
<br>
|
<dt>
|
||||||
<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>
|
<dt>
|
||||||
<a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a> (University of Gothenburg)
|
<a href="http://www.cs.chalmers.se/~krijo">Kristofer Johannisson</a> (University of Gothenburg)
|
||||||
<br>
|
<dt>
|
||||||
<a href="http://www.cs.chalmers.se/~janna">Janna Khegai</a> (Chalmers)
|
<a href="http://www.cs.chalmers.se/~janna">Janna Khegai</a> (Chalmers)
|
||||||
<br>
|
<dt>
|
||||||
<a href="http://www.cs.chalmers.se/~peb">Peter Ljunglöf</a> (University of Gothenburg)
|
<a href="http://www.cs.chalmers.se/~peb">Peter Ljunglöf</a> (University of Gothenburg)
|
||||||
<br>
|
<dt>
|
||||||
Petri Mäenpää (Nokia)
|
Petri Mäenpää (Nokia)
|
||||||
|
</dl>
|
||||||
|
|
||||||
<p>
|
|
||||||
|
|
||||||
At least the following colleagues are thanked for suggestions,
|
At least the following colleagues are thanked for suggestions,
|
||||||
bug reports, and other indirect contributions to the code. (Notice:
|
bug reports, and other indirect contributions to the code. (Notice:
|
||||||
|
|||||||
@@ -2,12 +2,13 @@
|
|||||||
<HTML>
|
<HTML>
|
||||||
<HEAD>
|
<HEAD>
|
||||||
<META NAME="generator" CONTENT="http://txt2tags.sf.net">
|
<META NAME="generator" CONTENT="http://txt2tags.sf.net">
|
||||||
|
<LINK REL="stylesheet" TYPE="text/css" HREF="../css/style.css">
|
||||||
<TITLE>GF Quick Reference</TITLE>
|
<TITLE>GF Quick Reference</TITLE>
|
||||||
</HEAD><BODY BGCOLOR="white" TEXT="black">
|
</HEAD><BODY BGCOLOR="white" TEXT="black">
|
||||||
<P ALIGN="center"><CENTER><H1>GF Quick Reference</H1>
|
<P ALIGN="center"><CENTER><H1>GF Quick Reference</H1>
|
||||||
<FONT SIZE="4">
|
<FONT SIZE="4">
|
||||||
<I>Aarne Ranta</I><BR>
|
<I>Aarne Ranta</I><BR>
|
||||||
Tue Apr 4 09:41:30 2006
|
April 4, 2006
|
||||||
</FONT></CENTER>
|
</FONT></CENTER>
|
||||||
|
|
||||||
<P></P>
|
<P></P>
|
||||||
@@ -572,6 +573,6 @@ A. Ranta, Grammatical Framework: A Type-Theoretical Grammar Formalism.
|
|||||||
<I>The Journal of Functional Programming</I>, vol. 14:2. 2004, pp. 145-189.
|
<I>The Journal of Functional Programming</I>, vol. 14:2. 2004, pp. 145-189.
|
||||||
</P>
|
</P>
|
||||||
|
|
||||||
<!-- html code generated by txt2tags 2.0 (http://txt2tags.sf.net) -->
|
<!-- html code generated by txt2tags 2.5 (http://txt2tags.sf.net) -->
|
||||||
<!-- cmdline: txt2tags -thtml -\-toc gf-reference.txt -->
|
<!-- cmdline: txt2tags -thtml ./doc/gf-reference.t2t -->
|
||||||
</BODY></HTML>
|
</BODY></HTML>
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
GF Quick Reference
|
GF Quick Reference
|
||||||
Aarne Ranta
|
Aarne Ranta
|
||||||
%%date(%c)
|
April 4, 2006
|
||||||
|
|
||||||
% NOTE: this is a txt2tags file.
|
% NOTE: this is a txt2tags file.
|
||||||
% Create an html file from this file using:
|
% Create an html file from this file using:
|
||||||
% txt2tags -thtml --toc gf-reference.html
|
% txt2tags -thtml --toc gf-reference.html
|
||||||
|
|
||||||
|
%!style:../css/style.css
|
||||||
%!target:html
|
%!target:html
|
||||||
|
%!options: --toc
|
||||||
|
|
||||||
This is a quick reference on GF grammars. It aims to
|
This is a quick reference on GF grammars. It aims to
|
||||||
cover all forms of expression available when writing
|
cover all forms of expression available when writing
|
||||||
@@ -2,11 +2,7 @@
|
|||||||
<HTML>
|
<HTML>
|
||||||
<HEAD>
|
<HEAD>
|
||||||
<TITLE>GF - Grammatical Framework</TITLE>
|
<TITLE>GF - Grammatical Framework</TITLE>
|
||||||
<style>
|
<link rel=stylesheet href="css/style.css">
|
||||||
div.center { text-align: center; }
|
|
||||||
h1,h2,h3 { font-family: sans-serif; }
|
|
||||||
div.news { font-size: small; }
|
|
||||||
</style>
|
|
||||||
</HEAD>
|
</HEAD>
|
||||||
|
|
||||||
<BODY>
|
<BODY>
|
||||||
|
|||||||
191
index.txt
191
index.txt
@@ -1,191 +0,0 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
%!postproc(html): "#BECE" "<center>"
|
|
||||||
%!postproc(html): "#ENCE" "</center>"
|
|
||||||
%!postproc(html): "#BESMALL" "<font size=-1>"
|
|
||||||
%!postproc(html): "#ENSMALL" "</font>"
|
|
||||||
%!postproc(html): "#BELARGE" "<font size=+2>"
|
|
||||||
%!postproc(html): "#ENLARGE" "</font>"
|
|
||||||
|
|
||||||
#BECE
|
|
||||||
|
|
||||||
[doc/Logos/gf0.png]
|
|
||||||
|
|
||||||
=Grammatical Framework=
|
|
||||||
|
|
||||||
Version 3.1
|
|
||||||
|
|
||||||
December 2009
|
|
||||||
|
|
||||||
|
|
||||||
#BELARGE
|
|
||||||
|
|
||||||
``[`` [Demos demos/index.html]
|
|
||||||
``|`` [Download download/index.html]
|
|
||||||
``|`` [Libraries lib/doc/synopsis.html]
|
|
||||||
``|`` [Reference doc/gf-refman.html]
|
|
||||||
``|`` [Tutorial doc/gf-tutorial.html]
|
|
||||||
``]``
|
|
||||||
|
|
||||||
#ENLARGE
|
|
||||||
|
|
||||||
``[`` [Demos demos/index.html]
|
|
||||||
``|`` [Download download/index.html]
|
|
||||||
``|`` [Developers http://code.google.com/p/grammatical-framework/wiki/SideBar?tm=6]
|
|
||||||
``|`` [Libraries lib/doc/synopsis.html]
|
|
||||||
``|`` [People doc/gf-people.html]
|
|
||||||
``|`` [Publications doc/gf-bibliography.html]
|
|
||||||
``|`` [QuickRefCard doc/gf-reference.html]
|
|
||||||
``|`` [Reference doc/gf-refman.html]
|
|
||||||
``|`` [Tutorial doc/gf-tutorial.html]
|
|
||||||
``|`` [LibTutorial doc/resource-tutorial.pdf]
|
|
||||||
``]``
|
|
||||||
|
|
||||||
#ENCE
|
|
||||||
|
|
||||||
|
|
||||||
#BESMALL
|
|
||||||
|
|
||||||
==News==
|
|
||||||
|
|
||||||
GF users mailing list and wiki - link forthcoming here!
|
|
||||||
|
|
||||||
|
|
||||||
#ENSMALL
|
|
||||||
|
|
||||||
|
|
||||||
==What is GF==
|
|
||||||
|
|
||||||
GF, Grammatical Framework, is a programming language for
|
|
||||||
**multilingual grammar applications**. It is
|
|
||||||
- a **special-purpose language for grammars**, like YACC, Bison, Happy, BNFC,
|
|
||||||
but not restricted to programming languages
|
|
||||||
- a **functional language**, like Haskell, Lisp, OCaml, Scheme, SML,
|
|
||||||
but specialized to grammar writing
|
|
||||||
- a **natural language processing framework**, like LKB, XLE, Regulus,
|
|
||||||
but based on functional programming and type theory
|
|
||||||
- a **categorial grammar formalism**, like ACG, CCG,
|
|
||||||
but different and equipped with different tools
|
|
||||||
- a **logical framework**, like Agda, Coq, Isabelle,
|
|
||||||
but equipped with concrete syntax in addition to logic
|
|
||||||
|
|
||||||
|
|
||||||
Don't worry if you don't know most of the references above - but if you do know at
|
|
||||||
least one, it may help you to get a first idea of what GF is.
|
|
||||||
|
|
||||||
|
|
||||||
==Applications==
|
|
||||||
|
|
||||||
GF can be used for building
|
|
||||||
- [text translators http://tournesol.cs.chalmers.se:41296]
|
|
||||||
- [multilingual web gadgets http://tournesol.cs.chalmers.se:41296/fridge]
|
|
||||||
- [speech translators http://www.cs.chalmers.se/~bringert/gf/translatespeech.html]
|
|
||||||
- [natural-language interfaces http://www.cs.chalmers.se/~hallgren/Alfa/Tutorial/GFplugin.html]
|
|
||||||
% - [multilingual web pages http://www.restauranggajden.se/tomas/]
|
|
||||||
- [multilingual authoring systems http://www.cs.chalmers.se/~markus/gramlets/letter-applet.html]
|
|
||||||
- [dialogue systems http://www.cs.chalmers.se/~bringert/xv/pizza/]
|
|
||||||
% - [language training systems http://csmisc14.cs.chalmers.se/~bjorn/langtrain.cgi]
|
|
||||||
- [natural language resources lib/resource/doc/synopsis.html]
|
|
||||||
|
|
||||||
|
|
||||||
==Availability==
|
|
||||||
|
|
||||||
GF is **open-source**, licensed under [GPL LICENSE] (the program) and
|
|
||||||
[LGPL lib/LICENSE] (the libraries). It
|
|
||||||
is available for
|
|
||||||
- Linux
|
|
||||||
- Mac OS X
|
|
||||||
- Windows
|
|
||||||
- via compilation to JavaScript, almost any platform that has a web browser
|
|
||||||
|
|
||||||
|
|
||||||
==Projects==
|
|
||||||
|
|
||||||
GF was first created in 1998 at
|
|
||||||
[Xerox Research Centre Europe http://www.xrce.xerox.com/],
|
|
||||||
Grenoble, in the project
|
|
||||||
Multilingual Document Authoring. At Xerox, it was used for prototypes including
|
|
||||||
a restaurant phrase book,
|
|
||||||
a database query system,
|
|
||||||
a formalization of an alarm system instructions with translations to 5 languages, and
|
|
||||||
an authoring system for medical drug descriptions.
|
|
||||||
|
|
||||||
Later projects using GF and involving third parties include, in chronological order,
|
|
||||||
- [GF-Alfa http://www.cs.chalmers.se/~hallgren/Alfa/Tutorial/GFplugin.html]:
|
|
||||||
natural language interface to formal proofs
|
|
||||||
- [Efficient http://efficient.citi.tudor.lu/index_noframe.html]:
|
|
||||||
authoring tool for business models.
|
|
||||||
- [GF-KeY http://www.key-project.org/]:
|
|
||||||
authoring and translation of software specifications
|
|
||||||
- [TALK http://www.talk-project.org]:
|
|
||||||
multilingual and multimodal spoken dialogue systems
|
|
||||||
- [WebALT http://webalt.math.helsinki.fi/]:
|
|
||||||
multilingual generation of mathematical exercises (commercial project)
|
|
||||||
- [SALDO http://spraakbanken.gu.se/sal/]:
|
|
||||||
Swedish morphological dictionary based on rules developed for GF and
|
|
||||||
[Functional Morphology http://www.cs.chalmers.se/~markus/FM/]
|
|
||||||
|
|
||||||
|
|
||||||
Academically, GF has been used in four PhD theses and resulted in around
|
|
||||||
fifty scientific publications (see [GF publication list doc/gf-bibliography.html]).
|
|
||||||
|
|
||||||
|
|
||||||
==Programming in GF==
|
|
||||||
|
|
||||||
GF is easy to learn by following the [tutorial doc/gf-tutorial.html].
|
|
||||||
You can write your first translator in 15 minutes.
|
|
||||||
|
|
||||||
GF has an interactive command interpreter, as well as a batch compiler.
|
|
||||||
Grammars can be compiled to parser and translator code in many different
|
|
||||||
formats. These components can then be embedded in applications written
|
|
||||||
in other programming languages. The formats currently supported are:
|
|
||||||
- Haskell
|
|
||||||
- JavaScript
|
|
||||||
- Speech recognition: HTK/ATK, Nuance, JSGF
|
|
||||||
|
|
||||||
|
|
||||||
The GF programming language is high-level and advanced, featuring
|
|
||||||
- static type checking
|
|
||||||
- higher-order functions
|
|
||||||
- dependent types
|
|
||||||
- pattern matching with data constructors and regular expressions
|
|
||||||
- module system with multiple inheritance and parametrized modules
|
|
||||||
|
|
||||||
|
|
||||||
==Libraries==
|
|
||||||
|
|
||||||
Libraries are at the heart of modern software engineering. In natural language
|
|
||||||
applications, libraries are a way to cope with thousands of details involved in
|
|
||||||
syntax, lexicon, and inflection. The
|
|
||||||
[GF resource grammar library lib/doc/synopsis.html] has
|
|
||||||
support for an increasing number of languages, currently including
|
|
||||||
+ Arabic (partial)
|
|
||||||
+ Bulgarian
|
|
||||||
+ Catalan
|
|
||||||
+ Danish
|
|
||||||
+ Dutch
|
|
||||||
+ English
|
|
||||||
+ Finnish
|
|
||||||
+ French
|
|
||||||
+ German
|
|
||||||
+ Hindi/Urdu (fragments)
|
|
||||||
+ [Interlingua http://www.interlingua.com/]
|
|
||||||
+ Italian
|
|
||||||
+ Latin (fragments)
|
|
||||||
+ Norwegian bokmål
|
|
||||||
+ Polish
|
|
||||||
+ Romanian
|
|
||||||
+ Russian
|
|
||||||
+ Spanish
|
|
||||||
+ Swedish
|
|
||||||
+ Thai (fragments)
|
|
||||||
|
|
||||||
|
|
||||||
Adding a language to the resource library takes 3 to 9
|
|
||||||
months - contributions
|
|
||||||
are welcome! You can start with the [resource grammarian's tutorial doc/resource-tutorial.pdf].
|
|
||||||
|
|
||||||
% [doc/10lang-small.png]
|
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user