diff --git a/doc/script/makeindex.py b/doc/script/makeindex.py new file mode 100755 index 000000000..c11a38caf --- /dev/null +++ b/doc/script/makeindex.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python +"Update the script index in script-index.html." + +import os, string + +commands = [] +reffiles = {} +sep = "<!-- SCRIPT -->" + +for infile in os.listdir('.'): + if not infile.endswith('.html'): continue + if (infile == "script-index.html"): continue + x = open(infile).read() + if string.find(x, sep) == -1: continue + head, stuff, tail = x.split(sep) + + loclist = [] + for y in stuff.split("<a name=")[1:]: + loclist.append("<a name=" + y) + y = y.split('"')[1].split('"')[0] + commands.append(y) + reffiles[y] = infile + loclist.sort() + + f = open(infile, 'w') + f.write(head + sep + stuff.split("<a name=")[0]) + for y in loclist: + f.write(y) + f.write(sep + tail) + +head, trash, tail = open('script-index.html').read().split(sep) + +f = open('script-index.html', 'w') +f.write(head + sep) +for command in commands: + f.write('<dt><a href="' + reffiles[command] + '#' + command + '">' + command + '</a></dt>\n') +f.write(sep + tail) diff --git a/doc/script/script-index.html b/doc/script/script-index.html new file mode 100644 index 000000000..cd17b9cf3 --- /dev/null +++ b/doc/script/script-index.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head> + <!-- + ---- (c) Copyright 2004 by Crestez Leonard + + ---- This program is free software; you can redistribute it and/or modify + ---- it under the terms of the GNU General Public License as published by + ---- the Free Software Foundation; version 2 dated June, 1991. + ---- + ---- This program is distributed in the hope that it will be useful, + ---- but WITHOUT ANY WARRANTY; without even the implied warranty of + ---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ---- GNU General Public License for more details. + ---- + ---- You should have received a copy of the GNU General Public License + ---- along with this program; if not, write to the Free Software + ---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + ---- 02111-1307, USA. + --> + <title>Stratagus Scripting Language Description: Index</title> + <meta http-equiv="Content-Type" content="text/html; CHARSET=iso-8859-1"> + <meta name="Author" content="clenard@go.ro"> + <meta name="Keyword" content="script,index"> + <meta name="Description" content=""> +</head><body> + <h1>Stratagus Scripting Language Description: Index</h1> + <p><b> + (C) Copyright 2002-2003 by The Stratagus Project. Distributed under the + <a href="../gpl.html">"GNU General Public License"</a> + </b></p> + <hr> + <a href="../faq.html">FAQ</a> + <a href="script.html">Script main</a> + <a href="script-index.html">Script index</a> + <hr> + <a href="stratagus.html">Stratagus.*</a> + <hr> + + <dl> + <!-- SCRIPT --><dt><a href="stratagus.html#Stratagus.GameCycle">Stratagus.GameCycle</a></dt> +<dt><a href="stratagus.html#Stratagus.GameName">Stratagus.GameName</a></dt> +<dt><a href="stratagus.html#Stratagus.GamePaused">Stratagus.GamePaused</a></dt> +<dt><a href="stratagus.html#Stratagus.LibraryFilePath">Stratagus.LibraryFilePath</a></dt> +<!-- SCRIPT --> + </dl> + + <hr> + Last changed: $Id$<br> + All trademarks and copyrights on this page are owned by their respective owners. + <address>(c) 2002-2004 by <a href="http://stratagus.org">The Stratagus Project</a></address> +</body></html> + diff --git a/doc/script/script.html b/doc/script/script.html index 21d5cf179..bbdc3c5bf 100644 --- a/doc/script/script.html +++ b/doc/script/script.html @@ -1,6 +1,5 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html> -<head> +<html><head> <!-- ---- (c) Copyright 2004 by Crestez Leonard. @@ -18,21 +17,23 @@ ---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA ---- 02111-1307, USA. --> - <title>Stratagus Configuration Language Description: Content</title> + <title>Stratagus Scripting Language Description: Content</title> <meta http-equiv="Content-Type" content="text/html; CHARSET=iso-8859-1"> <meta name="Author" content="cleonard@go.ro"> <meta name="Keyword" content="scripting"> <meta name="Description" content="Scripting language main structure"> -</head> -<body> - <h1>Stratagus Configuration Language Description: Content</h1> +</head><body> + <h1>Stratagus Scripting Language Description: Content</h1> <p><b> (C) Copyright 1998-2004 by The Stratagus Project. Distributed under the <a href="../gpl.html">"GNU General Public License"</a> </b></p> <hr> - <a href="../stratagus.html">Stratagus</a> <a href="../faq.html">FAQ</a> + <a href="script.html">Script main</a> + <a href="script-index.html">Script index</a> + <hr> + <a href="stratagus.html">Stratagus.*</a> <hr> <h2>Intro - Introduction to scripting in Stratagus</h2> @@ -157,8 +158,6 @@ <b>FIXME: this is not complete, but it should give you an idea.</b> - <h2>Content</h2> - <a href="stratagus.html">Stratagus.*</a> <hr> Last changed: $Id$<br> All trademarks and copyrights on this page are owned by their respective owners. diff --git a/doc/script/stratagus.html b/doc/script/stratagus.html new file mode 100644 index 000000000..770adfdda --- /dev/null +++ b/doc/script/stratagus.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head> + <!-- + ---- (c) Copyright 2004 by Crestez Leonard + + ---- This program is free software; you can redistribute it and/or modify + ---- it under the terms of the GNU General Public License as published by + ---- the Free Software Foundation; version 2 dated June, 1991. + ---- + ---- This program is distributed in the hope that it will be useful, + ---- but WITHOUT ANY WARRANTY; without even the implied warranty of + ---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + ---- GNU General Public License for more details. + ---- + ---- You should have received a copy of the GNU General Public License + ---- along with this program; if not, write to the Free Software + ---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + ---- 02111-1307, USA. + --> + <title>Stratagus Scripting Language Description: Content</title> + <meta http-equiv="Content-Type" content="text/html; CHARSET=iso-8859-1"> + <meta name="Author" content="cleonard@go.ro"> + <meta name="Keyword" content="scripting"> + <meta name="Description" content="Documentation for Stratagus.*"> +</head><body> + <h1>Stratagus Scripting Language: Stratagus.*</h1> + <p><b> + (C) Copyright 1998-2004 by The Stratagus Project. Distributed under the + <a href="../gpl.html">"GNU General Public License"</a> + </b></p> + <hr> + <a href="../faq.html">FAQ</a> + <a href="script.html">Script main</a> + <a href="script-index.html">Script index</a> + <hr> + <a href="stratagus.html">Stratagus.*</a> + <hr> + <dl> + <!-- SCRIPT --> + <a name="Stratagus.GameCycle"> + <dt><b>Stratagus.GameCycle</b></dt> + <dd><b>Type:</b> int </dd> + <dd>Game cycle. How many ticks from the start of the game.</dd> + <a name="Stratagus.GameName"> + <dt><b>Stratagus.GameName</b></dt> + <dd><b>Type:</b> string </dd> + <dd>The name of the game. Specified ONCE in the config file, it should be + unique. It will be the name of the pref dir, and used to as a check + in multiplayer. Keep it short and lowercase.</dd> + <a name="Stratagus.GamePaused"> + <dt><b>Stratagus.GamePaused</b></dt> + <dd><b>Type:</b> boolean </dd> + <dd>True if the game is paused, false otherwise.</dd> + <a name="Stratagus.LibraryFilePath"> + <dt><b>Stratagus.LibraryFilePath</b></dt> + <dd><b>Type:</b> string </dd> + <dd>This is the path for the stratagus data dir, the one you specify + with -d on the command line.</dd> + <!-- SCRIPT --> + </dl><hr> + Last changed: $Id$<br> + All trademarks and copyrights on this page are owned by their respective owners. + <address>(c) 2002-2004 by <a href="http://stratagus.org">The Stratagus Project</a></address> +</body></html>