Re: [lanubeblanca@googlemail.com: Typos in the Widget library documentation]

["Stuart D. Herring" <herring@lanl.gov>]

[-- Attachment #1: Type: text/plain, Size: 830 bytes --]

> Would someone please fix these, then ack?

Done -- almost all as suggested, and a couple of others that I saw while
editing.  All the multiline changes in the attached patch are due to
refilling.  I notice, however, that some of the text is inconsistent and
confusing, particularly in the Composite Sexp Widgets node; the
descriptions of the composite widgets are not parallel in style and
elements of the value of a set widget are said to be irrelevant when
surely it is their order that is irrelevant.  I don't know enough about
the widgets library to reliably fix those (I may even be incorrect about
their incorrectness), so I'm just drawing attention to them.

Davis

-- 
This product is sold by volume, not by mass.  If it appears too dense or
too sparse, it is because mass-energy conversion has occurred during
shipping.

[-- Attachment #2: widget.patch --]
[-- Type: application/octet-stream, Size: 7189 bytes --]

*** widget.texi.~1.36.~	2006-03-25 16:13:20.000000000 -0700
--- widget.texi	2006-10-11 13:18:23.000000000 -0600
***************
*** 158,164 ****
  @comment  node-name,  next,  previous,  up
  @section User Interface
  
! A form consist of read only text for documentation and some fields,
  where each field contains two parts, a tag and a value.  The tags are
  used to identify the fields, so the documentation can refer to the
  @samp{foo field}, meaning the field tagged with @samp{Foo}. Here is an
--- 158,164 ----
  @comment  node-name,  next,  previous,  up
  @section User Interface
  
! A form consists of read only text for documentation and some fields,
  where each field contains two parts, a tag and a value.  The tags are
  used to identify the fields, so the documentation can refer to the
  @samp{foo field}, meaning the field tagged with @samp{Foo}. Here is an
***************
*** 195,201 ****
  @b{[Apply Form]} @b{[Reset Form]}
  @end example
  
! The top level widgets in is example are tagged @samp{Name},
  @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},
  @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
  @samp{[Reset Form]}.  There are basically two things the user can do
--- 195,201 ----
  @b{[Apply Form]} @b{[Reset Form]}
  @end example
  
! The top level widgets in this example are tagged @samp{Name},
  @samp{Choose}, @samp{Address}, @samp{_other work_}, @samp{Numbers},
  @samp{Select multiple}, @samp{Select one}, @samp{[Apply Form]}, and
  @samp{[Reset Form]}.  There are basically two things the user can do
***************
*** 276,295 ****
  The list is created by the @code{editable-list} widget.
  @cindex embedded buttons
  @item Embedded Buttons
! The @samp{@b{_other work_}} is an example of an embedded
! button.  Embedded buttons are not associated with a fields, but can serve
! any purpose, such as implementing hypertext references.  They are
! usually created by the @code{link} widget.
  @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons
  Activating one of these will convert it to the other.  This is useful
! for implementing multiple-choice fields.  You can create it with the
  @code{checkbox} widget.
  @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons
  Only one radio button in a @code{radio-button-choice} widget can be
  selected at any time.  When you invoke one of the unselected radio
  buttons, it will be selected and the previous selected radio button will
  become unselected.
! @item The @samp{@b{[Apply Form]}} @samp{@b{[Reset Form]}} buttons
  These are explicit buttons made with the @code{push-button} widget.  The
  main difference from the @code{link} widget is that the buttons will be
  displayed as GUI buttons when possible.
--- 276,295 ----
  The list is created by the @code{editable-list} widget.
  @cindex embedded buttons
  @item Embedded Buttons
! The @samp{@b{_other work_}} is an example of an embedded button.
! Embedded buttons are not associated with any field, but can serve any
! purpose, such as implementing hypertext references.  They are usually
! created by the @code{link} widget.
  @item The @samp{@b{[ ]}} and @samp{@b{[X]}} buttons
  Activating one of these will convert it to the other.  This is useful
! for implementing multiple-choice fields.  You can create them with the
  @code{checkbox} widget.
  @item The @samp{@b{( )}} and @samp{@b{(*)}} buttons
  Only one radio button in a @code{radio-button-choice} widget can be
  selected at any time.  When you invoke one of the unselected radio
  buttons, it will be selected and the previous selected radio button will
  become unselected.
! @item The @samp{@b{[Apply Form]}} and @samp{@b{[Reset Form]}} buttons
  These are explicit buttons made with the @code{push-button} widget.  The
  main difference from the @code{link} widget is that the buttons will be
  displayed as GUI buttons when possible.
***************
*** 492,498 ****
  are interpreted in a widget specific way.
  
  @cindex keyword arguments
! The following keyword arguments that apply to all widgets:
  
  @table @code
  @vindex value@r{ keyword}
--- 492,498 ----
  are interpreted in a widget specific way.
  
  @cindex keyword arguments
! The following keyword arguments apply to all widgets:
  
  @table @code
  @vindex value@r{ keyword}
***************
*** 807,813 ****
  @end example
  
  The @var{value}, if present, is used to initialize the @code{:value}
! property.  The value should be a string, which will be inserted in
  field.  This widget will match all string values.
  
  The following extra properties are recognized:
--- 807,813 ----
  @end example
  
  The @var{value}, if present, is used to initialize the @code{:value}
! property.  The value should be a string, which will be inserted in the
  field.  This widget will match all string values.
  
  The following extra properties are recognized:
***************
*** 1349,1355 ****
  
  @deffn Widget list
  The value of a @code{list} widget is a list containing the value of
! each of its component.
  @end deffn
  
  @deffn Widget vector
--- 1349,1355 ----
  
  @deffn Widget list
  The value of a @code{list} widget is a list containing the value of
! each of its components.
  @end deffn
  
  @deffn Widget vector
***************
*** 1359,1371 ****
  
  The above suffice for specifying fixed size lists and vectors.  To get
  variable length lists and vectors, you can use a @code{choice},
! @code{set}, or @code{repeat} widgets together with the @code{:inline}
! keywords.  If any component of a composite widget has the @code{:inline}
! keyword set, its value must be a list which will then be spliced into
! the composite.  For example, to specify a list whose first element must
! be a file name, and whose remaining arguments should either by the
! symbol @code{t} or two files, you can use the following widget
! specification:
  
  @example
  (list file
--- 1359,1371 ----
  
  The above suffice for specifying fixed size lists and vectors.  To get
  variable length lists and vectors, you can use a @code{choice},
! @code{set}, or @code{repeat} widget together with the @code{:inline}
! keyword.  If any component of a composite widget has the
! @code{:inline} keyword set, its value must be a list which will then
! be spliced into the composite.  For example, to specify a list whose
! first element must be a file name, and whose remaining arguments
! should either be the symbol @code{t} or two strings, you can use the
! following widget specification:
  
  @example
  (list file
***************
*** 1390,1398 ****
  
  @deffn Widget set
  Allows you to specify a type which must be a list whose elements all
! belong to given set.  The elements of the list are not significant.
! This is implemented on top of the @code{checklist} basic widget, and has
! a similar syntax.
  @end deffn
  
  @deffn Widget repeat
--- 1390,1398 ----
  
  @deffn Widget set
  Allows you to specify a type which must be a list whose elements all
! belong to a given set.  The elements of the list are not significant.
! This is implemented on top of the @code{checklist} basic widget, and
! has a similar syntax.
  @end deffn
  
  @deffn Widget repeat

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel