Minor code cleanup to address elint issues.
[muse-el.git] / muse-html.el
blob9be0a4dee825432b971a7c4f3f448db4fd7cbbec
1 ;;; muse-html.el --- Publish to HTML and XHTML.
3 ;; Copyright (C) 2004, 2005 Free Software Foundation, Inc.
5 ;; This file is not part of GNU Emacs.
7 ;; This is free software; you can redistribute it and/or modify it under
8 ;; the terms of the GNU General Public License as published by the Free
9 ;; Software Foundation; either version 2, or (at your option) any later
10 ;; version.
12 ;; This is distributed in the hope that it will be useful, but WITHOUT
13 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 ;; for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 ;; Boston, MA 02110-1301, USA.
22 ;;; Commentary:
24 ;;; Contributors:
26 ;; Zhiqiang Ye (yezq AT mail DOT cbi DOT pku DOT edu DOT cn) suggested
27 ;; appending an 'encoding="..."' fragment to the first line of the
28 ;; sample publishing header so that when editing the resulting XHTML
29 ;; file, Emacs would use the proper encoding.
31 ;;; Code:
33 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
35 ;; Muse HTML Publishing
37 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
39 (require 'muse-publish)
40 (require 'muse-regexps)
42 (defgroup muse-html nil
43 "Options controlling the behaviour of Muse HTML publishing.
44 See `muse-html' for more information."
45 :group 'muse-publish)
47 (defcustom muse-html-extension ".html"
48 "Default file extension for publishing HTML files."
49 :type 'string
50 :group 'muse-html)
52 (defcustom muse-html-style-sheet
53 "<style type=\"text/css\">
54 body {
55 background: white; color: black;
56 margin-left: 3%; margin-right: 7%;
59 p { margin-top: 1% }
60 p.verse { margin-left: 3% }
62 .example { margin-left: 3% }
64 h2 {
65 margin-top: 25px;
66 margin-bottom: 0px;
68 h3 { margin-bottom: 0px; }
69 </style>"
70 "Store your stylesheet definitions here.
71 This is used in `muse-html-header'.
72 You can put raw CSS in here or a <link> tag to an external stylesheet.
73 This text may contain <lisp> markup tags.
75 An example of using <link> is as follows.
77 <link rel=\"stylesheet\" type=\"text/css\" charset=\"utf-8\" media=\"all\" href=\"/default.css\">
79 If you are using XHTML, make sure to close the tag properly, as
80 shown in the following example.
82 <link rel=\"stylesheet\" type=\"text/css\" charset=\"utf-8\" media=\"all\" href=\"/default.css\" />"
83 :type 'string
84 :group 'muse-html)
86 (defcustom muse-html-header
87 "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0//EN\">
88 <html>
89 <head>
90 <title><lisp>
91 (concat (muse-publishing-directive \"title\")
92 (let ((author (muse-publishing-directive \"author\")))
93 (if (not (string= author (user-full-name)))
94 (concat \" (by \" author \")\"))))</lisp></title>
95 <meta name=\"generator\" content=\"muse.el\">
96 <meta http-equiv=\"<lisp>muse-html-meta-http-equiv</lisp>\"
97 content=\"<lisp>muse-html-meta-content-type</lisp>\">
98 <lisp>
99 (let ((maintainer (muse-style-element :maintainer)))
100 (when maintainer
101 (concat \"<link rev=\\\"made\\\" href=\\\"\" maintainer \"\\\">\")))
102 </lisp>
103 <lisp>muse-html-style-sheet</lisp>
104 </head>
105 <body>
106 <h1><lisp>
107 (concat (muse-publishing-directive \"title\")
108 (let ((author (muse-publishing-directive \"author\")))
109 (if (not (string= author (user-full-name)))
110 (concat \" (by \" author \")\"))))</lisp></h1>
111 <!-- Page published by Emacs Muse begins here -->\n"
112 "Header used for publishing HTML files."
113 :type '(choice string file)
114 :group 'muse-html)
116 (defcustom muse-html-footer "
117 <!-- Page published by Emacs Muse ends here -->
118 </body>
119 </html>\n"
120 "Footer used for publishing HTML files."
121 :type '(choice string file)
122 :group 'muse-html)
124 (defcustom muse-xhtml-header
125 "<?xml version=\"1.0\" encoding=\"<lisp>
126 (muse-html-encoding)</lisp>\"?>
127 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
128 \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
129 <html xmlns=\"http://www.w3.org/1999/xhtml\">
130 <head>
131 <title><lisp>
132 (concat (muse-publishing-directive \"title\")
133 (let ((author (muse-publishing-directive \"author\")))
134 (if (not (string= author (user-full-name)))
135 (concat \" (by \" author \")\"))))</lisp></title>
136 <meta name=\"generator\" content=\"muse.el\" />
137 <meta http-equiv=\"<lisp>muse-html-meta-http-equiv</lisp>\"
138 content=\"<lisp>muse-html-meta-content-type</lisp>\" />
139 <lisp>
140 (let ((maintainer (muse-style-element :maintainer)))
141 (when maintainer
142 (concat \"<link rev=\\\"made\\\" href=\\\"\" maintainer \"\\\" />\")))
143 </lisp>
144 <lisp>muse-html-style-sheet</lisp>
145 </head>
146 <body>
147 <h1><lisp>
148 (concat (muse-publishing-directive \"title\")
149 (let ((author (muse-publishing-directive \"author\")))
150 (if (not (string= author (user-full-name)))
151 (concat \" (by \" author \")\"))))</lisp></h1>
152 <!-- Page published by Emacs Muse begins here -->\n"
153 "Header used for publishing XHTML files."
154 :type '(choice string file)
155 :group 'muse-html)
157 (defcustom muse-xhtml-footer "
158 <!-- Page published by Emacs Muse ends here -->
159 </body>
160 </html>\n"
161 "Footer used for publishing XHTML files."
162 :type '(choice string file)
163 :group 'muse-html)
165 (defcustom muse-html-anchor-on-word nil
166 "When true, anchors surround the closest word. This allows you
167 to select them in a browser (ie, for pasting), but has the
168 side-effect of marking up headers in multiple colours if your
169 header style is different from your link style."
170 :type 'boolean
171 :group 'muse-html)
173 (defcustom muse-html-table-attributes
174 "class=\"muse-table\" border=\"2\" cellpadding=\"5\""
175 "The attribute to be used with HTML <table> tags.
176 Note that since Muse supports direct insertion of HTML tags, you
177 can easily create any kind of table you want, as long as each
178 line begins at column 0 (to prevent it from being blockquote'd).
179 To make such a table, use this idiom:
181 <verbatim>
182 <table>
183 [... contents of my table, in raw HTML ...]
184 </verbatim></table>
186 It may look strange to have the tags out of sequence, but this is
187 because the Muse verbatim tag is handled during a different pass
188 than the HTML table tag."
189 :type 'string
190 :group 'muse-html)
192 (defcustom muse-html-markup-regexps
193 `(;; join together the parts of a list or table
194 (10000 "</\\([oud]l\\)>\\s-*<\\1>\\s-*" 0 "")
195 (10100 ,(concat " </t\\(body\\|head\\|foot\\)>\\s-*</table>\\s-*"
196 "<table[^>]*>\\s-*<t\\1>\n") 0 "")
197 (10200 "</table>\\s-*<table[^>]*>\n" 0 "")
199 ;; beginning of doc, end of doc, or plain paragraph separator
200 (10300 ,(concat "\\(\n</\\(blockquote\\|center\\)>\\)?"
201 "\\(?:\n\\(["
202 muse-regexp-blank
203 "]*\n\\)+\\|\\`\\s-*\\|\\s-*\\'\\)"
204 "\\(<\\(blockquote\\|center\\)>\n\\)?")
205 0 muse-html-markup-paragraph))
206 "List of markup rules for publishing a Muse page to HTML.
207 For more on the structure of this list, see `muse-publish-markup-regexps'."
208 :type '(repeat (choice
209 (list :tag "Markup rule"
210 integer
211 (choice regexp symbol)
212 integer
213 (choice string function symbol))
214 function))
215 :group 'muse-html)
217 (defcustom muse-html-markup-functions
218 '((anchor . muse-html-markup-anchor)
219 (table . muse-html-markup-table)
220 (footnote . muse-html-markup-footnote))
221 "An alist of style types to custom functions for that kind of text.
222 For more on the structure of this list, see
223 `muse-publish-markup-functions'."
224 :type '(alist :key-type symbol :value-type function)
225 :group 'muse-html)
227 (defcustom muse-html-markup-strings
228 '((image-with-desc . "<img src=\"%s\" alt=\"%s\">")
229 (image-link . "<img src=\"%s\">")
230 (url-with-image . "<a class=\"image-link\" href=\"%s\"><img src=\"%s\"></a>")
231 (url-link . "<a href=\"%s\">%s</a>")
232 (email-addr . "<a href=\"mailto:%s\">%s</a>")
233 (emdash . " &mdash; ")
234 (rule . "<hr>")
235 (fn-sep . "<hr>\n")
236 (enddots . "....")
237 (dots . "...")
238 (section . "<h2>")
239 (section-end . "</h2>")
240 (subsection . "<h3>")
241 (subsection-end . "</h3>")
242 (subsubsection . "<h4>")
243 (subsubsection-end . "</h4>")
244 (begin-underline . "<u>")
245 (end-underline . "</u>")
246 (begin-literal . "<code>")
247 (end-literal . "</code>")
248 (begin-emph . "<em>")
249 (end-emph . "</em>")
250 (begin-more-emph . "<strong>")
251 (end-more-emph . "</strong>")
252 (begin-most-emph . "<strong><em>")
253 (end-most-emph . "</em></strong>")
254 (begin-verse . "<p class=\"verse\">\n")
255 (verse-space . "&nbsp;&nbsp;")
256 (end-verse-line . "<br>")
257 (last-stanza-end . "<br>")
258 (empty-verse-line . "<br>")
259 (end-verse . "</p>")
260 (begin-example . "<pre class=\"example\">")
261 (end-example . "</pre>")
262 (begin-center . "<center>\n")
263 (end-center . "\n</center>")
264 (begin-quote . "<blockquote>\n")
265 (end-quote . "\n</blockquote>")
266 (begin-uli . "<ul>\n<li>")
267 (end-uli . "</li>\n</ul>")
268 (begin-oli . "<ol>\n<li>")
269 (end-oli . "</li>\n</ol>")
270 (begin-ddt . "<dl>\n<dt><strong>")
271 (start-dde . "</strong></dt>\n<dd>")
272 (end-ddt . "</dd>\n</dl>"))
273 "Strings used for marking up text.
274 These cover the most basic kinds of markup, the handling of which
275 differs little between the various styles."
276 :type '(alist :key-type symbol :value-type string)
277 :group 'muse-html)
279 (defcustom muse-xhtml-markup-strings
280 '((image-with-desc . "<img src=\"%s\" alt=\"%s\" />")
281 (image-link . "<img src=\"%s\" alt=\"\" />")
282 (url-with-image . "<a class=\"image-link\" href=\"%s\"><img src=\"%s\" alt=\"\" /></a>")
283 (rule . "<hr />")
284 (fn-sep . "<hr />\n")
285 (begin-underline . "<span style=\"text-decoration: underline;\">\n")
286 (end-underline . "</span>")
287 (begin-center . "<span style=\"text-align: center;\">\n")
288 (end-verse-line . "<br />")
289 (last-stanza-end . "<br />")
290 (empty-verse-line . "<br />")
291 (end-center . "\n</span>"))
292 "Strings used for marking up text.
293 These cover the most basic kinds of markup, the handling of which
294 differs little between the various styles.
296 If a markup rule is not found here, `muse-html-markup-strings' is
297 searched."
298 :type '(alist :key-type symbol :value-type string)
299 :group 'muse-html)
301 (defcustom muse-html-markup-tags
302 '(("class" t t muse-html-class-tag))
303 "A list of tag specifications, for specially marking up HTML."
304 :type '(repeat (list (string :tag "Markup tag")
305 (boolean :tag "Expect closing tag" :value t)
306 (boolean :tag "Parse attributes" :value nil)
307 function))
308 :group 'muse-html)
310 (defcustom muse-html-markup-specials
311 '((?\" . "&quot;")
312 (?\< . "&lt;")
313 (?\> . "&gt;")
314 (?\& . "&amp;"))
315 "A table of characters which must be represented specially."
316 :type '(alist :key-type character :value-type string)
317 :group 'muse-html)
319 (defcustom muse-html-meta-http-equiv "Content-Type"
320 "The http-equiv attribute used for the HTML <meta> tag."
321 :type 'string
322 :group 'muse-html)
324 (defcustom muse-html-meta-content-type "text/html"
325 "The content type used for the HTML <meta> tag."
326 :type 'string
327 :group 'muse-html)
329 (defcustom muse-html-meta-content-encoding (if (featurep 'mule)
330 'detect
331 "iso-8859-1")
332 "If set to the symbol 'detect, use `muse-coding-map' to try
333 and determine the HTML charset from emacs's coding. If set to a string, this
334 string will be used to force a particular charset"
335 :type '(choice string symbol)
336 :group 'muse-html)
338 (defcustom muse-html-charset-default "iso-8859-1"
339 "The default HTML meta charset to use if no translation is found in
340 `muse-coding-map'"
341 :type 'string
342 :group 'muse-html)
344 (defcustom muse-html-encoding-default 'iso-8859-1
345 "The default emacs coding use if no special characters are found"
346 :type 'symbol
347 :group 'muse-html)
349 (defcustom muse-html-encoding-map
350 '((iso-2022-jp . "iso-2022-jp")
351 (utf-8 . "utf-8")
352 (japanese-iso-8bit . "euc-jp")
353 (chinese-big5 . "big5")
354 (mule-utf-8 . "utf-8")
355 (chinese-iso-8bit . "gb2312")
356 (chinese-gbk . "gbk"))
357 "An alist mapping emacs coding systems to appropriate HTML charsets.
358 Use the base name of the coding system (ie, without the -unix)"
359 :type '(alist :key-type coding-system :value-type string)
360 :group 'muse-html)
362 (defun muse-html-transform-content-type (content-type)
363 "Using `muse-html-encoding-map', try and resolve an emacs coding
364 system to an associated HTML coding system. If no match is found,
365 `muse-html-charset-default' is used instead."
366 (let ((match (assoc (coding-system-base content-type)
367 muse-html-encoding-map)))
368 (if match
369 (cdr match)
370 muse-html-charset-default)))
372 (defun muse-html-insert-anchor (anchor)
373 "Insert an anchor, either around the word at point, or within a tag."
374 (skip-chars-forward muse-regexp-space)
375 (if (looking-at "<\\([^ />]+\\)>")
376 (let ((tag (match-string 1)))
377 (goto-char (match-end 0))
378 (insert "<a name=\"" anchor "\" id=\"" anchor "\">")
379 (when muse-html-anchor-on-word
380 (or (and (search-forward (format "</%s>" tag)
381 (line-end-position) t)
382 (goto-char (match-beginning 0)))
383 (forward-word 1)))
384 (insert "</a>"))
385 (insert "<a name=\"" anchor "\" id=\"" anchor "\">")
386 (when muse-html-anchor-on-word
387 (forward-word 1))
388 (insert "</a>")))
390 (defun muse-html-markup-paragraph ()
391 (let ((end (copy-marker (match-end 0) t)))
392 (goto-char (match-beginning 0))
393 (when (save-excursion
394 (save-match-data
395 (and (re-search-backward "<\\(/\\)?p[ >]" nil t)
396 (not (string-equal (match-string 1) "/")))))
397 (insert "</p>"))
398 (goto-char end))
399 (if (eobp)
400 (cond
401 ((bolp)
402 nil)
404 (insert "\n")))
405 (unless (and (eq (char-after) ?\<)
406 (not (or (looking-at "<\\(em\\|strong\\|code\\)>")
407 (and (looking-at "<a ")
408 (not (looking-at "<a[^>]+><img"))))))
409 (cond
410 ((muse-looking-back "\\(</h[1-4]>\\|<hr>\\)\n\n")
411 (insert "<p class=\"first\">"))
412 ((muse-looking-back "<\\(blockquote\\|center\\)>\n")
413 (insert "<p class=\"quoted\">"))
415 (insert "<p>"))))))
417 (defun muse-html-markup-anchor ()
418 (save-match-data
419 (muse-html-insert-anchor (match-string 1))) "")
421 (defun muse-html-escape-string (str)
422 "Convert to character entities any non-alphanumeric characters
423 outside a few punctuation symbols, that risk being misinterpreted
424 if not escaped."
425 (when str
426 (let (pos code len)
427 (save-match-data
428 (while (setq pos (string-match (concat "[^-"
429 muse-regexp-alnum
430 "/:._=@\\?~#]")
431 str pos))
432 (setq code (int-to-string (aref str pos))
433 len (length code)
434 str (replace-match (concat "&#" code ";") nil nil str)
435 pos (+ 3 len pos)))
436 str))))
438 (defun muse-html-markup-footnote ()
439 (if (/= (line-beginning-position) (match-beginning 0))
440 "<sup><a name=\"fnr.\\1\" href=\"#fn.\\1\">\\1</a></sup>"
441 (prog1
442 "<p class=\"footnote\"><a name=\"fn.\\1\" href=\"#fnr.\\1\">\\1.</a>"
443 (save-excursion
444 (save-match-data
445 (let* ((beg (goto-char (match-end 0)))
446 (end (and (search-forward "\n\n" nil t)
447 (prog1
448 (copy-marker (match-beginning 0))
449 (goto-char beg)))))
450 (while (re-search-forward (concat "^["
451 muse-regexp-blank
452 "]+\\([^\n]\\)")
453 end t)
454 (replace-match "\\1" t))))))))
456 (defun muse-html-markup-table ()
457 (let* ((str (prog1
458 (match-string 1)
459 (delete-region (match-beginning 0) (match-end 0))))
460 (fields (split-string str "\\s-*|+\\s-*"))
461 (type (and (string-match "\\s-*\\(|+\\)\\s-*" str)
462 (length (match-string 1 str))))
463 (part (cond ((= type 1) "tbody")
464 ((= type 2) "thead")
465 ((= type 3) "tfoot")))
466 (col (cond ((= type 1) "td")
467 ((= type 2) "th")
468 ((= type 3) "td")))
469 field)
470 (insert "<table " muse-html-table-attributes ">\n"
471 " <" part ">\n"
472 " <tr>\n")
473 (dolist (field fields)
474 (insert " <" col ">" field "</" col ">\n"))
475 (insert " </tr>\n"
476 " </" part ">\n"
477 "</table>\n")))
479 ;; Handling of tags for HTML
481 (defun muse-html-insert-contents (depth)
482 (let ((max-depth (or depth 2))
483 (index 1)
484 base contents l)
485 (save-excursion
486 (goto-char (point-min))
487 (search-forward "Page published by Emacs Muse begins here" nil t)
488 (catch 'done
489 (while (re-search-forward "^<h\\([0-9]+\\)>\\(.+?\\)</h\\1>" nil t)
490 (unless (get-text-property (point) 'read-only)
491 (setq l (1- (string-to-number (match-string 1))))
492 (if (null base)
493 (setq base l)
494 (if (< l base)
495 (throw 'done t)))
496 (when (<= l max-depth)
497 (setq contents (cons (cons l (match-string-no-properties 2))
498 contents))
499 (goto-char (match-beginning 2))
500 (muse-html-insert-anchor (concat "sec" (int-to-string index)))
501 (setq index (1+ index)))))))
502 (setq index 1 contents (reverse contents))
503 (let ((depth 1) (sub-open 0) (p (point)))
504 (insert "<dl class=\"contents\">\n")
505 (while contents
506 (insert "<dt class=\"contents\">\n")
507 (insert "<a href=\"#sec" (int-to-string index) "\">"
508 (muse-publish-strip-tags (cdar contents))
509 "</a>\n")
510 (setq index (1+ index))
511 (insert "</dt>\n")
512 (setq depth (caar contents)
513 contents (cdr contents))
514 (if contents
515 (cond
516 ((< (caar contents) depth)
517 (let ((idx (caar contents)))
518 (while (< idx depth)
519 (insert "</dl>\n</dd>\n")
520 (setq sub-open (1- sub-open)
521 idx (1+ idx)))))
522 ((> (caar contents) depth) ; can't jump more than one ahead
523 (insert "<dd>\n<dl class=\"contents\">\n")
524 (setq sub-open (1+ sub-open))))))
525 (while (> sub-open 0)
526 (insert "</dl>\n</dd>\n")
527 (setq sub-open (1- sub-open)))
528 (insert "</dl>\n")
529 (muse-publish-mark-read-only p (point)))))
531 (defun muse-html-class-tag (beg end attrs)
532 (goto-char beg)
533 (insert "<span class=\"" (cdr (assoc "name" attrs)) "\">")
534 (goto-char end)
535 (insert "</span>"))
537 ;; Register the Muse HTML Publisher
539 (defun muse-html-browse-file (file)
540 (browse-url (concat "file:" file)))
542 (defun muse-html-encoding ()
543 (if (stringp muse-html-meta-content-encoding)
544 muse-html-meta-content-encoding
545 (muse-html-transform-content-type
546 (or buffer-file-coding-system
547 muse-html-encoding-default))))
549 (defun muse-html-prepare-buffer ()
550 (set (make-local-variable 'muse-publish-url-transforms)
551 (cons 'muse-html-escape-string muse-publish-url-transforms))
552 (make-local-variable 'muse-html-meta-http-equiv)
553 (set (make-local-variable 'muse-html-meta-content-type)
554 (concat muse-html-meta-content-type "; charset="
555 (muse-html-encoding))))
557 (defun muse-html-finalize-buffer ()
558 (when muse-publish-generate-contents
559 (goto-char (car muse-publish-generate-contents))
560 (muse-html-insert-contents (cdr muse-publish-generate-contents)))
561 (when (memq buffer-file-coding-system '(no-conversion undecided-unix))
562 ;; make it agree with the default charset
563 (setq buffer-file-coding-system muse-html-encoding-default)))
565 (unless (assoc "html" muse-publishing-styles)
566 (muse-define-style "html"
567 :suffix 'muse-html-extension
568 :regexps 'muse-html-markup-regexps
569 :functions 'muse-html-markup-functions
570 :strings 'muse-html-markup-strings
571 :tags 'muse-html-markup-tags
572 :specials 'muse-html-markup-specials
573 :before 'muse-html-prepare-buffer
574 :after 'muse-html-finalize-buffer
575 :header 'muse-html-header
576 :footer 'muse-html-footer
577 :browser 'muse-html-browse-file)
579 (muse-derive-style "xhtml" "html"
580 :strings 'muse-xhtml-markup-strings
581 :header 'muse-xhtml-header
582 :footer 'muse-xhtml-footer))
584 (provide 'muse-html)
586 ;;; muse-html.el ends here