From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id gu5aGZTOcF8gcAAA0tVLHw (envelope-from ) for ; Sun, 27 Sep 2020 17:40:36 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id sElqFJTOcF9sMgAAB5/wlQ (envelope-from ) for ; Sun, 27 Sep 2020 17:40:36 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id BCC5F940365 for ; Sun, 27 Sep 2020 17:40:35 +0000 (UTC) Received: from localhost ([::1]:56412 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kMaf3-0005eS-JY for larch@yhetil.org; Sun, 27 Sep 2020 13:40:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47092) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kMaeV-0005eL-Sl for emacs-orgmode@gnu.org; Sun, 27 Sep 2020 13:39:59 -0400 Received: from mail-pf1-x441.google.com ([2607:f8b0:4864:20::441]:33571) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kMaeU-0003PV-1j for emacs-orgmode@gnu.org; Sun, 27 Sep 2020 13:39:59 -0400 Received: by mail-pf1-x441.google.com with SMTP id q123so1964597pfb.0 for ; Sun, 27 Sep 2020 10:39:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:message-id :date:mime-version; bh=VIZ6E5Mqk5GXWMB0pTHnjWTHcuwWAZxwzzQQu1ngnIs=; b=YhruQTE54rhIOxYDeuIUOnFcfnwPZlpaweFFaRvce8AObtvWLbwMHg35/RMnBksqUF ZM0x5oPZmyrn9yE0QqK86ilsBt9pXG+MeQ4tcA4FeWOscLMndTUgPleV98jsz16ep67i oCGpYECLiO7VGQ8sL4Wxszm8lXPicEyxqlOCmTOuHTrUUhbVGlDBojg9egwrNpkr3lLY 3++93tAMfUfsF3GaoTxvZ8yzmIzUzEJgtQtY2U0zSM7Wy3Xsvagrt06GT05t3s6Iswb+ gikZHbzqN1zBli9xnlNLJSLUeFk9gnyV3DVARndyEDkOQxleJ0QS+Ph2sKoe/jj8AUpi mNEw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:message-id:date:mime-version; bh=VIZ6E5Mqk5GXWMB0pTHnjWTHcuwWAZxwzzQQu1ngnIs=; b=cbLaZ4kStoPWAsfpuj53oGZuT5d3QPyDmHkXT410peHoyUInCFpOsO258wElpwRIu7 j3A57JN/qPnOWlEfSAunIEJP3GngXOeIVPdY2ftQUZL2h0HsnSj+1dd70dDaApSVF3ev PHfOHbnTxP1KedkPcHuOPFkCzWOMVQZ4yoEp47cN+Aaxh8AQeNZs4csf+V7VfQLNhDNa sob2o+kn+BmKYof7OYvWYGCdbZx8A/8Lq3GsBvTq7Q+A2r/EmQNKpQfJdmvawuxMuBeI 0QtCEgka1FXg0NAj+gkH1kZxjBj0s3T2o4B/zS21/LBskUtl9L0r/2EBFAaWRGXlKj03 AreQ== X-Gm-Message-State: AOAM530A4kI/sDN0f/PgqzGVn5zP60bZ4QEGNV/mMMjzlMYTvWhh7r78 alhQl2klApldc+wXC0gC4SbtWcEY1JI= X-Google-Smtp-Source: ABdhPJwAqHA4mJpTZUsIg+DOlHwHp/mXtmPCl0KaGn/jRdehzF+sG/ZjsWyUVTbbvTa7zabRbIStbg== X-Received: by 2002:aa7:941a:0:b029:142:2501:35d1 with SMTP id x26-20020aa7941a0000b0290142250135d1mr7749335pfo.49.1601228395670; Sun, 27 Sep 2020 10:39:55 -0700 (PDT) Received: from localhost (180-150-91-8.b4965b.per.nbn.aussiebb.net. [180.150.91.8]) by smtp.gmail.com with ESMTPSA id z1sm7349388pgu.80.2020.09.27.10.39.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 27 Sep 2020 10:39:55 -0700 (PDT) References: <87pn6kfr19.fsf@gmail.com> <87v9gcz9ge.fsf@wi.uni-muenster.de> <87lfh8fkj1.fsf@gmail.com> <87zh5n1p3s.fsf@wi.uni-muenster.de> <87tuvl3fyc.fsf@gmail.com> <878scvs0z7.fsf@wi.uni-muenster.de> User-agent: mu4e 1.4.13; emacs 27.1 From: TEC To: Jens Lechtenboerger Subject: Re: [PATCH] Enhance org-html--build-meta-info In-reply-to: <878scvs0z7.fsf@wi.uni-muenster.de> Message-ID: <87wo0fktjs.fsf@gmail.com> Date: Mon, 28 Sep 2020 01:39:51 +0800 MIME-Version: 1.0 Content-Type: text/plain; format=flowed Received-SPF: pass client-ip=2607:f8b0:4864:20::441; envelope-from=tecosaur@gmail.com; helo=mail-pf1-x441.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: org-mode-email Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=fail (body hash did not verify) header.d=gmail.com header.s=20161025 header.b=YhruQTE5; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Spam-Score: 0.09 X-TUID: KmHhsJEaGu/U Jens Lechtenboerger writes: >> Currently the only element handled differently to >> `org-html-encode-plain-text' is "author". I don't know why so I >> don't >> want to touch it. > > I believe that was also the previous conclusion. However, as > this > is not documented, maybe now could be the chance to change this? Hmm. Maybe, it sounds like some tests may be in order. > I must I admit that I do not fully understand your approach. > > Why do you treat keywords and description differently (with > description in org-html-meta-tags and keywords in > org-html--build-meta-info)? Ooops, that should have been in org-html-meta-tags as the rest are. [Fixed] > Why do you pass _title into the lambda expressions in > org-html-meta-tags when it is never used? Currently, the > variable > org-html-meta-tags does not seem user-friendly to me. Title and author just seemed like the most likely useful information for customisation. It would be nice if it looked less boiler-plate-y, but I'm not sure what the best approach for that would be, and it's already miles better than the current. If you have any ideas, please let me know. > Also, in org-html--build-meta-info you call > org-html-encode-plain-text with two arguments, but it just > accepts > one. ? No I don't. > Best wishes > Jens Hope that clarifies things a bit, Timothy. ------ Moved the keyword in with the rest. >From 889ae918aed267417825d565df9135221dae16b1 Mon Sep 17 00:00:00 2001 From: TEC Subject: [PATCH] lisp/ox-html.el: make html meta func nicer * lisp/ox-html.el (org-html--build-meta-info): Multi-line repeated structure extracted to new function `org-html--build-meta-entry'. The opportunity was taken to extract most metadata info to custom variable `org-html-meta-tags', allowing for easy end-user modification. --- lisp/ox-html.el | 114 +++++++++++++++++++++++++++--------------------- 1 file changed, 64 insertions(+), 50 deletions(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index d2f24f5c6..46195b0e0 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1425,6 +1425,31 @@ not be modified." ;;;; Template :: Styles +(defcustom org-html-meta-tags + '((lambda (_title author _info) + (when (org-string-nw-p author) + (list "name" "author" author))) + (lambda (_title _author info) + (when (org-string-nw-p (plist-get info :description)) + (list "name" "description" + (plist-get info :description)))) + (lambda (_title _author info) + (when (org-string-nw-p (plist-get info :keywords)) + (list "keywords" (plist-get info :keywords)))) + ("name" "generator" "Org Mode")) + "A list of arguments to be passed to `org-html--build-meta-entry'. +Each argument can either be an list which is applied, or a function which +generates such a list with signature (TITLE AUTHOR INFO) where TITLE and AUTHOR +are strings, and INFO a communication plist." + :group 'org-export-html + :package-version '(Org . "9.5") + :type '(repeat + (choice + (list (string :tag "Meta label") + (string :tag "label value") + (string :tag "Content value")) + function))) + (defcustom org-html-head-include-default-style t "Non-nil means include the default style in exported HTML files. The actual style is defined in `org-html-style-default' and @@ -1835,23 +1860,31 @@ INFO is a plist used as a communication channel." ;;; Template +(defun org-html--build-meta-entry (label identity &optional content-format &rest content-formatters) + "Construct tag with LABEL=\"IDENTITY\" and content from CONTENT-FORMAT and CONTENT-FORMATTER." + (concat "\n")) + (defun org-html--build-meta-info (info) "Return meta tags for exported document. INFO is a plist used as a communication channel." - (let* ((protect-string - (lambda (str) - (replace-regexp-in-string - "\"" """ (org-html-encode-plain-text str)))) - (title (org-export-data (plist-get info :title) info)) + (let* ((title (org-html-encode-plain-text (plist-get info :title) info)) ;; Set title to an invisible character instead of leaving it ;; empty, which is invalid. (title (if (org-string-nw-p title) title "‎")) (author (and (plist-get info :with-author) (let ((auth (plist-get info :author))) - ;; Return raw Org syntax. + ;; Return raw Org syntax. (and auth (org-element-interpret-data auth))))) - (description (plist-get info :description)) - (keywords (plist-get info :keywords)) (charset (or (and org-html-coding-system (fboundp 'coding-system-get) (coding-system-get org-html-coding-system @@ -1863,50 +1896,31 @@ INFO is a plist used as a communication channel." (concat "\n"))) - (format - (if (org-html-html5-p info) - (org-html-close-tag "meta" "charset=\"%s\"" info) - (org-html-close-tag - "meta" "http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"" - info)) - charset) "\n" + + (if (org-html-html5-p info) + (org-html--build-meta-entry "charset" charset) + (org-html--build-meta-entry "http-equiv" "Content-Type" + (concat "text/html;charset=" charset))) + (let ((viewport-options - (cl-remove-if-not (lambda (cell) (org-string-nw-p (cadr cell))) - (plist-get info :html-viewport)))) - (and viewport-options - (concat - (org-html-close-tag - "meta" - (format "name=\"viewport\" content=\"%s\"" - (mapconcat - (lambda (elm) (format "%s=%s" (car elm) (cadr elm))) - viewport-options ", ")) - info) - "\n"))) + (cl-remove-if-not (lambda (cell) (org-string-nw-p (cadr cell))) + (plist-get info :html-viewport)))) + (if viewport-options + (org-html--build-meta-entry "name" "viewport" + (mapconcat + (lambda (elm) (format "%s=%s" (car elm) (cadr elm))) + viewport-options ", ")))) + (format "%s\n" title) - (org-html-close-tag "meta" "name=\"generator\" content=\"Org mode\"" info) - "\n" - (and (org-string-nw-p author) - (concat - (org-html-close-tag "meta" - (format "name=\"author\" content=\"%s\"" - (funcall protect-string author)) - info) - "\n")) - (and (org-string-nw-p description) - (concat - (org-html-close-tag "meta" - (format "name=\"description\" content=\"%s\"\n" - (funcall protect-string description)) - info) - "\n")) - (and (org-string-nw-p keywords) - (concat - (org-html-close-tag "meta" - (format "name=\"keywords\" content=\"%s\"" - (funcall protect-string keywords)) - info) - "\n"))))) + + (apply #'concat + (mapcar + (lambda (form) + (when (functionp form) + (setq form (funcall form title author info))) + (when form + (apply #'org-html--build-meta-entry form))) + org-html-meta-tags))))) (defun org-html--build-head (info) "Return information for the .. of the HTML output. -- 2.28.0