annotate lisp/forms-d2.el @ 84189:3adfc25d5a81

Move to ../doc/emacs/, misc/
author Glenn Morris <rgm@gnu.org>
date Thu, 06 Sep 2007 04:39:38 +0000
parents 8b0dabde9595
children 73661ddc7ac7 f55f9811f5d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47726
33d53d287ee4 Add "no-byte-compile: t" in first line.
Juanma Barranquero <lekktu@gmail.com>
parents: 38436
diff changeset
1 ;;; forms-d2.el --- demo forms-mode -*- no-byte-compile: t -*-
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
2
74679
829062b6492b Copy copyright header from forms.el (at rms instruction).
Glenn Morris <rgm@gnu.org>
parents: 64542
diff changeset
3 ;; Copyright (C) 1991, 1994, 1995, 1996, 1997, 2001, 2002, 2003,
75347
e3694f1cb928 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74679
diff changeset
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
74679
829062b6492b Copy copyright header from forms.el (at rms instruction).
Glenn Morris <rgm@gnu.org>
parents: 64542
diff changeset
5
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
6 ;; Author: Johan Vromans <jvromans@squirrel.nl>
Dave Love <fx@gnu.org>
parents:
diff changeset
7 ;; Created: 1989
Dave Love <fx@gnu.org>
parents:
diff changeset
8
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
9 ;; This file is part of GNU Emacs.
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
10
78235
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
13 ;; the Free Software Foundation; either version 3, or (at your option)
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
14 ;; any later version.
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
15
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
19 ;; GNU General Public License for more details.
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
20
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
21 ;; You should have received a copy of the GNU General Public License
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
24 ;; Boston, MA 02110-1301, USA.
8b0dabde9595 Add missing license notice (GPLv3 or later).
Glenn Morris <rgm@gnu.org>
parents: 75347
diff changeset
25
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
26 ;;; Commentary:
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
27
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
28 ;; This sample forms exploit most of the features of forms mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
29
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
30 ;;; Code:
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
31
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
32 ;; Set the name of the data file.
Dave Love <fx@gnu.org>
parents:
diff changeset
33 (setq forms-file "forms-d2.dat")
Dave Love <fx@gnu.org>
parents:
diff changeset
34
Dave Love <fx@gnu.org>
parents:
diff changeset
35 ;; Use 'forms-enumerate' to set field names and number thereof.
Dave Love <fx@gnu.org>
parents:
diff changeset
36 (setq forms-number-of-fields
Dave Love <fx@gnu.org>
parents:
diff changeset
37 (forms-enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
38 '(arch-newsgroup ; 1
Dave Love <fx@gnu.org>
parents:
diff changeset
39 arch-volume ; 2
Dave Love <fx@gnu.org>
parents:
diff changeset
40 arch-issue ; and ...
Dave Love <fx@gnu.org>
parents:
diff changeset
41 arch-article ; ... so
Dave Love <fx@gnu.org>
parents:
diff changeset
42 arch-shortname ; ... ... on
Dave Love <fx@gnu.org>
parents:
diff changeset
43 arch-parts
Dave Love <fx@gnu.org>
parents:
diff changeset
44 arch-from
Dave Love <fx@gnu.org>
parents:
diff changeset
45 arch-longname
Dave Love <fx@gnu.org>
parents:
diff changeset
46 arch-keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
47 arch-date
Dave Love <fx@gnu.org>
parents:
diff changeset
48 arch-remarks)))
Dave Love <fx@gnu.org>
parents:
diff changeset
49
Dave Love <fx@gnu.org>
parents:
diff changeset
50 ;; The following functions are used by this form for layout purposes.
Dave Love <fx@gnu.org>
parents:
diff changeset
51 ;;
Dave Love <fx@gnu.org>
parents:
diff changeset
52 (defun arch-tocol (target &optional fill)
64542
24c6e1c8e0cb (arch-rj): Fix typo in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
53 "Produces a string to skip to column TARGET. Prepends newline if needed.
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
54 The optional FILL should be a character, used to fill to the column."
Dave Love <fx@gnu.org>
parents:
diff changeset
55 (if (null fill)
64542
24c6e1c8e0cb (arch-rj): Fix typo in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
56 (setq fill ?\s))
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
57 (if (< target (current-column))
Dave Love <fx@gnu.org>
parents:
diff changeset
58 (concat "\n" (make-string target fill))
Dave Love <fx@gnu.org>
parents:
diff changeset
59 (make-string (- target (current-column)) fill)))
Dave Love <fx@gnu.org>
parents:
diff changeset
60 ;;
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47726
diff changeset
61 (defun arch-rj (target field &optional fill)
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
62 "Produces a string to skip to column TARGET minus the width of field FIELD.
64542
24c6e1c8e0cb (arch-rj): Fix typo in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 52401
diff changeset
63 Prepends newline if needed. The optional FILL should be a character,
25867
Dave Love <fx@gnu.org>
parents:
diff changeset
64 used to fill to the column."
Dave Love <fx@gnu.org>
parents:
diff changeset
65 (arch-tocol (- target (length (nth field forms-fields))) fill))
Dave Love <fx@gnu.org>
parents:
diff changeset
66
Dave Love <fx@gnu.org>
parents:
diff changeset
67 ;; Record filters.
Dave Love <fx@gnu.org>
parents:
diff changeset
68 ;;
Dave Love <fx@gnu.org>
parents:
diff changeset
69 (defun arch-new-record-filter (the-record)
Dave Love <fx@gnu.org>
parents:
diff changeset
70 "Form a new record with some defaults."
Dave Love <fx@gnu.org>
parents:
diff changeset
71 (aset the-record arch-from (user-full-name))
Dave Love <fx@gnu.org>
parents:
diff changeset
72 (aset the-record arch-date (current-time-string))
Dave Love <fx@gnu.org>
parents:
diff changeset
73 the-record ; return it
Dave Love <fx@gnu.org>
parents:
diff changeset
74 )
Dave Love <fx@gnu.org>
parents:
diff changeset
75 (setq forms-new-record-filter 'arch-new-record-filter)
Dave Love <fx@gnu.org>
parents:
diff changeset
76
Dave Love <fx@gnu.org>
parents:
diff changeset
77 ;; The format list.
Dave Love <fx@gnu.org>
parents:
diff changeset
78 (setq forms-format-list
Dave Love <fx@gnu.org>
parents:
diff changeset
79 (list
Dave Love <fx@gnu.org>
parents:
diff changeset
80 "====== Public Domain Software Archive ======\n\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
81 arch-shortname
Dave Love <fx@gnu.org>
parents:
diff changeset
82 " - " arch-longname
Dave Love <fx@gnu.org>
parents:
diff changeset
83 "\n\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
84 "Article: " arch-newsgroup
Dave Love <fx@gnu.org>
parents:
diff changeset
85 "/" arch-article
Dave Love <fx@gnu.org>
parents:
diff changeset
86 " "
Dave Love <fx@gnu.org>
parents:
diff changeset
87 '(arch-tocol 40)
Dave Love <fx@gnu.org>
parents:
diff changeset
88 "Issue: " arch-issue
Dave Love <fx@gnu.org>
parents:
diff changeset
89 " "
Dave Love <fx@gnu.org>
parents:
diff changeset
90 '(arch-rj 73 10)
Dave Love <fx@gnu.org>
parents:
diff changeset
91 "Date: " arch-date
Dave Love <fx@gnu.org>
parents:
diff changeset
92 "\n\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
93 "Submitted by: " arch-from
Dave Love <fx@gnu.org>
parents:
diff changeset
94 "\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
95 '(arch-tocol 79 ?-)
Dave Love <fx@gnu.org>
parents:
diff changeset
96 "\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
97 "Keywords: " arch-keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
98 "\n\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
99 "Parts: " arch-parts
Dave Love <fx@gnu.org>
parents:
diff changeset
100 "\n\n====== Remarks ======\n\n"
Dave Love <fx@gnu.org>
parents:
diff changeset
101 arch-remarks
Dave Love <fx@gnu.org>
parents:
diff changeset
102 ))
Dave Love <fx@gnu.org>
parents:
diff changeset
103
Dave Love <fx@gnu.org>
parents:
diff changeset
104 ;; That's all, folks!
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
105
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49588
diff changeset
106 ;;; arch-tag: 8e5d5dac-7abf-4722-ab5e-03eb749beaca
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 25867
diff changeset
107 ;;; forms-d2.el ends here