Body wrapper customization (prologue and epilogue)

jrblevin · jrblevin · commit a49554ba80e6 · 2017-12-30T13:41:49.000-05:00
Add markdown-xhtml-body-preamble and markdown-xhtml-body-epilogue variables for wrapping additional XHTML tags around the output. Based on pull request GH-281 by Jimmy Yuen Ho Wong (@wyuenho). Closes GH-280.
diff --git a/CHANGES.md b/CHANGES.md
@@ -40,6 +40,9 @@
         `help-mode`.  ([GH-296][])
     -   Optionally add footnote definitions to the end of the imenu
         index using `markdown-add-footnotes-to-imenu`.  ([GH-235][])
+    -   Add custom variables `markdown-xhtml-body-preamble` and
+        `markdown-xhtml-body-epilogue` for wrapping additional XHTML
+        tags around the output.  ([GH-280][], [GH-281][])
 
 *   Improvements:
 
@@ -130,6 +133,8 @@
   [gh-275]: https://github.com/jrblevin/markdown-mode/issues/275
   [gh-276]: https://github.com/jrblevin/markdown-mode/issues/276
   [gh-277]: https://github.com/jrblevin/markdown-mode/pull/277
+  [gh-280]: https://github.com/jrblevin/markdown-mode/issues/280
+  [gh-281]: https://github.com/jrblevin/markdown-mode/pull/281
   [gh-284]: https://github.com/jrblevin/markdown-mode/issues/284
   [gh-291]: https://github.com/jrblevin/markdown-mode/issues/291
   [gh-296]: https://github.com/jrblevin/markdown-mode/issues/296
diff --git a/README.md b/README.md
@@ -762,6 +762,16 @@ provides an interface to all of the possible customizations:
   * `markdown-xhtml-header-content` - additional content to include
     in the XHTML `<head>` block (default: `""`).
 
+  * `markdown-xhtml-body-preamble` - additional content to include in
+    the XHTML <body> block, before the output (default: `""`).  This
+    is useful for enclosing additional elements around the Markdown
+    output.
+
+  * `markdown-xhtml-body-epilogue` - additional content to include in
+    the XHTML <body> block, after the output (default: `""`).  This is
+    useful for enclosing additional elements around the Markdown
+    output.
+
   * `markdown-xhtml-standalone-regexp` - a regular expression which
     `markdown-mode` uses to determine whether the output of
     `markdown-command` is a standalone XHTML document or an XHTML
diff --git a/markdown-mode.el b/markdown-mode.el
@@ -353,6 +353,20 @@ exporting with `markdown-export'."
   :group 'markdown
   :type 'string)
 
+(defcustom markdown-xhtml-body-preamble ""
+  "Content to include in the XHTML <body> block, before the output."
+  :group 'markdown
+  :type 'string
+  :safe 'stringp
+  :package-version '(markdown-mode . "2.4"))
+
+(defcustom markdown-xhtml-body-epilogue ""
+  "Content to include in the XHTML <body> block, after the output."
+  :group 'markdown
+  :type 'string
+  :safe 'stringp
+  :package-version '(markdown-mode . "2.4"))
+
 (defcustom markdown-xhtml-standalone-regexp
   "^\\(<\\?xml\\|<!DOCTYPE\\|<html\\)"
   "Regexp indicating whether `markdown-command' output is standalone XHTML."
@@ -7251,7 +7265,11 @@ Standalone XHTML output is identified by an occurrence of
     (insert markdown-xhtml-header-content))
   (insert "\n</head>\n\n"
           "<body>\n\n")
+  (when (> (length markdown-xhtml-body-preamble) 0)
+    (insert markdown-xhtml-body-preamble "\n"))
   (goto-char (point-max))
+  (when (> (length markdown-xhtml-body-epilogue) 0)
+    (insert "\n" markdown-xhtml-body-epilogue))
   (insert "\n"
           "</body>\n"
           "</html>\n"))
diff --git a/tests/markdown-test.el b/tests/markdown-test.el
@@ -5140,6 +5140,36 @@ This includes preserving whitespace after the pipe."
       ;; Output buffer should be killed.
       (should-not export-buffer))))
 
+(ert-deftest test-markdown-export/body-preamble ()
+  "Test `markdown-xhtml-body-preamble'."
+  (markdown-test-temp-file "inline.text"
+    (let* ((str "<!-- body preamble test -->")
+           (markdown-xhtml-body-preamble str)
+           (markdown-command #'markdown-command-identity)
+           (markdown-export-kill-buffer nil)
+           (ofile (markdown-export))
+           (obuffer (get-file-buffer ofile)))
+      (with-current-buffer obuffer
+        (goto-char (point-min))
+        (should (search-forward str)))
+      (kill-buffer obuffer)
+      (delete-file ofile))))
+
+(ert-deftest test-markdown-export/body-epilogue ()
+  "Test `markdown-xhtml-body-epilogue'."
+  (markdown-test-temp-file "inline.text"
+    (let* ((str "<!-- body epilogue test -->")
+           (markdown-xhtml-body-epilogue str)
+           (markdown-command #'markdown-command-identity)
+           (markdown-export-kill-buffer nil)
+           (ofile (markdown-export))
+           (obuffer (get-file-buffer ofile)))
+      (with-current-buffer obuffer
+        (goto-char (point-min))
+        (should (search-forward str)))
+      (kill-buffer obuffer)
+      (delete-file ofile))))
+
 ;;; Hook tests:
 
 (ert-deftest test-markdown-hook/before-export ()
