emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Rudolf Adamkovič" <salutis@me.com>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Improve the docstring for 'org-html-mathjax-options'
Date: Wed, 31 Aug 2022 16:18:34 +0200	[thread overview]
Message-ID: <m25yi85wed.fsf@me.com> (raw)
In-Reply-To: <87h71xuhdw.fsf@localhost>

[-- Attachment #1: Type: text/plain, Size: 1052 bytes --]

Ihor Radchenko <yantar92@gmail.com> 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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-incorrectly-documented-auto-numbering-of-MathJax.patch --]
[-- Type: text/x-patch, Size: 1218 bytes --]

From c9b82b85515c7a7f334976aa90bd59bac8932461 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= <salutis@me.com>
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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Fix-under-documented-MathJax-indentation-option.patch --]
[-- Type: text/x-patch, Size: 1193 bytes --]

From 003013f8e79ccc4570df5f7df89ccc3dfcb35e06 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rudolf=20Adamkovi=C4=8D?= <salutis@me.com>
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


[-- Attachment #4: Type: text/plain, Size: 300 bytes --]

-- 
"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č <salutis@me.com> [he/him]
Studenohorská 25
84103 Bratislava
Slovakia

  reply	other threads:[~2022-08-31 14:19 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-26  6:09 Improve the docstring for 'org-html-mathjax-options' Rudolf Adamkovič
2022-06-26  6:25 ` Ihor Radchenko
2022-06-26  6:26   ` Ihor Radchenko
2022-06-26  8:25   ` Bastien Guerry
2022-08-28  4:22 ` Ihor Radchenko
2022-08-31 14:18   ` Rudolf Adamkovič [this message]
2022-09-02 12:45     ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m25yi85wed.fsf@me.com \
    --to=salutis@me.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).