emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Eric Schulte <schulte.eric@gmail.com>
Cc: Org Mode Mailing List <emacs-orgmode@gnu.org>
Subject: Re: numbered equations in html export
Date: Tue, 01 Jul 2014 15:29:22 +0200	[thread overview]
Message-ID: <878uodryvh.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <877g3xd82k.fsf@gmail.com> (Eric Schulte's message of "Tue, 01 Jul 2014 00:19:43 -0400")


Eric Schulte <schulte.eric@gmail.com> writes:

> Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

>> Only captioned equations are numbered. Behaviour is undefined for other
>> equations.

> Why is this the default behavior?  It looks to me like even when they're
> present captions on equations aren't displayed for HTML or LaTeX export.

LaTeX export uses its own numbering mechanism over which Org has no
control. It is true that captions are not used in latex environments,
but that's orthogonal to the problem. Let's put it aside for now.

HTML export relies on Org's mechanism to number objects (i.e.,
`org-export-get-ordinal'). It conforms to numbering rules of other
elements, like tables. It is important for tables to require a caption.
Otherwise, a list of tables would have non-consecutive numbers.
Equations are consistent with this.

> Additionally I don't see why captions should be related to, or required
> for, the numbering of equations.

It is odd to reference a number used nowhere. For example, it is
confusing to follow an "equation 2" link and see a page full of
equations with no attached number below.

Admittedly, this point is moot as long as captions are not visible on
latex environments. I think this should be fixed instead.

Another advantage is that you can always link to an unnumbered equation
(just providing a name and no caption), which would not be possible if
every named equation was numbered.

> In a related issue which I believe is more convincingly a bug; links to
> equations (whether numbered or not, with or without captions) don't
> actually point anywhere.  A link to the name is constructed, but no
> anchor with the name is inserted into the page.

This looks like a limitation from `org-html-latex-environment' (there
is a comment about it) due to mathjax handling.

> Would it make sense to change the current behavior as follows?
> 1. On HTML export all named equations are made into targets for a link
>    based on their name.

It makes sense, there is just mathjax case to handle. It could go along
with your other patch protecting characters, as a special treatment
related to mathjax.

> 2. All named and referenced equations are numbered.

IMO it would be more sensible to handle captions for equations, for the
reasons explained above.


Nicolas Goaziou

  reply	other threads:[~2014-07-01 13:29 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-30 16:35 numbered equations in html export Eric Schulte
2014-06-30 20:22 ` Nicolas Goaziou
2014-07-01  4:19   ` Eric Schulte
2014-07-01 13:29     ` Nicolas Goaziou [this message]
2014-07-01 14:02       ` Nick Dokos
2014-07-01 14:56         ` Nicolas Goaziou
2014-07-01 15:33           ` Nick Dokos

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:

  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=878uodryvh.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=emacs-orgmode@gnu.org \
    --cc=schulte.eric@gmail.com \


* 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


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).