From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id sOqGOOZtD2PY7AAAbAwnHQ (envelope-from ) for ; Wed, 31 Aug 2022 16:19:18 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id sE6gOOZtD2PC/gAA9RJhRA (envelope-from ) for ; Wed, 31 Aug 2022 16:19:18 +0200 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 718172CEE4 for ; Wed, 31 Aug 2022 16:19:18 +0200 (CEST) Received: from localhost ([::1]:58878 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oTOYm-00041s-QZ for larch@yhetil.org; Wed, 31 Aug 2022 10:19:16 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60090) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oTOYI-00040s-61 for emacs-orgmode@gnu.org; Wed, 31 Aug 2022 10:18:46 -0400 Received: from mr85p00im-ztdg06011101.me.com ([17.58.23.185]:37690) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oTOYF-0007MJ-J9 for emacs-orgmode@gnu.org; Wed, 31 Aug 2022 10:18:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=me.com; s=1a1hai; t=1661955518; bh=YYlBK+DFTXLZqoN+eWcYXZlyFb0+zKD27Me8xl9G4aI=; h=From:To:Subject:Date:Message-ID:MIME-Version:Content-Type; b=CXyHqwI16PQq+622twNhU5JKPETazNHxDGGJ7NUgAHqQtYPk5q2erhunf+AHIbFpL flABQD7meMz8Aq3/Pw6jdwARvAK3G1ssXHzWo973Jbsy4JqDcp7O2qJr2u4r5n7jI1 gQpd4opZQAcurF4I+i5KSTTApxlhBsAgnN+W7uCtJGprdm2MC6tuRy71NUqDoH2vCw 9jXY+qxyM7B1s6i/0DpbFTdKZtTd5NS4TUsaD6+VhSV2wLv3Q9akWSLROVgT64eXON bQrmzsmWsw9Aojf4thPXBUKjcMSmr5X7igFnwr3Oo1cJ23hQnRm2iWxedO5y5j4q6f E5biz4YFuT2jQ== Received: from Rudolfs-MacBook-Air.local (mr38p00im-dlb-asmtp-mailmevip.me.com [17.57.152.18]) by mr85p00im-ztdg06011101.me.com (Postfix) with ESMTPSA id 5014CDA0671; Wed, 31 Aug 2022 14:18:37 +0000 (UTC) From: Rudolf =?utf-8?Q?Adamkovi=C4=8D?= To: Ihor Radchenko Cc: emacs-orgmode@gnu.org Subject: Re: Improve the docstring for 'org-html-mathjax-options' In-Reply-To: <87h71xuhdw.fsf@localhost> References: <87h71xuhdw.fsf@localhost> Date: Wed, 31 Aug 2022 16:18:34 +0200 Message-ID: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Proofpoint-ORIG-GUID: lW0fFauEkCSlxviYoOHdDhbIr4fLadcf X-Proofpoint-GUID: lW0fFauEkCSlxviYoOHdDhbIr4fLadcf X-Proofpoint-Virus-Version: =?UTF-8?Q?vendor=3Dfsecure_engine=3D1.1.170-22c6f66c430a71ce266a39bfe25bc?= =?UTF-8?Q?2903e8d5c8f:6.0.138,18.0.572,17.11.62.513.0000000_definitions?= =?UTF-8?Q?=3D2020-02-14=5F11:2020-02-14=5F02,2020-02-14=5F11,2021-12-02?= =?UTF-8?Q?=5F01_signatures=3D0?= X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 bulkscore=0 mlxscore=0 clxscore=1015 spamscore=0 adultscore=0 phishscore=0 mlxlogscore=419 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2206140000 definitions=main-2208310072 Received-SPF: pass client-ip=17.58.23.185; envelope-from=salutis@me.com; helo=mr85p00im-ztdg06011101.me.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1661955558; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=YYlBK+DFTXLZqoN+eWcYXZlyFb0+zKD27Me8xl9G4aI=; b=KnlO62AOlSJHUsRbV0jVDid8/m09uJNexSFRgJ0kqc7lv9yVy9fnqf4eIZtSVschHpkJQ0 WDkFvy38BktL3GaTVPHNVjwyMRgAzGrkqZ1rAjoGJzmRitqaXKl0+6W3b2jqK72oyMUx0k Gxb/d3v8HNQzX8d4tZQ0142wCC6n6rCRc7arV/8bMB5fMT0k8IzwrNieb01FwmvJVjpUOs 5XY98mSG23bD+Kgxl/VMA8oquyP+RINkZzkbqnbXBgT2yTlLJ/pRwWsfONM2RHjlwMgk2U EaSY0j1E17M96FPeHM04oMgdT7DP8qmqS0BV10Vnsl7ZT2RgObKKFGy9lhGXGg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1661955558; a=rsa-sha256; cv=none; b=H+0jK87QUzeoCQ9kWjjImfei2RiBuE/vFUmErQHxGa8YxR7jvhJds9xSqtsWo1I/XUYe9q yTGh2QJ+KTakdUtczjzkTg9WiTNhHFj3rRsSdkQdz7NtcoiEcElUhuWpdqDOHYp9loByAt sqAHYoB5B43Ownfqknku/ZK0WdOrDyOOTl4UikXMLjU7ZxaNWh+4UHrDhFD1Ly3X9xR51m UJ3jg0P/rA6AedRFwasBoPFs9p/2DbedYfYG8FhZvwmuyJ+TEoCQW6VVBbEBSF7rSb2KqK ME7eavfmW5gUriWT7uCqG4VNyykoj0V5u2lfJH4NaUZxPOpfpGXI5iGw5QToBA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=me.com header.s=1a1hai header.b=CXyHqwI1; dmarc=pass (policy=quarantine) header.from=me.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -2.38 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=me.com header.s=1a1hai header.b=CXyHqwI1; dmarc=pass (policy=quarantine) header.from=me.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 718172CEE4 X-Spam-Score: -2.38 X-Migadu-Scanner: scn1.migadu.com X-TUID: GABqVeiHiZh4 --=-=-= Content-Type: text/plain Ihor Radchenko writes: > Rudolf, since you are probably more familiar with MathJax, may you > please take a look at the report below and tell us if the suggestions > are sensible? Sure, see below. > I tried setting 'autonumber' to "None", as the docstring suggests, but > only the lower-cased "none" worked fine. Oops! I screwed this up (via 15068ce30). I wanted to lowercase "None" but instead I capitalized "All". Please see the attached patch 0001. > Also, MathJax documentation for 2.7 (the version I've got HTML > rendered with by org-mode) mentions "AMS", not "AMS Math" > (http://docs.mathjax.org/en/v2.7-latest/tex.html). We have this fixed on main (via 15068ce30). > Another option that needs attention is 'indent'. The docstring > contains the phrase 'Valid values are "left" and "right"'. We have this fixed on main (via 15068ce30). > This phrase should be changed to something like 'An example of a valid > value is "2em"' or simply removed, I think. Good idea! Please see the attached patch 0002. Rudy --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Fix-incorrectly-documented-auto-numbering-of-MathJax.patch >From c9b82b85515c7a7f334976aa90bd59bac8932461 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Wed, 31 Aug 2022 16:03:38 +0200 Subject: [PATCH 1/2] Fix incorrectly documented auto-numbering of MathJax equations * lisp/org/ox-html.el (org-html-mathjax-options): Fix incorrect choices for the 'autonumber' MathJax option in the docstring. --- lisp/ox-html.el | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index 9e8740754..65b550603 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1186,8 +1186,8 @@ linebreaks Let MathJax perform automatic linebreaks. Valid values are \"true\" and \"false\". indent If align is not center, how far from the left/right side? multlinewidth The width of the multline environment. -autonumber How to number equations. Valid values are \"None\", - \"All\" and \"AMS\". +autonumber How to number equations. Valid values are \"none\", + \"all\" and \"AMS\". tagindent The amount tags are indented. tagside Which side to show tags/labels on. Valid values are \"left\" and \"right\" -- 2.37.2 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0002-Fix-under-documented-MathJax-indentation-option.patch >From 003013f8e79ccc4570df5f7df89ccc3dfcb35e06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= Date: Wed, 31 Aug 2022 16:05:04 +0200 Subject: [PATCH 2/2] Fix under-documented MathJax indentation option * lisp/org/ox-html.el (org-html-mathjax-options): Add an example of a valid value for the 'indent' MathJax option the docstring. --- lisp/ox-html.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index 65b550603..68b35492d 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1184,7 +1184,8 @@ font The font to use with HTML-CSS and SVG output. As of MathJax 2.5 \"Gyre-Termes\", and \"Latin-Modern\". linebreaks Let MathJax perform automatic linebreaks. Valid values are \"true\" and \"false\". -indent If align is not center, how far from the left/right side? +indent If align is not center, how far from the left/right side? For + example, \"1em\". multlinewidth The width of the multline environment. autonumber How to number equations. Valid values are \"none\", \"all\" and \"AMS\". -- 2.37.2 --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable --=20 "Mathematics takes us still further from what is human into the region of absolute necessity, to which not only the actual world, but every possible world, must conform." -- Bertrand Russell, 1902 Rudolf Adamkovi=C4=8D [he/him] Studenohorsk=C3=A1 25 84103 Bratislava Slovakia --=-=-=--