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
vitaly-z · Dec 22, 2010 · 40b84d2 · 40b84d2
1 parent 59b36e0
commit 40b84d2
Show file tree

Hide file tree

Showing 14 changed files with 44 additions and 234 deletions.
diff --git a/Makefile b/Makefile
@@ -25,3 +25,5 @@ gf:
 	runghc Setup.hs build rgl-none
 	strip dist/build/gf/gf
 
+html::
+	bash bin/update_html
diff --git a/bin/update_html b/bin/update_html
@@ -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
diff --git a/css/style.css b/css/style.css
@@ -1,7 +1,9 @@
 
 body { background-color: #f2f2f2; }
 
+
 h1,h2,h3 { font-family: sans-serif; }
+h1 { text-align: center; }
 h2 { border-bottom: 2px solid black; clear: right; }
 
 div.center { text-align: center; }

diff --git a/demos/index-numbers.txt → demos/index-numbers.t2t b/demos/index-numbers.txt → demos/index-numbers.t2t
diff --git a/demos/index.html b/demos/index.html
@@ -2,9 +2,11 @@
 <HTML>
 <HEAD>
 <TITLE>Grammatical Framework Demos</TITLE>
-</HEAD><BODY BGCOLOR="white" TEXT="black">
-<CENTER><H1>Grammatical Framework Demos</H1>
-</CENTER>
+<link rel=stylesheet href="../css/style.css">
+</HEAD>
+
+<BODY>
+<H1><IMG SRC="../doc/Logos/gf0.png" alt="">Grammatical Framework Demos</H1>
 
 <p>
 <a href="http://www.grammaticalframework.org/demos/phrasebook/">Tourist
@@ -67,6 +69,3 @@
 <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 -->
diff --git a/doc/Makefile b/doc/Makefile
@@ -21,14 +21,3 @@ Logos/gf00.png: Logos/gf00.svg Makefile
 
 Logos/gf0.png: Logos/gf0.svg Makefile
 	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
diff --git a/doc/gf-bibliography.txt → doc/gf-bibliography.t2t b/doc/gf-bibliography.txt → doc/gf-bibliography.t2t
diff --git a/doc/gf-developers.txt → doc/gf-developers.t2t b/doc/gf-developers.txt → doc/gf-developers.t2t
diff --git a/doc/gf-people.html b/doc/gf-people.html
@@ -2,9 +2,10 @@
 
 <head>
 <title>GF People</title>
+<link rel=stylesheet href="../css/style.css">
 </head>
 
-<body bgcolor="#FFFFFF" text="#000000" >
+<body>
 
 <center>
 <IMG SRC="Logos/gf0.png">
@@ -15,9 +16,9 @@ <h1>Grammatical Framework: Authors and Acknowledgements</h1>
 
 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.cs.chalmers.se/~hallgren">Thomas Hallgren</a>,
+<a href="http://www.cse.chalmers.se/~hallgren/">Thomas Hallgren</a>,
 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
 <a href="http://code.google.com/p/grammatical-framework/issues/list">GF bug tracker</a>.
 
@@ -26,29 +27,28 @@ <h1>Grammatical Framework: Authors and Acknowledgements</h1>
 
 Also the following people have contributed code to some of the versions:
 
-<p>
+<dl>
 
-Grégoire Détrez (University of Gothenburg)
-<br> 
-Ramona Enache (University of Gothenburg)
-<br>
+<dt>Grégoire Détrez (University of Gothenburg)
+<dt>Ramona Enache (University of Gothenburg)
+<dt>
 <a href="http://www.cse.chalmers.se/alumni/bringert">Björn Bringert</a> (University of Gothenburg)
-<br>
+<dt>
 Håkan Burden (University of Gothenburg)
-<br>
+<dt>
 Hans-Joachim Daniels (Karlsruhe)
-<br>
+<dt>
 <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)
-<br>
+<dt>
 <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)
-<br>
+<dt>
 Petri Mäenpää (Nokia)
+</dl>
 
-<p>
 
 At least the following colleagues are thanked for suggestions,
 bug reports, and other indirect contributions to the code. (Notice:

diff --git a/doc/gf-reference.html b/doc/gf-reference.html
@@ -2,12 +2,13 @@
 <HTML>
 <HEAD>
 <META NAME="generator" CONTENT="http://txt2tags.sf.net">
+<LINK REL="stylesheet" TYPE="text/css" HREF="../css/style.css">
 <TITLE>GF Quick Reference</TITLE>
 </HEAD><BODY BGCOLOR="white" TEXT="black">
 <P ALIGN="center"><CENTER><H1>GF Quick Reference</H1>
 <FONT SIZE="4">
 <I>Aarne Ranta</I><BR>
-Tue Apr  4 09:41:30 2006
+April 4, 2006
 </FONT></CENTER>
 
 <P></P>
@@ -572,6 +573,6 @@ <H3>References</H3>
 <I>The Journal of Functional Programming</I>, vol. 14:2. 2004, pp. 145-189. 
 </P>
 
-<!-- html code generated by txt2tags 2.0 (http://txt2tags.sf.net) -->
-<!-- cmdline: txt2tags -thtml -\-toc gf-reference.txt -->
+<!-- html code generated by txt2tags 2.5 (http://txt2tags.sf.net) -->
+<!-- cmdline: txt2tags -thtml ./doc/gf-reference.t2t -->
 </BODY></HTML>
diff --git a/doc/gf-reference.txt → doc/gf-reference.t2t b/doc/gf-reference.txt → doc/gf-reference.t2t
@@ -1,13 +1,14 @@
 GF Quick Reference
 Aarne Ranta
-%%date(%c)
+April 4, 2006
 
 % NOTE: this is a txt2tags file.
 % Create an html file from this file using:
 % txt2tags -thtml --toc gf-reference.html
 
+%!style:../css/style.css
 %!target:html
-
+%!options: --toc
 
 This is a quick reference on GF grammars. It aims to
 cover all forms of expression available when writing

diff --git a/doc/tutorial/gf-tutorial.txt → doc/tutorial/gf-tutorial.t2t b/doc/tutorial/gf-tutorial.txt → doc/tutorial/gf-tutorial.t2t
diff --git a/index.html b/index.html
@@ -2,11 +2,7 @@
 <HTML>
 <HEAD>
 <TITLE>GF - Grammatical Framework</TITLE>
-<style>
-div.center { text-align: center; }
-h1,h2,h3 { font-family: sans-serif; }
-div.news { font-size: small; }
-</style>
+<link rel=stylesheet href="css/style.css">
 </HEAD>
 
 <BODY>

diff --git a/index.txt b/index.txt