Initial commit

not manx 3 years ago
commit 8352169f17
Signed by: C-xC-c
GPG Key ID: F52ED472284EF2F4

@ -0,0 +1,25 @@
* PlumHTML
org-export backend for sane HTML. Basically some changes and
extensions (currently just tables) to [[][ox-slimhtml]].
Used to publish words I write.
** Installation
You want to clone the repo into somewhere like
=~/.emacs.d/elpa/plumhtml-1.0.0/= then do ~M-x package-install-file
** Functions
- ~ox-plumhtml-export-as-html~
Makes a temporary buffer with the exported HTML.
- ~ox-plumhtml-export-to-html~
Like ~ox-plumhtml-export-as-html~ but dumps the exported HTML to a
file like -> =example.html=
- ~ox-plumhtml-publish-to-html~
Same as ~ox-plumhtml-export-as-html~ but for ~org-publish~
** Tests
I stole them from =ox-slimhtml= lole
emacs -batch \
-l ert \
-l ox-plumhtml-tests.el \
-f ert-run-tests-batch-and-exit

@ -0,0 +1,46 @@
(require 'package)
(load-file "ox-plumhtml.el")
(defun should-render-as (expected-result org-source &optional info skip-newline)
(let ((expected-result (if skip-newline expected-result (concat expected-result "\n")))
(info (plist-put info :html-container nil)))
(should (string= expected-result
(org-export-string-as org-source 'plumhtml t info)))))
;; Tables
(ert-deftest body ()
(ert-deftest multi-line-body ()
(ert-deftest header-no-body ()
"<table><tbody><tr><td>just a header</td></tr></tbody>\n</table>"
"|just a header|\n|---|"))
(ert-deftest header-and-body ()
(ert-deftest header-and-multi-line-body ()
"<table><thead><tr><th>header</th></tr></thead>\n<tbody><tr><td>line 1</td></tr>\n<tr><td>line 2</td></tr>\n<tr><td>line 3</td></tr></tbody>\n</table>"
"|header|\n|---|\n|line 1|\n|line 2|\n|line 3|"))
(ert-deftest header-and-multiple-bodies ()
(ert-deftest header-and-body ()

@ -0,0 +1,113 @@
;;; ox-plumhtml.el --- sane HTML export for org-mode -*- lexical-binding: t; -*-
;; Copyright (C) 2020 Plum
;; Author: Plum <>
;; Created: June 2020
;; Package-Version: 1.0.0
;; Keywords: org-export
;; URL:
;; Package-Requires: ((emacs "24") (ox-slimhtml "0.4.5"))
;; This file is not part of GNU Emacs
;;; License:
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this file. If not, see <>.
;;; Commentary:
;; Sane extensions to ox-slimhtml
;;; Code:
(require 'ox-slimhtml)
;; Utils
(defun ox-plumhtml--table-header-p (element info)
(or (org-export-table-has-header-p element info)
(org-export-table-has-header-p (org-export-get-parent-table element) info)))
;; org-export Translations
(defun ox-plumhtml-paragraph (paragraph contents info)
"This is the same as `ox-slimhtml-paragraph' but doesn't add a
<p> before export-snippet blocks like #+begin_src .... #+end_src"
(when contents
(if (or (ox-slimhtml--immediate-child-of-p paragraph 'item)
(ox-slimhtml--immediate-child-of-p paragraph 'special-block)
(ox-slimhtml--has-immediate-child-of-p paragraph 'export-snippet))
(if (ox-slimhtml--has-immediate-child-of-p paragraph 'link)
(format "<p>%s</p>" contents)
(format "<p%s>%s</p>" (ox-slimhtml--attr paragraph) contents)))))
(defun ox-plumhtml-table (table contents info)
(format "<table>%s</table>" contents))
(defun ox-plumhtml-table-row (table-row contents info)
"Transcodes an org table-row to HTML
Implements <thead> and <tbody>"
(when (eq 'standard (org-element-property :type table-row))
(let* ((open (org-export-table-row-starts-rowgroup-p table-row info))
(close (org-export-table-row-ends-rowgroup-p table-row info))
(first-row (= 0 (org-export-table-row-number table-row info)))
((and (ox-plumhtml--table-header-p table-row info)
(or (equal '(top) open)
(equal '(below) close)))
'("<thead>" . "</thead>"))
((or (equal '(above) open)
(equal '(bottom) close)
'("<tbody>" . "</tbody>")))))
(concat (and (or open first-row) (car tags))
(format "<tr>%s</tr>" contents)
(and close (cdr tags))))))
(defun ox-plumhtml-table-cell (table-cell contents info)
"Transcodes and org table-cell to HTML
Uses <th> for table headers"
(if (and (ox-plumhtml--table-header-p table-cell info)
(org-export-table-row-in-header-p (org-export-get-parent table-cell) info))
(format "<th>%s</th>" contents)
(format "<td>%s</td>" contents)))
;; org-export backend and export/publish functions
(org-export-define-derived-backend 'plumhtml
'((table . ox-plumhtml-table)
(table-row . ox-plumhtml-table-row)
(table-cell . ox-plumhtml-table-cell)
(paragraph . ox-plumhtml-paragraph)))
(defun ox-plumhtml-publish-to-html (plist filename pub-dir)
(org-publish-org-to 'plumhtml filename ".html" plist pub-dir))
(defun ox-plumhtml-export-as-html
(&optional async subtreep visible-only body-only ext-plist)
(org-export-to-buffer 'plumhtml "*Org PlumHTML Export*"
async subtreep visible-only body-only ext-plist
(lambda () (set-auto-mode t))))
(defun ox-plumhtml-export-to-html (&optional async subtreep visible-only body-only ext-plist)
(let ((org-export-coding-system org-html-coding-system))
(org-export-to-file 'plumhtml
(org-export-output-file-name ".html" subtreep)
async subtreep visible-only body-only ext-plist)))
(provide 'ox-plumhtml)
;;; ox-plumhtml.el ends here