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 GMTAEtCLY1/tNgAA0tVLHw (envelope-from ) for ; Thu, 17 Sep 2020 16:16:16 +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 QNOIDtCLY1/3KQAAB5/wlQ (envelope-from ) for ; Thu, 17 Sep 2020 16:16:16 +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 C481B9404C5 for ; Thu, 17 Sep 2020 16:16:15 +0000 (UTC) Received: from localhost ([::1]:37164 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kIwZq-0004tU-Mx for larch@yhetil.org; Thu, 17 Sep 2020 12:16:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47992) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kIwY6-0004eM-L6 for emacs-orgmode@gnu.org; Thu, 17 Sep 2020 12:14:18 -0400 Received: from mail-pj1-x1036.google.com ([2607:f8b0:4864:20::1036]:53837) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kIwY4-0006pt-9t for emacs-orgmode@gnu.org; Thu, 17 Sep 2020 12:14:18 -0400 Received: by mail-pj1-x1036.google.com with SMTP id t7so1535307pjd.3 for ; Thu, 17 Sep 2020 09:14:15 -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:content-transfer-encoding; bh=s/mZdb3psysov93LcNOCaylFt5Ug6F5AtkYROwxDaes=; b=OqHLi66SuGiRCOP66lyBiFM5tQIVQu6yAKPi3iI97+lk9oBGsjyeXB6ffc5jLer6tq /pHk1sSJyE5uw5HAMA2lN+BMX/bFIvF7V6tE41AI2G3ykOa5kFgwvjMFfoM3MspmLzbK dXp7zg7zfQJupu1IAE0aKBFmY3PfEgvxGpg1aswn7ErzsbJnB/kZczf1bQs2hINlgk3c aHOukhFMXXgy+uS1YfKtulluETPPccExJMvDmWhG8gyOCkhFCce3nPG+wZUiLZvO7Lcq AjrmevJUVpBl88TpV+As8kS+UR+XkkY51nmwQVL9L1SdQPyxMQDzgoN/7GlGAi0iEjES 0PpA== 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:content-transfer-encoding; bh=s/mZdb3psysov93LcNOCaylFt5Ug6F5AtkYROwxDaes=; b=VjzReb+PsDlTS52e1007vEAoYjPM50EH39WSqim18T2wfZacRpsnSQiv7QfQ/yVApZ NxZ1g7DMDXEI9XJkPtITSs1zSPy7eN9nZp2REM2MNrWeZ3TN7ubR5aH8KHjuvTcVeb9K IMYMTYYQMpjHhpMw4g/QJitU1kDo//RXzb8/SKbhC82lUwT1dWbHiElekJyod7dhVKGi 3FgFvqawrd1fR2MnwFoQuXqxRHam1QopGJIzeBb0i6/ko1JtgfIzQapsJVwzNdtkPd6I 0mKprrWvCtZQ1HiPfHJIGeYppOORyM5AWQ8UWgj+7NimgEfrTkEWI9ENmfQh3F8FWsCb blqQ== X-Gm-Message-State: AOAM531N5Q3frAK3Q4oLph5XvvfyKlvKmsZ/8zImiRmE7APRCdLNx8qU tU5luZr5p/544nvS3ETEiJA= X-Google-Smtp-Source: ABdhPJwphTlHw61J2GBnYaIBwvhN7sMs7wKwKxjROyJTqAVcxXozvw3N6uWoLfcOwCNXHKoQ59dgVg== X-Received: by 2002:a17:902:b685:b029:d1:e5f8:81e1 with SMTP id c5-20020a170902b685b02900d1e5f881e1mr10915337pls.83.1600359254678; Thu, 17 Sep 2020 09:14:14 -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 5sm73176pgf.21.2020.09.17.09.14.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Sep 2020 09:14:14 -0700 (PDT) References: <87pn6kfr19.fsf@gmail.com> <87v9gcz9ge.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: <87v9gcz9ge.fsf@wi.uni-muenster.de> Message-ID: <87lfh8fkj1.fsf@gmail.com> Date: Fri, 18 Sep 2020 00:14:10 +0800 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=2607:f8b0:4864:20::1036; envelope-from=tecosaur@gmail.com; helo=mail-pj1-x1036.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=OqHLi66S; 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: hyZZszD5EuY1 Jens Lechtenboerger writes: > Hi Timothy, Hi Jens! Thanks for responding. > yes, I agree that org-html--build-meta-info needs work, and the HTML > backend would benefit from more documentation. Back then [1], I > wondered which parts of meta data need to be treated how. That was > continued in thread [2]. I haven't really considered changing the output of the function (other than removing keywords). Reading the email you've linked to, it looks like a change to `org-html-encode-plain-text' would be a good idea though. > As pointed out back then, using org-export-data on the title is > wrong as it creates nested elements, leading to invalid HTML. > > Currently, org-element-interpret-data is applied for author > information, while description and keywords are treated differently. > Your patch goes for org-html-encode-plain-text in the new function > org-html--build-meta-entry, which (if I=E2=80=99m not mistaken) produces > author and description. Did you think about using > org-element-interpret-data instead? What if that was used? > I believe this to be an important question as it might affect > backward compatibility and should be documented. I was not aware of org-element-interpret-data, and I can't say I can really tell what it does. If you'd care to elaborate that would be helpful. > Does this really work for you? For the author, first > org-html--build-meta-entry gets called from the new defcustom. The > result is assigned with setq to form, which then is non-nil so that > org-html--build-meta-entry is applied again, leading to an error > here. Ooops, I forgot to remove org-html--build-meta-entry from the defcustom. (I didn't notice because I overwrite it anyway in my personal config). > Besides, did you forget keywords or remove them on purpose? This is a deliberate omission. My impression is that the value of keywords in HTML documents has evaporated over the past decade, see: https://yoast.com/meta-keywords/ Let me know if you know otherwise. > Best wishes > Jens Thanks for your feedback! Timothy. ----- Updated patch: >From 3a02e4d3bce5f7f0cbdb34c98f4267cea40eec3e 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 | 111 ++++++++++++++++++++++++++---------------------- 1 file changed, 61 insertions(+), 50 deletions(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index d2f24f5c6..df7da1a68 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1425,6 +1425,28 @@ 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)))) + ("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 A= UTHOR +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 +1857,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=3D\"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 +1893,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=3D\"%s\"" info) - (org-html-close-tag - "meta" "http-equiv=3D\"Content-Type\" content=3D\"text/html;charset=3D%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=3D" 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=3D\"viewport\" content=3D\"%s\"" - (mapconcat - (lambda (elm) (format "%s=3D%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=3D%s" (c= ar elm) (cadr elm))) + viewport-options ", ")))) + (format "%s\n" title) - (org-html-close-tag "meta" "name=3D\"generator\" content=3D\"Org mode= \"" info) - "\n" - (and (org-string-nw-p author) - (concat - (org-html-close-tag "meta" - (format "name=3D\"author\" content=3D\"%s\"" - (funcall protect-string author)) - info) - "\n")) - (and (org-string-nw-p description) - (concat - (org-html-close-tag "meta" - (format "name=3D\"description\" content=3D\"%s\"\n" - (funcall protect-string description)) - info) - "\n")) - (and (org-string-nw-p keywords) - (concat - (org-html-close-tag "meta" - (format "name=3D\"keywords\" content=3D\"%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