emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Scott Randby <srandby@gmail.com>
To: Scott Otterson <scotto@sharpleaf.org>, emacs-orgmode@gnu.org
Subject: Re: Multiple underscores crash org latex export; other exporters survive
Date: Tue, 6 Dec 2016 13:18:42 -0500	[thread overview]
Message-ID: <501f73ab-1384-a087-1fdc-e3c81ccec1e3@gmail.com> (raw)
In-Reply-To: <CAPY3P0QcpouDjmNpmaY6FzNSNjZyHAGufrbVtSuBzPxr6mUAzg@mail.gmail.com>

On 12/06/2016 02:19 AM, Scott Otterson wrote:
> I understand that orgmode is literally copying Latex; I am suggesting
> that orgmode should do more than copy.

Org only literally copies some expressions. The expression "A_B_C" is
not a LaTeX expression and it cannot be literally copied when exporting
to LaTeX. Instead, Org must export "A_B_C" to a LaTeX expression. In
this case, Org exports to "A\(_{\text{B}}_{\text{C}}\)" because in LaTeX
the underscore character is used for subscripts in mathematical
expressions. The exported string is not a valid LaTeX expression because
the original string is incomplete. If you don't want Org LaTeX export to
export the underscore character to a subscript, the you need to tell Org
you want it to do that with additional markup such as "~A_B_C~" or
something similar. As someone who relies on Org's LaTeX exporting
capability, I would not be in favor of changing how Org exports a
non-LaTeX expression containing underscores.

> 
> This is for the reasons I gave: fixing problems export problems for one
> export type (usually Latex) breaks it for other export types; new users,
> etc. ...). 

I don't think it is possible to have a markup scheme that enables one to
perfectly export every document to every possible format. For instance,
LaTeX and HTML were designed to meet very different needs. The
intersection of these two markup languages is far from the union of
them. Org does a fantastic job of taking care of the intersection, and
it also includes wonderful tools that allow users to deal with instances
outside of the intersection.

I generally avoid exporting an Org file to both LaTeX and HTML (the two
export formats I use) unless the file is very basic. It is too much work
to make a file that exports to both formats well. But I can't blame Org
for that problem. It is the differing natures and purposes of LaTeX and
HTML that cause the trouble.

I'm not saying that Org export is as good as it can be. Certain aspects
of the default LaTeX export could be improved to help new users in my
opinion, but I haven't had the time to suggest those improvements.

I sympathize with the problems some new users may face when exporting an
Org file to various formats. I have friends who moved to Org but had
trouble with PDF export because they had no knowledge of LaTeX or
understanding of TeX distributions. Installing Emacs was a challenge for
some of my friends. The only solution I've been able to devise is to
provide as much help as possible and to encourage my friends to
subscribe to this mailing list.

Scott Randby

> 
> What do you think of those points?
> 
> On Tue, Dec 6, 2016 at 2:33 AM, Scott Randby <srandby@gmail.com
> <mailto:srandby@gmail.com>> wrote:
> 
>     On 12/05/2016 03:36 AM, Scott Otterson wrote:
>     > Yes, there's a general question of how to escape multiple underscores.
>     >
>     > But there's a bigger question too:  Should an org-doc that runs fine in
>     > other exporters cause a messy-to-debug crash when it's exported to
>     > Latex?  Is that the Pandoc-like behavior that orgmode seems to be aiming
>     > for?
>     >
>     > I love org-mode.  For years, I've used it as a project organizer,
>     > brainstorming tool, and extremely versatile notekeeper.  I've already
>     > got a big investment in it, so I'll spend the time to track down this
>     > kind of problem.
>     >
>     > But I'd guess that such unexpected Latex crashes have driven new users
>     > back to Word or whatever.
> 
>     I don't think you can blame Org for the crashes you've experienced. Org
>     exports the string "a_variable_deleteThisAndItWorks" to
>     "a\(_{\text{variable}}_{\text{deleteThisAndItWorks}}\)" which is not a
>     valid LaTeX expression. This invalid output is not the fault of Org, it
>     is the fault of the input string. Since there are different ways of
>     interpreting "a_variable_deleteThisAndItWorks," you have to tell Org
>     which interpretation you want it to make when you export to LaTeX. This
>     means additional markup of the string is required.
> 
>     That the exported LaTeX file crashes your installation of pdfTeX (or
>     whatever TeX engine you use) when you process it is not the fault of
>     Org. The exported LaTeX file contains an invalid LaTeX expression that
>     came from a ambiguous string, so pdfTeX shows an error when processing
>     the LaTeX file. Using additional markup of the string so that Org
>     exports it as a valid LaTeX expression is the solution to the problem.
> 
>     Scott Randby
> 
> 

  parent reply	other threads:[~2016-12-06 18:19 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-03 19:40 Multiple underscores crash org latex export; other exporters survive Scott Otterson
2016-12-03 21:24 ` Scott Randby
2016-12-03 22:31   ` Charles C. Berry
2016-12-04  4:53     ` Scott Randby
2016-12-04 10:13       ` Nicolas Goaziou
2016-12-04 16:03         ` Scott Randby
2016-12-05  8:36         ` Scott Otterson
2016-12-06  1:33           ` Scott Randby
     [not found]             ` <CAPY3P0QcpouDjmNpmaY6FzNSNjZyHAGufrbVtSuBzPxr6mUAzg@mail.gmail.com>
2016-12-06 18:18               ` Scott Randby [this message]
2016-12-06 23:50             ` Nicolas Goaziou
2016-12-07  2:06               ` Scott Randby
2016-12-07 11:21                 ` Nicolas Goaziou
2016-12-10 23:24                   ` Scott Randby
2016-12-11  0:05                     ` Nicolas Goaziou
2016-12-12  3:37                       ` Scott Randby
2016-12-12  7:46                         ` Nicolas Goaziou
2016-12-12 15:18                           ` Scott Otterson
2016-12-13 12:54                             ` Nicolas Goaziou
2016-12-05 17:30         ` Charles C. Berry

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=501f73ab-1384-a087-1fdc-e3c81ccec1e3@gmail.com \
    --to=srandby@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=scotto@sharpleaf.org \
    /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).