diff options
| author | Jesper Harder | 2004-04-21 22:27:52 +0000 |
|---|---|---|
| committer | Jesper Harder | 2004-04-21 22:27:52 +0000 |
| commit | 9995b95430d44d4dcb3512eba51c06033788250d (patch) | |
| tree | 7a976bc4947aba8cee639879bfda85f66768c07a | |
| parent | 89b064a99986bb0b927cd132b6d424d008c0a5b3 (diff) | |
| download | emacs-9995b95430d44d4dcb3512eba51c06033788250d.tar.gz emacs-9995b95430d44d4dcb3512eba51c06033788250d.zip | |
Markup fixes.
| -rw-r--r-- | man/widget.texi | 47 |
1 files changed, 24 insertions, 23 deletions
diff --git a/man/widget.texi b/man/widget.texi index 290c56c6812..c919a394efe 100644 --- a/man/widget.texi +++ b/man/widget.texi | |||
| @@ -680,7 +680,7 @@ image, with either a @file{.xpm} (if supported) or @file{.xbm} extension. | |||
| 680 | @end deffn | 680 | @end deffn |
| 681 | 681 | ||
| 682 | @deffn{User Option} widget-glyph-enable | 682 | @deffn{User Option} widget-glyph-enable |
| 683 | If non-nil, allow glyphs to appear on displays where they are supported. | 683 | If non-@code{nil}, allow glyphs to appear on displays where they are supported. |
| 684 | @end deffn | 684 | @end deffn |
| 685 | 685 | ||
| 686 | 686 | ||
| @@ -813,7 +813,7 @@ Face used for highlighting the editable field. Default is | |||
| 813 | @item :secret | 813 | @item :secret |
| 814 | Character used to display the value. You can set this to e.g.@: @code{?*} | 814 | Character used to display the value. You can set this to e.g.@: @code{?*} |
| 815 | if the field contains a password or other secret information. By | 815 | if the field contains a password or other secret information. By |
| 816 | default, this is nil, and the value is not secret. | 816 | default, this is @code{nil}, and the value is not secret. |
| 817 | 817 | ||
| 818 | @vindex valid-regexp@r{ keyword} | 818 | @vindex valid-regexp@r{ keyword} |
| 819 | @item :valid-regexp | 819 | @item :valid-regexp |
| @@ -865,12 +865,12 @@ specified @var{type} arguments. | |||
| 865 | 865 | ||
| 866 | @vindex case-fold@r{ keyword} | 866 | @vindex case-fold@r{ keyword} |
| 867 | @item :case-fold | 867 | @item :case-fold |
| 868 | Set this to nil if you don't want to ignore case when prompting for a | 868 | Set this to @code{nil} if you don't want to ignore case when prompting for a |
| 869 | choice through the minibuffer. | 869 | choice through the minibuffer. |
| 870 | 870 | ||
| 871 | @vindex children@r{ keyword} | 871 | @vindex children@r{ keyword} |
| 872 | @item :children | 872 | @item :children |
| 873 | A list whose @code{car} is the widget representing the currently chosen | 873 | A list whose @sc{car} is the widget representing the currently chosen |
| 874 | type in the buffer. | 874 | type in the buffer. |
| 875 | 875 | ||
| 876 | @vindex choice@r{ keyword} | 876 | @vindex choice@r{ keyword} |
| @@ -1064,9 +1064,9 @@ Insert a literal @samp{%}. | |||
| 1064 | @item :greedy | 1064 | @item :greedy |
| 1065 | Usually a checklist will only match if the items are in the exact | 1065 | Usually a checklist will only match if the items are in the exact |
| 1066 | sequence given in the specification. By setting @code{:greedy} to | 1066 | sequence given in the specification. By setting @code{:greedy} to |
| 1067 | non-nil, it will allow the items to come in any sequence. However, if | 1067 | non-@code{nil}, it will allow the items to come in any sequence. |
| 1068 | you extract the value they will be in the sequence given in the | 1068 | However, if you extract the value they will be in the sequence given |
| 1069 | checklist, i.e.@: the original sequence is forgotten. | 1069 | in the checklist, i.e.@: the original sequence is forgotten. |
| 1070 | 1070 | ||
| 1071 | @vindex button-args@r{ keyword} | 1071 | @vindex button-args@r{ keyword} |
| 1072 | @item :button-args | 1072 | @item :button-args |
| @@ -1141,7 +1141,7 @@ The widgets representing the elements of the list. | |||
| 1141 | 1141 | ||
| 1142 | @vindex args@r{ keyword} | 1142 | @vindex args@r{ keyword} |
| 1143 | @item :args | 1143 | @item :args |
| 1144 | List whose @code{car} is the type of the list elements. | 1144 | List whose @sc{car} is the type of the list elements. |
| 1145 | @end table | 1145 | @end table |
| 1146 | 1146 | ||
| 1147 | @node group, , editable-list, Basic Types | 1147 | @node group, , editable-list, Basic Types |
| @@ -1164,7 +1164,7 @@ The value is a list, with one member for each @var{type}. | |||
| 1164 | @section Sexp Types | 1164 | @section Sexp Types |
| 1165 | @cindex sexp types | 1165 | @cindex sexp types |
| 1166 | 1166 | ||
| 1167 | A number of widgets for editing @dfn{s-expressions} (lisp types), sexp | 1167 | A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp |
| 1168 | for short, are also available. These basically fall in several | 1168 | for short, are also available. These basically fall in several |
| 1169 | categories described in this section. | 1169 | categories described in this section. |
| 1170 | 1170 | ||
| @@ -1180,7 +1180,7 @@ categories described in this section. | |||
| 1180 | @subsection The Constant Widgets | 1180 | @subsection The Constant Widgets |
| 1181 | @cindex constant widgets | 1181 | @cindex constant widgets |
| 1182 | 1182 | ||
| 1183 | The @code{const} widget can contain any lisp expression, but the user is | 1183 | The @code{const} widget can contain any Lisp expression, but the user is |
| 1184 | prohibited from editing it, which is mainly useful as a component of one | 1184 | prohibited from editing it, which is mainly useful as a component of one |
| 1185 | of the composite widgets. | 1185 | of the composite widgets. |
| 1186 | 1186 | ||
| @@ -1217,7 +1217,7 @@ An immutable symbol that is bound as a function. | |||
| 1217 | @subsection Generic Sexp Widget | 1217 | @subsection Generic Sexp Widget |
| 1218 | @cindex generic sexp widget | 1218 | @cindex generic sexp widget |
| 1219 | 1219 | ||
| 1220 | The @code{sexp} widget can contain any lisp expression, and allows the | 1220 | The @code{sexp} widget can contain any Lisp expression, and allows the |
| 1221 | user to edit it inline in the buffer. | 1221 | user to edit it inline in the buffer. |
| 1222 | 1222 | ||
| 1223 | The syntax for the @code{sexp} widget is: | 1223 | The syntax for the @code{sexp} widget is: |
| @@ -1278,8 +1278,8 @@ Keywords: | |||
| 1278 | @table @code | 1278 | @table @code |
| 1279 | @vindex must-match@r{ keyword} | 1279 | @vindex must-match@r{ keyword} |
| 1280 | @item :must-match | 1280 | @item :must-match |
| 1281 | If this is set to non-nil, only existing file names will be allowed in | 1281 | If this is set to non-@code{nil}, only existing file names will be |
| 1282 | the minibuffer. | 1282 | allowed in the minibuffer. |
| 1283 | @end table | 1283 | @end table |
| 1284 | @end deffn | 1284 | @end deffn |
| 1285 | 1285 | ||
| @@ -1289,7 +1289,7 @@ Similar to the @code{file} widget. | |||
| 1289 | @end deffn | 1289 | @end deffn |
| 1290 | 1290 | ||
| 1291 | @deffn Widget symbol | 1291 | @deffn Widget symbol |
| 1292 | Allows you to edit a lisp symbol in an editable field. | 1292 | Allows you to edit a Lisp symbol in an editable field. |
| 1293 | @end deffn | 1293 | @end deffn |
| 1294 | 1294 | ||
| 1295 | @deffn Widget function | 1295 | @deffn Widget function |
| @@ -1309,8 +1309,8 @@ Allows you to edit a number in an editable field. | |||
| 1309 | @end deffn | 1309 | @end deffn |
| 1310 | 1310 | ||
| 1311 | @deffn Widget boolean | 1311 | @deffn Widget boolean |
| 1312 | Allows you to edit a boolean. In lisp this means a variable which is | 1312 | Allows you to edit a boolean. In Lisp this means a variable which is |
| 1313 | either nil meaning false, or non-nil meaning true. | 1313 | either @code{nil} meaning false, or non-@code{nil} meaning true. |
| 1314 | @end deffn | 1314 | @end deffn |
| 1315 | 1315 | ||
| 1316 | 1316 | ||
| @@ -1330,8 +1330,8 @@ where each @var{component} must be a widget type. Each component widget | |||
| 1330 | will be displayed in the buffer, and will be editable by the user. | 1330 | will be displayed in the buffer, and will be editable by the user. |
| 1331 | 1331 | ||
| 1332 | @deffn Widget cons | 1332 | @deffn Widget cons |
| 1333 | The value of a @code{cons} widget is a cons-cell where the @code{car} is | 1333 | The value of a @code{cons} widget is a cons-cell where the @sc{car} is |
| 1334 | the value of the first component and the @code{cdr} is the value of the | 1334 | the value of the first component and the @sc{cdr} is the value of the |
| 1335 | second component. There must be exactly two components. | 1335 | second component. There must be exactly two components. |
| 1336 | @end deffn | 1336 | @end deffn |
| 1337 | 1337 | ||
| @@ -1432,7 +1432,8 @@ In @var{widget} return the value for @var{property}. | |||
| 1432 | @end defun | 1432 | @end defun |
| 1433 | 1433 | ||
| 1434 | @defun widget-member widget property | 1434 | @defun widget-member widget property |
| 1435 | Non-nil if @var{widget} has a value (even nil) for property @var{property}. | 1435 | Non-@code{nil} if @var{widget} has a value (even @code{nil}) for |
| 1436 | property @var{property}. | ||
| 1436 | @end defun | 1437 | @end defun |
| 1437 | 1438 | ||
| 1438 | Occasionally it can be useful to know which kind of widget you have, | 1439 | Occasionally it can be useful to know which kind of widget you have, |
| @@ -1475,7 +1476,7 @@ all its ancestors. | |||
| 1475 | @end lisp | 1476 | @end lisp |
| 1476 | 1477 | ||
| 1477 | You can check if a widget has been made inactive by examining the value | 1478 | You can check if a widget has been made inactive by examining the value |
| 1478 | of the @code{:inactive} keyword. If this is non-nil, the widget itself | 1479 | of the @code{:inactive} keyword. If this is non-@code{nil}, the widget itself |
| 1479 | has been deactivated. This is different from using the @code{:active} | 1480 | has been deactivated. This is different from using the @code{:active} |
| 1480 | keyword, in that the latter tells you if the widget @strong{or} any of | 1481 | keyword, in that the latter tells you if the widget @strong{or} any of |
| 1481 | its ancestors have been deactivated. Do not attempt to set the | 1482 | its ancestors have been deactivated. Do not attempt to set the |
| @@ -1500,7 +1501,7 @@ Define a new widget type named @var{name} from @code{class}. | |||
| 1500 | @var{name} and class should both be symbols, @code{class} should be one | 1501 | @var{name} and class should both be symbols, @code{class} should be one |
| 1501 | of the existing widget types. | 1502 | of the existing widget types. |
| 1502 | 1503 | ||
| 1503 | The third argument @var{DOC} is a documentation string for the widget. | 1504 | The third argument @var{doc} is a documentation string for the widget. |
| 1504 | 1505 | ||
| 1505 | After the new widget has been defined, the following two calls will | 1506 | After the new widget has been defined, the following two calls will |
| 1506 | create identical widgets: | 1507 | create identical widgets: |
| @@ -1653,7 +1654,7 @@ Function to prompt for a value in the minibuffer. The function should | |||
| 1653 | take four arguments, @var{widget}, @var{prompt}, @var{value}, and | 1654 | take four arguments, @var{widget}, @var{prompt}, @var{value}, and |
| 1654 | @var{unbound} and should return a value for widget entered by the user. | 1655 | @var{unbound} and should return a value for widget entered by the user. |
| 1655 | @var{prompt} is the prompt to use. @var{value} is the default value to | 1656 | @var{prompt} is the prompt to use. @var{value} is the default value to |
| 1656 | use, unless @var{unbound} is non-nil, in which case there is no default | 1657 | use, unless @var{unbound} is non-@code{nil}, in which case there is no default |
| 1657 | value. The function should read the value using the method most natural | 1658 | value. The function should read the value using the method most natural |
| 1658 | for this widget, and does not have to check that it matches. | 1659 | for this widget, and does not have to check that it matches. |
| 1659 | @end table | 1660 | @end table |
| @@ -1719,7 +1720,7 @@ Keymap used in @code{widget-minor-mode}. | |||
| 1719 | @defun widget-prompt-value widget prompt [ value unbound ] | 1720 | @defun widget-prompt-value widget prompt [ value unbound ] |
| 1720 | Prompt for a value matching @var{widget}, using @var{prompt}. | 1721 | Prompt for a value matching @var{widget}, using @var{prompt}. |
| 1721 | The current value is assumed to be @var{value}, unless @var{unbound} is | 1722 | The current value is assumed to be @var{value}, unless @var{unbound} is |
| 1722 | non-nil.@refill | 1723 | non-@code{nil}.@refill |
| 1723 | @end defun | 1724 | @end defun |
| 1724 | 1725 | ||
| 1725 | @defun widget-get-sibling widget | 1726 | @defun widget-get-sibling widget |