Convert .DS/.DE into HTML tables, not preformatted text.

2 files changed, 167 insertions, 167 deletions

diff --git a/ChangeLog b/ChangeLog
index b365bab..9f0beca 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,10 +1,15 @@
+2007-10-17  Donal K. Fellows  <donal.k.fellows@manchester.ac.uk>
+
+	* tools/man2html2.tcl: Convert .DS/.DE into HTML tables, not
+	preformatted text.
+
 2007-10-17  Kevin B. Kenny  <kennykb@acm.org>
 
 	* generic/tclCompExpr.c: Moved a misplaced declaration that blocked
 	                         compilation on VC++.
 	* generic/tclExecute.c: Silenced several VC++ compiler warnings about
 	                        converting 'long' to 'unsigned short'.
-	
+
 2007-10-16  David Gravereaux <davygrvy@pobox.com>
 
 	* win/makefile.vc: removed old dependency cruft that is no longer
@@ -39,17 +44,17 @@
 	* tests/set.test:
 	* tests/string.test:
 	* tests/stringComp.test:
-	
+
 2007-10-15  David Gravereaux <davygrvy@pobox.com>
 
-	* tools/mkdepend.tcl:	Produces usable output.  Include path
-	* win/makefile.vc:	problem fixed.  Never fight city hall
-	when it comes to levels of quoting issues.
+	* tools/mkdepend.tcl:	Produces usable output. Include path problem
+	* win/makefile.vc:	fixed. Never fight city hall when it comes to
+	levels of quoting issues.
 
 2007-10-15  Miguel Sofer  <msofer@users.sf.net>
 
-	* generic/tclParse.c (Tcl_ParseBraces): fix for possible read
-	after the end of buffer, [Bug 1813528] (Joe Mistachkin).
+	* generic/tclParse.c (Tcl_ParseBraces): fix for possible read after
+	the end of buffer. [Bug 1813528] (Joe Mistachkin)
 
 2007-10-14  David Gravereaux <davygrvy@pobox.com>
 
@@ -60,10 +65,10 @@
 
 	* win/makefile.vc:  Mine all version information from headers.
 	* win/rules.vc:     Sync tcl and tk and bring extension versions
-	* win/nmakehlp.c:   closer together. Try and avoid using tclsh
-	                    to do substitutions as we may cross compile.
+	* win/nmakehlp.c:   closer together. Try and avoid using tclsh to do
+	                    substitutions as we may cross compile.
 	* win/coffbase.txt: Added offsets for snack dlls.
-	
+
 2007-10-11  David Gravereaux <davygrvy@pobox.com>
 
 	* win/makefile.vc:  Fixed my bad spelling mistakes from years back.
@@ -73,12 +78,12 @@
 
 	* generic/tclCmdMZ.c:	Correct [string is (wide)integer] failure
 	* tests/string.test:	to report correct failindex values for
-	non-decimal integer strings.  [Bug 1805887].
+	non-decimal integer strings. [Bug 1805887]
 
 	* compat/strtoll.c (removed):	The routines strtoll() and strtoull()
 	* compat/strtoull.c (removed):	are no longer called by the Tcl source
-	* generic/tcl.h:	code.  (Their functionality has been replaced
-	* unix/Makefile.in:	by TclParseNumber().)  Remove outdated comments
+	* generic/tcl.h:	code. (Their functionality has been replaced
+	* unix/Makefile.in:	by TclParseNumber().) Remove outdated comments
 	* unix/configure.in:	and mountains of configury autogoo that
 	* unix/tclUnixPort.h:	allegedly support the mythical systems where
 	* win/Makefile.in:	these routines might not have been available.
@@ -90,17 +95,17 @@
 
 2007-10-11  Miguel Sofer  <msofer@users.sf.net>
 
-	* generic/tclObj.c: remove superfluous #include of tclCompile.h 
+	* generic/tclObj.c: remove superfluous #include of tclCompile.h
 
 2007-10-08  George Peter Staplin <georgeps@xmission.com>
 
-	* doc/Hash.3: Correct the valid usage of the flags member for the 
-	Tcl_HashKeyType.  It should be 0 or more of the flags mentioned.
+	* doc/Hash.3: Correct the valid usage of the flags member for the
+	Tcl_HashKeyType. It should be 0 or more of the flags mentioned.
 
 2007-10-02  Jeff Hobbs  <jeffh@ActiveState.com>
 
-	* generic/tcl.h (Tcl_DecrRefCount): Update change from 2006-05-29
-	to make macro more warning-robust in unbraced if code.
+	* generic/tcl.h (Tcl_DecrRefCount): Update change from 2006-05-29 to
+	make macro more warning-robust in unbraced if code.
 
 2007-10-02  Don Porter	<dgp@users.sourceforge.net>
 
@@ -115,8 +120,8 @@
 
 2007-10-02  Andreas Kupries  <andreask@activestate.com>
 
-	* library/tclIndex: Added 'tcl::tm::path' to the tclIndex. This
-	  fixes [SF Bug 1806422] reported by Don Porter.
+	* library/tclIndex: Added 'tcl::tm::path' to the tclIndex. This fixes
+	[Bug 1806422] reported by Don Porter.
 
 2007-09-25  Donal K. Fellows  <donal.k.fellows@manchester.ac.uk>
 
diff --git a/tools/man2html2.tcl b/tools/man2html2.tcl
index 14bbab0..c000e21 100644
--- a/tools/man2html2.tcl
+++ b/tools/man2html2.tcl
@@ -1,31 +1,31 @@
+##############################################################################
 # man2html2.tcl --
 #
-# This file defines procedures that are used during the second pass of the
-# man page to html conversion process. It is sourced by man2html.tcl.
+# This file defines procedures that are used during the second pass of the man
+# page to html conversion process. It is sourced by man2html.tcl.
 #
 # Copyright (c) 1996 by Sun Microsystems, Inc.
 #
-# $Id: man2html2.tcl,v 1.9 2005/05/10 18:35:25 kennykb Exp $
+# $Id: man2html2.tcl,v 1.10 2007/10/17 17:33:51 dkf Exp $
 #
 
 package require Tcl 8.4
 
 # Global variables used by these scripts:
 #
-# NAME_file -	array indexed by NAME and containing file names used
-#		for hyperlinks.
+# NAME_file -	array indexed by NAME and containing file names used for
+#		hyperlinks.
 #
 # textState -	state variable defining action of 'text' proc.
 #
-# nestStk -	stack oriented list containing currently active
-#		HTML tags (UL, OL, DL). Local to 'nest' proc.
+# nestStk -	stack oriented list containing currently active HTML tags (UL,
+#		OL, DL). Local to 'nest' proc.
 #
-# inDT -	set by 'TPmacro', cleared by 'newline'. Used to insert
-#		the <DT> tag while in a dictionary list <DL>.
+# inDT -	set by 'TPmacro', cleared by 'newline'. Used to insert the
+#		tag while in a dictionary list <DL>.
 #
-# curFont -	Name of special font that is currently in
-#		use.  Null means the default paragraph font
-#		is being used.
+# curFont -	Name of special font that is currently in use. Null means the
+#		default paragraph font is being used.
 #
 # file -	Where to output the generated HTML.
 #
@@ -33,28 +33,29 @@ package require Tcl 8.4
 #
 # fontEnd -	Array to map font names to ending sequences.
 #
-# noFillCount -	Non-zero means don't fill the next $noFillCount
-#		lines: force a line break at each newline.  Zero
-#		means filling is enabled, so don't output line
-#		breaks for each newline.
+# noFillCount -	Non-zero means don't fill the next $noFillCount lines: force a
+#		line break at each newline. Zero means filling is enabled, so
+#		don't output line breaks for each newline.
 #
-# footer -	info inserted at bottom of each page. Normally read
-#		from the xref.tcl file
-	
+# footer -	info inserted at bottom of each page. Normally read from the
+#		xref.tcl file
+
+##############################################################################
 # initGlobals --
 #
-# This procedure is invoked to set the initial values of all of the
-# global variables, before processing a man page.
+# This procedure is invoked to set the initial values of all of the global
+# variables, before processing a man page.
 #
 # Arguments:
 # None.
 
 proc initGlobals {} {
     global file noFillCount textState
-    global fontStart fontEnd curFont inPRE charCnt
+    global fontStart fontEnd curFont inPRE charCnt inTable
 
     nest init
     set inPRE 0
+    set inTable 0
     set textState 0
     set curFont ""
     set fontStart(Code) "<B>"
@@ -65,12 +66,12 @@ proc initGlobals {} {
     set charCnt 0
     setTabs 0.5i
 }
-
-
+
+##############################################################################
 # beginFont --
 #
-# Arranges for future text to use a special font, rather than
-# the default paragraph font.
+# Arranges for future text to use a special font, rather than the default
+# paragraph font.
 #
 # Arguments:
 # font -		Name of new font to use.
@@ -86,7 +87,7 @@ proc beginFont font {
     set curFont $font
 }
 
-
+##############################################################################
 # endFont --
 #
 # Reverts to the default font for the paragraph type.
@@ -102,67 +103,74 @@ proc endFont {} {
 	set curFont ""
     }
 }
-
-
-
+
+##############################################################################
 # text --
 #
-# This procedure adds text to the current paragraph.  If this is
-# the first text in the paragraph then header information for the
-# paragraph is output before the text.
+# This procedure adds text to the current paragraph. If this is the first text
+# in the paragraph then header information for the paragraph is output before
+# the text.
 #
 # Arguments:
 # string -		Text to output in the paragraph.
 
 proc text string {
-    global file textState inDT charCnt
+    global file textState inDT charCnt inTable
 
     set pos [string first "\t" $string]
     if {$pos >= 0} {
     	text [string range $string 0 [expr $pos-1]]
     	tab
     	text [string range $string [expr $pos+1] end]
-	return    	
+	return
+    }
+    if {$inTable} {
+	if {$inTable == 1} {
+	    puts -nonewline $file <TR>
+	    set inTable 2
+	}
+	puts -nonewline $file <TD>
     }
     incr charCnt [string length $string]
     regsub -all {&} $string {\&amp;}  string
     regsub -all {<} $string {\&lt;}  string
     regsub -all {>} $string {\&gt;}  string
     regsub -all \"  $string {\&quot;}  string
-    switch $textState {
-	REF { 
+    switch -exact -- $textState {
+	REF {
 	    if {$inDT eq ""} {
 		set string [insertRef $string]
 	    }
 	}
-	SEE { 
+	SEE {
 	    global NAME_file
 	    foreach i [split $string] {
-		if ![regexp -nocase {^[a-z_]+} [string trim $i] i ] {
+		if {![regexp -nocase {^[a-z_]+} [string trim $i] i]} {
 # 		    puts "Warning: $i in SEE ALSO not found"
 		    continue
 		}
-		if ![catch {set ref $NAME_file($i)} ] {
+		if {![catch { set ref $NAME_file($i) }]} {
 		    regsub $i $string "<A HREF=\"$ref.html\">$i</A>" string
 		}
 	    }
 	}
     }
     puts -nonewline $file "$string"
+    if {$inTable} {
+	puts -nonewline $file </TD>
+    }
 }
 
-
-
+##############################################################################
 # insertRef --
 #
-#
 # Arguments:
 # string -		Text to output in the paragraph.
 
 proc insertRef string {
     global NAME_file self
     set path {}
-    if ![catch {set ref $NAME_file([string trim $string])} ] {
+    if {![catch { set ref $NAME_file([string trim $string]) }]} {
 	if {"$ref.html" ne $self} {
 	    set string "<A HREF=\"${path}$ref.html\">$string</A>"
 #	    puts "insertRef: $self $ref.html ---$string--"
@@ -170,13 +178,12 @@ proc insertRef string {
     }
     return $string
 }
-
-
-
+
+##############################################################################
 # macro --
 #
-# This procedure is invoked to process macro invocations that start
-# with "." (instead of ').
+# This procedure is invoked to process macro invocations that start with "."
+# (instead of ').
 #
 # Arguments:
 # name -		The name of the macro (without the ".").
@@ -200,7 +207,7 @@ proc macro {name args} {
 	}
 	AS {}				;# next page and previous page
 	br {
-	    lineBreak	
+	    lineBreak
 	}
 	BS {}
 	BE {}
@@ -215,16 +222,16 @@ proc macro {name args} {
 	    set inPRE 1
 	}
 	DE {
-	    global file noFillCount inPRE
-	    puts $file </PRE></BLOCKQUOTE>
-	    set inPRE 0
+	    global file noFillCount inTable
+	    puts $file </TABLE></BLOCKQUOTE>
+	    set inTable 0
 	    set noFillCount 0
 	}
 	DS {
-	    global file noFillCount inPRE
-	    puts -nonewline $file <BLOCKQUOTE><PRE>
+	    global file noFillCount inTable
+	    puts -nonewline $file {<BLOCKQUOTE><TABLE BORDER="0">}
 	    set noFillCount 10000000
-	    set inPRE 1
+	    set inTable 1
 	}
 	fi {
 	    global noFillCount
@@ -245,13 +252,13 @@ proc macro {name args} {
 	    set noFillCount 1000000
 	}
 	OP {
-	    global inDT file inPRE 
+	    global inDT file inPRE
 	    if {[llength $args] != 3} {
 		puts stderr "Bad .OP macro: .$name [join $args " "]"
 	    }
 	    nest para DL DT
 	    set inPRE 1
-	    puts -nonewline $file <PRE>				
+	    puts -nonewline $file <PRE>
 	    setTabs 4c
 	    text "Command-Line Name:"
 	    tab
@@ -272,8 +279,8 @@ proc macro {name args} {
 	    font B
 	    text [lindex $args 2]
 	    font R
-	    puts -nonewline $file </PRE>				
-	    set inDT "\n<DD>"			;# next newline writes inDT 
+	    puts -nonewline $file </PRE>
+	    set inDT "\n<DD>"			;# next newline writes inDT
 	    set inPRE 0
 	    newline
 	}
@@ -283,7 +290,7 @@ proc macro {name args} {
 	    newPara
 	}
 	RE {
-	    nest decr    
+	    nest decr
 	}
 	RS {
 	    nest incr
@@ -375,12 +382,11 @@ proc macro {name args} {
 #	global nestStk; puts "$name [format "%-20s" $args] $nestStk"
 #	flush stdout; flush stderr
 }
-
-
+
+##############################################################################
 # font --
 #
-# This procedure is invoked to handle font changes in the text
-# being output.
+# This procedure is invoked to handle font changes in the text being output.
 #
 # Arguments:
 # type -		Type of font: R, I, B, or S.
@@ -411,13 +417,12 @@ proc font type {
 	}
     }
 }
-
-
-
+
+##############################################################################
 # formattedText --
 #
-# Insert a text string that may also have \fB-style font changes
-# and a few other backslash sequences in it.
+# Insert a text string that may also have \fB-style font changes and a few
+# other backslash sequences in it.
 #
 # Arguments:
 # text -		Text to insert.
@@ -455,13 +460,12 @@ proc formattedText text {
 	}
     }
 }
-
-
-
+
+##############################################################################
 # dash --
 #
-# This procedure is invoked to handle dash characters ("\-" in
-# troff).  It outputs a special dash character.
+# This procedure is invoked to handle dash characters ("\-" in troff). It
+# outputs a special dash character.
 #
 # Arguments:
 # None.
@@ -474,18 +478,17 @@ proc dash {} {
     incr charCnt
     text "-"
 }
-
-
+
+##############################################################################
 # tab --
 #
 # This procedure is invoked to handle tabs in the troff input.
-# Right now it does nothing.
 #
 # Arguments:
 # None.
 
 proc tab {} {
-    global inPRE charCnt tabString
+    global inPRE charCnt tabString file
 #	? charCnt
     if {$inPRE == 1} {
 	set pos [expr $charCnt % [string length $tabString] ]
@@ -496,7 +499,7 @@ proc tab {} {
     }
 }
 
-
+##############################################################################
 # setTabs --
 #
 # This procedure handles the ".ta" macro, which sets tab stops.
@@ -552,9 +555,8 @@ proc setTabs {tabList} {
     }
     # puts "setTabs: --$tabString--"
 }
-
-
-
+
+##############################################################################
 # lineBreak --
 #
 # Generates a line break in the HTML output.
@@ -567,23 +569,26 @@ proc lineBreak {} {
     puts $file "<BR>"
 }
 
-
-
+##############################################################################
 # newline --
 #
-# This procedure is invoked to handle newlines in the troff input.
-# It outputs either a space character or a newline character, depending
-# on fill mode.
+# This procedure is invoked to handle newlines in the troff input. It outputs
+# either a space character or a newline character, depending on fill mode.
 #
 # Arguments:
 # None.
 
 proc newline {} {
-    global noFillCount file inDT inPRE charCnt
+    global noFillCount file inDT inPRE charCnt inTable
 
     if {$inDT ne ""} {
     	puts $file "\n$inDT"
     	set inDT {}
+    } elseif {$inTable} {
+	if {$inTable > 1} {
+	    puts $file </tr>
+	    set inTable 1
+	}
     } elseif {$noFillCount == 0 || $inPRE == 1} {
 	puts $file {}
     } else {
@@ -592,9 +597,8 @@ proc newline {} {
     }
     set charCnt 0
 }
-
-
-
+
+##############################################################################
 # char --
 #
 # This procedure is called to handle a special character.
@@ -625,13 +629,12 @@ proc char name {
 	}
     }
 }
-
-
+
+##############################################################################
 # macro2 --
 #
-# This procedure handles macros that are invoked with a leading "'"
-# character instead of space.  Right now it just generates an
-# error diagnostic.
+# This procedure handles macros that are invoked with a leading "'" character
+# instead of space. Right now it just generates an error diagnostic.
 #
 # Arguments:
 # name -		The name of the macro (without the ".").
@@ -640,16 +643,15 @@ proc char name {
 proc macro2 {name args} {
     puts stderr "Unknown macro: '$name [join $args " "]"
 }
-
-
-
+
+##############################################################################
 # SHmacro --
 #
 # Subsection head; handles the .SH and .SS macros.
 #
 # Arguments:
 # name -		Section name.
-# style -		Type of section (optional) 
+# style -		Type of section (optional)
 
 proc SHmacro {argList {style section}} {
     global file noFillCount textState charCnt
@@ -673,7 +675,7 @@ proc SHmacro {argList {style section}} {
 #	? args textState
 
     # control what the text proc does with text
-    
+
     switch $args {
 	NAME {set textState NAME}
 	DESCRIPTION {set textState INSERT}
@@ -684,21 +686,20 @@ proc SHmacro {argList {style section}} {
     }
     set charCnt 0
 }
-
-
-
+
+##############################################################################
 # IPmacro --
 #
-# This procedure is invoked to handle ".IP" macros, which may take any
-# of the following forms:
+# This procedure is invoked to handle ".IP" macros, which may take any of the
+# following forms:
 #
 # .IP [1]			Translate to a "1Step" paragraph.
 # .IP [x] (x > 1)		Translate to a "Step" paragraph.
 # .IP				Translate to a "Bullet" paragraph.
 # .IP \(bu			Translate to a "Bullet" paragraph.
-# .IP text count		Translate to a FirstBody paragraph with special
-#				indent and tab stop based on "count", and tab
-#				after "text".
+# .IP text count		Translate to a FirstBody paragraph with
+#				special indent and tab stop based on "count",
+#				and tab after "text".
 #
 # Arguments:
 # argList -		List of arguments to the .IP macro.
@@ -728,38 +729,35 @@ proc IPmacro argList {
     puts $file "\n<DD>"
     return
 }
-
-
+
+##############################################################################
 # TPmacro --
 #
-# This procedure is invoked to handle ".TP" macros, which may take any
-# of the following forms:
+# This procedure is invoked to handle ".TP" macros, which may take any of the
+# following forms:
 #
-# .TP x		Translate to an indented paragraph with the
-# 			specified indent (in 100 twip units).
-# .TP		Translate to an indented paragraph with
-# 			default indent.
+# .TP x		Translate to an indented paragraph with the specified indent
+# 			(in 100 twip units).
+# .TP		Translate to an indented paragraph with default indent.
 #
 # Arguments:
 # argList -		List of arguments to the .IP macro.
 #
 # HTML limitations: 'x' in '.TP x' is ignored.
 
-
 proc TPmacro {argList} {
     global inDT
     nest para DL DT
-    set inDT "\n<DD>"			;# next newline writes inDT 
+    set inDT "\n<DD>"			;# next newline writes inDT
     setTabs 0.5i
 }
-
-
-
+
+##############################################################################
 # THmacro --
 #
-# This procedure handles the .TH macro.  It generates the non-scrolling
-# header section for a given man page, and enters information into the
-# table of contents.  The .TH macro has the following form:
+# This procedure handles the .TH macro. It generates the non-scrolling header
+# section for a given man page, and enters information into the table of
+# contents. The .TH macro has the following form:
 #
 # .TH name section date footer header
 #
@@ -782,38 +780,36 @@ proc THmacro {argList} {
     puts -nonewline $file "<HTML><HEAD><TITLE>"
     text "$lib - $name ($page)"
     puts $file "</TITLE></HEAD><BODY>\n"
-    
+
     puts -nonewline $file "<H1><CENTER>"
     text $pname
     puts $file "</CENTER></H1>\n"
 }
-
-
-
+
+##############################################################################
 # newPara --
 #
-# This procedure sets the left and hanging indents for a line.
-# Indents are specified in units of inches or centimeters, and are
-# relative to the current nesting level and left margin.
+# This procedure sets the left and hanging indents for a line. Indents are
+# specified in units of inches or centimeters, and are relative to the current
+# nesting level and left margin.
 #
 # Arguments:
 # None
 
 proc newPara {} {
     global file nestStk
-	
+
     if {[lindex $nestStk end] ne "NEW"} {
-	nest decr    
+	nest decr
     }
     puts -nonewline $file "<P>"
 }
-
-
-
+
+##############################################################################
 # nest --
 #
-# This procedure takes care of inserting the tags associated with the
-# IP, TP, RS, RE, LP and PP macros. Only 'nest para' takes arguments.
+# This procedure takes care of inserting the tags associated with the IP, TP,
+# RS, RE, LP and PP macros. Only 'nest para' takes arguments.
 #
 # Arguments:
 # op -				operation: para, incr, decr, reset, init
@@ -863,14 +859,13 @@ proc nest {op {listStart "NEW"} {listItem ""} } {
     }
     set charCnt 0
 }
-
-
-
+
+##############################################################################
 # do --
 #
-# This is the toplevel procedure that translates a man page
-# to Frame.  It runs the man2tcl program to turn the man page
-# into a script, then it evals that script.
+# This is the toplevel procedure that translates a man page to HTML. It runs
+# the man2tcl program to turn the man page into a script, then it evals that
+# script.
 #
 # Arguments:
 # fileName -		Name of the file to translate.
@@ -882,7 +877,7 @@ proc do fileName {
     puts "  Pass 2 -- $fileName"
     flush stdout
     initGlobals
-    if [catch {eval [exec man2tcl [glob $fileName]]} msg] {
+    if {[catch { eval [exec man2tcl [glob $fileName]] } msg]} {
 	global errorInfo
 	puts stderr $msg
 	puts "in"