(imenu-space-replacement): Use `.'.
[bpt/emacs.git] / lisp / textmodes / sgml-mode.el
CommitLineData
1caf38eb 1;;; sgml-mode.el --- SGML- and HTML-editing modes
72c0ae01 2
aa7a8f0e 3;; Copyright (C) 1992, 1995, 1996, 1998 Free Software Foundation, Inc.
6d74b528 4
64ae0c23 5;; Author: James Clark <jjc@jclark.com>
1caf38eb 6;; Adapted-By: ESR; Daniel.Pfeiffer@Informatik.START.dbp.de
a391b179 7;; F.Potorti@cnuce.cnr.it
1caf38eb 8;; Keywords: wp, hypermedia, comm, languages
72c0ae01 9
72c0ae01
ER
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
7c938215 14;; the Free Software Foundation; either version 2, or (at your option)
72c0ae01
ER
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
72c0ae01
ER
26
27;;; Commentary:
28
1caf38eb
RS
29;; Configurable major mode for editing document in the SGML standard general
30;; markup language. As an example contains a mode for editing the derived
31;; HTML hypertext markup language.
72c0ae01
ER
32
33;;; Code:
34
64ae0c23
RS
35(defgroup sgml nil
36 "SGML editing mode"
37 :group 'languages)
38
d10447ba 39(defcustom sgml-transformation 'identity
a391b179
RS
40 "*Default value for `skeleton-transformation' (which see) in SGML mode."
41 :type 'function
c60e7b0d 42 :group 'sgml)
a391b179
RS
43
44(put 'sgml-transformation 'variable-interactive
45 "aTransformation function: ")
46
1caf38eb
RS
47;; As long as Emacs' syntax can't be complemented with predicates to context
48;; sensitively confirm the syntax of characters, we have to live with this
49;; kludgy kind of tradeoff.
21a6f23c 50(defvar sgml-specials '(?\")
f788776c 51 "List of characters that have a special meaning for SGML mode.
1caf38eb
RS
52This list is used when first loading the sgml-mode library.
53The supported characters and potential disadvantages are:
54
55 ?\\\" Makes \" in text start a string.
56 ?' Makes ' in text start a string.
57 ?- Makes -- in text start a comment.
58
4fa91cfe 59When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
1caf38eb 60DTDs, start a string. To partially avoid this problem this also makes these
21a6f23c
RS
61self insert as named entities depending on `sgml-quick-keys'.
62
63Including ?- has the problem of affecting dashes that have nothing to do
64with comments, so we normally turn it off.")
fcc3195e
RS
65
66(defvar sgml-quick-keys nil
f788776c
RS
67 "Use <, >, &, SPC and `sgml-specials' keys \"electrically\" when non-nil.
68This takes effect when first loading the sgml-mode library.")
1caf38eb
RS
69
70
71(defvar sgml-mode-map
72 (let ((map (list 'keymap (make-vector 256 nil)))
73 (menu-map (make-sparse-keymap "SGML")))
74 (define-key map "\t" 'indent-relative-maybe)
75 (define-key map "\C-c\C-i" 'sgml-tags-invisible)
76 (define-key map "/" 'sgml-slash)
fcc3195e
RS
77 (define-key map "\C-c\C-n" 'sgml-name-char)
78 (define-key map "\C-c\C-t" 'sgml-tag)
1caf38eb
RS
79 (define-key map "\C-c\C-a" 'sgml-attributes)
80 (define-key map "\C-c\C-b" 'sgml-skip-tag-backward)
81 (define-key map [?\C-c left] 'sgml-skip-tag-backward)
82 (define-key map "\C-c\C-f" 'sgml-skip-tag-forward)
83 (define-key map [?\C-c right] 'sgml-skip-tag-forward)
84 (define-key map "\C-c\C-d" 'sgml-delete-tag)
85 (define-key map "\C-c\^?" 'sgml-delete-tag)
86 (define-key map "\C-c?" 'sgml-tag-help)
1caf38eb
RS
87 (define-key map "\C-c8" 'sgml-name-8bit-mode)
88 (define-key map "\C-c\C-v" 'sgml-validate)
fcc3195e
RS
89 (if sgml-quick-keys
90 (progn
91 (define-key map "&" 'sgml-name-char)
92 (define-key map "<" 'sgml-tag)
93 (define-key map " " 'sgml-auto-attributes)
94 (define-key map ">" 'sgml-maybe-end-tag)
95 (if (memq ?\" sgml-specials)
96 (define-key map "\"" 'sgml-name-self))
97 (if (memq ?' sgml-specials)
98 (define-key map "'" 'sgml-name-self))))
1caf38eb
RS
99 (let ((c 127)
100 (map (nth 1 map)))
101 (while (< (setq c (1+ c)) 256)
102 (aset map c 'sgml-maybe-name-self)))
103 (define-key map [menu-bar sgml] (cons "SGML" menu-map))
104 (define-key menu-map [sgml-validate] '("Validate" . sgml-validate))
105 (define-key menu-map [sgml-name-8bit-mode]
106 '("Toggle 8 Bit Insertion" . sgml-name-8bit-mode))
107 (define-key menu-map [sgml-tags-invisible]
108 '("Toggle Tag Visibility" . sgml-tags-invisible))
109 (define-key menu-map [sgml-tag-help]
110 '("Describe Tag" . sgml-tag-help))
111 (define-key menu-map [sgml-delete-tag]
112 '("Delete Tag" . sgml-delete-tag))
113 (define-key menu-map [sgml-skip-tag-forward]
114 '("Forward Tag" . sgml-skip-tag-forward))
115 (define-key menu-map [sgml-skip-tag-backward]
116 '("Backward Tag" . sgml-skip-tag-backward))
117 (define-key menu-map [sgml-attributes]
118 '("Insert Attributes" . sgml-attributes))
119 (define-key menu-map [sgml-tag] '("Insert Tag" . sgml-tag))
120 map)
121 "Keymap for SGML mode. See also `sgml-specials'.")
122
123
124(defvar sgml-mode-syntax-table
125 (let ((table (copy-syntax-table text-mode-syntax-table)))
126 (modify-syntax-entry ?< "(>" table)
127 (modify-syntax-entry ?> ")<" table)
128 (if (memq ?- sgml-specials)
129 (modify-syntax-entry ?- "_ 1234" table))
130 (if (memq ?\" sgml-specials)
131 (modify-syntax-entry ?\" "\"\"" table))
132 (if (memq ?' sgml-specials)
133 (modify-syntax-entry ?\' "\"'" table))
134 table)
135 "Syntax table used in SGML mode. See also `sgml-specials'.")
136
72c0ae01 137
64ae0c23 138(defcustom sgml-name-8bit-mode nil
f788776c 139 "*When non-nil, insert 8 bit characters with their names."
64ae0c23
RS
140 :type 'boolean
141 :group 'sgml)
72c0ae01 142
1caf38eb
RS
143(defvar sgml-char-names
144 [nil nil nil nil nil nil nil nil
145 nil nil nil nil nil nil nil nil
146 nil nil nil nil nil nil nil nil
147 nil nil nil nil nil nil nil nil
a391b179 148 "nbsp" "excl" "quot" "num" "dollar" "percnt" "amp" "apos"
1caf38eb
RS
149 "lpar" "rpar" "ast" "plus" "comma" "hyphen" "period" "sol"
150 nil nil nil nil nil nil nil nil
151 nil nil "colon" "semi" "lt" "eq" "gt" "quest"
152 "commat" nil nil nil nil nil nil nil
153 nil nil nil nil nil nil nil nil
154 nil nil nil nil nil nil nil nil
155 nil nil nil "lsqb" nil "rsqb" "uarr" "lowbar"
156 "lsquo" nil nil nil nil nil nil nil
157 nil nil nil nil nil nil nil nil
158 nil nil nil nil nil nil nil nil
159 nil nil nil "lcub" "verbar" "rcub" "tilde" nil
160 nil nil nil nil nil nil nil nil
161 nil nil nil nil nil nil nil nil
162 nil nil nil nil nil nil nil nil
163 nil nil nil nil nil nil nil nil
164 "nbsp" "iexcl" "cent" "pound" "curren" "yen" "brvbar" "sect"
165 "uml" "copy" "ordf" "laquo" "not" "shy" "reg" "macr"
166 "ring" "plusmn" "sup2" "sup3" "acute" "micro" "para" "middot"
167 "cedil" "sup1" "ordm" "raquo" "frac14" "half" "frac34" "iquest"
168 "Agrave" "Aacute" "Acirc" "Atilde" "Auml" "Aring" "AElig" "Ccedil"
169 "Egrave" "Eacute" "Ecirc" "Euml" "Igrave" "Iacute" "Icirc" "Iuml"
170 "ETH" "Ntilde" "Ograve" "Oacute" "Ocirc" "Otilde" "Ouml" nil
171 "Oslash" "Ugrave" "Uacute" "Ucirc" "Uuml" "Yacute" "THORN" "szlig"
172 "agrave" "aacute" "acirc" "atilde" "auml" "aring" "aelig" "ccedil"
173 "egrave" "eacute" "ecirc" "euml" "igrave" "iacute" "icirc" "iuml"
174 "eth" "ntilde" "ograve" "oacute" "ocirc" "otilde" "ouml" "divide"
175 "oslash" "ugrave" "uacute" "ucirc" "uuml" "yacute" "thorn" "yuml"]
176 "Vector of symbolic character names without `&' and `;'.")
177
178
179;; sgmls is a free SGML parser available from
180;; ftp.uu.net:pub/text-processing/sgml
181;; Its error messages can be parsed by next-error.
182;; The -s option suppresses output.
183
64ae0c23 184(defcustom sgml-validate-command "sgmls -s"
72c0ae01
ER
185 "*The command to validate an SGML document.
186The file name of current buffer file name will be appended to this,
64ae0c23
RS
187separated by a space."
188 :type 'string
189 :group 'sgml)
72c0ae01
ER
190
191(defvar sgml-saved-validate-command nil
192 "The command last used to validate in this buffer.")
193
72c0ae01 194
1caf38eb
RS
195;;; I doubt that null end tags are used much for large elements,
196;;; so use a small distance here.
64ae0c23 197(defcustom sgml-slash-distance 1000
f788776c 198 "*If non-nil, is the maximum distance to search for matching `/'."
64ae0c23
RS
199 :type '(choice (const nil) integer)
200 :group 'sgml)
72c0ae01 201
1caf38eb
RS
202(defconst sgml-start-tag-regex
203 "<[A-Za-z]\\([-.A-Za-z0-9= \n\t]\\|\"[^\"]*\"\\|'[^']*'\\)*"
204 "Regular expression that matches a non-empty start tag.
f788776c 205Any terminating `>' or `/' is not matched.")
1caf38eb
RS
206
207
c6a63534
RS
208;; internal
209(defconst sgml-font-lock-keywords-1
4fa91cfe
DL
210 '(("<\\([!?][a-z][-.a-z0-9]+\\)" 1 font-lock-keyword-face)
211 ("<\\(/?[a-z][-.a-z0-9]+\\)" 1 font-lock-function-name-face)
212 ("[&%][a-z][-.a-z0-9]+;?" . font-lock-variable-name-face)
213 ("<! *--.*-- *>" . font-lock-comment-face)))
c6a63534
RS
214
215(defconst sgml-font-lock-keywords-2 ())
216
217;; for font-lock, but must be defvar'ed after
218;; sgml-font-lock-keywords-1 and sgml-font-lock-keywords-2 above
219(defvar sgml-font-lock-keywords sgml-font-lock-keywords-1
1caf38eb
RS
220 "*Rules for highlighting SGML code. See also `sgml-tag-face-alist'.")
221
222;; internal
1caf38eb
RS
223(defvar sgml-face-tag-alist ()
224 "Alist of face and tag name for facemenu.")
225
226(defvar sgml-tag-face-alist ()
227 "Tag names and face or list of faces to fontify with when invisible.
228When `font-lock-maximum-decoration' is 1 this is always used for fontifying.
229When more these are fontified together with `sgml-font-lock-keywords'.")
230
231
232(defvar sgml-display-text ()
233 "Tag names as lowercase symbols, and display string when invisible.")
234
235;; internal
236(defvar sgml-tags-invisible nil)
237
238
64ae0c23 239(defcustom sgml-tag-alist
fcc3195e
RS
240 '(("![" ("ignore" t) ("include" t))
241 ("!attlist")
1caf38eb
RS
242 ("!doctype")
243 ("!element")
244 ("!entity"))
245 "*Alist of tag names for completing read and insertion rules.
246This alist is made up as
247
248 ((\"tag\" . TAGRULE)
249 ...)
250
251TAGRULE is a list of optionally `t' (no endtag) or `\\n' (separate endtag by
252newlines) or a skeleton with `nil', `t' or `\\n' in place of the interactor
253followed by an ATTRIBUTERULE (for an always present attribute) or an
254attribute alist.
255
256The attribute alist is made up as
257
258 ((\"attribute\" . ATTRIBUTERULE)
259 ...)
260
261ATTRIBUTERULE is a list of optionally `t' (no value when no input) followed by
64ae0c23
RS
262an optional alist of possible values."
263 :type '(repeat (cons (string :tag "Tag Name")
264 (repeat :tag "Tag Rule" sexp)))
265 :group 'sgml)
1caf38eb 266
64ae0c23 267(defcustom sgml-tag-help
1caf38eb
RS
268 '(("!" . "Empty declaration for comment")
269 ("![" . "Embed declarations with parser directive")
270 ("!attlist" . "Tag attributes declaration")
271 ("!doctype" . "Document type (DTD) declaration")
272 ("!element" . "Tag declaration")
273 ("!entity" . "Entity (macro) declaration"))
64ae0c23
RS
274 "*Alist of tag name and short description."
275 :type '(repeat (cons (string :tag "Tag Name")
276 (string :tag "Description")))
277 :group 'sgml)
1caf38eb 278
1caf38eb
RS
279(defun sgml-mode-common (sgml-tag-face-alist sgml-display-text)
280 "Common code for setting up `sgml-mode' and derived modes.
c6a63534 281SGML-TAG-FACE-ALIST is used for calculating `sgml-font-lock-keywords-2'.
1caf38eb
RS
282SGML-DISPLAY-TEXT sets up alternate text for when tags are invisible (see
283varables of same name)."
72c0ae01
ER
284 (kill-all-local-variables)
285 (setq local-abbrev-table text-mode-abbrev-table)
1caf38eb
RS
286 (set-syntax-table sgml-mode-syntax-table)
287 (make-local-variable 'indent-line-function)
72c0ae01 288 (make-local-variable 'paragraph-start)
72c0ae01 289 (make-local-variable 'paragraph-separate)
9e832d81 290 (make-local-variable 'adaptive-fill-regexp)
72c0ae01 291 (make-local-variable 'sgml-saved-validate-command)
72c0ae01 292 (make-local-variable 'comment-start)
72c0ae01 293 (make-local-variable 'comment-end)
e41b2db1 294 (make-local-variable 'comment-indent-function)
72c0ae01 295 (make-local-variable 'comment-start-skip)
1caf38eb
RS
296 (make-local-variable 'comment-indent-function)
297 (make-local-variable 'sgml-tags-invisible)
298 (make-local-variable 'skeleton-transformation)
299 (make-local-variable 'skeleton-further-elements)
300 (make-local-variable 'skeleton-end-hook)
301 (make-local-variable 'font-lock-defaults)
302 (make-local-variable 'sgml-font-lock-keywords-1)
c6a63534 303 (make-local-variable 'sgml-font-lock-keywords-2)
1caf38eb
RS
304 (make-local-variable 'facemenu-add-face-function)
305 (make-local-variable 'facemenu-end-add-face)
306 ;;(make-local-variable 'facemenu-remove-face-function)
307 (and sgml-tag-face-alist
308 (not (assq 1 sgml-tag-face-alist))
309 (nconc sgml-tag-face-alist
310 `((1 (,(concat "<\\("
311 (mapconcat 'car sgml-tag-face-alist "\\|")
312 "\\)\\([ \t].+\\)?>\\(.+\\)</\\1>")
aa7a8f0e
DL
313 3 (cdr (assoc (downcase (match-string 1))
314 ',sgml-tag-face-alist)))))))
1caf38eb
RS
315 (setq indent-line-function 'indent-relative-maybe
316 ;; A start or end tag by itself on a line separates a paragraph.
317 ;; This is desirable because SGML discards a newline that appears
318 ;; immediately after a start tag or immediately before an end tag.
6c455d5c
RS
319 paragraph-separate "[ \t]*$\\|\
320\[ \t]*</?\\([A-Za-z]\\([-.A-Za-z0-9= \t\n]\\|\"[^\"]*\"\\|'[^']*'\\)*\\)?>$"
321 paragraph-start "[ \t]*$\\|\
322\[ \t]*</?\\([A-Za-z]\\([-.A-Za-z0-9= \t\n]\\|\"[^\"]*\"\\|'[^']*'\\)*\\)?>$"
323 adaptive-fill-regexp "[ \t]*"
1caf38eb
RS
324 comment-start "<!-- "
325 comment-end " -->"
326 comment-indent-function 'sgml-comment-indent
327 ;; This will allow existing comments within declarations to be
328 ;; recognized.
329 comment-start-skip "--[ \t]*"
a391b179 330 skeleton-transformation sgml-transformation
1caf38eb
RS
331 skeleton-further-elements '((completion-ignore-case t))
332 skeleton-end-hook (lambda ()
333 (or (eolp)
334 (not (or (eq v2 '\n)
335 (eq (car-safe v2) '\n)))
336 (newline-and-indent)))
c6a63534
RS
337 sgml-font-lock-keywords-2 (append
338 sgml-font-lock-keywords-1
339 (cdr (assq 1 sgml-tag-face-alist)))
1caf38eb 340 font-lock-defaults '((sgml-font-lock-keywords
c6a63534
RS
341 sgml-font-lock-keywords-1
342 sgml-font-lock-keywords-2)
1caf38eb
RS
343 nil
344 t)
6811a757 345 facemenu-add-face-function 'sgml-mode-facemenu-add-face-function)
1caf38eb
RS
346 (while sgml-display-text
347 (put (car (car sgml-display-text)) 'before-string
348 (cdr (car sgml-display-text)))
349 (setq sgml-display-text (cdr sgml-display-text)))
72c0ae01
ER
350 (run-hooks 'text-mode-hook 'sgml-mode-hook))
351
1caf38eb 352
6811a757
RS
353(defun sgml-mode-facemenu-add-face-function (face end)
354 (if (setq face (cdr (assq face sgml-face-tag-alist)))
355 (progn
356 (setq face (funcall skeleton-transformation face))
357 (setq facemenu-end-add-face (concat "</" face ">"))
358 (concat "<" face ">"))
359 (error "Face not configured for %s mode." mode-name)))
360
361
1caf38eb
RS
362;;;###autoload
363(defun sgml-mode (&optional function)
364 "Major mode for editing SGML documents.
365Makes > match <. Makes / blink matching /.
fcc3195e
RS
366Keys <, &, SPC within <>, \" and ' can be electric depending on
367`sgml-quick-keys'.
1caf38eb 368
f788776c
RS
369An argument of N to a tag-inserting command means to wrap it around
370the next N words. In Transient Mark mode, when the mark is active,
371N defaults to -1, which means to wrap it around the current region.
a391b179 372
d10447ba 373If you like upcased tags, put (setq sgml-transformation 'upcase) in
f788776c 374your `.emacs' file.
1caf38eb
RS
375
376Use \\[sgml-validate] to validate your document with an SGML parser.
a391b179
RS
377
378Do \\[describe-variable] sgml- SPC to see available variables.
379Do \\[describe-key] on the following bindings to discover what they do.
1caf38eb
RS
380\\{sgml-mode-map}"
381 (interactive)
382 (sgml-mode-common sgml-tag-face-alist sgml-display-text)
ec79b93a
KH
383 ;; Set imenu-generic-expression here, rather than in sgml-mode-common,
384 ;; because this definition probably is not useful in HTML mode.
385 (make-local-variable 'imenu-generic-expression)
386 (setq imenu-generic-expression
387 "<!\\(element\\|entity\\)[ \t\n]+%?[ \t\n]*\\([A-Za-z][-A-Za-z.0-9]*\\)")
1caf38eb
RS
388 (use-local-map sgml-mode-map)
389 (setq mode-name "SGML"
390 major-mode 'sgml-mode))
391
392
393
72c0ae01
ER
394(defun sgml-comment-indent ()
395 (if (and (looking-at "--")
1caf38eb 396 (not (and (eq (preceding-char) ?!)
72c0ae01
ER
397 (eq (char-after (- (point) 2)) ?<))))
398 (progn
399 (skip-chars-backward " \t")
400 (max comment-column (1+ (current-column))))
401 0))
402
72c0ae01 403
72c0ae01
ER
404
405(defun sgml-slash (arg)
f788776c
RS
406 "Insert `/' and display any previous matching `/'.
407Two `/'s are treated as matching if the first `/' ends a net-enabling
408start tag, and the second `/' is the corresponding null end tag."
72c0ae01
ER
409 (interactive "p")
410 (insert-char ?/ arg)
411 (if (> arg 0)
412 (let ((oldpos (point))
413 (blinkpos)
414 (level 0))
415 (save-excursion
416 (save-restriction
417 (if sgml-slash-distance
418 (narrow-to-region (max (point-min)
419 (- (point) sgml-slash-distance))
420 oldpos))
421 (if (and (re-search-backward sgml-start-tag-regex (point-min) t)
422 (eq (match-end 0) (1- oldpos)))
423 ()
424 (goto-char (1- oldpos))
425 (while (and (not blinkpos)
426 (search-backward "/" (point-min) t))
427 (let ((tagend (save-excursion
428 (if (re-search-backward sgml-start-tag-regex
429 (point-min) t)
430 (match-end 0)
431 nil))))
432 (if (eq tagend (point))
433 (if (eq level 0)
434 (setq blinkpos (point))
435 (setq level (1- level)))
436 (setq level (1+ level)))))))
437 (if blinkpos
438 (progn
439 (goto-char blinkpos)
440 (if (pos-visible-in-window-p)
441 (sit-for 1)
442 (message "Matches %s"
443 (buffer-substring (progn
444 (beginning-of-line)
445 (point))
446 (1+ blinkpos))))))))))
447
1caf38eb
RS
448
449(defun sgml-name-char (&optional char)
450 "Insert a symbolic character name according to `sgml-char-names'.
4518 bit chars may be inserted with the meta key as in M-SPC for no break space,
452or M-- for a soft hyphen."
453 (interactive "*")
454 (insert ?&)
455 (or char
9b0ffdac 456 (setq char (read-quoted-char "Enter char or octal number")))
1caf38eb
RS
457 (delete-backward-char 1)
458 (insert char)
459 (undo-boundary)
460 (delete-backward-char 1)
461 (insert ?&
462 (or (aref sgml-char-names char)
463 (format "#%d" char))
464 ?\;))
465
466
467(defun sgml-name-self ()
468 "Insert a symbolic character name according to `sgml-char-names'."
469 (interactive "*")
470 (sgml-name-char last-command-char))
471
472
473(defun sgml-maybe-name-self ()
474 "Insert a symbolic character name according to `sgml-char-names'."
475 (interactive "*")
476 (if sgml-name-8bit-mode
477 (sgml-name-char last-command-char)
478 (self-insert-command 1)))
479
480
481(defun sgml-name-8bit-mode ()
482 "Toggle insertion of 8 bit characters."
483 (interactive)
d10447ba
RS
484 (setq sgml-name-8bit-mode (not sgml-name-8bit-mode))
485 (message "sgml name 8 bit mode is now %"
486 (if sgml-name-8bit-mode "ON" "OFF")))
1caf38eb
RS
487
488
f788776c
RS
489;; When an element of a skeleton is a string "str", it is passed
490;; through skeleton-transformation and inserted. If "str" is to be
491;; inserted literally, one should obtain it as the return value of a
492;; function, e.g. (identity "str").
1caf38eb
RS
493
494(define-skeleton sgml-tag
f788776c
RS
495 "Prompt for a tag and insert it, optionally with attributes.
496Completion and configuration are done according to `sgml-tag-alist'.
d10447ba 497If you like tags and attributes in uppercase do \\[set-variable]
f788776c
RS
498skeleton-transformation RET upcase RET, or put this in your `.emacs':
499 (setq sgml-transformation 'upcase)"
1caf38eb
RS
500 (funcall skeleton-transformation
501 (completing-read "Tag: " sgml-tag-alist))
502 ?< (setq v1 (eval str)) |
d10447ba 503 (("") -1 '(undo-boundary) (identity "&lt;")) | ; see comment above
1caf38eb 504 (("") '(setq v2 (sgml-attributes v1 t)) ?>
fcc3195e
RS
505 (if (string= "![" v1)
506 (prog1 '(("") " [ " _ " ]]")
507 (backward-char))
508 (if (or (eq v2 t)
509 (string-match "^[/!?]" v1))
510 ()
511 (if (symbolp v2)
512 '(("") v2 _ v2 "</" v1 ?>)
513 (if (eq (car v2) t)
514 (cons '("") (cdr v2))
515 (append '(("") (car v2))
516 (cdr v2)
517 '(resume: (car v2) _ "</" v1 ?>))))))))
1caf38eb
RS
518
519(autoload 'skeleton-read "skeleton")
520
d10447ba 521(defun sgml-attributes (tag &optional quiet)
f788776c 522 "When at top level of a tag, interactively insert attributes.
d10447ba 523
f788776c
RS
524Completion and configuration of TAG are done according to `sgml-tag-alist'.
525If QUIET, do not print a message when there are no attributes for TAG."
1caf38eb 526 (interactive (list (save-excursion (sgml-beginning-of-tag t))))
d10447ba
RS
527 (or (stringp tag) (error "Wrong context for adding attribute"))
528 (if tag
1caf38eb 529 (let ((completion-ignore-case t)
d10447ba 530 (alist (cdr (assoc (downcase tag) sgml-tag-alist)))
1caf38eb 531 car attribute i)
1caf38eb
RS
532 (if (or (symbolp (car alist))
533 (symbolp (car (car alist))))
534 (setq car (car alist)
535 alist (cdr alist)))
536 (or quiet
537 (message "No attributes configured."))
538 (if (stringp (car alist))
539 (progn
d10447ba
RS
540 (insert (if (eq (preceding-char) ? ) "" ? )
541 (funcall skeleton-transformation (car alist)))
1caf38eb
RS
542 (sgml-value alist))
543 (setq i (length alist))
544 (while (> i 0)
545 (insert ? )
546 (insert (funcall skeleton-transformation
547 (setq attribute
548 (skeleton-read '(completing-read
d10447ba 549 "Attribute: "
1caf38eb
RS
550 alist)))))
551 (if (string= "" attribute)
552 (setq i 0)
aa7a8f0e 553 (sgml-value (assoc (downcase attribute) alist))
1caf38eb
RS
554 (setq i (1- i))))
555 (if (eq (preceding-char) ? )
556 (delete-backward-char 1)))
557 car)))
558
559(defun sgml-auto-attributes (arg)
f788776c
RS
560 "Self insert the character typed; at top level of tag, prompt for attributes.
561With prefix argument, only self insert."
1caf38eb
RS
562 (interactive "*P")
563 (let ((point (point))
564 tag)
565 (if (or arg
1caf38eb
RS
566 (not sgml-tag-alist) ; no message when nothing configured
567 (symbolp (setq tag (save-excursion (sgml-beginning-of-tag t))))
568 (eq (aref tag 0) ?/))
569 (self-insert-command (prefix-numeric-value arg))
570 (sgml-attributes tag)
571 (setq last-command-char ? )
572 (or (> (point) point)
573 (self-insert-command 1)))))
574
575
576(defun sgml-tag-help (&optional tag)
f788776c 577 "Display description of tag TAG. If TAG is omitted, use the tag at point."
1caf38eb
RS
578 (interactive)
579 (or tag
580 (save-excursion
581 (if (eq (following-char) ?<)
582 (forward-char))
583 (setq tag (sgml-beginning-of-tag))))
584 (or (stringp tag)
585 (error "No tag selected"))
586 (setq tag (downcase tag))
f68f40e0 587 (message "%s"
aa7a8f0e 588 (or (cdr (assoc (downcase tag) sgml-tag-help))
1caf38eb 589 (and (eq (aref tag 0) ?/)
aa7a8f0e 590 (cdr (assoc (downcase (substring tag 1)) sgml-tag-help)))
1caf38eb
RS
591 "No description available")))
592
593
594(defun sgml-maybe-end-tag ()
595 "Name self unless in position to end a tag."
596 (interactive)
597 (or (condition-case nil
598 (save-excursion (up-list -1))
599 (error
600 (sgml-name-self)
601 t))
602 (condition-case nil
603 (progn
604 (save-excursion (up-list 1))
605 (sgml-name-self))
606 (error (self-insert-command 1)))))
607
608
609(defun sgml-skip-tag-backward (arg)
610 "Skip to beginning of tag or matching opening tag if present.
f788776c 611With prefix argument ARG, repeat this ARG times."
1caf38eb
RS
612 (interactive "p")
613 (while (>= arg 1)
614 (search-backward "<" nil t)
615 (if (looking-at "</\\([^ \n\t>]+\\)")
616 ;; end tag, skip any nested pairs
617 (let ((case-fold-search t)
618 (re (concat "</?" (regexp-quote (match-string 1)))))
619 (while (and (re-search-backward re nil t)
620 (eq (char-after (1+ (point))) ?/))
621 (forward-char 1)
622 (sgml-skip-tag-backward 1))))
623 (setq arg (1- arg))))
624
625(defun sgml-skip-tag-forward (arg &optional return)
626 "Skip to end of tag or matching closing tag if present.
f788776c 627With prefix argument ARG, repeat this ARG times.
1caf38eb
RS
628Return t iff after a closing tag."
629 (interactive "p")
630 (setq return t)
631 (while (>= arg 1)
632 (skip-chars-forward "^<>")
633 (if (eq (following-char) ?>)
634 (up-list -1))
635 (if (looking-at "<\\([^/ \n\t>]+\\)")
636 ;; start tag, skip any nested same pairs _and_ closing tag
637 (let ((case-fold-search t)
638 (re (concat "</?" (regexp-quote (match-string 1))))
639 point close)
640 (forward-list 1)
641 (setq point (point))
642 (while (and (re-search-forward re nil t)
643 (not (setq close
644 (eq (char-after (1+ (match-beginning 0))) ?/)))
645 (not (up-list -1))
646 (sgml-skip-tag-forward 1))
647 (setq close nil))
648 (if close
649 (up-list 1)
650 (goto-char point)
651 (setq return)))
652 (forward-list 1))
653 (setq arg (1- arg)))
654 return)
655
656(defun sgml-delete-tag (arg)
657 "Delete tag on or after cursor, and matching closing or opening tag.
f788776c 658With prefix argument ARG, repeat this ARG times."
1caf38eb
RS
659 (interactive "p")
660 (while (>= arg 1)
661 (save-excursion
662 (let* (close open)
fcc3195e 663 (if (looking-at "[ \t\n]*<")
1caf38eb
RS
664 ;; just before tag
665 (if (eq (char-after (match-end 0)) ?/)
666 ;; closing tag
667 (progn
668 (setq close (point))
669 (goto-char (match-end 0))))
670 ;; on tag?
671 (or (save-excursion (setq close (sgml-beginning-of-tag)
672 close (and (stringp close)
673 (eq (aref close 0) ?/)
674 (point))))
675 ;; not on closing tag
676 (let ((point (point)))
677 (sgml-skip-tag-backward 1)
678 (if (or (not (eq (following-char) ?<))
679 (save-excursion
680 (forward-list 1)
681 (<= (point) point)))
682 (error "Not on or before tag")))))
683 (if close
684 (progn
685 (sgml-skip-tag-backward 1)
686 (setq open (point))
687 (goto-char close)
688 (kill-sexp 1))
689 (setq open (point))
690 (sgml-skip-tag-forward 1)
691 (backward-list)
692 (forward-char)
693 (if (eq (aref (sgml-beginning-of-tag) 0) ?/)
694 (kill-sexp 1)))
695 (goto-char open)
696 (kill-sexp 1)))
697 (setq arg (1- arg))))
a391b179
RS
698\f
699;; Put read-only last to enable setting this even when read-only enabled.
700(or (get 'sgml-tag 'invisible)
701 (setplist 'sgml-tag
702 (append '(invisible t
703 intangible t
704 point-entered sgml-point-entered
705 rear-nonsticky t
706 read-only t)
707 (symbol-plist 'sgml-tag))))
1caf38eb
RS
708
709(defun sgml-tags-invisible (arg)
710 "Toggle visibility of existing tags."
711 (interactive "P")
712 (let ((modified (buffer-modified-p))
713 (inhibit-read-only t)
a391b179
RS
714 ;; This is needed in case font lock gets called,
715 ;; since it moves point and might call sgml-point-entered.
716 (inhibit-point-motion-hooks t)
1caf38eb
RS
717 symbol)
718 (save-excursion
a391b179 719 (goto-char (point-min))
1caf38eb
RS
720 (if (setq sgml-tags-invisible
721 (if arg
722 (>= (prefix-numeric-value arg) 0)
723 (not sgml-tags-invisible)))
724 (while (re-search-forward "<\\([!/?A-Za-z][-A-Za-z0-9]*\\)"
725 nil t)
726 (setq symbol (intern-soft (downcase (match-string 1))))
727 (goto-char (match-beginning 0))
728 (and (get symbol 'before-string)
729 (not (overlays-at (point)))
730 (overlay-put (make-overlay (point)
731 (match-beginning 1))
732 'category symbol))
a391b179
RS
733 (put-text-property (point)
734 (progn (forward-list) (point))
1caf38eb 735 'category 'sgml-tag))
a391b179
RS
736 (let ((pos (point)))
737 (while (< (setq pos (next-overlay-change pos)) (point-max))
738 (delete-overlay (car (overlays-at pos)))))
1caf38eb
RS
739 (remove-text-properties (point-min) (point-max)
740 '(category sgml-tag intangible t))))
741 (set-buffer-modified-p modified)
742 (run-hooks 'sgml-tags-invisible-hook)
743 (message "")))
744
745(defun sgml-point-entered (x y)
746 ;; Show preceding or following hidden tag, depending of cursor direction.
747 (let ((inhibit-point-motion-hooks t))
748 (save-excursion
749 (message "Invisible tag: %s"
750 (buffer-substring
751 (point)
752 (if (or (and (> x y)
753 (not (eq (following-char) ?<)))
754 (and (< x y)
755 (eq (preceding-char) ?>)))
756 (backward-list)
757 (forward-list)))))))
a391b179 758\f
1caf38eb
RS
759(autoload 'compile-internal "compile")
760
72c0ae01
ER
761(defun sgml-validate (command)
762 "Validate an SGML document.
763Runs COMMAND, a shell command, in a separate process asynchronously
f788776c 764with output going to the buffer `*compilation*'.
72c0ae01
ER
765You can then use the command \\[next-error] to find the next error message
766and move to the line in the SGML document that caused it."
767 (interactive
768 (list (read-string "Validate command: "
769 (or sgml-saved-validate-command
770 (concat sgml-validate-command
771 " "
772 (let ((name (buffer-file-name)))
773 (and name
774 (file-name-nondirectory name))))))))
775 (setq sgml-saved-validate-command command)
0afdd8d0
RS
776 (if (or (not compilation-ask-about-save)
777 (y-or-n-p (message "Save buffer %s? " (buffer-name))))
778 (save-buffer))
c7aa4667 779 (compile-internal command "No more errors"))
72c0ae01 780
1caf38eb
RS
781
782(defun sgml-beginning-of-tag (&optional top-level)
783 "Skip to beginning of tag and return its name.
f788776c 784If this can't be done, return t."
1caf38eb
RS
785 (or (if top-level
786 (condition-case nil
787 (up-list -1)
788 (error t))
789 (>= (point)
790 (if (search-backward "<" nil t)
791 (save-excursion
792 (forward-list)
793 (point))
794 0)))
795 (if (looking-at "<[!?/]?[[A-Za-z][A-Za-z0-9]*")
796 (buffer-substring-no-properties
797 (1+ (point))
798 (match-end 0))
799 t)))
800
801(defun sgml-value (alist)
f788776c
RS
802 "Interactively insert value taken from attributerule ALIST.
803See `sgml-tag-alist' for info about attributerules.."
1caf38eb
RS
804 (setq alist (cdr alist))
805 (if (stringp (car alist))
806 (insert "=\"" (car alist) ?\")
807 (if (eq (car alist) t)
808 (if (cdr alist)
809 (progn
810 (insert "=\"")
811 (setq alist (skeleton-read '(completing-read
d10447ba 812 "Value: " (cdr alist))))
1caf38eb 813 (if (string< "" alist)
a391b179 814 (insert alist ?\")
1caf38eb
RS
815 (delete-backward-char 2))))
816 (insert "=\"")
817 (if alist
a391b179 818 (insert (skeleton-read '(completing-read "Value: " alist))))
1caf38eb
RS
819 (insert ?\"))))
820
821(provide 'sgml-mode)
822\f
fcc3195e 823(defvar html-quick-keys sgml-quick-keys
b1e7bb48 824 "Use C-c X combinations for quick insertion of frequent tags when non-nil.
fcc3195e 825This defaults to `sgml-quick-keys'.
1caf38eb
RS
826This takes effect when first loading the library.")
827
828(defvar html-mode-map
829 (let ((map (nconc (make-sparse-keymap) sgml-mode-map))
830 (menu-map (make-sparse-keymap "HTML")))
7e49eef2
RS
831 (define-key map "\C-c6" 'html-headline-6)
832 (define-key map "\C-c5" 'html-headline-5)
833 (define-key map "\C-c4" 'html-headline-4)
834 (define-key map "\C-c3" 'html-headline-3)
835 (define-key map "\C-c2" 'html-headline-2)
836 (define-key map "\C-c1" 'html-headline-1)
fcc3195e
RS
837 (define-key map "\C-c\r" 'html-paragraph)
838 (define-key map "\C-c\n" 'html-line)
839 (define-key map "\C-c\C-c-" 'html-horizontal-rule)
7e49eef2
RS
840 (define-key map "\C-c\C-co" 'html-ordered-list)
841 (define-key map "\C-c\C-cu" 'html-unordered-list)
fcc3195e
RS
842 (define-key map "\C-c\C-cr" 'html-radio-buttons)
843 (define-key map "\C-c\C-cc" 'html-checkboxes)
844 (define-key map "\C-c\C-cl" 'html-list-item)
845 (define-key map "\C-c\C-ch" 'html-href-anchor)
846 (define-key map "\C-c\C-cn" 'html-name-anchor)
847 (define-key map "\C-c\C-ci" 'html-image)
1caf38eb
RS
848 (if html-quick-keys
849 (progn
1caf38eb 850 (define-key map "\C-c-" 'html-horizontal-rule)
7e49eef2
RS
851 (define-key map "\C-co" 'html-ordered-list)
852 (define-key map "\C-cu" 'html-unordered-list)
1caf38eb 853 (define-key map "\C-cr" 'html-radio-buttons)
fcc3195e 854 (define-key map "\C-cc" 'html-checkboxes)
1caf38eb
RS
855 (define-key map "\C-cl" 'html-list-item)
856 (define-key map "\C-ch" 'html-href-anchor)
857 (define-key map "\C-cn" 'html-name-anchor)
858 (define-key map "\C-ci" 'html-image)))
859 (define-key map "\C-c\C-s" 'html-autoview-mode)
860 (define-key map "\C-c\C-v" 'browse-url-of-buffer)
861 (define-key map [menu-bar html] (cons "HTML" menu-map))
862 (define-key menu-map [html-autoview-mode]
863 '("Toggle Autoviewing" . html-autoview-mode))
864 (define-key menu-map [browse-url-of-buffer]
865 '("View Buffer Contents" . browse-url-of-buffer))
866 (define-key menu-map [nil] '("--"))
7e49eef2
RS
867 ;;(define-key menu-map "6" '("Heading 6" . html-headline-6))
868 ;;(define-key menu-map "5" '("Heading 5" . html-headline-5))
869 ;;(define-key menu-map "4" '("Heading 4" . html-headline-4))
870 (define-key menu-map "3" '("Heading 3" . html-headline-3))
871 (define-key menu-map "2" '("Heading 2" . html-headline-2))
872 (define-key menu-map "1" '("Heading 1" . html-headline-1))
1caf38eb 873 (define-key menu-map "l" '("Radio Buttons" . html-radio-buttons))
fcc3195e 874 (define-key menu-map "c" '("Checkboxes" . html-checkboxes))
1caf38eb 875 (define-key menu-map "l" '("List Item" . html-list-item))
7e49eef2
RS
876 (define-key menu-map "u" '("Unordered List" . html-unordered-list))
877 (define-key menu-map "o" '("Ordered List" . html-ordered-list))
fcc3195e 878 (define-key menu-map "-" '("Horizontal Rule" . html-horizontal-rule))
1caf38eb
RS
879 (define-key menu-map "\n" '("Line Break" . html-line))
880 (define-key menu-map "\r" '("Paragraph" . html-paragraph))
881 (define-key menu-map "i" '("Image" . html-image))
882 (define-key menu-map "h" '("Href Anchor" . html-href-anchor))
883 (define-key menu-map "n" '("Name Anchor" . html-name-anchor))
884 map)
885 "Keymap for commands for use in HTML mode.")
886
887
888(defvar html-face-tag-alist
889 '((bold . "b")
890 (italic . "i")
891 (underline . "u")
892 (modeline . "rev"))
893 "Value of `sgml-face-tag-alist' for HTML mode.")
894
895(defvar html-tag-face-alist
896 '(("b" . bold)
897 ("big" . bold)
898 ("blink" . highlight)
899 ("cite" . italic)
900 ("em" . italic)
901 ("h1" bold underline)
902 ("h2" bold-italic underline)
903 ("h3" italic underline)
904 ("h4" . underline)
905 ("h5" . underline)
906 ("h6" . underline)
907 ("i" . italic)
908 ("rev" . modeline)
909 ("s" . underline)
910 ("small" . default)
911 ("strong" . bold)
912 ("title" bold underline)
913 ("tt" . default)
914 ("u" . underline)
915 ("var" . italic))
916 "Value of `sgml-tag-face-alist' for HTML mode.")
917
918
919(defvar html-display-text
920 '((img . "[/]")
921 (hr . "----------")
922 (li . "o "))
923 "Value of `sgml-display-text' for HTML mode.")
924
925
926; should code exactly HTML 3 here when that is finished
927(defvar html-tag-alist
d10447ba
RS
928 (let* ((1-7 '(("1") ("2") ("3") ("4") ("5") ("6") ("7")))
929 (1-9 '(,@1-7 ("8") ("9")))
1caf38eb
RS
930 (align '(("align" ("left") ("center") ("right"))))
931 (valign '(("top") ("middle") ("bottom") ("baseline")))
932 (rel '(("next") ("previous") ("parent") ("subdocument") ("made")))
933 (href '("href" ("ftp:") ("file:") ("finger:") ("gopher:") ("http:")
934 ("mailto:") ("news:") ("rlogin:") ("telnet:") ("tn3270:")
fcc3195e 935 ("wais:") ("/cgi-bin/")))
1caf38eb
RS
936 (name '("name"))
937 (link `(,href
938 ("rel" ,@rel)
939 ("rev" ,@rel)
940 ("title")))
d10447ba
RS
941 (list '((nil \n ( "List item: "
942 "<li>" str \n))))
1caf38eb
RS
943 (cell `(t
944 ,align
945 ("valign" ,@valign)
946 ("colspan" ,@1-9)
947 ("rowspan" ,@1-9)
948 ("nowrap" t))))
949 ;; put ,-expressions first, else byte-compile chokes (as of V19.29)
950 ;; and like this it's more efficient anyway
951 `(("a" ,name ,@link)
952 ("base" t ,@href)
953 ("dir" ,@list)
d10447ba 954 ("font" nil "size" ("-1") ("+1") ("-2") ("+2") ,@1-7)
fcc3195e
RS
955 ("form" (\n _ \n "<input type=\"submit\" value=\"\">")
956 ("action" ,@(cdr href)) ("method" ("get") ("post")))
1caf38eb
RS
957 ("h1" ,@align)
958 ("h2" ,@align)
959 ("h3" ,@align)
960 ("h4" ,@align)
961 ("h5" ,@align)
962 ("h6" ,@align)
963 ("hr" t ("size" ,@1-9) ("width") ("noshade" t) ,@align)
964 ("img" t ("align" ,@valign ("texttop") ("absmiddle") ("absbottom"))
965 ("src") ("alt") ("width" "1") ("height" "1")
966 ("border" "1") ("vspace" "1") ("hspace" "1") ("ismap" t))
967 ("input" t ("size" ,@1-9) ("maxlength" ,@1-9) ("checked" t) ,name
fcc3195e
RS
968 ("type" ("text") ("password") ("checkbox") ("radio")
969 ("submit") ("reset"))
1caf38eb
RS
970 ("value"))
971 ("link" t ,@link)
972 ("menu" ,@list)
d10447ba 973 ("ol" ,@list ("type" ("A") ("a") ("I") ("i") ("1")))
1caf38eb
RS
974 ("p" t ,@align)
975 ("select" (nil \n
976 ("Text: "
977 "<option>" str \n))
978 ,name ("size" ,@1-9) ("multiple" t))
979 ("table" (nil \n
980 ((completing-read "Cell kind: " '(("td") ("th"))
981 nil t "t")
982 "<tr><" str ?> _ \n))
983 ("border" t ,@1-9) ("width" "10") ("cellpadding"))
984 ("td" ,@cell)
985 ("textarea" ,name ("rows" ,@1-9) ("cols" ,@1-9))
986 ("th" ,@cell)
d10447ba 987 ("ul" ,@list ("type" ("disc") ("circle") ("square")))
1caf38eb
RS
988
989 ,@sgml-tag-alist
990
991 ("abbrev")
992 ("acronym")
993 ("address")
994 ("array" (nil \n
995 ("Item: " "<item>" str \n))
996 "align")
997 ("au")
998 ("b")
999 ("big")
1000 ("blink")
1001 ("blockquote" \n)
1002 ("body" \n ("background" ".gif") ("bgcolor" "#") ("text" "#")
1003 ("link" "#") ("alink" "#") ("vlink" "#"))
1004 ("box" (nil _ "<over>" _))
1005 ("br" t ("clear" ("left") ("right")))
1006 ("caption" ("valign" ("top") ("bottom")))
1007 ("center" \n)
1008 ("cite")
1009 ("code" \n)
1010 ("dd" t)
1011 ("del")
1012 ("dfn")
1013 ("dl" (nil \n
1014 ( "Term: "
1015 "<dt>" str "<dd>" _ \n)))
1016 ("dt" (t _ "<dd>"))
1017 ("em")
d10447ba 1018 ;("fn" "id" "fn") ; ???
1caf38eb
RS
1019 ("head" \n)
1020 ("html" (\n
1021 "<head>\n"
1022 "<title>" (setq str (read-input "Title: ")) "</title>\n"
1023 "<body>\n<h1>" str "</h1>\n" _
1024 "\n<address>\n<a href=\"mailto:"
be047262 1025 user-mail-address
1caf38eb
RS
1026 "\">" (user-full-name) "</a>\n</address>"))
1027 ("i")
1028 ("ins")
1029 ("isindex" t ("action") ("prompt"))
1030 ("kbd")
1031 ("lang")
1032 ("li" t)
1033 ("math" \n)
1034 ("nobr")
1035 ("option" t ("value") ("label") ("selected" t))
1036 ("over" t)
1037 ("person")
1038 ("pre" \n)
1039 ("q")
1040 ("rev")
1041 ("s")
1042 ("samp")
1043 ("small")
1044 ("strong")
1045 ("sub")
1046 ("sup")
1047 ("title")
1048 ("tr" t)
1049 ("tt")
1050 ("u")
1051 ("var")
1052 ("wbr" t)))
1053 "*Value of `sgml-tag-alist' for HTML mode.")
1054
1055(defvar html-tag-help
1056 `(,@sgml-tag-help
1057 ("a" . "Anchor of point or link elsewhere")
1058 ("abbrev" . "?")
1059 ("acronym" . "?")
1060 ("address" . "Formatted mail address")
1061 ("array" . "Math array")
1062 ("au" . "?")
1063 ("b" . "Bold face")
1064 ("base" . "Base address for URLs")
1065 ("big" . "Font size")
1066 ("blink" . "Blinking text")
1067 ("blockquote" . "Indented quotation")
1068 ("body" . "Document body")
1069 ("box" . "Math fraction")
1070 ("br" . "Line break")
1071 ("caption" . "Table caption")
1072 ("center" . "Centered text")
1073 ("changed" . "Change bars")
1074 ("cite" . "Citation of a document")
1075 ("code" . "Formatted source code")
1076 ("dd" . "Definition of term")
1077 ("del" . "?")
1078 ("dfn" . "?")
1079 ("dir" . "Directory list (obsolete)")
1080 ("dl" . "Definition list")
1081 ("dt" . "Term to be definined")
1082 ("em" . "Emphasised")
1083 ("embed" . "Embedded data in foreign format")
1084 ("fig" . "Figure")
1085 ("figa" . "Figure anchor")
1086 ("figd" . "Figure description")
1087 ("figt" . "Figure text")
d10447ba 1088 ;("fn" . "?") ; ???
1caf38eb
RS
1089 ("font" . "Font size")
1090 ("form" . "Form with input fields")
1091 ("group" . "Document grouping")
1092 ("h1" . "Most important section headline")
1093 ("h2" . "Important section headline")
1094 ("h3" . "Section headline")
1095 ("h4" . "Minor section headline")
1096 ("h5" . "Unimportant section headline")
1097 ("h6" . "Least important section headline")
1098 ("head" . "Document header")
1099 ("hr" . "Horizontal rule")
1100 ("html" . "HTML Document")
1101 ("i" . "Italic face")
1102 ("img" . "Graphic image")
1103 ("input" . "Form input field")
1104 ("ins" . "?")
1105 ("isindex" . "Input field for index search")
1106 ("kbd" . "Keybard example face")
1107 ("lang" . "Natural language")
1108 ("li" . "List item")
1109 ("link" . "Link relationship")
1110 ("math" . "Math formula")
1111 ("menu" . "Menu list (obsolete)")
1112 ("mh" . "Form mail header")
1113 ("nextid" . "Allocate new id")
1114 ("nobr" . "Text without line break")
1115 ("ol" . "Ordered list")
1116 ("option" . "Selection list item")
1117 ("over" . "Math fraction rule")
1118 ("p" . "Paragraph start")
1119 ("panel" . "Floating panel")
1120 ("person" . "?")
1121 ("pre" . "Preformatted fixed width text")
1122 ("q" . "?")
1123 ("rev" . "Reverse video")
1124 ("s" . "?")
1125 ("samp" . "Sample text")
1126 ("select" . "Selection list")
1127 ("small" . "Font size")
1128 ("sp" . "Nobreak space")
1129 ("strong" . "Standout text")
1130 ("sub" . "Subscript")
1131 ("sup" . "Superscript")
1132 ("table" . "Table with rows and columns")
1133 ("tb" . "Table vertical break")
1134 ("td" . "Table data cell")
1135 ("textarea" . "Form multiline edit area")
1136 ("th" . "Table header cell")
1137 ("title" . "Document title")
1138 ("tr" . "Table row separator")
1139 ("tt" . "Typewriter face")
1140 ("u" . "Underlined text")
1141 ("ul" . "Unordered list")
1142 ("var" . "Math variable face")
1143 ("wbr" . "Enable <br> within <nobr>"))
1144"*Value of `sgml-tag-help' for HTML mode.")
1145
1146
1147
1148;;;###autoload
1149(defun html-mode ()
1150 "Major mode based on SGML mode for editing HTML documents.
fcc3195e
RS
1151This allows inserting skeleton costructs used in hypertext documents with
1152completion. See below for an introduction to HTML. Use
1153\\[browse-url-of-buffer] to see how this comes out. See also `sgml-mode' on
1154which this is based.
1caf38eb 1155
fcc3195e 1156Do \\[describe-variable] html- SPC and \\[describe-variable] sgml- SPC to see available variables.
1caf38eb
RS
1157
1158To write fairly well formatted pages you only need to know few things. Most
1159browsers have a function to read the source code of the page being seen, so
1160you can imitate various tricks. Here's a very short HTML primer which you
1161can also view with a browser to see what happens:
1162
1163<title>A Title Describing Contents</title> should be on every page. Pages can
1164have <h1>Very Major Headlines</h1> through <h6>Very Minor Headlines</h6>
1165<hr> Parts can be separated with horizontal rules.
1166
1167<p>Paragraphs only need an opening tag. Line breaks and multiple spaces are
1168ignored unless the text is <pre>preformatted.</pre> Text can be marked as
1169<b>bold</b>, <i>italic</i> or <u>underlined</u> using the normal M-g or
1170Edit/Text Properties/Face commands.
1171
1172Pages can have <a name=\"SOMENAME\">named points</a> and can link other points
1173to them with <a href=\"#SOMENAME\">see also somename</a>. In the same way <a
1174href=\"URL\">see also URL</a> where URL is a filename relative to current
f788776c 1175directory, or absolute as in `http://www.cs.indiana.edu/elisp/w3/docs.html'.
1caf38eb
RS
1176
1177Images in many formats can be inlined with <img src=\"URL\">.
1178
f788776c
RS
1179If you mainly create your own documents, `sgml-specials' might be
1180interesting. But note that some HTML 2 browsers can't handle `&apos;'.
1181To work around that, do:
1182 (eval-after-load \"sgml-mode\" '(aset sgml-char-names ?' nil))
1caf38eb 1183
1caf38eb
RS
1184\\{html-mode-map}"
1185 (interactive)
1186 (sgml-mode-common html-tag-face-alist html-display-text)
1187 (use-local-map html-mode-map)
1188 (make-local-variable 'sgml-tag-alist)
1189 (make-local-variable 'sgml-face-tag-alist)
1190 (make-local-variable 'sgml-tag-help)
1191 (make-local-variable 'outline-regexp)
1192 (make-local-variable 'outline-heading-end-regexp)
1193 (make-local-variable 'outline-level)
da84bdc4
RS
1194 (make-local-variable 'sentence-end)
1195 (setq sentence-end
1196 "[.?!][]\"')}]*\\(<[^>]*>\\)*\\($\\| $\\|\t\\| \\)[ \t\n]*")
1caf38eb
RS
1197 (setq mode-name "HTML"
1198 major-mode 'html-mode
1199 sgml-tag-alist html-tag-alist
1200 sgml-face-tag-alist html-face-tag-alist
1201 sgml-tag-help html-tag-help
1202 outline-regexp "^.*<[Hh][1-6]\\>"
1203 outline-heading-end-regexp "</[Hh][1-6]>"
1204 outline-level (lambda ()
1205 (char-after (1- (match-end 0)))))
1206 (run-hooks 'html-mode-hook))
1207
1208
1209(define-skeleton html-href-anchor
1210 "HTML anchor tag with href attribute."
a391b179
RS
1211 "URL: "
1212 '(setq input "http:")
1213 "<a href=\"" str "\">" _ "</a>")
1caf38eb
RS
1214
1215(define-skeleton html-name-anchor
1216 "HTML anchor tag with name attribute."
a391b179
RS
1217 "Name: "
1218 "<a name=\"" str "\">" _ "</a>")
1caf38eb 1219
7e49eef2
RS
1220(define-skeleton html-headline-1
1221 "HTML level 1 headline tags."
1222 nil
1223 "<h1>" _ "</h1>")
1224
1225(define-skeleton html-headline-2
1226 "HTML level 2 headline tags."
1227 nil
1228 "<h2>" _ "</h2>")
1229
1230(define-skeleton html-headline-3
1231 "HTML level 3 headline tags."
1232 nil
1233 "<h3>" _ "</h3>")
1234
1235(define-skeleton html-headline-4
1236 "HTML level 4 headline tags."
1237 nil
1238 "<h4>" _ "</h4>")
1239
1240(define-skeleton html-headline-5
1241 "HTML level 5 headline tags."
1242 nil
1243 "<h5>" _ "</h5>")
1244
1245(define-skeleton html-headline-6
1246 "HTML level 6 headline tags."
1247 nil
1248 "<h6>" _ "</h6>")
1caf38eb
RS
1249
1250(define-skeleton html-horizontal-rule
1251 "HTML horizontal rule tag."
1252 nil
1253 "<hr>" \n)
1254
1255(define-skeleton html-image
1256 "HTML image tag."
1257 nil
a391b179 1258 "<img src=\"" _ "\">")
1caf38eb
RS
1259
1260(define-skeleton html-line
1261 "HTML line break tag."
1262 nil
1263 "<br>" \n)
1264
7e49eef2
RS
1265(define-skeleton html-ordered-list
1266 "HTML ordered list tags."
1267 nil
a391b179 1268 "<ol>" \n
7e49eef2
RS
1269 "<li>" _ \n
1270 "</ol>")
1271
1272(define-skeleton html-unordered-list
1273 "HTML unordered list tags."
1274 nil
a391b179 1275 "<ul>" \n
1caf38eb 1276 "<li>" _ \n
7e49eef2 1277 "</ul>")
1caf38eb
RS
1278
1279(define-skeleton html-list-item
1280 "HTML list item tag."
1281 nil
1282 (if (bolp) nil '\n)
1283 "<li>")
1284
1285(define-skeleton html-paragraph
1286 "HTML paragraph tag."
1287 nil
1288 (if (bolp) nil ?\n)
1289 \n "<p>")
1290
fcc3195e
RS
1291(define-skeleton html-checkboxes
1292 "Group of connected checkbox inputs."
1293 nil
a391b179
RS
1294 '(setq v1 nil
1295 v2 nil)
1296 ("Value: "
d10447ba 1297 "<input type=\"" (identity "checkbox") ; see comment above about identity
a391b179 1298 "\" name=\"" (or v1 (setq v1 (skeleton-read "Name: ")))
fcc3195e 1299 "\" value=\"" str ?\"
a391b179
RS
1300 (if (y-or-n-p "Set \"checked\" attribute? ")
1301 (funcall skeleton-transformation " checked")) ">"
1302 (skeleton-read "Text: " (capitalize str))
1303 (or v2 (setq v2 (if (y-or-n-p "Newline after text? ")
1304 (funcall skeleton-transformation "<br>")
1305 "")))
1306 \n))
fcc3195e 1307
1caf38eb
RS
1308(define-skeleton html-radio-buttons
1309 "Group of connected radio button inputs."
1310 nil
a391b179
RS
1311 '(setq v1 nil
1312 v2 (cons nil nil))
1313 ("Value: "
d10447ba 1314 "<input type=\"" (identity "radio") ; see comment above about identity
a391b179 1315 "\" name=\"" (or (car v2) (setcar v2 (skeleton-read "Name: ")))
1caf38eb 1316 "\" value=\"" str ?\"
a391b179
RS
1317 (if (and (not v1) (setq v1 (y-or-n-p "Set \"checked\" attribute? ")))
1318 (funcall skeleton-transformation " checked") ">")
1319 (skeleton-read "Text: " (capitalize str))
1320 (or (cdr v2) (setcdr v2 (if (y-or-n-p "Newline after text? ")
1321 (funcall skeleton-transformation "<br>")
1322 "")))
1323 \n))
1caf38eb
RS
1324
1325
1326(defun html-autoview-mode (&optional arg)
1327 "Toggle automatic viewing via `html-viewer' upon saving buffer.
1328With positive prefix ARG always turns viewing on, with negative ARG always off.
1329Can be used as a value for `html-mode-hook'."
1330 (interactive "P")
1331 (if (setq arg (if arg
1332 (< (prefix-numeric-value arg) 0)
1333 (and (boundp 'after-save-hook)
1334 (memq 'browse-url-of-buffer after-save-hook))))
1335 (setq after-save-hook (delq 'browse-url-of-buffer after-save-hook))
1336 (make-local-hook 'after-save-hook)
1337 (add-hook 'after-save-hook 'browse-url-of-buffer nil t))
1338 (message "Autoviewing turned %s."
1339 (if arg "off" "on")))
1340
72c0ae01 1341;;; sgml-mode.el ends here