From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Adam Porter Newsgroups: gmane.emacs.devel Subject: Re: [ELPA/elpa-admin] Render README.org as HTML with ox-html Date: Thu, 02 Sep 2021 21:01:50 -0500 Message-ID: <87a6ku2z8x.fsf@alphapapa.net> References: <87h7f7zww5.fsf@alphapapa.net> <87zgszy91h.fsf_-_@alphapapa.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28286"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Sep 03 04:02:51 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mLyXb-0007DO-7u for ged-emacs-devel@m.gmane-mx.org; Fri, 03 Sep 2021 04:02:51 +0200 Original-Received: from localhost ([::1]:55346 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mLyXZ-0007DI-J9 for ged-emacs-devel@m.gmane-mx.org; Thu, 02 Sep 2021 22:02:49 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51578) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mLyWn-0006XP-8N for emacs-devel@gnu.org; Thu, 02 Sep 2021 22:02:02 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]:40952) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mLyWl-0007jQ-HJ for emacs-devel@gnu.org; Thu, 02 Sep 2021 22:02:01 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1mLyWi-0006KT-Si for emacs-devel@gnu.org; Fri, 03 Sep 2021 04:01:56 +0200 X-Injected-Via-Gmane: http://gmane.org/ Received-SPF: pass client-ip=116.202.254.214; envelope-from=ged-emacs-devel@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: -15 X-Spam_score: -1.6 X-Spam_bar: - X-Spam_report: (-1.6 / 5.0 requ) BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:273739 Archived-At: --=-=-= Content-Type: text/plain After some more thinking, the ASCII-only patch seemed redundant, so here is a new, simpler patch that also accounts for a few other details I had overlooked. It exports Org readmes to HTML in the ELPA Web page and to plain-text for the PACKAGE-readme.txt file. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-elpa-admin.el-Export-Org-readmes-to-ASCII-and-HTML.patch >From 60c959ddfad184988be74c1ed32f1759d1a24610 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Sun, 29 Aug 2021 17:45:22 -0500 Subject: [PATCH] * elpa-admin.el: Export Org readmes to ASCII and HTML (elpaa--export-org): New function. (elpaa--org-export-options): New variable. (elpaa--html-make-pkg): Export Org readmes to HTML and plain-text, and other readme formats to plain-text. --- elpa-admin.el | 63 ++++++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 49 insertions(+), 14 deletions(-) diff --git a/elpa-admin.el b/elpa-admin.el index ac72f2f..40a355f 100644 --- a/elpa-admin.el +++ b/elpa-admin.el @@ -69,6 +69,11 @@ to be installed and has only been tested on some Debian systems.") (defvar elpaa--debug nil) +(defvar elpaa--org-export-options + '(:with-author nil :with-creator nil :with-broken-links t) + "Options used common to all Org export backends. +See variable `org-export-options-alist'.") + (unless (fboundp 'ignore-error) (defmacro ignore-error (condition &rest body) `(condition-case nil (progn ,@body) (,condition nil)))) @@ -1209,15 +1214,23 @@ return section under HEADER in package's main file." (delete-region (point) (point-max)) (buffer-string))))))) -(defun elpaa--get-README (pkg-spec dir) - (elpaa--get-section - "Commentary" (elpaa--spec-get pkg-spec :readme - '("README" "README.rst" - ;; Most README.md files seem to be currently - ;; worse than the Commentary: section :-( - ;; "README.md" - "README.org")) - dir pkg-spec)) +(cl-defun elpaa--export-org (file backend &key body-only ext-plist) + "Return Org FILE as an exported string. +BACKEND and EXT-PLIST are passed to `org-export-as', which see. +Uses `elpaa--call-sandboxed', since exporting with Org may run +arbitrary code." + (declare (indent defun)) + (cl-check-type backend symbol) + (cl-assert (memq body-only '(nil t)) t + "BODY-ONLY may only be nil or t") + (with-temp-buffer + (unless (zerop (elpaa--call-sandboxed + t "emacs" "--batch" "-l" (format "ox-%s" backend) + file + "--eval" (format "(message \"%%s\" (org-export-as '%s nil nil %S '%S))" + backend body-only ext-plist))) + (error "Unable to export Org file: %S" file)) + (buffer-string))) (defun elpaa--get-NEWS (pkg-spec dir) (let ((text @@ -1313,11 +1326,33 @@ return section under HEADER in package's main file." (insert (format "

To install this package, run in Emacs:

M-x package-install RET %s RET
" name)) - (let ((rm (elpaa--get-README pkg-spec srcdir))) - (when rm - (write-region rm nil (concat name "-readme.txt")) - (insert "

Full description

\n" (elpaa--html-quote rm)
-                  "\n
\n"))) + (let ((readme-file-name + (elpaa--spec-get pkg-spec :readme + '("README" "README.rst" + ;; Most README.md files seem to be currently + ;; worse than the Commentary: section :-( + ;; "README.md" + "README.org"))) + (output-filename (concat name "-readme.txt")) + readme-content page-content) + (pcase readme-file-name + ("README.org" + (setf readme-content (elpaa--export-org readme-file-name 'ascii + :ext-plist (append '(:ascii-charset utf-8) + elpaa--org-export-options)) + page-content (elpaa--export-org readme-file-name 'html + :body-only t :ext-plist elpaa--org-export-options))) + (_ ;; Non-Org readme. + (setf readme-content (elpaa--get-section + "Commentary" readme-file-name + dir pkg-spec) + page-content (when readme-content + (concat "
\n"
+                                        (elpaa--html-quote readme-content)
+                                        "\n
\n"))))) + (when readme-content + (write-region readme-content nil output-filename) + (insert "

Full description

\n" page-content))) ;; (message "latest=%S; files=%S" latest files) (unless (< (length files) (if (zerop (length latest)) 1 2)) (insert (format "

Old versions

\n")) -- 2.7.4 --=-=-=--