# This is a -*- Tcl -*- script.
#
# driver.tcl --- InfoPrism::Driver class documentation
#
# Copyright (C) 1998, 1999 Stefan Hornburg
#
# Author: Stefan Hornburg <racke@gundel.han.de>
# Maintainer: Stefan Hornburg <racke@gundel.han.de>
# Version: 0.0.6
#
# This file 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; either version 2, or (at your option) any
# later version.
# 
# This file 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 file; see the file COPYING.  If not, write to the Free
# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

manual "The Driver Class"
stamp "Mon Jan  4 22:34:49 1999 MET"

makeindex fn
makeindex vr

include common.tcl

h2 "Attributes"
dl {
	dt [code [withindex vr lang]]
	dd ""
	dt [code [withindex vr logfile]]
	dd ""
	dt [code [withindex vr output_file]]
	dd ""
	dt [code [withindex vr rulebasedirs]]
	dd ""
	dt [code [withindex vr translators]]
	dd ""
}

h2 "Methods"
h3 "Configuration"
dl {
	dt "[withindex fn [code defineformat]] [var NAME] [var CLASS]"
	dd "Defines new output format [var NAME]. [var CLASS] implements the
	corresponding translator."
}
h3 "Document Translation"
dl {
	dt "[withindex fn [code parse]] [var FILE]"
	dd "Parses SGML source [var FILE]. Returns [link document document]
	object or an empty string in case of errors."
	dt "[withindex fn [code format]] [var DOC] [var NAME]"
	dd "Translates document [var DOC] to output format [var NAME].
	Returns result or an empty string in case of errors."
}

h3 "Index of Variables"
insertindex vr

h3 "Index of Methods"
insertindex fn