[question/patch] How detailed may org.texi be?

[question/patch] How detailed may org.texi be?

[Rasmus]

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

Hi,

I would like to push the following patch to org.texi on export
behavior of sub/superscripts and LaTeX delimiters.  To me it seems
relevant, but it's somewhat technical.  Is it relevant to include such
"implementation" details/choices in org.texi?

—Rasmus

-- 
You people at the NSA are becoming my new best friends!

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org.texi-Clarifications-of-math-subscript-export.patch --]
[-- Type: text/x-diff, Size: 1694 bytes --]

From 04e0b5c7ed5329bf62175f58192577b895a10cdb Mon Sep 17 00:00:00 2001
From: rasmus <rasmus@gmx.us>
Date: Wed, 29 Oct 2014 14:15:41 +0100
Subject: [PATCH] org.texi: Clarifications of math/subscript export.

* org.texi (Subscripts and superscripts), (@LaTeX{} fragments):
	More information on export output.
---
 doc/org.texi | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/org.texi b/doc/org.texi
index 3c1790a..0d8fa0e 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -10222,6 +10222,11 @@ The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
 the sun is R_@{sun@} = 6.96 x 10^8 m.
 @end example
 
+By default super- and subscript are exported as plain text, rather than math,
+when exporting to HTML and @LaTeX{}.  Thus @code{\beta_t} is exported as
+@code{&beta;<sub>t</sub>} for HTML and @code{\(\beta_@{\text@{t@}@}\)} for
+@LaTeX{}.
+
 @vindex org-use-sub-superscripts
 If you write a text where the underscore is often used in a different
 context, Org's convention to always interpret these as subscripts can get in
@@ -10269,7 +10274,9 @@ math delimiters if the enclosed text contains at most two line breaks, is
 directly attached to the @samp{$} characters with no whitespace in between,
 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
 For the other delimiters, there is no such restriction, so when in doubt, use
-@samp{\(...\)} as inline math delimiters.
+@samp{\(...\)} as inline math delimiters.  In HTML and @LaTeX{} exports,
+inline math are enclosed in @samp{\(...\)} irrespective of whether enclosed
+in @samp{$} or @samp{\(...\)} in the Org source.
 @end itemize
 
 @noindent For example:
-- 
2.1.2

Re: [question/patch] How detailed may org.texi be?

[Nicolas Goaziou]

Hello,

Rasmus <rasmus@gmx.us> writes:

> I would like to push the following patch to org.texi on export
> behavior of sub/superscripts and LaTeX delimiters.  To me it seems
> relevant, but it's somewhat technical.  Is it relevant to include such
> "implementation" details/choices in org.texi?

FWIW, I think it's too technical.


Regards,

-- 
Nicolas Goaziou

Re: [question/patch] How detailed may org.texi be?

[Skip Collins]

Rasmus <rasmus@gmx.us> writes:
> I would like to push the following patch to org.texi on export

As long as you are tweaking the manual, please fix the typesetting of
LaTeX-verbatim-environments in the Variable Index. It should appear as
a simple string, not as a fancy logo. As a point of style, I would
prefer that all index entries stick with TeX and LaTeX rather than
\TeX and \LaTeX.