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 kE+pHABU118ybAAA0tVLHw (envelope-from ) for ; Mon, 14 Dec 2020 12:01:04 +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 2JieGABU118vVwAAB5/wlQ (envelope-from ) for ; Mon, 14 Dec 2020 12:01:04 +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 77B539405D4 for ; Mon, 14 Dec 2020 12:00:58 +0000 (UTC) Received: from localhost ([::1]:40066 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kokih-00024d-9d for larch@yhetil.org; Mon, 14 Dec 2020 05:04:43 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:35656) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kokhE-0001qi-36 for emacs-orgmode@gnu.org; Mon, 14 Dec 2020 05:03:17 -0500 Received: from mail-pj1-x1044.google.com ([2607:f8b0:4864:20::1044]:38795) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kokhA-0006Tj-8j; Mon, 14 Dec 2020 05:03:11 -0500 Received: by mail-pj1-x1044.google.com with SMTP id j13so6319334pjz.3; Mon, 14 Dec 2020 02:03:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:date:in-reply-to :message-id:mime-version; bh=WwgzYF/ljZa1luJ90eiHdrT0ZihBWOIfNwqqxO9440U=; b=AmljFs4bSSTKbdEnQEMB6i8MLTmsilgCMIfhMIOXQsfdYu6hzfAngTc40FswC049GE tYDcbb9kOoiako1873eIsZ64zyssyVPBzx+JplydILc4pcC1cfx5orcvB5bNd+Z9n+1Q A2k9XVy8gLm0WsSdW6L/n5u5gB4KB0GX9TiDO5Rks3pRewHJeOr0QFaDmwSMcxkDfhN6 W7gd+OMYH9ksBHRpvXipyWdryvAWanDBlkCHnOpUSLuFBqzUitWcpSNscZs3oEg5lUSW fAO8ljx6uNbZqbWsZ8IpW3lEd71K2H6+lJOt+i2Rl0pMAHg6l+TTwVKiS046HHdoIUWY 7p0g== 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:date :in-reply-to:message-id:mime-version; bh=WwgzYF/ljZa1luJ90eiHdrT0ZihBWOIfNwqqxO9440U=; b=CU+iKIttgVRyvVtgZeTNwOJQvqXPW6hk/3yOhtsVjql9S6DJAJpXkCn74rRfUDta7G F63B1f0wS6KiBoEriaREWvj1yRlII8QJ157gTRDOm3uWChVETvQ3fwovi1e9waTMR5T5 83R0rf73ySN5EtcbvrDk2YZtEHPEAxnGsUKVvkKTmo+P+YclrKR5YX6NVIp/93UuxSOf 2TbiRBsRxxaKzDiPrfgVVIiQ5g147Tg611jfCd+zkWQKJlsoa5dbkJdFI+2TjxqBSnzP Msz10H51bszQh2CJ5MGysKKrEufDdR3IFM4NArbCGfOLT5ZCtF3W7oRgAG3Ev4HPj/iz rPOA== X-Gm-Message-State: AOAM532MNliXJWn0VA3OZUiLb88wWzO+xF41R3+BPuWgGH5r29O1nTgj PCNRawiLvyOG6+4a5PFyFksQQ6ZSO74= X-Google-Smtp-Source: ABdhPJx3RGCwBtqIgp/pqpt0X74B75q1lBXHHwjv6ykgbyz2CG8xrPX2ufnMqUbQZwqKUcuBhi+fvg== X-Received: by 2002:a17:902:7149:b029:db:a6de:4965 with SMTP id u9-20020a1709027149b02900dba6de4965mr21992321plm.3.1607940186090; Mon, 14 Dec 2020 02:03:06 -0800 (PST) Received: from localhost (180-150-91-8.b4965b.per.nbn.aussiebb.net. [180.150.91.8]) by smtp.gmail.com with ESMTPSA id g34sm19232719pgb.33.2020.12.14.02.03.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 14 Dec 2020 02:03:05 -0800 (PST) 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> <87wo0fktjs.fsf@gmail.com> <874knjrtg9.fsf@wi.uni-muenster.de> <87tuvjkqzl.fsf@gmail.com> <87sgb28gd8.fsf@wi.uni-muenster.de> <87blexel9f.fsf@gmail.com> <87im94ordh.fsf@gnu.org> <871rfs6fl0.fsf@gmail.com> <87k0tkam61.fsf@bzg.fr> <87zh2g4zem.fsf@gmail.com> <877dpkajtl.fsf@bzg.fr> User-agent: mu4e 1.4.13; emacs 27.1 From: TEC To: Bastien Subject: Re: [PATCH] Enhance org-html--build-meta-info Date: Mon, 14 Dec 2020 18:01:38 +0800 In-reply-to: <877dpkajtl.fsf@bzg.fr> Message-ID: <87blewpuwa.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::1044; envelope-from=tecosaur@gmail.com; helo=mail-pj1-x1044.google.com 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: Jens Lechtenboerger , org-mode-email Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -1.21 Authentication-Results: aspmx1.migadu.com; dkim=fail (body hash did not verify) header.d=gmail.com header.s=20161025 header.b=AmljFs4b; 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-Migadu-Queue-Id: 77B539405D4 X-Spam-Score: -1.21 X-Migadu-Scanner: scn0.migadu.com X-TUID: Hrq4raQW2DnE --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Bastien writes: > TEC writes: > >> In case of confusion, this isn't replacing the #+title in the document, >> just the ... which is used as the tab content. > > Fine then. =F0=9F=98=85 as it so happens I've revised my thoughts, and I'm just leavin= g it blank as it currently is. Anyway, here are the revised patches. Let me know if there's anything else you'd like to see tweaked :) -- Timothy --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-lisp-ox-html.el-make-html-meta-tag-builder-nicer.patch >From 92b2ab771a1f90f269f20727903c9f42596d32e6 Mon Sep 17 00:00:00 2001 From: TEC Date: Mon, 14 Dec 2020 17:41:33 +0800 Subject: [PATCH 1/2] lisp/ox-html.el: make html meta tag builder nicer * lisp/ox-html.el (org-html--build-meta-info): Multi-line repeated structure extracted to new function `org-html--build-meta-entry'. The keyword value formatting is changed from `org-export-data' to `org-html-encode-plain-text' to avoid potentially nesting HTML tags in meta tags and the element, which would violate W3C. --- lisp/ox-html.el | 112 +++++++++++++++++++++++------------------------- 1 file changed, 54 insertions(+), 58 deletions(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index d2f24f5c6..e774b53ac 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1835,78 +1835,74 @@ 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 <meta> tag of form <meta LABEL=\"IDENTITY\" />, or when CONTENT-FORMAT is present: +<meta LABEL=\"IDENTITY\" content=\"{content}\" /> + +Here {content} is determined by applying any CONTENT-FORMATTERS to the CONTENT-FORMAT and encoding +the result as plain text." + (concat "<meta " + (format "%s=\"%s" label identity) + (when content-format + (concat "\" content=\"" + (replace-regexp-in-string + "\"" """ + (org-html-encode-plain-text + (if content-formatters + (apply #'format content-format content-formatters) + content-format))))) + "\" />\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)) - ;; 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))) + (let* ((title (org-html-encode-plain-text (or (car (plist-get info :title)) ""))) + ;; 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. - (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 - 'mime-charset)) - "iso-8859-1"))) + (and auth (org-element-interpret-data auth))))) + (charset (or (and org-html-coding-system + (fboundp 'coding-system-get) + (symbol-name + (coding-system-get org-html-coding-system + 'mime-charset))) + "iso-8859-1"))) (concat (when (plist-get info :time-stamp-file) (format-time-string (concat "<!-- " (plist-get info :html-metadata-timestamp-format) " -->\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"))) + (if viewport-options + (org-html--build-meta-entry "name" "viewport" + (mapconcat + (lambda (elm) (format "%s=%s" (car elm) (cadr elm))) + viewport-options ", ")))) + (format "<title>%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"))))) + + (when (org-string-nw-p author) + (org-html--build-meta-entry "name" "author" author)) + + (when (org-string-nw-p (plist-get info :description)) + (org-html--build-meta-entry "name" "description" (plist-get info :description))) + + (when (org-string-nw-p (plist-get info :keywords)) + (org-html--build-meta-entry "keywords" (plist-get info :keywords))) + + (org-html--build-meta-entry "name" "generator" "Org Mode")))) (defun org-html--build-head (info) "Return information for the .. of the HTML output. -- 2.29.2 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-lisp-ox-html.el-make-html-meta-tags-customizable.patch >From a2fae2c3c7f38ee8d22a4fedbce25d046c8a818d Mon Sep 17 00:00:00 2001 From: TEC Date: Mon, 14 Dec 2020 17:50:15 +0800 Subject: [PATCH 2/2] lisp/ox-html.el: make html meta tags customizable * lisp/ox-html.el (org-html-meta-tags): Introduce this as a new option which can be modified to set the meta tags added in HTML exports. (org-html--build-meta-info): Make use of `org-html-meta-tags' instead of hardcoded meta tags. This is leveraging the earlier restructuring of `org-html--build-meta-info' into a much DRYer form, such that this modification has a negligible impact on complexity and readability. --- lisp/ox-html.el | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index e774b53ac..35e056557 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 @@ -1893,16 +1918,14 @@ INFO is a plist used as a communication channel." (format "%s\n" title) - (when (org-string-nw-p author) - (org-html--build-meta-entry "name" "author" author)) - - (when (org-string-nw-p (plist-get info :description)) - (org-html--build-meta-entry "name" "description" (plist-get info :description))) - - (when (org-string-nw-p (plist-get info :keywords)) - (org-html--build-meta-entry "keywords" (plist-get info :keywords))) - - (org-html--build-meta-entry "name" "generator" "Org Mode")))) + (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.29.2 --=-=-=--