home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / info / forms (.txt) < prev    next >
GNU Info File  |  1996-09-28  |  32KB  |  658 lines
  1. This is Info file ../info/forms, produced by Makeinfo-1.54 from the
  2. input file forms.texi.
  3.    This file documents Forms mode, a form-editing major mode for GNU
  4. Emacs.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8. File: forms,  Node: Top,  Next: Forms Example,  Prev: (DIR),  Up: (DIR)
  9. Forms Mode
  10. **********
  11.    Forms mode is an Emacs major mode for working with simple textual
  12. data bases in a forms-oriented manner.  In Forms mode, the information
  13. in these files is presented in an Emacs window in a user-defined format,
  14. one record at a time.  The user can view records or modify their
  15. contents.
  16.    Forms mode is not a simple major mode, but requires two files to do
  17. its job: a control file and a data file.  The data file holds the
  18. actual data to be presented.  The control file describes how to present
  19. * Menu:
  20. * Forms Example::               An example: editing the password data base.
  21. * Entering and Exiting Forms Mode::
  22.                                 How to visit a file in Forms mode.
  23. * Forms Commands::              Special commands to use while in Forms mode.
  24. * Data File Format::            How to format the data file.
  25. * Control File Format::         How to control forms mode.
  26. * Format Description::          How to define the forms layout.
  27. * Modifying Forms Contents::    How to modify.
  28. * Miscellaneous::               Forms mode messages and other remarks.
  29. * Error Messages::              List of error messages forms mode can produce.
  30. * Long Example::                A more complex control file example.
  31. * Credits::                     Thanks everyone.
  32. * Index::                       Index to this manual.
  33. File: forms,  Node: Forms Example,  Next: Entering and Exiting Forms Mode,  Prev: Top,  Up: Top
  34. Forms Example
  35. *************
  36.    Let's illustrate Forms mode with an example.  Suppose you are
  37. looking at the `/etc/passwd' file, and the screen looks like this:
  38.      ====== /etc/passwd ======
  39.      
  40.      User : root   Uid: 0   Gid: 1
  41.      
  42.      Name : Super User
  43.      
  44.      Home : /
  45.      
  46.      Shell: /bin/sh
  47.    As you can see, the familiar fields from the entry for the super user
  48. are all there, but instead of being colon-separated on one single line,
  49. they make up a forms.
  50.    The contents of the forms consists of the contents of the fields of
  51. the record (e.g., `root', `0', `1', `Super User') interspersed with
  52. normal text (e.g `User : ', `Uid: ').
  53.    If you modify the contents of the fields, Forms mode will analyze
  54. your changes and update the file appropriately.  You cannot modify the
  55. interspersed explanatory text (unless you go to some trouble about it),
  56. because that is marked read-only (*note Text Properties: (elisp)Text
  57. Properties.).
  58.    The Forms mode control file specifies the relationship between the
  59. format of `/etc/passwd' and what appears on the screen in Forms mode.
  60. *Note Control File Format::.
  61. File: forms,  Node: Entering and Exiting Forms Mode,  Next: Forms Commands,  Prev: Forms Example,  Up: Top
  62. Entering and Exiting Forms Mode
  63. *******************************
  64. `M-x forms-find-file RET CONTROL-FILE RET'
  65.      Visit a database using Forms mode.  Specify the name of the
  66.      *control file*, not the data file!
  67. `M-x forms-find-file-other-window RET CONTROL-FILE RET'
  68.      Similar, but displays the file in another window.
  69.    The command `forms-find-file' evaluates the file CONTROL-FILE, and
  70. also visits it in Forms mode.  What you see in its buffer is not the
  71. contents of this file, but rather a single record of the corresponding
  72. data file that is visited in its own buffer.  So there are two buffers
  73. involved in Forms mode: the "forms buffer" that is initially used to
  74. visit the control file and that shows the records being browsed, and
  75. the "data buffer" that holds the data file being visited.  The latter
  76. buffer is normally not visible.
  77.    Initially, the first record is displayed in the forms buffer.  The
  78. mode line displays the major mode name `Forms', followed by the minor
  79. mode `View' if the data base is read-only.  The number of the current
  80. record (N) and the total number of records in the file(T) are shown in
  81. the mode line as `N/T'.  For example:
  82.      --%%-Emacs: passwd-demo          (Forms View 1/54)----All-------
  83.    If the buffer is not read-only, you may change the buffer to modify
  84. the fields in the record.  When you move to a different record, the
  85. contents of the buffer are parsed using the specifications in
  86. `forms-format-list', and the data file is updated.  If the record has
  87. fields that aren't included in the display, they are not changed.
  88.    Entering Forms mode runs the normal hook `forms-mode-hooks' to
  89. perform user-defined customization.
  90.    To save any modified data, you can use `C-x C-s'
  91. (`forms-save-buffer').  This does not save the forms buffer (which would
  92. be rather useless), but instead saves the buffer visiting the data file.
  93.    To terminate Forms mode, you can use `C-x C-s' (`forms-save-buffer')
  94. and then kill the forms buffer.  However, the data buffer will still
  95. remain.  If this is not desired, you have to kill this buffer too.
  96. File: forms,  Node: Forms Commands,  Next: Data File Format,  Prev: Entering and Exiting Forms Mode,  Up: Top
  97. Forms Commands
  98. **************
  99.    The commands of Forms mode belong to the `C-c' prefix, with one
  100. exception: TAB, which moves to the next field.  Forms mode uses
  101. different key maps for normal mode and read-only mode.  In read-only
  102. Forms mode, you can access most of the commands without the `C-c'
  103. prefix, but you must type ordinary letters instead of control
  104. characters; for example, type `n' instead of `C-c C-n'.
  105. `C-c C-n'
  106.      Show the next record (`forms-next-record').  With a numeric
  107.      argument N, show the Nth next record.
  108. `C-c C-p'
  109.      Show the previous record (`forms-prev-record').  With a numeric
  110.      argument N, show the Nth previous record.
  111. `C-c C-l'
  112.      Jump to a record by number (`forms-jump-record').   Specify the
  113.      record number with a numeric argument.
  114. `C-c <'
  115.      Jump to the first record (`forms-first-record').
  116. `C-c >'
  117.      Jump to the last record (`forms-last-record').  This command also
  118.      recalculates the number of records in the data file.
  119. `TAB'
  120. `C-c TAB'
  121.      Jump to the next field in the current record (`forms-next-field').
  122.      With a numeric argument N, jump forward N fields.  If this command
  123.      would move past the last field, it wraps around to the first field.
  124. `C-c C-q'
  125.      Toggles read-only mode (`forms-toggle-read-only').  In read-only
  126.      Forms mode, you cannot edit the fields; most Forms mode commands
  127.      can be accessed without the prefix `C-c' if you use the normal
  128.      letter instead (for example, type `n' instead of `C-c C-n').  In
  129.      edit mode, you can edit the fields and thus change the contents of
  130.      the data base; you must begin Forms mode commands with `C-c'.
  131.      Switching to edit mode is allowed only if you have write access to
  132.      the data file.
  133. `C-c C-o'
  134.      Create a new record and insert it before the current record
  135.      (`forms-insert-record').  It starts out with empty (or default)
  136.      contents for its fields; you can then edit the fields.  With a
  137.      numeric argument, the new record is created *after* the current
  138.      one.  See also `forms-modified-record-filter' in *Note Modifying
  139.      Forms Contents::.
  140. `C-c C-k'
  141.      Delete the current record (`forms-delete-record').  You are
  142.      prompted for confirmation before the record is deleted unless a
  143.      numeric argument has been provided.
  144. `C-c C-s REGEXP RET'
  145.      Search for REGEXP in all records following this one
  146.      (`forms-search').  If found, this record is shown.  If you give an
  147.      empty argument, the previous regexp is used again.
  148. `M-x forms-prev-field'
  149.      Similar to `forms-next-field' but moves backwards.
  150. `M-x forms-save-buffer'
  151. `C-x C-s'
  152.      Forms mode replacement for `save-buffer'. When executed in the
  153.      forms buffer it will save the contents of the (modified) data
  154.      buffer instead. In Forms mode this function will be bound to `C-x
  155.      C-s'.
  156.    In addition the command `M-x revert-buffer' is useful in Forms mode
  157. just as in other modes.
  158.    The following function key definitions are set up in Forms mode
  159. (whether read-only or not):
  160. `next'
  161.      forms-next-record
  162. `prior'
  163.      forms-prev-record
  164. `begin'
  165.      forms-first-record
  166. `end'
  167.      forms-last-record
  168. `S-Tab'
  169.      forms-prev-field
  170. File: forms,  Node: Data File Format,  Next: Control File Format,  Prev: Forms Commands,  Up: Top
  171. Data File Format
  172. ****************
  173.    Files for use with Forms mode are very simple--each "record"
  174. (usually one line) forms the contents of one form.  Each record consists
  175. of a number of "fields", which are separated by the value of the string
  176. `forms-field-sep', which is `"\t"' (a Tab) by default.
  177.    If the format of the data file is not suitable enough you can define
  178. the filter functions `forms-read-file-filter' and
  179. `forms-write-file-filter'. `forms-read-file-filter' is called when the
  180. data file is read from disk into the data buffer. It operates on the
  181. data buffer, ignoring read-only protections. When the data file is
  182. saved to disk `forms-write-file-filter' is called to cancel the effects
  183. of `forms-read-file-filter'. After being saved,
  184. `forms-read-file-filter' is called again to prepare the data buffer for
  185. further processing.
  186.    Fields may contain text which shows up in the forms in multiple
  187. lines.  These lines are separated in the field using a "pseudo-newline"
  188. character which is defined by the value of the string
  189. `forms-multi-line'.  Its default value is `"\^k"' (a Control-K
  190. character).  If it is set to `nil', multiple line fields are prohibited.
  191.    If the data file does not exist, it is automatically created.
  192. File: forms,  Node: Control File Format,  Next: Format Description,  Prev: Data File Format,  Up: Top
  193. Control File Format
  194. *******************
  195.    The Forms mode "control file" serves two purposes.  First, it names
  196. the data file to use, and defines its format and properties.  Second,
  197. the Emacs buffer it occupies is used by Forms mode to display the forms.
  198.    The contents of the control file are evaluated as a Lisp program.  It
  199. should set the following Lisp variables to suitable values:
  200. `forms-file'
  201.      This variable specifies the name of the data file.  Example:
  202.           (setq forms-file "my/data-file")
  203.      If the control file doesn't set `forms-file', Forms mode reports
  204.      an error.
  205. `forms-format-list'
  206.      This variable describes the way the fields of the record are
  207.      formatted on the screen.  For details, see *Note Format
  208.      Description::.
  209. `forms-number-of-fields'
  210.      This variable holds the number of fields in each record of the data
  211.      file.  Example:
  212.           (setq forms-number-of-fields 10)
  213.    If the control file does not set `forms-format-list' a default
  214. format is used.  In this situation, Forms mode will deduce the number of
  215. fields from the data file providing this file exists and
  216. `forms-number-of-records' has not been set in the control file.
  217.    The control file can optionally set the following additional Forms
  218. mode variables.  Most of them have default values that are good for most
  219. applications.
  220. `forms-field-sep'
  221.      This variable may be used to designate the string which separates
  222.      the fields in the records of the data file.  If not set, it
  223.      defaults to the string `"\t"' (a Tab character).  Example:
  224.           (setq forms-field-sep "\t")
  225. `forms-read-only'
  226.      If the value is non-`nil', the data file is treated read-only.
  227.      (Forms mode also treats the data file as read-only if you don't
  228.      have access to write it.)  Example:
  229.           (set forms-read-only t)
  230. `forms-multi-line'
  231.      This variable specifies the "pseudo newline" separator that allows
  232.      multi-line fields.  This separator goes between the "lines" within
  233.      a field--thus, the field doesn't really contain multiple lines,
  234.      but it appears that way when displayed in Forms mode.  If the
  235.      value is `nil', multi-line text fields are prohibited.  The pseudo
  236.      newline must not be a character contained in `forms-field-sep'.
  237.      The default value is `"\^k"', the character Control-K.  Example:
  238.           (setq forms-multi-line "\^k")
  239. `forms-read-file-filter'
  240.      This variable holds the name of a function to be called after the
  241.      data file has been read in. This can be used to transform the
  242.      contents of the data file into a format more suitable for forms
  243.      processing.  If it is `nil', no function is called.
  244. `forms-write-file-filter'
  245.      This variable holds the name of a function to be called before
  246.      writing out the contents of the data file.  This can be used to
  247.      undo the effects of `forms-read-file-filter'.  If it is `nil', no
  248.      function is called.
  249. `forms-new-record-filter'
  250.      This variable holds a function to be called whenever a new record
  251.      is created to supply default values for fields.  If it is `nil',
  252.      no function is called.  *Note Modifying Forms Contents::, for
  253.      details.
  254. `forms-modified-record-filter'
  255.      This variable holds a function to be called whenever a record is
  256.      modified, just before updating the Forms data file.  If it is
  257.      `nil', no function is called.  *Note Modifying Forms Contents::,
  258.      for details.
  259. File: forms,  Node: Format Description,  Next: Modifying Forms Contents,  Prev: Control File Format,  Up: Top
  260. The Format Description
  261. **********************
  262.    The variable `forms-format-list' specifies the format of the data in
  263. the data file, and how to convert the data for display in Forms mode.
  264. Its value must be a list of Forms mode "formatting elements", each of
  265. which can be a string, a number, a Lisp list, or a Lisp symbol that
  266. evaluates to one of those.  The formatting elements are processed in the
  267. order they appear in the list.
  268. STRING
  269.      A string formatting element is inserted in the forms "as is," as
  270.      text that the user cannot alter.
  271. NUMBER
  272.      A number element selects a field of the record.  The contents of
  273.      this field are inserted in the display at this point.  Field
  274.      numbers count starting from 1 (one).
  275.      A formatting element that is a list specifies a function call.
  276.      This function is called every time a record is displayed, and its
  277.      result, which must be a string, is inserted in the display text.
  278.      The function should do nothing but returning a string.
  279.      The function you call can access the fields of the record as a
  280.      list in the variable `forms-fields'.
  281. SYMBOL
  282.      A symbol used as a formatting element should evaluate to a string,
  283.      number, or list; the value is interpreted as a formatting element,
  284.      as described above.
  285.    If a record does not contain the number of fields as specified in
  286. `forms-number-of-fields', a warning message will be printed.  Excess
  287. fields are ignored, missing fields are set to empty.
  288.    The control file which displays `/etc/passwd' file as demonstrated
  289. in the beginning of this manual might look as follows:
  290.      ;; This demo visits `/etc/passwd'.
  291.      
  292.      (setq forms-file "/etc/passwd")
  293.      (setq forms-number-of-fields 7)
  294.      (setq forms-read-only t)                 ; to make sure
  295.      (setq forms-field-sep ":")
  296.      ;; Don't allow multi-line fields.
  297.      (setq forms-multi-line nil)
  298.      
  299.      (setq forms-format-list
  300.            (list
  301.             "====== /etc/passwd ======\n\n"
  302.             "User : "    1
  303.             "   Uid: "   3
  304.             "   Gid: "   4
  305.             "\n\n"
  306.             "Name : "    5
  307.             "\n\n"
  308.             "Home : "    6
  309.             "\n\n"
  310.             "Shell: "    7
  311.             "\n"))
  312.    When you construct the value of  `forms-format-list', you should
  313. usually either quote the whole value, like this,
  314.      (setq forms-format-list
  315.           '(
  316.             "====== " forms-file " ======\n\n"
  317.             "User : "    1
  318.             (make-string 20 ?-)
  319.             ...
  320.            ))
  321. or quote the elements which are lists, like this:
  322.      (setq forms-format-list
  323.            (list
  324.             "====== " forms-file " ======\n\n"
  325.             "User : "    1
  326.             '(make-string 20 ?-)
  327.             ...
  328.            ))
  329.    Forms mode validates the contents of `forms-format-list' when you
  330. visit a database.  If there are errors, processing is aborted with an
  331. error message which includes a descriptive text.  *Note Error
  332. Messages::, for a detailed list of error messages.
  333.    If no `forms-format-list' is specified, Forms mode will supply a
  334. default format list.  This list contains the name of the file being
  335. visited, and a simple label for each field indicating the field number.
  336. File: forms,  Node: Modifying Forms Contents,  Next: Miscellaneous,  Prev: Format Description,  Up: Top
  337. Modifying The Forms Contents
  338. ****************************
  339.    If `forms-read-only' is `nil', the user can modify the fields and
  340. records of the database.
  341.    All normal editing commands are available for editing the contents
  342. of the displayed record.  You cannot delete or modify the fixed,
  343. explanatory text that comes from string formatting elements, but you
  344. can modify the actual field contents.
  345.    If the variable `forms-modified-record-filter' is non-`nil', it is
  346. called as a function before the new data is written to the data file.
  347. The function receives one argument, a vector that contains the contents
  348. of the fields of the record.
  349.    The function can refer to fields with `aref' and modify them with
  350. `aset'.  The first field has number 1 (one); thus, element 0 of the
  351. vector is not used.  The function should return the same vector it was
  352. passed; the (possibly modified) contents of the vector determine what is
  353. actually written in the file.  Here is an example:
  354.      (defun my-modified-record-filter (record)
  355.        ;; Modify second field.
  356.        (aset record 2 (current-time-string))
  357.        ;; Return the field vector.
  358.        record)
  359.      
  360.      (setq forms-modified-record-filter 'my-modified-record-filter)
  361.    If the variable `forms-new-record-filter' is non-`nil', its value is
  362. a function to be called to fill in default values for the fields of a
  363. new record.  The function is passed a vector of empty strings, one for
  364. each field; it should return the same vector, with the desired field
  365. values stored in it.  Fields are numbered starting from 1 (one).
  366. Example:
  367.      (defun my-new-record-filter (fields)
  368.        (aset fields 5 (login-name))
  369.        (aset fields 1 (current-time-string))
  370.        fields)
  371.      
  372.      (setq forms-new-record-filter 'my-new-record-filter)
  373. File: forms,  Node: Miscellaneous,  Next: Error Messages,  Prev: Modifying Forms Contents,  Up: Top
  374. Miscellaneous
  375. *************
  376.    The global variable `forms-version' holds the version information of
  377. the Forms mode software.
  378.    It is very convenient to use symbolic names for the fields in a
  379. record.  The function `forms-enumerate' provides an elegant means to
  380. define a series of variables whose values are consecutive integers.  The
  381. function returns the highest number used, so it can be used to set
  382. `forms-number-of-fields' also.  For example:
  383.      (setq forms-number-of-fields
  384.            (forms-enumerate
  385.             '(field1 field2 field3 ...)))
  386.    This sets `field1' to 1, `field2' to 2, and so on.
  387.    Care has been taken to keep the Forms mode variables buffer-local,
  388. so it is possible to visit multiple files in Forms mode simultaneously,
  389. even if they have different properties.
  390.    If you have visited the control file in normal fashion with
  391. `find-file' or a like command, you can switch to Forms mode with the
  392. command `M-x forms-mode'.  If you put `-*- forms -*-' in the first line
  393. of the control file, then visiting it enables Forms mode automatically.
  394. But this makes it hard to edit the control file itself, so you'd
  395. better think twice before using this.
  396.    The default format for the data file, using `"\t"' to separate
  397. fields and `"\^k"' to separate lines within a field, matches the file
  398. format of some popular database programs, such as FileMaker.  So
  399. `forms-mode' can decrease the need to use proprietary software.
  400. File: forms,  Node: Error Messages,  Next: Long Example,  Prev: Miscellaneous,  Up: Top
  401. Error Messages
  402. **************
  403.    This section describes all error messages which can be generated by
  404. forms mode.  Error messages that result from parsing the control file
  405. all start with the text `Forms control file error'.  Messages generated
  406. while analyzing the definition of `forms-format-list' start with `Forms
  407. format error'.
  408. `Forms control file error: 'forms-file' has not been set'
  409.      The variable `forms-file' was not set by the control file.
  410. `Forms control file error: 'forms-number-of-fields' has not been set'
  411.      The variable `forms-number-of-fields' was not set by the control
  412.      file.
  413. `Forms control file error: 'forms-number-of-fields' must be a number > 0'
  414.      The variable `forms-number-of-fields' did not contain a positive
  415.      number.
  416. `Forms control file error: 'forms-field-sep' is not a string'
  417. `Forms control file error: 'forms-multi-line' must be nil or a one-character string'
  418.      The variable `forms-multi-line' was set to something other than
  419.      `nil' or a single-character string.
  420. `Forms control file error: 'forms-multi-line' is equal to 'forms-field-sep''
  421.      The variable `forms-multi-line' may not be equal to
  422.      `forms-field-sep' for this would make it impossible to distinguish
  423.      fields and the lines in the fields.
  424. `Forms control file error: 'forms-new-record-filter' is not a function'
  425. `Forms control file error: 'forms-modified-record-filter' is not a function'
  426.      The variable has been set to something else than a function.
  427. `Forms control file error: 'forms-format-list' is not a list'
  428.      The variable `forms-format-list' was not set to a Lisp list by the
  429.      control file.
  430. `Forms format error: field number XX out of range 1..NN'
  431.      A field number was supplied in `forms-format-list' with a value of
  432.      XX, which was not greater than zero and smaller than or equal to
  433.      the number of fields in the forms, NN.
  434. `Forms format error:  not a function FUN'
  435.      The first element of a list which is an element of
  436.      `forms-format-list' was not a valid Lisp function.
  437. `Forms format error:  invalid element XX'
  438.      A list element was supplied in `forms-format-list' which was not a
  439.      string, number or list.
  440. `Warning: this record has XX fields instead of YY'
  441.      The number of fields in this record in the data file did not match
  442.      `forms-number-of-fields'.  Missing fields will be made empty.
  443. `Multi-line fields in this record - update refused!'
  444.      The current record contains newline characters, hence can not be
  445.      written back to the data file, for it would corrupt it.  Probably
  446.      you inserted a newline in a field, while `forms-multi-line' was
  447.      `nil'.
  448. `Field separator occurs in record - update refused!'
  449.      The current record contains the field separator string inside one
  450.      of the fields. It can not be written back to the data file, for it
  451.      would corrupt it. Probably you inserted the field separator string
  452.      in a field.
  453. `Record number XX out of range 1..YY'
  454.      A jump was made to non-existing record XX.  YY denotes the number
  455.      of records in the file.
  456. `Stuck at record XX'
  457.      An internal error prevented a specific record from being retrieved.
  458. `No write access to `"'FILE`"''
  459.      An attempt was made to enable edit mode on a file that has been
  460.      write protected.
  461. ``"'REGEXP`"' not found'
  462.      The REGEXP could not be found in the data file, starting at the
  463.      current record location.
  464. `Warning: number of records changed to NN'
  465.      Forms mode's idea of the number of records has been adjusted to the
  466.      number of records actually present in the data file.
  467. `Problem saving buffers?'
  468.      An error occurred while saving the data file buffer. Most likely,
  469.      Emacs did ask to confirm deleting the buffer because it had been
  470.      modified, and you said `no'.
  471. File: forms,  Node: Long Example,  Next: Credits,  Prev: Error Messages,  Up: Top
  472. Long Example
  473. ************
  474.    The following example exploits most of the features of Forms mode.
  475. This example is included in the distribution as file `forms-d2.el'.
  476.      ;; demo2 -- demo forms-mode    -*- emacs-lisp -*-
  477.      
  478.      ;; SCCS Status     : demo2    1.1.2
  479.      ;; Author          : Johan Vromans
  480.      ;; Created On      : 1989
  481.      ;; Last Modified By: Johan Vromans
  482.      ;; Last Modified On: Mon Jul  1 13:56:31 1991
  483.      ;; Update Count    : 2
  484.      ;; Status          : OK
  485.      ;;
  486.      ;; This sample forms exploit most of the features of forms mode.
  487.      
  488.      ;; Set the name of the data file.
  489.      (setq forms-file "forms-d2.dat")
  490.      
  491.      ;; Use `forms-enumerate' to set field names and number thereof.
  492.      (setq forms-number-of-fields
  493.            (forms-enumerate
  494.             '(arch-newsgroup            ; 1
  495.           arch-volume            ; 2
  496.           arch-issue            ; and ...
  497.           arch-article            ; ... so
  498.           arch-shortname            ; ... ... on
  499.           arch-parts
  500.           arch-from
  501.           arch-longname
  502.           arch-keywords
  503.           arch-date
  504.           arch-remarks)))
  505.      
  506.      ;; The following functions are used by this form for layout purposes.
  507.      ;;
  508.      (defun arch-tocol (target &optional fill)
  509.        "Produces a string to skip to column TARGET.
  510.      Prepends newline if needed.
  511.      The optional FILL should be a character, used to fill to the column."
  512.        (if (null fill)
  513.            (setq fill ? ))
  514.        (if (< target (current-column))
  515.            (concat "\n" (make-string target fill))
  516.          (make-string (- target (current-column)) fill)))
  517.      ;;
  518.      (defun arch-rj (target field &optional fill)
  519.        "Produces a string to skip to column TARGET\
  520.       minus the width of field FIELD.
  521.      Prepends newline if needed.
  522.      The optional FILL should be a character,
  523.      used to fill to the column."
  524.        (arch-tocol (- target (length (nth field forms-fields))) fill))
  525.      
  526.      ;; Record filters.
  527.      ;;
  528.      (defun new-record-filter (the-record)
  529.        "Form a new record with some defaults."
  530.        (aset the-record arch-from (user-full-name))
  531.        (aset the-record arch-date (current-time-string))
  532.        the-record)                ; return it
  533.      (setq forms-new-record-filter 'new-record-filter)
  534.      
  535.      ;; The format list.
  536.      (setq forms-format-list
  537.           (list
  538.             "====== Public Domain Software Archive ======\n\n"
  539.             arch-shortname
  540.             " - "            arch-longname
  541.             "\n\n"
  542.             "Article: "        arch-newsgroup
  543.             "/"            arch-article
  544.             " "
  545.             '(arch-tocol 40)
  546.             "Issue: "        arch-issue
  547.             " "
  548.             '(arch-rj 73 10)
  549.             "Date: "            arch-date
  550.             "\n\n"
  551.             "Submitted by: "        arch-from
  552.             "\n"
  553.             '(arch-tocol 79 ?-)
  554.             "\n"
  555.             "Keywords: "        arch-keywords
  556.             "\n\n"
  557.             "Parts: "        arch-parts
  558.             "\n\n====== Remarks ======\n\n"
  559.             arch-remarks
  560.           ))
  561.      
  562.      ;; That's all, folks!
  563. File: forms,  Node: Credits,  Next: Index,  Prev: Long Example,  Up: Top
  564. Credits
  565. *******
  566.    Bug fixes and other useful suggestions were supplied by Harald
  567. Hanche-Olsen (`hanche@imf.unit.no'), `cwitty@portia.stanford.edu',
  568. Jonathan I. Kamens, Per Cederqvist  (`ceder@signum.se'), Michael Lipka
  569. (`lipka@lip.hanse.de'), Andy Piper (`ajp@eng.cam.ac.uk'), Ignatios
  570. Souvatzis and Richard Stallman (`rms@gnu.ai.mit.edu').
  571.    This documentation was slightly inspired by the documentation of
  572. "rolo mode" by Paul Davis at Schlumberger Cambridge Research
  573. (`davis%scrsu1%sdr.slb.com@relay.cs.net').
  574.    None of this would have been possible without GNU Emacs of the Free
  575. Software Foundation.  Thanks, Richard!
  576. File: forms,  Node: Index,  Prev: Credits,  Up: Top
  577. Index
  578. *****
  579. * Menu:
  580. * TAB:                                  Forms Commands.
  581. * begin:                                Forms Commands.
  582. * C-c <:                                Forms Commands.
  583. * C-c >:                                Forms Commands.
  584. * C-c TAB:                              Forms Commands.
  585. * C-c C-k:                              Forms Commands.
  586. * C-c C-l:                              Forms Commands.
  587. * C-c C-n:                              Forms Commands.
  588. * C-c C-o:                              Forms Commands.
  589. * C-c C-p:                              Forms Commands.
  590. * C-c C-q:                              Forms Commands.
  591. * C-c C-s REGEXP RET:                   Forms Commands.
  592. * C-x C-s:                              Forms Commands.
  593. * control file:                         Control File Format.
  594. * end:                                  Forms Commands.
  595. * field:                                Data File Format.
  596. * forms-delete-record:                  Forms Commands.
  597. * forms-enumerate:                      Miscellaneous.
  598. * forms-field-sep:                      Control File Format.
  599. * forms-field-sep:                      Data File Format.
  600. * forms-fields:                         Format Description.
  601. * forms-file:                           Control File Format.
  602. * forms-find-file:                      Entering and Exiting Forms Mode.
  603. * forms-find-file-other-window:         Entering and Exiting Forms Mode.
  604. * forms-first-record:                   Forms Commands.
  605. * forms-format-list:                    Control File Format.
  606. * forms-format-list:                    Format Description.
  607. * forms-insert-record:                  Forms Commands.
  608. * forms-jump-record:                    Forms Commands.
  609. * forms-last-record:                    Forms Commands.
  610. * forms-mode:                           Miscellaneous.
  611. * forms-mode-hooks:                     Entering and Exiting Forms Mode.
  612. * forms-modified-record-filter:         Control File Format.
  613. * forms-multi-line:                     Data File Format.
  614. * forms-multi-line:                     Control File Format.
  615. * forms-new-record-filter:              Control File Format.
  616. * forms-next-field:                     Forms Commands.
  617. * forms-next-record:                    Forms Commands.
  618. * forms-number-of-fields:               Control File Format.
  619. * forms-prev-field:                     Forms Commands.
  620. * forms-prev-field:                     Forms Commands.
  621. * forms-prev-record:                    Forms Commands.
  622. * forms-read-file-filter:               Data File Format.
  623. * forms-read-file-filter:               Control File Format.
  624. * forms-read-only:                      Control File Format.
  625. * forms-save-buffer:                    Forms Commands.
  626. * forms-search:                         Forms Commands.
  627. * forms-toggle-read-only:               Forms Commands.
  628. * forms-version:                        Miscellaneous.
  629. * forms-write-file-filter:              Data File Format.
  630. * forms-write-file-filter:              Control File Format.
  631. * next:                                 Forms Commands.
  632. * prior:                                Forms Commands.
  633. * pseudo-newline:                       Data File Format.
  634. * record:                               Data File Format.
  635. * S-Tab:                                Forms Commands.
  636. Tag Table:
  637. Node: Top
  638. Node: Forms Example
  639. Node: Entering and Exiting Forms Mode
  640. Node: Forms Commands
  641. Node: Data File Format
  642. Node: Control File Format
  643. Node: Format Description
  644. 13371
  645. Node: Modifying Forms Contents
  646. 16713
  647. Node: Miscellaneous
  648. 18600
  649. Node: Error Messages
  650. 20141
  651. Node: Long Example
  652. 24029
  653. Node: Credits
  654. 27101
  655. Node: Index
  656. 27805
  657. End Tag Table
  658.