rant 0.3.4 → 0.3.6

data/NEWS

@@ -1,6 +1,19 @@
 
 = Rant NEWS
 
+== Rant 0.3.6
+
+This version should be fully backwards compatible to 0.3.4.
+
+New features:
+* Automatic cleanup of generated files
+* Directed rules
+* Constraining variables
+* rant-import searches $LOAD_PATH
+* Immediately build targets with <tt>rac.build "target"</tt>
+Read doc/rantfile.rdoc[link:files/doc/rantfile_rdoc.html] and
+doc/advanced.rdoc[link:files/doc/advanced_rdoc.html] for docu.
+
 == Rant 0.3.4
 
 Incompatible changes:

data/README

@@ -36,7 +36,7 @@ Running rant in the directory of this file:
 will ensure that the "data" file in the "backup" directory is up to
 date.
 
-This document was written for version 0.3.4 of Rant. Most things
+This document was written for version 0.3.6 of Rant. Most things
 described here will work for older/newer versions of Rant, but look at
 the README file in the Rant distribution you've installed for exact
 documentation of your Rant version.

data/Rantfile

@@ -1,7 +1,7 @@
 
 # Rantfile for Rant :)
 
-import %w(rubytest rubydoc rubypackage)
+import %w(rubytest rubydoc rubypackage autoclean)
 
 task :default => :test
 
@@ -9,6 +9,7 @@ lib_files = sys["lib/**/*.rb"]
 dist_files = sys["{bin,lib,test,doc}/**/*"].shun("html", "coverage") +
 	sys["*"].no_dir.exclude("InstalledFiles", "Session.vim")
 bin_files = sys["bin/*"]
+rdoc_opts = %w(-S -c UTF-8 --title Rant --main README)
 
 gen RubyPackage, "rant" do |t|
     t.version = `#{Env::RUBY} run_rant --version`.split[1]
@@ -19,18 +20,20 @@ gen RubyPackage, "rant" do |t|
     t.author = "Stefan Lang"
     t.email = "langstefan@gmx.at"
     t.rubyforge_project = "make"
-    t.gem_extra_rdoc_files = sys["**/README", "NEWS"].no_dir("pkg").no_dir("test") + sys["doc/**/*.rdoc"]
     t.homepage = "http://make.rubyforge.org"
+    t.gem_extra_rdoc_files = sys["**/README", "NEWS"].no_dir("pkg").no_dir("test") + sys["doc/**/*.rdoc"]
+    t.gem_rdoc_options = rdoc_opts
     desc "Create packages for distribution."
     t.package_task
 end
 
 desc "Generate documentation."
 gen RubyDoc do |g|
+    g.verbose = true
     g.dir = "doc/html"
-    g.files.concat FileList["NEWS", "**/README"].no_dir("pkg").no_dir("test")
-    g.files.concat FileList["doc/**/*.rdoc"]
-    g.opts = %w(-S -c UTF-8 --title Rant --main README)
+    g.files.concat sys["NEWS", "**/README"].no_dir("pkg").no_dir("test")
+    g.files.concat sys["doc/**/*.rdoc"]
+    g.opts = rdoc_opts + %w(-T doc/jamis.rb)
 end
 
 desc "Run basic tests."
@@ -77,6 +80,18 @@ gen RubyTest, :tsubdirs do |t|
     t.test_files = sys["test/subdirs/test_*.rb"]
 end
 
+desc "Test rant-import command."
+gen RubyTest, :trimport do |t|
+    t.libs << "test"
+    t.test_files = sys["test/rant-import/test_*.rb"]
+end
+
+desc "Test import/ libraries."
+gen RubyTest, :timport do |t|
+    t.libs << "test"
+    t.test_files = sys["test/import/**/test_*.rb"]
+end
+
 desc "Run all tests."
 gen RubyTest, :tall do |g|
     g.libs << "test"
@@ -85,11 +100,10 @@ end
 task :testall => %w(test testp1 testp2 testrb1 testplugins)
 
 desc "Remove autogenerated files."
-task :clean do
-    sys.rm_f %w(InstalledFiles .config bench-rant bench-depsearch)
-    sys.rm_rf %w(doc/html pkg test/coverage)
-    sys.rm_f sys["bin/*.cmd"]
-end
+gen AutoClean, :clean
+var[:clean].include %w(
+    InstalledFiles .config bench-rant bench-depsearch test/coverage
+)
 
 desc "Publish html docs on make.rubyfore.org.",
      "Note: scp will prompt for rubyforge password."
@@ -132,10 +146,4 @@ if Env.on_windows?
     }
 end
 
-# for quich rant testing
-#plugin :Configure
-
-# mainly for rant testing
-#source 'rantmethods.rb'
-
 # vim:ft=ruby:

data/doc/advanced.rdoc

@@ -47,6 +47,194 @@ any directory/file named "CVS" or ending in ~. Examples would be:
     xy~
     src/util.c~
 
+=== More on selecting files with the glob operator
+
+The sys[] operator actually returns a _filelist_ object, which behaves
+similar to an array. There are many methods for filelist objects, here
+is a brief overview:
+
+    # create a filelist containing all files in the current directory
+    # and in the src directory
+    fl = sys["*", "src/*"]
+
+    # remove all files from the list which end in .bak
+    fl.exclude "*.bak"
+
+    # add all .rb files in directories lib and test
+    fl.include "lib/*.rb", "test/*.rb"
+
+    # remove all files from the list which contain the path element
+    # "coverage" (e.g.: test/coverage/ lib/coverage/main.c)
+    fl.exclude_all "coverage"
+
+    # add a single file to the list
+    fl << "doc/README"
+
+    # get a new filelist containing only directories, fl isn't
+    # modified:
+    dirs = fl.select { |f| File.directory? f }
+
+    # create a manifest file
+    open("MANIFEST", "w") { |f| f.puts fl }
+
+Additionally, you can use all methods available for an array. Lookup
+docs with ri for array methods:
+    % ri Array
+
+=== Cleaning up generated files
+
+Use the +Clean+ generator in your Rantfiles:
+    import "clean"
+
+    file "junk" do
+       # create junk
+    end
+
+    # create a task called clean
+    desc "cleanup generated files"
+    gen Clean
+
+    # var[:clean] is a filelist object now
+    var[:clean] << "junk"
+    var[:clean].include "**/*.bak", "**/*.obj"
+
+=== Let Rant cleanup for you
+
+Use the +AutoClean+ generator which will remove all files generated by
+any filetask (include those created by rules):
+    import "autoclean"
+
+    file "junk" do
+        # create junk
+    end
+
+    gen Rule, :o => :c do |t|
+        sys "cc -c -o #{t.name} #{t.source}"
+    end
+
+    desc "Cleanup generated files."
+    gen AutoClean, :clean
+    # The clean task automatically detects which files where created
+    # by our rule and the junk task.
+    # Additionally we can add files to remove to the variable with the
+    # same name as the AutoClean taskname (here: clean):
+    var[:clean].include "**/*.bak"
+
+=== The DirectedRule generator
+
+A directed rule is some sort of special rule. It searches for source
+files in one or more given directories and produces file in one output
+directory.
+
+    import "directedrule"
+
+    ro = gen DirectedRule, "obj" => sys["src_*"], :o => :c do |t|
+	sys "cc -c -o #{t.name} #{t.source}"
+    end
+
+This rule produces a file task for targets in the obj/ directory
+ending in `.o'. It looks for a source file in all directories starting
+with `src_' and files ending in `.c'.
+
+Practically, this means that it compiles the C files in src_x/, src_y,
+... to object files which are placed in the obj/ directory.
+
+Look in the doc/examples/directedrule directory of the Rant
+distribution for a small example project.
+
+=== Constraining variables
+
+Rant allows you to constrain variables which are managed by the +var+
+command (and thus can be set from the commandline):
+
+    var :count, 0..10
+
+This initializes the variable +count+ to 0 and restricts it to the
+integer range 0 to 10. Create a task to test it:
+
+    task :show_count do
+        puts var[:count]
+    end
+
+And now try to set the count variable from the commandline:
+
+    % rant
+    0
+    % rant count=5
+    5
+    % rant count=-1
+    rant: [ERROR] in file `/home/stefan/tmp/Rantfile', line 2:
+		  "-1" doesn't match constraint: integer 0..10
+    rant aborted!
+    % rant count=100
+    rant: [ERROR] in file `/home/stefan/tmp/Rantfile', line 2:
+		  "100" doesn't match constraint: integer 0..10
+    rant aborted!
+
+Other available constraints:
+
+    # variable str is ensured to be a string
+    var :str, :String
+
+    # variable b is a bool (always true or false)
+    # can be set to "yes", "no", "1", "0", "true", "false"
+    var :b, :Bool
+
+=== The Action generator
+
+Consider a C project. In some C source file, let's say config.h you
+define the project version, e.g.:
+    #define VERSION 2.3
+Many of your tools use this version number, so you have decided to
+duplicate it in a file called +version+, which contains just a line
+with the program version. On solution to automate the +version+ file
+creation would be to write a file task:
+    file "version" => "config.h" do |t|
+	puts "updating version file"
+	open("w", t.name) { |f| f.puts(extract_config_version()) }
+    end
+and make all other tasks that need this version dependent on it. But
+this can get very tedious if you have many tasks that need this
+version file. Another solution is to just run the task every time the
+Rantfile is sourced. This can be achieved by placing the following
+statement after the "version" task:
+    rac.build "version"
+This tells rant to immediately invoke all tasks that are required to
+build the version file. But imagine your users just want to see the
+list of available tasks:
+    % rant --tasks
+    updating version file
+    rant foo		# build foo program
+    rant lib		# build libfoo.so
+    rant clean		# remove generated files
+Hmm, we really didn't need the version to show our users the available
+tasks. To avoid this, wrap such code in an Action:
+    file "version" => "config.h" do |t|
+	puts "updating version file"
+	open("w", t.name) { |f| f.puts(extract_config_version()) }
+    end
+
+    gen Action do
+	rac.build "version"
+    end
+And now on a clean source base:
+    % rant --tasks
+    rant foo		# build foo program
+    rant lib		# build libfoo.so
+    rant clean		# remove generated files
+OK. Didn't confuse our users! Run any task:
+    % rant foo
+    updating version file
+    cc -o foo foo.c
+This means, Action blocks are executed whenever we actually want to
+build something, not just extract information from our Rantfile. It is
+recommended to wrap any code that has effects on the environment
+(mainly the file system) inside an Action block instead of embedding
+it plain in the Rantfile.
+
+An Action block also won't be run when our Rantfile is read by
+rant-import.
+
 == See also
 
 Rantfile basics::

data/doc/examples/directedrule/Rantfile

@@ -0,0 +1,23 @@
+
+import %w(directedrule autoclean)
+
+desc "Build foo."
+file :foo => "obj/libfoo.a" do |t|
+    sys "cc -o #{t.name} #{t.source}"
+end
+
+gen Directory, "obj"
+
+ro = gen DirectedRule, "obj" => sys["src_*"], :o => :c do |t|
+    rac.build "obj"
+    sys "cc -c -o #{t.name} #{t.source}"
+end
+
+file "obj/libfoo.a" => ro.candidates do |t|
+    sys "ar cr #{t.name} #{t.prerequisites.arglist}"
+    sys "ranlib #{t.name}"
+end
+
+gen AutoClean, :clean
+
+# vim: ft=ruby

data/doc/examples/directedrule/src_a/a_2.c

@@ -0,0 +1,5 @@
+
+int main()
+{
+    return 0;
+}

data/doc/jamis.rb

@@ -0,0 +1,590 @@
+module RDoc
+module Page
+
+FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"
+
+STYLE = <<CSS
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #77F;
+  text-decoration: underline;
+}
+
+body, td, p {
+  font-family: %fonts%;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: small;
+}
+
+#content {
+  margin: 2em;
+}
+
+#description p {
+  margin-bottom: 0.5em;
+}
+
+.sectiontitle {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  padding-left: 2em;
+  background: #005;
+  color: #FFF;
+  font-weight: bold;
+  border: 1px dotted black;
+}
+
+.attr-rw {
+  padding-left: 1em;
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+
+.attr-name {
+  font-weight: bold;
+}
+
+.attr-desc {
+}
+
+.attr-value {
+  font-family: monospace;
+}
+
+.file-title-prefix {
+  font-size: large;
+}
+
+.file-title {
+  font-size: large;
+  font-weight: bold;
+  background: #005;
+  color: #FFF;
+}
+
+.banner {
+  background: #005;
+  color: #FFF;
+  border: 1px solid black;
+  padding: 1em;
+}
+
+.banner td {
+  background: transparent;
+  color: #FFF;
+}
+
+h1 a, h2 a, .sectiontitle a, .banner a {
+  color: #FF0;
+}
+
+h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
+  color: #FF7;
+}
+
+.dyn-source {
+  display: none;
+  background: #FFE;
+  color: #000;
+  border: 1px dotted black;
+  margin: 0.5em 2em 0.5em 2em;
+  padding: 0.5em;
+}
+
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+
+.method {
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-bottom: 1em;
+}
+
+.description pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+.method .title {
+  font-family: monospace;
+  font-size: large;
+  border-bottom: 1px dashed black;
+  margin-bottom: 0.3em;
+  padding-bottom: 0.1em;
+}
+
+.method .description, .method .sourcecode {
+  margin-left: 1em;
+}
+
+.description p, .sourcecode p {
+  margin-bottom: 0.5em;
+}
+
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+
+h1 {
+  padding: 1em;
+  border: 1px solid black;
+  font-size: x-large;
+  font-weight: bold;
+  color: #FFF;
+  background: #007;
+}
+
+h2 {
+  padding: 0.5em 1em 0.5em 1em;
+  border: 1px solid black;
+  font-size: large;
+  font-weight: bold;
+  color: #FFF;
+  background: #009;
+}
+
+h3, h4, h5, h6 {
+  padding: 0.2em 1em 0.2em 1em;
+  border: 1px dashed black;
+  color: #000;
+  background: #AAF;
+}
+
+.sourcecode > pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+CSS
+
+XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+}
+
+HEADER = XHTML_PREAMBLE + <<ENDHEADER
+<html>
+  <head>
+    <title>%title%</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
+
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+        function toggleSource( id )
+        {
+          var elem
+          var link
+
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </script>
+  </head>
+
+  <body>
+ENDHEADER
+
+FILE_PAGE = <<HTML
+<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
+  <tr><td>
+    <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
+      <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td>
+      <td align="right">
+        <table border='0' cellspacing="0" cellpadding="2">
+          <tr>
+            <td>Path:</td>
+            <td>%full_path%
+IF:cvsurl
+				&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+            </td>
+          </tr>
+          <tr>
+            <td>Modified:</td>
+            <td>%dtm_modified%</td>
+          </tr>
+        </table>
+      </td></tr>
+    </table>
+  </td></tr>
+</table><br>
+HTML
+
+###################################################################
+
+CLASS_PAGE = <<HTML
+<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
+  <td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+START:infiles
+HREF:full_path_url:full_path:
+IF:cvsurl
+&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+END:infiles
+        </td>
+      </tr>
+IF:parent
+    <tr>
+      <td>Parent:</td>
+      <td>
+IF:par_url
+        <a href="%par_url%">
+ENDIF:par_url
+%parent%
+IF:par_url
+         </a>
+ENDIF:par_url
+     </td>
+   </tr>
+ENDIF:parent
+         </table>
+        </td>
+        </tr>
+      </table>
+HTML
+
+###################################################################
+
+METHOD_LIST = <<HTML
+  <div id="content">
+IF:diagram
+  <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center">
+    %diagram%
+  </td></tr></table>
+ENDIF:diagram
+
+IF:description
+  <div class="description">%description%</div>
+ENDIF:description
+
+IF:requires
+  <div class="sectiontitle">Required Files</div>
+  <ul>
+START:requires
+  <li>HREF:aref:name:</li>
+END:requires
+  </ul>
+ENDIF:requires
+
+IF:toc
+  <div class="sectiontitle">Contents</div>
+  <ul>
+START:toc
+  <li><a href="#%href%">%secname%</a></li>
+END:toc
+  </ul>
+ENDIF:toc
+
+IF:methods
+  <div class="sectiontitle">Methods</div>
+  <ul>
+START:methods
+  <li>HREF:aref:name:</li>
+END:methods
+  </ul>
+ENDIF:methods
+
+IF:includes
+<div class="sectiontitle">Included Modules</div>
+<ul>
+START:includes
+  <li>HREF:aref:name:</li>
+END:includes
+</ul>
+ENDIF:includes
+
+START:sections
+IF:sectitle
+<div class="sectiontitle"><a nem="%secsequence%">%sectitle%</a></div>
+IF:seccomment
+<div class="description">
+%seccomment%
+</div>
+ENDIF:seccomment
+ENDIF:sectitle
+
+IF:classlist
+  <div class="sectiontitle">Classes and Modules</div>
+  %classlist%
+ENDIF:classlist
+
+IF:constants
+  <div class="sectiontitle">Constants</div>
+  <table border='0' cellpadding='5'>
+START:constants
+  <tr valign='top'>
+    <td class="attr-name">%name%</td>
+    <td>=</td>
+    <td class="attr-value">%value%</td>
+  </tr>
+IF:desc
+  <tr valign='top'>
+    <td>&nbsp;</td>
+    <td colspan="2" class="attr-desc">%desc%</td>
+  </tr>
+ENDIF:desc
+END:constants
+  </table>
+ENDIF:constants
+
+IF:attributes
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+START:attributes
+  <tr valign='top'>
+    <td class='attr-rw'>
+IF:rw
+[%rw%]
+ENDIF:rw
+    </td>
+    <td class='attr-name'>%name%</td>
+    <td class='attr-desc'>%a_desc%</td>
+  </tr>
+END:attributes
+  </table>
+ENDIF:attributes
+
+IF:method_list
+START:method_list
+IF:methods
+<div class="sectiontitle">%type% %category% methods</div>
+START:methods
+<div class="method">
+  <div class="title">
+IF:callseq
+    <a name="%aref%"></a><b>%callseq%</b>
+ENDIF:callseq
+IFNOT:callseq
+    <a name="%aref%"></a><b>%name%</b>%params%
+ENDIF:callseq
+IF:codeurl
+[ <a href="javascript:openCode('%codeurl%')">source</a> ]
+ENDIF:codeurl
+  </div>
+IF:m_desc
+  <div class="description">
+  %m_desc%
+  </div>
+ENDIF:m_desc
+IF:aka
+<div class="aka">
+  This method is also aliased as
+START:aka
+  <a href="%aref%">%name%</a>
+END:aka
+</div>
+ENDIF:aka
+IF:sourcecode
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p>
+  <div id="%aref%_source" class="dyn-source">
+<pre>
+%sourcecode%
+</pre>
+  </div>
+</div>
+ENDIF:sourcecode
+</div>
+END:methods
+ENDIF:methods
+END:method_list
+ENDIF:method_list
+END:sections
+</div>
+HTML
+
+FOOTER = <<ENDFOOTER
+  </body>
+</html>
+ENDFOOTER
+
+BODY = HEADER + <<ENDBODY
+  !INCLUDE! <!-- banner header -->
+
+  <div id="bodyContent">
+    #{METHOD_LIST}
+  </div>
+
+  #{FOOTER}
+ENDBODY
+
+########################## Source code ##########################
+
+SRC_PAGE = XHTML_PREAMBLE + <<HTML
+<html>
+<head><title>%title%</title>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+.ruby-comment    { color: green; font-style: italic }
+.ruby-constant   { color: #4433aa; font-weight: bold; }
+.ruby-identifier { color: #222222;  }
+.ruby-ivar       { color: #2233dd; }
+.ruby-keyword    { color: #3333FF; font-weight: bold }
+.ruby-node       { color: #777777; }
+.ruby-operator   { color: #111111;  }
+.ruby-regexp     { color: #662222; }
+.ruby-value      { color: #662222; font-style: italic }
+  .kw { color: #3333FF; font-weight: bold }
+  .cmt { color: green; font-style: italic }
+  .str { color: #662222; font-style: italic }
+  .re  { color: #662222; }
+</style>
+</head>
+<body bgcolor="white">
+<pre>%code%</pre>
+</body>
+</html>
+HTML
+
+########################## Index ################################
+
+FR_INDEX_BODY = <<HTML
+!INCLUDE!
+HTML
+
+FILE_INDEX = XHTML_PREAMBLE + <<HTML
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+<!--
+  body {
+    background-color: #EEE;
+    font-family: #{FONTS}; 
+    color: #000;
+    margin: 0px;
+  }
+  .banner {
+    background: #005;
+    color: #FFF;
+    padding: 0.2em;
+    font-size: small;
+    font-weight: bold;
+    text-align: center;
+  }
+  .entries {
+    margin: 0.25em 1em 0 1em;
+    font-size: x-small;
+  }
+  a {
+    color: #00F;
+    text-decoration: none;
+    white-space: nowrap;
+  }
+  a:hover {
+    color: #77F;
+    text-decoration: underline;
+  }
+-->
+</style>
+<base target="docwin">
+</head>
+<body>
+<div class="banner">%list_title%</div>
+<div class="entries">
+START:entries
+<a href="%href%">%name%</a><br>
+END:entries
+</div>
+</body></html>
+HTML
+
+CLASS_INDEX = FILE_INDEX
+METHOD_INDEX = FILE_INDEX
+
+INDEX = XHTML_PREAMBLE + <<HTML
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>%title%</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+</head>
+
+<frameset cols="20%,*">
+    <frameset rows="15%,35%,50%">
+        <frame src="fr_file_index.html"   title="Files" name="Files" />
+        <frame src="fr_class_index.html"  name="Classes" />
+        <frame src="fr_method_index.html" name="Methods" />
+    </frameset>
+IF:inline_source
+      <frame  src="%initial_page%" name="docwin">
+ENDIF:inline_source
+IFNOT:inline_source
+    <frameset rows="80%,20%">
+      <frame  src="%initial_page%" name="docwin">
+      <frame  src="blank.html" name="source">
+    </frameset>
+ENDIF:inline_source
+    <noframes>
+          <body bgcolor="white">
+            Click <a href="html/index.html">here</a> for a non-frames
+            version of this page.
+          </body>
+    </noframes>
+</frameset>
+
+</html>
+HTML
+
+end
+end
+