Move some forms.el example files to etc/forms directory

[bpt/emacs.git] / etc / forms / forms-d2.el

diff --git a/etc/forms/forms-d2.el b/etc/forms/forms-d2.el
new file mode 100644 (file)
index 0000000..9fa2145
--- /dev/null
+++ b/etc/forms/forms-d2.el
@@ -0,0 +1,103 @@
+;;; forms-d2.el --- demo forms-mode
+
+;; Copyright (C) 1991, 1994-1997, 2001-2012 Free Software Foundation, Inc.
+
+;; Author: Johan Vromans <jvromans@squirrel.nl>
+;; Created: 1989
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This sample forms exploit most of the features of forms mode.
+
+;;; Code:
+
+;; Set the name of the data file.
+(setq forms-file (expand-file-name "forms/forms-d2.dat" data-directory))
+
+;; Use 'forms-enumerate' to set field names and number thereof.
+(setq forms-number-of-fields
+      (forms-enumerate
+       '(arch-newsgroup                        ; 1
+        arch-volume                    ; 2
+        arch-issue                     ; and ...
+        arch-article                   ; ... so
+        arch-shortname                 ; ... ... on
+        arch-parts
+        arch-from
+        arch-longname
+        arch-keywords
+        arch-date
+        arch-remarks)))
+
+;; The following functions are used by this form for layout purposes.
+;;
+(defun arch-tocol (target &optional fill)
+  "Produces a string to skip to column TARGET.  Prepends newline if needed.
+The optional FILL should be a character, used to fill to the column."
+  (if (null fill)
+      (setq fill ?\s))
+  (if (< target (current-column))
+      (concat "\n" (make-string target fill))
+    (make-string (- target (current-column)) fill)))
+;;
+(defun arch-rj (target field &optional fill)
+  "Produces a string to skip to column TARGET minus the width of field FIELD.
+Prepends newline if needed.  The optional FILL should be a character,
+used to fill to the column."
+  (arch-tocol (- target (length (nth field forms-fields))) fill))
+
+;; Record filters.
+;;
+(defun arch-new-record-filter (the-record)
+  "Form a new record with some defaults."
+  (aset the-record arch-from (user-full-name))
+  (aset the-record arch-date (current-time-string))
+  the-record                           ; return it
+)
+(setq forms-new-record-filter 'arch-new-record-filter)
+
+;; The format list.
+(setq forms-format-list
+     (list
+       "====== Public Domain Software Archive ======\n\n"
+       arch-shortname
+       " - "                   arch-longname
+       "\n\n"
+       "Article: "             arch-newsgroup
+       "/"                     arch-article
+       " "
+       '(arch-tocol 40)
+       "Issue: "               arch-issue
+       " "
+       '(arch-rj 73 10)
+       "Date: "                        arch-date
+       "\n\n"
+       "Submitted by: "                arch-from
+       "\n"
+       '(arch-tocol 79 ?-)
+       "\n"
+       "Keywords: "            arch-keywords
+       "\n\n"
+       "Parts: "               arch-parts
+       "\n\n====== Remarks ======\n\n"
+       arch-remarks
+     ))
+
+;; That's all, folks!
+
+;;; forms-d2.el ends here