lisp/muse-html.el

   1 ;;; muse-html.el --- publish to HTML and XHTML
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
   4
   5 ;; This file is part of Emacs Muse.  It is not part of GNU Emacs.
   6
   7 ;; Emacs Muse is free software; you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published
   9 ;; by the Free Software Foundation; either version 3, or (at your
  10 ;; option) any later version.
  11
  12 ;; Emacs Muse is distributed in the hope that it will be useful, but
  13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ;; General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with Emacs Muse; 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.
  21
  22 ;;; Commentary:
  23
  24 ;;; Contributors:
  25
  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.
  30
  31 ;; Sun Jiyang (sunyijiang AT gmail DOT com) came up with the idea for
  32 ;; the <src> tag and provided an implementation for emacs-wiki.
  33
  34 ;; Charles Wang (wcy123 AT gmail DOT com) provided an initial
  35 ;; implementation of the <src> tag for Muse.
  36
  37 ;; Clinton Ebadi (clinton AT unknownlamer DOT org) provided further
  38 ;; ideas for the implementation of the <src> tag.
  39
  40 ;;; Code:
  41
  42 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  43 ;;
  44 ;; Muse HTML Publishing
  45 ;;
  46 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  47
  48 (require 'muse-publish)
  49 (require 'muse-regexps)
  50 (require 'muse-xml-common)
  51
  52 (defgroup muse-html nil
  53   "Options controlling the behavior of Muse HTML publishing."
  54   :group 'muse-publish)
  55
  56 (defcustom muse-html-extension ".html"
  57   "Default file extension for publishing HTML files."
  58   :type 'string
  59   :group 'muse-html)
  60
  61 (defcustom muse-xhtml-extension ".html"
  62   "Default file extension for publishing XHTML files."
  63   :type 'string
  64   :group 'muse-html)
  65
  66 (defcustom muse-html-style-sheet
  67   "<style type=\"text/css\">
  68 body {
  69   background: white; color: black;
  70   margin-left: 3%; margin-right: 7%;
  71 }
  72
  73 p { margin-top: 1% }
  74 p.verse { margin-left: 3% }
  75
  76 .example { margin-left: 3% }
  77
  78 h2 {
  79   margin-top: 25px;
  80   margin-bottom: 0px;
  81 }
  82 h3 { margin-bottom: 0px; }
  83     </style>"
  84   "Store your stylesheet definitions here.
  85 This is used in `muse-html-header'.
  86 You can put raw CSS in here or a <link> tag to an external stylesheet.
  87 This text may contain <lisp> markup tags.
  88
  89 An example of using <link> is as follows.
  90
  91 <link rel=\"stylesheet\" type=\"text/css\" charset=\"utf-8\" media=\"all\" href=\"/default.css\">"
  92   :type 'string
  93   :group 'muse-html)
  94
  95 (defcustom muse-xhtml-style-sheet
  96   "<style type=\"text/css\">
  97 body {
  98   background: white; color: black;
  99   margin-left: 3%; margin-right: 7%;
 100 }
 101
 102 p { margin-top: 1% }
 103 p.verse { margin-left: 3% }
 104
 105 .example { margin-left: 3% }
 106
 107 h2 {
 108   margin-top: 25px;
 109   margin-bottom: 0px;
 110 }
 111 h3 { margin-bottom: 0px; }
 112     </style>"
 113   "Store your stylesheet definitions here.
 114 This is used in `muse-xhtml-header'.
 115 You can put raw CSS in here or a <link> tag to an external stylesheet.
 116 This text may contain <lisp> markup tags.
 117
 118 An example of using <link> is as follows.
 119
 120 <link rel=\"stylesheet\" type=\"text/css\" charset=\"utf-8\" media=\"all\" href=\"/default.css\" />"
 121   :type 'string
 122   :group 'muse-html)
 123
 124 (defcustom muse-html-header
 125   "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">
 126 <html>
 127   <head>
 128     <title><lisp>
 129   (concat (muse-publishing-directive \"title\")
 130           (let ((author (muse-publishing-directive \"author\")))
 131             (if (not (string= author (user-full-name)))
 132                 (concat \" (by \" author \")\"))))</lisp></title>
 133     <meta name=\"generator\" content=\"muse.el\">
 134     <meta http-equiv=\"<lisp>muse-html-meta-http-equiv</lisp>\"
 135           content=\"<lisp>muse-html-meta-content-type</lisp>\">
 136     <lisp>
 137       (let ((maintainer (muse-style-element :maintainer)))
 138         (when maintainer
 139           (concat \"<link rev=\\\"made\\\" href=\\\"\" maintainer \"\\\">\")))
 140     </lisp><lisp>
 141       (muse-style-element :style-sheet muse-publishing-current-style)
 142     </lisp>
 143   </head>
 144   <body>
 145     <h1><lisp>
 146   (concat (muse-publishing-directive \"title\")
 147           (let ((author (muse-publishing-directive \"author\")))
 148             (if (not (string= author (user-full-name)))
 149                 (concat \" (by \" author \")\"))))</lisp></h1>
 150     <!-- Page published by Emacs Muse begins here -->\n"
 151   "Header used for publishing HTML files.  This may be text or a filename."
 152   :type 'string
 153   :group 'muse-html)
 154
 155 (defcustom muse-html-footer "
 156 <!-- Page published by Emacs Muse ends here -->
 157   </body>
 158 </html>\n"
 159   "Footer used for publishing HTML files.  This may be text or a filename."
 160   :type 'string
 161   :group 'muse-html)
 162
 163 (defcustom muse-xhtml-header
 164   "<?xml version=\"1.0\" encoding=\"<lisp>
 165   (muse-html-encoding)</lisp>\"?>
 166 <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
 167     \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
 168 <html xmlns=\"http://www.w3.org/1999/xhtml\">
 169   <head>
 170     <title><lisp>
 171   (concat (muse-publishing-directive \"title\")
 172           (let ((author (muse-publishing-directive \"author\")))
 173             (if (not (string= author (user-full-name)))
 174                 (concat \" (by \" author \")\"))))</lisp></title>
 175     <meta name=\"generator\" content=\"muse.el\" />
 176     <meta http-equiv=\"<lisp>muse-html-meta-http-equiv</lisp>\"
 177           content=\"<lisp>muse-html-meta-content-type</lisp>\" />
 178     <lisp>
 179       (let ((maintainer (muse-style-element :maintainer)))
 180         (when maintainer
 181           (concat \"<link rev=\\\"made\\\" href=\\\"\" maintainer \"\\\" />\")))
 182     </lisp><lisp>
 183       (muse-style-element :style-sheet muse-publishing-current-style)
 184     </lisp>
 185   </head>
 186   <body>
 187     <h1><lisp>
 188   (concat (muse-publishing-directive \"title\")
 189           (let ((author (muse-publishing-directive \"author\")))
 190             (if (not (string= author (user-full-name)))
 191                 (concat \" (by \" author \")\"))))</lisp></h1>
 192     <!-- Page published by Emacs Muse begins here -->\n"
 193   "Header used for publishing XHTML files.  This may be text or a filename."
 194   :type 'string
 195   :group 'muse-html)
 196
 197 (defcustom muse-xhtml-footer "
 198 <!-- Page published by Emacs Muse ends here -->
 199   </body>
 200 </html>\n"
 201   "Footer used for publishing XHTML files.  This may be text or a filename."
 202   :type 'string
 203   :group 'muse-html)
 204
 205 (defcustom muse-html-anchor-on-word nil
 206   "When true, anchors surround the closest word. This allows you
 207 to select them in a browser (i.e. for pasting), but has the
 208 side-effect of marking up headers in multiple colors if your
 209 header style is different from your link style."
 210   :type 'boolean
 211   :group 'muse-html)
 212
 213 (defcustom muse-html-table-attributes
 214   " class=\"muse-table\" border=\"2\" cellpadding=\"5\""
 215   "The attribute to be used with HTML <table> tags.
 216 Note that Muse supports insertion of raw HTML tags, as long
 217 as you wrap the region in <literal></literal>."
 218   :type 'string
 219   :group 'muse-html)
 220
 221 (defcustom muse-html-markup-regexps
 222   `(;; Beginning of doc, end of doc, or plain paragraph separator
 223     (10000 ,(concat "\\(\\(\n\\(?:[" muse-regexp-blank "]*\n\\)*"
 224                     "\\([" muse-regexp-blank "]*\n\\)\\)"
 225                     "\\|\\`\\s-*\\|\\s-*\\'\\)")
 226            ;; this is somewhat repetitive because we only require the
 227            ;; line just before the paragraph beginning to be not
 228            ;; read-only
 229            3 muse-html-markup-paragraph))
 230   "List of markup rules for publishing a Muse page to HTML.
 231 For more on the structure of this list, see `muse-publish-markup-regexps'."
 232   :type '(repeat (choice
 233                   (list :tag "Markup rule"
 234                         integer
 235                         (choice regexp symbol)
 236                         integer
 237                         (choice string function symbol))
 238                   function))
 239   :group 'muse-html)
 240
 241 (defcustom muse-html-markup-functions
 242   '((anchor   . muse-html-markup-anchor)
 243     (table    . muse-html-markup-table)
 244     (footnote . muse-html-markup-footnote))
 245   "An alist of style types to custom functions for that kind of text.
 246 For more on the structure of this list, see
 247 `muse-publish-markup-functions'."
 248   :type '(alist :key-type symbol :value-type function)
 249   :group 'muse-html)
 250
 251 (defcustom muse-html-markup-strings
 252   '((image-with-desc . "<table class=\"image\" width=\"100%%\">
 253   <tr><td align=\"center\"><img src=\"%1%.%2%\" alt=\"%3%\"></td></tr>
 254   <tr><td align=\"center\" class=\"image-caption\">%3%</td></tr>
 255 </table>")
 256     (image           . "<img src=\"%s.%s\" alt=\"\">")
 257     (image-link      . "<a class=\"image-link\" href=\"%s\">
 258 <img src=\"%s.%s\"></a>")
 259     (anchor-ref      . "<a href=\"#%s\">%s</a>")
 260     (url             . "<a href=\"%s\">%s</a>")
 261     (link            . "<a href=\"%s\">%s</a>")
 262     (link-and-anchor . "<a href=\"%s#%s\">%s</a>")
 263     (email-addr      . "<a href=\"mailto:%s\">%s</a>")
 264     (anchor          . "<a name=\"%1%\" id=\"%1%\">")
 265     (emdash          . "%s&mdash;%s")
 266     (comment-begin   . "<!-- ")
 267     (comment-end     . " -->")
 268     (rule            . "<hr>")
 269     (fn-sep          . "<hr>\n")
 270     (no-break-space  . "&nbsp;")
 271     (line-break      . "<br>")
 272     (enddots         . "....")
 273     (dots            . "...")
 274     (section         . "<h2>")
 275     (section-end     . "</h2>")
 276     (subsection      . "<h3>")
 277     (subsection-end  . "</h3>")
 278     (subsubsection   . "<h4>")
 279     (subsubsection-end . "</h4>")
 280     (section-other   . "<h5>")
 281     (section-other-end . "</h5>")
 282     (begin-underline . "<u>")
 283     (end-underline   . "</u>")
 284     (begin-literal   . "<code>")
 285     (end-literal     . "</code>")
 286     (begin-cite      . "<span class=\"citation\">")
 287     (begin-cite-author . "<span class=\"citation-author\">")
 288     (begin-cite-year . "<span class=\"citation-year\">")
 289     (end-cite        . "</span>")
 290     (begin-emph      . "<em>")
 291     (end-emph        . "</em>")
 292     (begin-more-emph . "<strong>")
 293     (end-more-emph   . "</strong>")
 294     (begin-most-emph . "<strong><em>")
 295     (end-most-emph   . "</em></strong>")
 296     (begin-verse     . "<p class=\"verse\">\n")
 297     (verse-space     . "&nbsp;&nbsp;")
 298     (end-verse-line  . "<br>")
 299     (end-last-stanza-line . "<br>")
 300     (empty-verse-line . "<br>")
 301     (end-verse       . "</p>")
 302     (begin-example   . "<pre class=\"example\">")
 303     (end-example     . "</pre>")
 304     (begin-center    . "<center>\n<p>")
 305     (end-center      . "</p>\n</center>")
 306     (begin-quote     . "<blockquote>\n")
 307     (end-quote       . "\n</blockquote>")
 308     (begin-quote-item . "<p class=\"quoted\">")
 309     (end-quote-item  . "</p>")
 310     (begin-uli       . "<ul>\n")
 311     (end-uli         . "\n</ul>")
 312     (begin-uli-item  . "<li>")
 313     (end-uli-item    . "</li>")
 314     (begin-oli       . "<ol>\n")
 315     (end-oli         . "\n</ol>")
 316     (begin-oli-item  . "<li>")
 317     (end-oli-item    . "</li>")
 318     (begin-dl        . "<dl>\n")
 319     (end-dl          . "\n</dl>")
 320     (begin-ddt       . "<dt><strong>")
 321     (end-ddt         . "</strong></dt>")
 322     (begin-dde       . "<dd>")
 323     (end-dde         . "</dd>")
 324     (begin-table     . "<table%s>\n")
 325     (end-table       . "</table>")
 326     (begin-table-row . "    <tr>\n")
 327     (end-table-row   . "    </tr>\n")
 328     (begin-table-entry . "      <%s>")
 329     (end-table-entry . "</%s>\n"))
 330   "Strings used for marking up text as HTML.
 331 These cover the most basic kinds of markup, the handling of which
 332 differs little between the various styles."
 333   :type '(alist :key-type symbol :value-type string)
 334   :group 'muse-html)
 335
 336 (defcustom muse-xhtml-markup-strings
 337   '((image-with-desc . "<table class=\"image\" width=\"100%%\">
 338   <tr><td align=\"center\"><img src=\"%1%.%2%\" alt=\"%3%\" /></td></tr>
 339   <tr><td align=\"center\" class=\"image-caption\">%3%</td></tr>
 340 </table>")
 341     (image           . "<img src=\"%s.%s\" alt=\"\" />")
 342     (image-link      . "<a class=\"image-link\" href=\"%s\">
 343 <img src=\"%s.%s\" alt=\"\" /></a>")
 344     (rule            . "<hr />")
 345     (fn-sep          . "<hr />\n")
 346     (line-break      . "<br />")
 347     (begin-underline . "<span style=\"text-decoration: underline;\">")
 348     (end-underline   . "</span>")
 349     (begin-center    . "<p style=\"text-align: center;\">\n")
 350     (end-center      . "\n</p>")
 351     (end-verse-line  . "<br />")
 352     (end-last-stanza-line . "<br />")
 353     (empty-verse-line . "<br />"))
 354   "Strings used for marking up text as XHTML.
 355 These cover the most basic kinds of markup, the handling of which
 356 differs little between the various styles.
 357
 358 If a markup rule is not found here, `muse-html-markup-strings' is
 359 searched."
 360   :type '(alist :key-type symbol :value-type string)
 361   :group 'muse-html)
 362
 363 (defcustom muse-xhtml1.1-markup-strings
 364   '((anchor          . "<a id=\"%s\">"))
 365   "Strings used for marking up text as XHTML 1.1.
 366 These cover the most basic kinds of markup, the handling of which
 367 differs little between the various styles.
 368
 369 If a markup rule is not found here, `muse-xhtml-markup-strings'
 370 and `muse-html-markup-strings' are searched."
 371   :type '(alist :key-type symbol :value-type string)
 372   :group 'muse-html)
 373
 374 (defcustom muse-html-markup-tags
 375   '(("class" t t   t muse-html-class-tag)
 376     ("src"   t t nil muse-html-src-tag))
 377  "A list of tag specifications, for specially marking up HTML."
 378   :type '(repeat (list (string :tag "Markup tag")
 379                        (boolean :tag "Expect closing tag" :value t)
 380                        (boolean :tag "Parse attributes" :value nil)
 381                        (boolean :tag "Nestable" :value nil)
 382                        function))
 383   :group 'muse-html)
 384
 385 (defcustom muse-html-meta-http-equiv "Content-Type"
 386   "The http-equiv attribute used for the HTML <meta> tag."
 387   :type 'string
 388   :group 'muse-html)
 389
 390 (defcustom muse-html-meta-content-type "text/html"
 391   "The content type used for the HTML <meta> tag.
 392 If you are striving for XHTML 1.1 compliance, you may want to
 393 change this to \"application/xhtml+xml\"."
 394   :type 'string
 395   :group 'muse-html)
 396
 397 (defcustom muse-html-meta-content-encoding (if (featurep 'mule)
 398                                               'detect
 399                                             "iso-8859-1")
 400   "The charset to append to the HTML <meta> tag.
 401 If set to the symbol 'detect, use `muse-html-encoding-map' to try
 402 and determine the HTML charset from emacs's coding.  If set to a
 403 string, this string will be used to force a particular charset"
 404   :type '(choice string symbol)
 405   :group 'muse-html)
 406
 407 (defcustom muse-html-encoding-default 'iso-8859-1
 408   "The default Emacs buffer encoding to use in published files.
 409 This will be used if no special characters are found."
 410   :type 'symbol
 411   :group 'muse-html)
 412
 413 (defcustom muse-html-charset-default "iso-8859-1"
 414   "The default HTML meta charset to use if no translation is found in
 415 `muse-html-encoding-map'."
 416   :type 'string
 417   :group 'muse-html)
 418
 419 (defcustom muse-html-src-allowed-modes t
 420   "Modes that we allow the <src> tag to colorize.
 421 If t, permit the <src> tag to colorize any mode.
 422
 423 If a list of mode names, such as '(\"html\" \"latex\"), and the
 424 lang argument to <src> is in the list, then use fundamental mode
 425 instead."
 426   :type '(choice (const :tag "Any" t)
 427                  (repeat (string :tag "Mode")))
 428   :group 'muse-html)
 429
 430 (defun muse-html-insert-anchor (anchor)
 431   "Insert an anchor, either around the word at point, or within a tag."
 432   (skip-chars-forward (concat muse-regexp-blank "\n"))
 433   (if (looking-at (concat "<\\([^" muse-regexp-blank "/>\n]+\\)>"))
 434       (let ((tag (match-string 1)))
 435         (goto-char (match-end 0))
 436         (muse-insert-markup (muse-markup-text 'anchor anchor))
 437         (when muse-html-anchor-on-word
 438           (or (and (search-forward (format "</%s>" tag)
 439                                    (muse-line-end-position) t)
 440                    (goto-char (match-beginning 0)))
 441               (forward-word 1)))
 442         (muse-insert-markup "</a>"))
 443     (muse-insert-markup (muse-markup-text 'anchor anchor))
 444     (when muse-html-anchor-on-word
 445       (forward-word 1))
 446     (muse-insert-markup "</a>\n")))
 447
 448 (defun muse-html-markup-anchor ()
 449   (unless (get-text-property (match-end 1) 'muse-link)
 450     (save-match-data
 451       (muse-html-insert-anchor (match-string 2)))
 452     (match-string 1)))
 453
 454 (defun muse-html-markup-paragraph ()
 455   (let ((end (copy-marker (match-end 0) t)))
 456     (goto-char (match-beginning 0))
 457     (when (save-excursion
 458             (save-match-data
 459               (and (re-search-backward "<\\(/?\\)p[ >]" nil t)
 460                    (not (string-equal (match-string 1) "/")))))
 461       (when (get-text-property (1- (point)) 'end-list)
 462         (goto-char (previous-single-property-change (1- (point)) 'end-list)))
 463       (muse-insert-markup "</p>"))
 464     (goto-char end))
 465   (cond
 466    ((eobp)
 467     (unless (bolp)
 468       (insert "\n")))
 469    ((eq (char-after) ?\<)
 470     (cond
 471      ((looking-at "<\\(em\\|strong\\|code\\|span\\)[ >]")
 472       (muse-insert-markup "<p>"))
 473      ((looking-at "<a ")
 474       (if (looking-at "<a[^>\n]+><img")
 475           (muse-insert-markup "<p class=\"image-link\">")
 476         (muse-insert-markup "<p>")))
 477      ((looking-at "<img[ >]")
 478       (muse-insert-markup "<p class=\"image\">"))
 479      (t
 480       (forward-char 1)
 481       nil)))
 482    ((muse-looking-back "\\(</h[1-4]>\\|<hr>\\)\n\n")
 483     (muse-insert-markup "<p class=\"first\">"))
 484    (t
 485     (muse-insert-markup "<p>"))))
 486
 487 (defun muse-html-markup-footnote ()
 488   (cond
 489    ((get-text-property (match-beginning 0) 'muse-link)
 490     nil)
 491    ((= (muse-line-beginning-position) (match-beginning 0))
 492     (prog1
 493         (let ((text (match-string 1)))
 494           (muse-insert-markup
 495            (concat "<p class=\"footnote\">"
 496                    "<a class=\"footnum\" name=\"fn." text
 497                    "\" href=\"#fnr." text "\">"
 498                    text ".</a>")))
 499       (save-excursion
 500         (save-match-data
 501           (let* ((beg (goto-char (match-end 0)))
 502                  (end (and (search-forward "\n\n" nil t)
 503                            (prog1
 504                                (copy-marker (match-beginning 0))
 505                              (goto-char beg)))))
 506             (while (re-search-forward (concat "^["
 507                                               muse-regexp-blank
 508                                               "]+\\([^\n]\\)")
 509                                       end t)
 510               (replace-match "\\1" t)))))
 511       (replace-match "")))
 512    (t (let ((text (match-string 1)))
 513         (muse-insert-markup
 514          (concat "<sup><a class=\"footref\" name=\"fnr." text
 515                  "\" href=\"#fn." text "\">"
 516                  text "</a></sup>")))
 517       (replace-match ""))))
 518
 519 (defun muse-html-markup-table ()
 520   (muse-xml-markup-table muse-html-table-attributes))
 521
 522 ;; Handling of tags for HTML
 523
 524 (defun muse-html-strip-links (string)
 525   "Remove all HTML links from STRING."
 526   (muse-replace-regexp-in-string "\\(<a .*?>\\|</a>\\)" "" string nil t))
 527
 528 (defun muse-html-insert-contents (depth)
 529   "Scan the current document and generate a table of contents at point.
 530 DEPTH indicates how many levels of headings to include.  The default is 2."
 531   (let ((max-depth (or depth 2))
 532         (index 1)
 533         base contents l end)
 534     (save-excursion
 535       (goto-char (point-min))
 536       (search-forward "Page published by Emacs Muse begins here" nil t)
 537       (catch 'done
 538         (while (re-search-forward "<h\\([0-9]+\\)>\\(.+?\\)</h\\1>$" nil t)
 539           (unless (and (get-text-property (point) 'read-only)
 540                        (not (get-text-property (match-beginning 0)
 541                                                'muse-contents)))
 542             (remove-text-properties (match-beginning 0) (match-end 0)
 543                                     '(muse-contents nil))
 544             (setq l (1- (string-to-number (match-string 1))))
 545             (if (null base)
 546                 (setq base l)
 547               (if (< l base)
 548                   (throw 'done t)))
 549             (when (<= l max-depth)
 550               ;; escape specials now before copying the text, so that we
 551               ;; can deal sanely with both emphasis in titles and
 552               ;; special characters
 553               (goto-char (match-end 2))
 554               (setq end (point-marker))
 555               (muse-publish-escape-specials (match-beginning 2) end
 556                                             nil 'document)
 557               (muse-publish-mark-read-only (match-beginning 2) end)
 558               (setq contents (cons (cons l (buffer-substring-no-properties
 559                                             (match-beginning 2) end))
 560                                    contents))
 561               (set-marker end nil)
 562               (goto-char (match-beginning 2))
 563               (muse-html-insert-anchor (concat "sec" (int-to-string index)))
 564               (setq index (1+ index)))))))
 565     (setq index 1 contents (nreverse contents))
 566     (let ((depth 1) (sub-open 0) (p (point)))
 567       (muse-insert-markup "<div class=\"contents\">\n<dl>\n")
 568       (while contents
 569         (muse-insert-markup "<dt>\n"
 570                             "<a href=\"#sec" (int-to-string index) "\">"
 571                             (muse-html-strip-links (cdar contents))
 572                             "</a>\n"
 573                             "</dt>\n")
 574         (setq index (1+ index)
 575               depth (caar contents)
 576               contents (cdr contents))
 577         (when contents
 578           (cond
 579            ((< (caar contents) depth)
 580             (let ((idx (caar contents)))
 581               (while (< idx depth)
 582                 (muse-insert-markup "</dl>\n</dd>\n")
 583                 (setq sub-open (1- sub-open)
 584                       idx (1+ idx)))))
 585            ((> (caar contents) depth) ; can't jump more than one ahead
 586             (muse-insert-markup "<dd>\n<dl>\n")
 587             (setq sub-open (1+ sub-open))))))
 588       (while (> sub-open 0)
 589         (muse-insert-markup "</dl>\n</dd>\n")
 590         (setq sub-open (1- sub-open)))
 591       (muse-insert-markup "</dl>\n</div>\n")
 592       (muse-publish-mark-read-only p (point)))))
 593
 594 (defun muse-html-denote-headings ()
 595   "Place a text property on any headings in the current buffer.
 596 This allows the headings to be picked up later on if publishing a
 597 table of contents."
 598   (save-excursion
 599     (goto-char (point-min))
 600     (search-forward "Page published by Emacs Muse begins here" nil t)
 601     (while (re-search-forward "<h\\([0-9]+\\)>\\(.+?\\)</h\\1>$" nil t)
 602       (unless (get-text-property (point) 'read-only)
 603         (add-text-properties (match-beginning 0) (match-end 0)
 604                              '(muse-contents t))))))
 605
 606 (defun muse-html-class-tag (beg end attrs)
 607   (let ((name (cdr (assoc "name" attrs))))
 608     (when name
 609       (goto-char beg)
 610       (muse-insert-markup "<span class=\"" name "\">")
 611       (save-excursion
 612         (goto-char end)
 613         (muse-insert-markup "</span>")))))
 614
 615 (defun muse-html-src-tag (beg end attrs)
 616   "Publish the region using htmlize.
 617 The language to use may be specified by the \"lang\" attribute.
 618
 619 Muse will look for a function named LANG-mode, where LANG is the
 620 value of the \"lang\" attribute.
 621
 622 This tag requires htmlize 1.34 or later in order to work."
 623   (if (condition-case nil
 624           (progn
 625             (require 'htmlize)
 626             (if (fboundp 'htmlize-region-for-paste)
 627                 nil
 628               (muse-display-warning
 629                (concat "The `htmlize-region-for-paste' function was not"
 630                        " found.\nThis is available in htmlize.el 1.34"
 631                        " or later."))
 632               t))
 633         (error nil t))
 634       ;; if htmlize.el was not found, treat this like an example tag
 635       (muse-publish-example-tag beg end)
 636     (muse-publish-ensure-block beg end)
 637     (let* ((mode (and (assoc "lang" attrs)
 638                       (intern (concat (cdr (assoc "lang" attrs))
 639                                       "-mode"))))
 640            (text (muse-delete-and-extract-region beg end))
 641            (htmltext
 642             (with-temp-buffer
 643               (insert text)
 644               (if (functionp mode)
 645                   (funcall mode)
 646                 (fundamental-mode))
 647               (font-lock-fontify-buffer)
 648               ;; silence the byte-compiler
 649               (when (fboundp 'htmlize-region-for-paste)
 650                 ;; transform the region to HTML
 651                 (htmlize-region-for-paste (point-min) (point-max))))))
 652       (save-restriction
 653         (narrow-to-region (point) (point))
 654         (insert htmltext)
 655         (goto-char (point-min))
 656         (re-search-forward "<pre\\([^>]*\\)>\n?" nil t)
 657         (replace-match "<pre class=\"src\">")
 658         (goto-char (point-max))
 659         (muse-publish-mark-read-only (point-min) (point-max))))))
 660
 661 ;; Register the Muse HTML Publisher
 662
 663 (defun muse-html-browse-file (file)
 664   (browse-url (concat "file:" file)))
 665
 666 (defun muse-html-encoding ()
 667   (if (stringp muse-html-meta-content-encoding)
 668       muse-html-meta-content-encoding
 669     (muse-xml-transform-content-type
 670      (or (and (boundp 'buffer-file-coding-system)
 671               buffer-file-coding-system)
 672          muse-html-encoding-default)
 673      muse-html-charset-default)))
 674
 675 (defun muse-html-prepare-buffer ()
 676   (make-local-variable 'muse-html-meta-http-equiv)
 677   (set (make-local-variable 'muse-html-meta-content-type)
 678        (if (save-match-data
 679              (string-match "charset=" muse-html-meta-content-type))
 680            muse-html-meta-content-type
 681          (concat muse-html-meta-content-type "; charset="
 682                  (muse-html-encoding)))))
 683
 684 (defun muse-html-munge-buffer ()
 685   (if muse-publish-generate-contents
 686       (progn
 687         (goto-char (car muse-publish-generate-contents))
 688         (muse-html-insert-contents (cdr muse-publish-generate-contents))
 689         (setq muse-publish-generate-contents nil))
 690     (muse-html-denote-headings)))
 691
 692 (defun muse-html-finalize-buffer ()
 693   (when (and (boundp 'buffer-file-coding-system)
 694              (memq buffer-file-coding-system '(no-conversion undecided-unix)))
 695     ;; make it agree with the default charset
 696     (setq buffer-file-coding-system muse-html-encoding-default)))
 697
 698 ;;; Register the Muse HTML and XHTML Publishers
 699
 700 (muse-define-style "html"
 701                    :suffix    'muse-html-extension
 702                    :regexps   'muse-html-markup-regexps
 703                    :functions 'muse-html-markup-functions
 704                    :strings   'muse-html-markup-strings
 705                    :tags      'muse-html-markup-tags
 706                    :specials  'muse-xml-decide-specials
 707                    :before    'muse-html-prepare-buffer
 708                    :before-end 'muse-html-munge-buffer
 709                    :after     'muse-html-finalize-buffer
 710                    :header    'muse-html-header
 711                    :footer    'muse-html-footer
 712                    :style-sheet 'muse-html-style-sheet
 713                    :browser   'muse-html-browse-file)
 714
 715 (muse-derive-style "xhtml" "html"
 716                    :suffix    'muse-xhtml-extension
 717                    :strings   'muse-xhtml-markup-strings
 718                    :header    'muse-xhtml-header
 719                    :footer    'muse-xhtml-footer
 720                    :style-sheet 'muse-xhtml-style-sheet)
 721
 722 ;; xhtml1.0 is an alias for xhtml
 723 (muse-derive-style "xhtml1.0" "xhtml")
 724
 725 ;; xhtml1.1 has some quirks that need attention from us
 726 (muse-derive-style "xhtml1.1" "xhtml"
 727                    :strings   'muse-xhtml1.1-markup-strings)
 728
 729 (provide 'muse-html)
 730
 731 ;;; muse-html.el ends here