
# Directory where to put the generated files
# set options(directory) "."
set options(directory) "~/tmp/doc"

# Verbose mode
# set options(verbose) off
set options(verbose) on

# Overwrite of files
# set options(forceWrite) off
set options(forceWrite) on

# Sort the functions per file
# set options(sortFile) on
set options(sortFile) "on"
# Sort the functions per file
# set options(sortProc) on
set options(sortProc) "on"
# Sort the global variables per function
# set options(sortGlobal) on
set options(sortGlobal) "on"

# Should we make appear the Empty comment with special format
# set options(showEmptyComment) off
set options(showEmptyComment) "on"
# Format of The 'no comment specification' if showEmptyComment is on
# set options(noCommentFormat) "<I>No Comment</I>"
set options(noCommentFormat) "<FONT COLOR=\"$options(errorColor)\">No Comment</FONT>"

# Options to display or not the parameters/globals used inside a
# function
#set options(detailGlobal) "on"
#set options(detailParam) "on"
set options(detailGlobal) "on"
set options(detailParam) "on"

# Option to get a file 'index.html' containing a reference to all the
# others indexed files. If set to off, then generalFunctionList,
#  indexTitle and summary are useless.
#set options(htmlIndex) "on"
set options(htmlIndex) "on"

# Options to get a summary and statistics about the indexation process
# set options(summary) "on"
set options(summary) "on"

# Options to get a list of all the found functions
# set options(generalFunctionList) "off"
set options(generalFunctionList) "off"

# Title of the 'index.tcl' file
# set options(indexTitle) "TCL Documentation"
set options(indexTitle) "TCL Documentation"

# If set to on this option gives a list of functions per file
# set options(indexFunction) "on"
set options(indexFunction) "on"

# Generated HTML Type
# For the moment, only 2 types are available:
# table and normal
# table generates files with intensive use of the <TABLE> tag
# normal generates files with <DL> style
#set options(htmlType) normal
set options(htmlType) table

# Regular expression to remove lines from the comments associated to a
# file. By default I remove the #!/ lines and the Emacs ones (-*-) 
# set options(removeReg) "^\#!.*|^\# -\*-.*"
set options(removeReg) "^\#!.*|^\# -\*-.*"

# Regular expression used to recognised the start of a function
# CAUTION It should have only one pair of parenthesis  around the name
# of the function
# set options(procReg) "^proc\[ \t\]*(\[^ \t\]*)\[ \t\]*\{.*"
set options(procReg) "^proc\[ \t\]*(\[^ \t\]*)\[ \t\]*\{.*"

# Option to be manipulated with care.
# When a function is found, an eval is done to get its definition (see
# README file for details), by default this definition is removed by
# the indexation process with a 'rename $function ""'
# If set to off, then this rename operation is not done.
# (This option has been added to be able to autodocument the script)
#set options(removeFunction) "on"
set options(removeFunction) "on"

#
# The following options allow to customize the generated HTML
# more precisely

# Body customized Tag
# set options(bodyHTML) "<BODY>"
set options(bodyHTML) "<BODY BGCOLOR=\"white\">"

# HTML Code inserted between 2 functions
#set options(procSeparatorHTML) "\n<P><HR>\n"
set options(procSeparatorHTML) "\n<P><HR>\n"

# HTML Code inserted before a parameter/global line in 'normal' output
# set options(parameterBulletHTML) ""
set options(parameterBulletHTML) "<IMG SRC=\"redball.gif\" ALT=\"*\">"

# HTML Code inserted before a function line in 'normal' output
# set options(functionBulletHTML) ""
set options(functionBulletHTML) "<IMG SRC=\"yellowball.gif\" ALT=\"*\">"

# HTML Parameters to any TABLE tag (used only in 'table' output
# set options(tableParam)  ""
set options(tableParam)  "BORDER=1 WIDTH=\"100%\""

# Parameters to TR Specification for a function
#set options(TRFunction) ""
set options(TRFunction) ""
# Parameters to TD Specification for a function
#set options(TDFunction) ""
set options(TDFunction) "ALIGN=CENTER BGCOLOR=\"yellow\""
# Parameters to TR Specification for a function comment
# set options(TRFunctionComment) ""
set options(TRFunctionComment) ""
# Parameters to TD Specification for a function comment
# set options(TDFunctionComment) ""
set options(TDFunctionComment) "ALIGN=LEFT"

# Options for the Parameters Title line of a function
#set options(TRParam) ""
#set options(TDParam) ""
set options(TRParam) ""
set options(TDParam) "ALIGN=CENTER BGCOLOR=\"violetred2\""

# Options for each parameters line. The name, comment and Value cells
# can be customized individually
#set options(TRParamLine) ""
#set options(TDParamName) "ALIGN=LEFT"
#set options(TDParamComment) "ALIGN=LEFT"
#set options(TDParamValue) "ALIGN=LEFT"
set options(TRParamLine) ""
set options(TDParamName) "ALIGN=LEFT"
set options(TDParamComment) "ALIGN=LEFT"
set options(TDParamValue) "ALIGN=LEFT"

# Same options but for the globals
#set options(TRGlobal) ""
#set options(TDGlobal) "ALIGN=CENTER"
#set options(TRGlobalLine) ""
#set options(TDGlobalName) "ALIGN=LEFT"
#set options(TDGlobalComment) "ALIGN=LEFT"
set options(TRGlobal) ""
set options(TDGlobal) "ALIGN=CENTER BGCOLOR=\"aquamarine\""
set options(TRGlobalLine) ""
set options(TDGlobalName) "ALIGN=LEFT"
set options(TDGlobalComment) "ALIGN=LEFT"

# Same options for the return of a function
#set options(TRReturn) ""
#set options(TDReturn) "ALIGN=CENTER"
#set options(TRReturnComment) ""
#set options(TDReturnComment) "ALIGN=LEFT"
set options(TRReturn) ""
set options(TDReturn) "ALIGN=CENTER BGCOLOR=\"MediumPurple2\""
set options(TRReturnComment) ""
set options(TDReturnComment) "ALIGN=LEFT"

# Same options for the summary table
#set options(TRSummary) ""
#set options(TDSummary) "ALIGN=CENTER"
#set options(TRSummaryLine) ""
#set options(TDSummaryText) "ALIGN=LEFT"
#set options(TDSummaryValue) "ALIGN=CENTER"
set options(TRSummary) ""
set options(TDSummary) "ALIGN=CENTER"
set options(TRSummaryLine) ""
set options(TDSummaryText) "ALIGN=LEFT"
set options(TDSummaryValue) "ALIGN=CENTER"

# Color used to denote errors (like not readable file)
# set options(errorColor) red
set options(errorColor) red

# Options to customize the paragraph style and the font style for the
# titles of the HTML pages
#set options(fileTitleParagraph) "ALIGN=CENTER"
#set options(fileTitleFont) "SIZE=\"+3\" COLOR=\"blue\""
set options(fileTitleParagraph) "ALIGN=CENTER"
set options(fileTitleFont) "SIZE=\"+3\" COLOR=\"blue\""

# HTML Text inserted just after the BODY specification and just before
# the /BODY
# Can be useful for inserting a company logo for example
# There are 2 for the index file (if generated) and the 2 others are
# for the other files.
#
#set options(startIndexHTML) ""
#set options(endIndexHTML) ""
#set options(startFileHTML) ""
#set options(endFileHTML) ""

set options(startIndexHTML) ""
set options(endIndexHTML) ""
set options(startFileHTML) ""
set options(endFileHTML) "<P><HR><A HREF=\"index.html\">Back to Index File</A>"

