X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/4f9d7df139695e97cd1772d41940500480585df7..fd60bf6c902b47daadda6ebf442045dbe1328941:/doc/misc/forms.texi diff --git a/doc/misc/forms.texi b/doc/misc/forms.texi index ec1b993d32..8ea470d2da 100644 --- a/doc/misc/forms.texi +++ b/doc/misc/forms.texi @@ -1,4 +1,4 @@ -\input texinfo @c -*-texinfo-*- +\input texinfo @c -*-texinfo-*- @c documentation for forms-mode @c Written by Johan Vromans, and edited by Richard Stallman @@ -14,31 +14,30 @@ @end iftex @c @smallbook @comment %**end of header (This is for running Texinfo on a region.) +@documentencoding UTF-8 @copying This file documents Forms mode, a form-editing major mode for GNU Emacs. -Copyright @copyright{} 1989, 1997, 2001, 2002, 2003, 2004, -2005, 2006, 2007, 2008 Free Software Foundation, Inc. +Copyright @copyright{} 1989, 1997, 2001--2014 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.2 or +under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' +modify this GNU manual.'' @end quotation @end copying -@dircategory Emacs +@dircategory Emacs misc features @direntry -* Forms: (forms). Emacs package for editing data bases - by filling in forms. +* Forms: (forms). Emacs package for editing data bases + by filling in forms. @end direntry @titlepage @@ -58,6 +57,8 @@ developing GNU and promoting software freedom.'' @insertcopying @end titlepage +@contents + @ifnottex @node Top @top Forms Mode @@ -73,6 +74,8 @@ job: a control file and a data file. The data file holds the actual data to be presented. The control file describes how to present it. +@insertcopying + @menu * Forms Example:: An example: editing the password data base. * Entering and Exiting Forms Mode:: @@ -85,8 +88,8 @@ how to present it. * Miscellaneous:: Forms mode messages and other remarks. * Error Messages:: List of error messages forms mode can produce. * Long Example:: A more complex control file example. -* GNU Free Documentation License:: The license for this documentation. * Credits:: Thanks everyone. +* GNU Free Documentation License:: The license for this documentation. * Index:: Index to this manual. @end menu @end ifnottex @@ -114,8 +117,8 @@ are all there, but instead of being colon-separated on one single line, they make up a forms. The contents of the forms consist of the contents of the fields of the -record (e.g. @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) -interspersed with normal text (e.g @samp{User : }, @samp{Uid: }). +record (e.g., @samp{root}, @samp{0}, @samp{1}, @samp{Super User}) +interspersed with normal text (e.g., @samp{User : }, @samp{Uid: }). If you modify the contents of the fields, Forms mode will analyze your changes and update the file appropriately. You cannot modify the @@ -167,8 +170,8 @@ of the buffer are parsed using the specifications in @code{forms-format-list}, and the data file is updated. If the record has fields that aren't included in the display, they are not changed. -@vindex forms-mode-hooks -Entering Forms mode runs the normal hook @code{forms-mode-hooks} to +@vindex forms-mode-hook +Entering Forms mode runs the normal hook @code{forms-mode-hook} to perform user-defined customization. To save any modified data, you can use @kbd{C-x C-s} @@ -464,7 +467,7 @@ appears that way when displayed in Forms mode. If the value is @code{nil}, multi-line text fields are prohibited. The pseudo newline must not be a character contained in @code{forms-field-sep}. -The default value is @code{"\^k"}, the character Control-K. Example: +The default value is @code{"\^k"}, the character Control-K@. Example: @example (setq forms-multi-line "\^k") @@ -736,7 +739,7 @@ so you'd better think twice before using this. The default format for the data file, using @code{"\t"} to separate fields and @code{"\^k"} to separate lines within a field, matches the -file format of some popular database programs, e.g. FileMaker. So +file format of some popular database programs, e.g., FileMaker. So @code{forms-mode} can decrease the need to use proprietary software. @node Error Messages @@ -858,7 +861,7 @@ you said `no'. @chapter Long Example The following example exploits most of the features of Forms mode. -This example is included in the distribution as file @file{forms-d2.el}. +This example is included in the distribution as file @file{etc/forms/forms-d2.el}. @example ;; demo2 -- demo forms-mode -*- emacs-lisp -*- @@ -866,7 +869,8 @@ This example is included in the distribution as file @file{forms-d2.el}. ;; @r{This sample forms exploit most of the features of forms mode.} ;; @r{Set the name of the data file.} -(setq forms-file "forms-d2.dat") +(setq forms-file + (expand-file-name "forms/forms-d2.dat" data-directory)) ;; @r{Use @code{forms-enumerate} to set field names and number thereof.} (setq forms-number-of-fields @@ -971,9 +975,4 @@ Software Foundation. Thanks, Richard! @unnumbered Index @printindex cp -@contents @bye - -@ignore - arch-tag: 2ac9810b-aa49-4ea6-8030-d7f1ecd467ed -@end ignore