Assorted documentation improvements.

6 files changed, 50 insertions, 11 deletions

diff --git a/ChangeLog b/ChangeLog
index 9894791..23766aa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2007-08-28  Donal K. Fellows  <donal.k.fellows@manchester.ac.uk>
+
+	Assorted documentation improvements.
+	* doc/button.n: Added examples.
+	* doc/checkbutton.n: Added example.
+	* doc/console.n: Standardized section ordering.
+	* doc/tk.n: Added "See also".
+	* doc/ttk_combobox.n: Added keywords.
+
 2007-08-27  Daniel Steffen  <das@users.sourceforge.net>
 
 	* macosx/tkMacOSXDialog.c (Tk_ChooseColorObjCmd): correct setting of
diff --git a/doc/button.n b/doc/button.n
index 333ff61..fcb44ff 100644
--- a/doc/button.n
+++ b/doc/button.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: button.n,v 1.11 2006/12/13 23:04:32 hobbs Exp $
+'\" RCS: @(#) $Id: button.n,v 1.12 2007/08/28 15:16:11 dkf Exp $
 '\" 
 .so man.macros
 .TH button n 4.4 Tk "Tk Built-In Commands"
@@ -177,8 +177,24 @@ actions occur:  the button is completely non-responsive.
 The behavior of buttons can be changed by defining new bindings for
 individual widgets or by redefining the class bindings.
 
+.SH EXAMPLES
+This is the classic Tk "Hello, World!" demonstration:
+.PP
+.CS
+    \fBbutton\fR .b -text "Hello, World!" -command exit
+    pack .b
+.CE
+.PP
+This example demonstrates how to handle button accelerators:
+.PP
+.CS
+    \fBbutton\fR .b1 -text Hello -underline 0
+    \fBbutton\fR .b2 -text World -underline 0
+    bind . <Key-h> {.b1 flash; .b1 invoke}
+    bind . <Key-w> {.b2 flash; .b2 invoke}
+    pack .b1 .b2
+.CE
 .SH "SEE ALSO"
 ttk_button(n)
-
 .SH KEYWORDS
 button, widget
diff --git a/doc/checkbutton.n b/doc/checkbutton.n
index c22bbcb..1383513 100644
--- a/doc/checkbutton.n
+++ b/doc/checkbutton.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: checkbutton.n,v 1.12 2006/12/13 23:04:32 hobbs Exp $
+'\" RCS: @(#) $Id: checkbutton.n,v 1.13 2007/08/28 15:16:11 dkf Exp $
 '\" 
 .so man.macros
 .TH checkbutton n 4.4 Tk "Tk Built-In Commands"
@@ -262,8 +262,19 @@ actions occur:  the checkbutton is completely non-responsive.
 The behavior of checkbuttons can be changed by defining new bindings for
 individual widgets or by redefining the class bindings.
 
+.SH EXAMPLE
+This example shows a group of uncoupled checkbuttons.
+.PP
+.CS
+    labelframe .lbl -text "Steps:"
+    \fBcheckbutton\fR .c1 -text Lights  -variable lights
+    \fBcheckbutton\fR .c2 -text Cameras -variable cameras
+    \fBcheckbutton\fR .c3 -text Action! -variable action
+    pack .c1 .c2 .c3 -in .lbl
+    pack .lbl
+.CE
+
 .SH "SEE ALSO"
 button(n), options(n), radiobutton(n), ttk_checkbutton(n)
-
 .SH KEYWORDS
 checkbutton, widget
diff --git a/doc/console.n b/doc/console.n
index 7992457..d7a1cf2 100644
--- a/doc/console.n
+++ b/doc/console.n
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: console.n,v 1.7 2004/10/28 10:22:51 dkf Exp $
+'\" RCS: @(#) $Id: console.n,v 1.8 2007/08/28 15:16:11 dkf Exp $
 '\"
 .so man.macros
 .TH console n 8.4 Tk "Tk Built-In Commands"
@@ -132,9 +132,7 @@ often has the following code fragment in it so output produced by
 .CS
 catch {\fBconsole show\fR}
 .CE
-
-.SH KEYWORDS
-console, interpreter, window, interactive, output channels
-
 .SH "SEE ALSO"
 destroy(n), fconfigure(n), history(n), interp(n), puts(n), text(n), wm(n)
+.SH KEYWORDS
+console, interpreter, window, interactive, output channels
diff --git a/doc/tk.n b/doc/tk.n
index b3bbbca..fe9a78d 100644
--- a/doc/tk.n
+++ b/doc/tk.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: tk.n,v 1.12 2007/05/03 23:55:29 dkf Exp $
+'\" RCS: @(#) $Id: tk.n,v 1.13 2007/08/28 15:16:11 dkf Exp $
 '\" 
 .so man.macros
 .TH tk n 8.4 Tk "Tk Built-In Commands"
@@ -28,6 +28,7 @@ The command can take any of a number of different forms
 depending on the \fIoption\fR argument.  The legal forms are:
 .TP
 \fBtk appname \fR?\fInewName\fR?
+.
 If \fInewName\fR isn't specified, this command returns the name
 of the application (the name that may be used in \fBsend\fR
 commands to communicate with the application).
@@ -110,5 +111,7 @@ state is returned.  This is turned on by default for the main display.
 Returns the current Tk windowing system, one of
 \fBx11\fR (X11-based), \fBwin32\fR (MS Windows),
 or \fBaqua\fR (Mac OS X Aqua).
+.SH "SEE ALSO"
+send(n), winfo(n)
 .SH KEYWORDS
 application name, send
diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n
index eaa3f69..85b2a24 100644
--- a/doc/ttk_combobox.n
+++ b/doc/ttk_combobox.n
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: ttk_combobox.n,v 1.4 2006/12/17 21:09:46 jenglish Exp $
+'\" RCS: @(#) $Id: ttk_combobox.n,v 1.5 2007/08/28 15:16:11 dkf Exp $
 '\"
 .so man.macros
 .TH ttk_combobox n 8.5 Tk "Tk Themed Widget"
@@ -108,3 +108,5 @@ This event is generated after the listbox is unposted.
 
 .SH "SEE ALSO"
 ttk_widget(n), ttk_entry(n)
+.SH KEYWORDS
+choice, entry, list box, text box, widget