[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [O] Latex export with \begin{equation}
|
From: |
Dominik Schrempf |
|
Subject: |
Re: [O] Latex export with \begin{equation} |
|
Date: |
Tue, 18 Sep 2018 15:09:30 +0200 |
|
User-agent: |
mu4e 1.0; emacs 26.1 |
Hello,
I tried to follow your suggestions. Please let me know, if the patch is OK like
this.
The patch only adds one footnote. It is unfortunate, that all subsequent
footnotes are changed too.
Best,
Dominik
>From 4b97952b0d6d218de7d7cab6f7017f87b68b966c Mon Sep 17 00:00:00 2001
From: Dominik Schrempf <address@hidden>
Date: Tue, 18 Sep 2018 15:04:47 +0200
Subject: [PATCH] Mention peculiarities of Math in HTML code. TINYCHANGE.
---
doc/org-manual.org | 132 +++++++++++++++++++++++----------------------
1 file changed, 68 insertions(+), 64 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 0732c1d97..90b2dbd12 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -12638,7 +12638,7 @@ is.
#+vindex: org-html-mathjax-options~
LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
different ways on HTML pages. The default is to use the
[[http://www.mathjax.org][MathJax]],
-which should work out of the box with Org[fn:123]. Some MathJax
+which should work out of the box with Org[fn:123][fn:124]. Some MathJax
display options can be configured via ~org-html-mathjax-options~, or
in the buffer. For example, with the following settings,
@@ -12650,7 +12650,7 @@ in the buffer. For example, with the following
settings,
#+texinfo: @noindent
equation labels are displayed on the left margin and equations are
five em from the left margin. In addition, it loads the two MathJax
-extensions =cancel.js= and =noErrors.js=[fn:124].
+extensions =cancel.js= and =noErrors.js=[fn:125].
#+vindex: org-html-mathjax-template
See the docstring of ~org-html-mathjax-options~ for all supported
@@ -12713,7 +12713,7 @@ line.
#+vindex: org-export-html-todo-kwd-class-prefix
#+vindex: org-export-html-tag-class-prefix
You can modify the CSS style definitions for the exported file. The
-HTML exporter assigns the following special CSS classes[fn:125] to
+HTML exporter assigns the following special CSS classes[fn:126] to
appropriate parts of the document---your style specifications may
change these, in addition to any of the standard classes like for
headlines, tables, etc.
@@ -12953,7 +12953,7 @@ LaTeX export back-end finds the compiler version to use
from
Org file. See the docstring for the
~org-latex-default-packages-alist~ for loading packages with certain
compilers. Also see ~org-latex-bibtex-compiler~ to set the
-bibliography compiler[fn:126].
+bibliography compiler[fn:127].
*** LaTeX specific export settings
:PROPERTIES:
@@ -13564,7 +13564,7 @@ a limit to a level before the absolute limit (see
[[*Export Settings]]).
The ODT export back-end handles creating of OpenDocument Text (ODT)
format. Documents created by this exporter use the
-{{{cite(OpenDocument-v1.2 specification)}}}[fn:127] and are compatible
+{{{cite(OpenDocument-v1.2 specification)}}}[fn:128] and are compatible
with LibreOffice 3.4.
*** Pre-requisites for ODT export
@@ -13965,7 +13965,7 @@ document in one of the following ways:
variables ~org-latex-to-mathml-convert-command~ and
~org-latex-to-mathml-jar-file~.
- If you prefer to use MathToWeb[fn:128] as your converter, you can
+ If you prefer to use MathToWeb[fn:129] as your converter, you can
configure the above variables as shown below.
#+begin_src emacs-lisp
@@ -13975,7 +13975,7 @@ document in one of the following ways:
"/path/to/mathtoweb.jar")
#+end_src
- To use LaTeXML[fn:129] use
+ To use LaTeXML[fn:130] use
#+begin_src emacs-lisp
(setq org-latex-to-mathml-convert-command
@@ -14295,7 +14295,7 @@ with the =#+ATTR_ODT= line. For a discussion on
default formatting of
tables, see [[*Tables in ODT export]].
This feature closely mimics the way table templates are defined in the
-OpenDocument-v1.2 specification.[fn:130]
+OpenDocument-v1.2 specification.[fn:131]
#+vindex: org-odt-table-styles
For quick preview of this feature, install the settings below and export the
@@ -14329,7 +14329,7 @@ templates, define new styles there.
To use this feature proceed as follows:
-1. Create a table template[fn:131].
+1. Create a table template[fn:132].
A table template is set of =table-cell= and =paragraph= styles for
each of the following table cell categories:
@@ -14368,7 +14368,7 @@ To use this feature proceed as follows:
=</office:automatic-styles>= element of the content template file
(see [[x-orgodtcontenttemplate-xml][Factory styles]]).
-2. Define a table style[fn:132].
+2. Define a table style[fn:133].
#+vindex: org-odt-table-styles
To define a table style, create an entry for the style in the
@@ -15395,7 +15395,7 @@ If you want to publish the Org file as an =.org= file
but with
~org-publish-org-to-org~. This produces =file.org= and put it in the
publishing directory. If you want a htmlized version of this file,
set the parameter ~:htmlized-source~ to ~t~. It produces
-=file.org.html= in the publishing directory[fn:133].
+=file.org.html= in the publishing directory[fn:134].
Other files like images only need to be copied to the publishing
destination; for this you can use ~org-publish-attachment~. For
@@ -16773,13 +16773,13 @@ See [[*Languages]] to enable other languages.
#+kindex: C-c C-v e
#+findex: org-babel-execute-src-block
Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
-{{{kbd(C-c C-v e)}}} with the point on a code block[fn:134] calls the
+{{{kbd(C-c C-v e)}}} with the point on a code block[fn:135] calls the
~org-babel-execute-src-block~ function, which executes the code in the
block, collects the results, and inserts them in the buffer.
#+cindex: @samp{CALL}, keyword
#+vindex: org-babel-inline-result-wrap
-By calling a named code block[fn:135] from an Org mode buffer or
+By calling a named code block[fn:136] from an Org mode buffer or
a table. Org can call the named code blocks from the current Org mode
buffer or from the "Library of Babel" (see [[*Library of Babel]]).
@@ -17137,7 +17137,7 @@ default behavior is to automatically determine the
result type.
If =file= is missing, Org generates the base name of the output
file from the name of the code block, and its extension from the
=file-ext= header argument. In that case, both the name and the
- extension are mandatory[fn:136].
+ extension are mandatory[fn:137].
#+begin_example
,#+name: circle
@@ -17586,10 +17586,10 @@ Code blocks in the following languages are supported.
| Asymptote | =asymptote= | Lua | =lua= |
| Awk | =awk= | MATLAB | =matlab= |
| C | =C= | Mscgen | =mscgen= |
-| C++ | =C++=[fn:137] | OCaml | =ocaml= |
+| C++ | =C++=[fn:138] | OCaml | =ocaml= |
| Clojure | =clojure= | Octave | =octave= |
| CSS | =css= | Org mode | =org= |
-| D | =D=[fn:138] | Oz | =oz= |
+| D | =D=[fn:139] | Oz | =oz= |
| ditaa | =ditaa= | Perl | =perl= |
| Emacs Calc | =calc= | Plantuml | =plantuml= |
| Emacs Lisp | =emacs-lisp= | Processing.js | =processing= |
@@ -17718,7 +17718,7 @@ for Python and Emacs Lisp languages.
#+cindex: syntax, Noweb
#+cindex: source code, Noweb reference
-Org supports named blocks in Noweb[fn:139] style syntax:
+Org supports named blocks in Noweb[fn:140] style syntax:
: <<CODE-BLOCK-ID>>
@@ -18218,7 +18218,7 @@ Org Tempo expands snippets to structures defined in
~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs
-init file[fn:140].
+init file[fn:141].
#+attr_texinfo: :columns 0.1 0.9
| {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
@@ -18491,7 +18491,7 @@ changes.
#+vindex: org-startup-indented
Dynamic virtual indentation is controlled by the variable
- ~org-startup-indented~[fn:141].
+ ~org-startup-indented~[fn:142].
- =indent= ::
@@ -18823,7 +18823,7 @@ uses only one star and indents text to line with the
heading:
#+findex: org-indent-mode
To turn this mode on, use the minor mode, ~org-indent-mode~. Text
lines that are not headlines are prefixed with spaces to vertically
-align with the headline text[fn:142].
+align with the headline text[fn:143].
#+vindex: org-indent-indentation-per-level
To make more horizontal space, the headlines are shifted by two stars.
@@ -18858,7 +18858,7 @@ headings as shown in examples below.
#+vindex: org-adapt-indentation
Org supports this with paragraph filling, line wrapping, and
structure editing, preserving or adapting the indentation as
- appropriate[fn:143].
+ appropriate[fn:144].
- /Hiding leading stars/ ::
@@ -18892,7 +18892,7 @@ headings as shown in examples below.
#+vindex: org-odd-levels-only
Using stars for only odd levels, 1, 3, 5, ..., can also clean up
- the clutter. This removes two stars from each level[fn:144].
+ the clutter. This removes two stars from each level[fn:145].
For Org to properly handle this cleaner structure during edits
and exports, configure the variable ~org-odd-levels-only~. To
set this per-file, use either one of the following lines:
@@ -19303,13 +19303,13 @@ with Emacs. With a public server, consider
encrypting the files.
MobileOrg version 1.5 supports encryption for the iPhone. Org also
requires =openssl= installed on the local computer. To turn on
encryption, set the same password in MobileOrg and in Emacs. Set the
-password in the variable ~org-mobile-use-encryption~[fn:145]. Note
+password in the variable ~org-mobile-use-encryption~[fn:146]. Note
that even after MobileOrg encrypts the file contents, the file name
remains visible on the file systems of the local computer, the server,
and the mobile device.
For a server to host files, consider options like
[[http://dropbox.com][Dropbox.com]]
-account[fn:146]. On first connection, MobileOrg creates a directory
+account[fn:147]. On first connection, MobileOrg creates a directory
=MobileOrg= on Dropbox. Pass its location to Emacs through an
initialisation file variable as follows:
@@ -19331,15 +19331,15 @@ Org pushes files listed in ~org-mobile-files~ to
~org-mobile-directory~. Files include agenda files (as listed in
~org-agenda-files~). Customize ~org-mobile-files~ to add other files.
File names are staged with paths relative to ~org-directory~, so all
-files should be inside this directory[fn:147].
+files should be inside this directory[fn:148].
Push creates a special Org file =agendas.org= with custom agenda views
-defined by the user[fn:148].
+defined by the user[fn:149].
Finally, Org writes the file =index.org=, containing links to other
files. MobileOrg reads this file first from the server to determine
what other files to download for agendas. For faster downloads,
-MobileOrg only reads files whose checksums[fn:149] have changed.
+MobileOrg only reads files whose checksums[fn:150] have changed.
** Pulling from MobileOrg
:PROPERTIES:
@@ -19353,7 +19353,7 @@ Org integrates its data in an inbox file format.
1.
#+vindex: org-mobile-inbox-for-pull
- Org moves all entries found in =mobileorg.org=[fn:150] and appends
+ Org moves all entries found in =mobileorg.org=[fn:151] and appends
them to the file pointed to by the variable
~org-mobile-inbox-for-pull~. Each captured entry and each editing
event is a top-level entry in the inbox file.
@@ -19644,9 +19644,9 @@ of these strategies:
#+cindex: @LaTeX{}, and Orgtbl mode
To wrap a source table in LaTeX, use the =comment= environment
-provided by =comment.sty=[fn:151]. To activate it, put
+provided by =comment.sty=[fn:152]. To activate it, put
~\usepackage{comment}~ in the document header. Orgtbl mode inserts
-a radio table skeleton[fn:144] with the command {{{kbd(M-x
+a radio table skeleton[fn:145] with the command {{{kbd(M-x
orgtbl-insert-radio-table)}}}, which prompts for a table name. For
example, if =salesfigures= is the name, the template inserts:
@@ -19665,7 +19665,7 @@ The line =#+ORGTBL: SEND= tells Orgtbl mode to use the
function
~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
the table at the target (receive) location named =salesfigures=. Now
the table is ready for data entry. It can even use spreadsheet
-features[fn:152]:
+features[fn:153]:
#+begin_example
% BEGIN RECEIVE ORGTBL salesfigures
@@ -19880,7 +19880,7 @@ Dynamic blocks, like any other block, can be narrowed
with
#+vindex: org-agenda-skip-function
#+vindex: org-agenda-skip-function-global
Org provides a special hook to further limit items in agenda views:
-~agenda~, ~agenda*~[fn:153], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
+~agenda~, ~agenda*~[fn:154], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
~tags-tree~. Specify a custom function that tests inclusion of every
matched item in the view. This function can also skip as much as is
needed.
@@ -19923,7 +19923,7 @@ meaningful string suitable for the agenda view.
#+vindex: org-agenda-skip-function
Search for entries with a limit set on levels for the custom search.
This is a general approach to creating custom searches in Org. To
-include all levels, use =LEVEL>0=[fn:154]. Then to selectively pick
+include all levels, use =LEVEL>0=[fn:155]. Then to selectively pick
the matched entries, use ~org-agenda-skip-function~, which also
accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
~org-agenda-skip-subtree-if~. For example:
@@ -21315,47 +21315,51 @@ semantic relevance.
[fn:123] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as
recommended by
[[http://www.mathjax.org][MathJax]].
-[fn:124] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX
and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to
learn
+[fn:124] Please note that exported formulas are part of an HTML
+document, and that signs such as =<=, =>=, or =&= have special
+meanings (see
[[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax
TeX and LaTeX support]]).
+
+[fn:125] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX
and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to
learn
about extensions.
-[fn:125] If the classes on TODO keywords and tags lead to conflicts,
+[fn:126] If the classes on TODO keywords and tags lead to conflicts,
use the variables ~org-html-todo-kwd-class-prefix~ and
~org-html-tag-class-prefix~ to make them unique.
-[fn:126] This does not allow setting different bibliography compilers
+[fn:127] This does not allow setting different bibliography compilers
for different files. However, "smart" LaTeX compilation systems, such
as latexmk, can select the correct bibliography compiler.
-[fn:127] See
[[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document
Format for Office Applications
+[fn:128] See
[[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document
Format for Office Applications
(OpenDocument) Version 1.2]].
-[fn:128] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
+[fn:129] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
-[fn:129] See [[http://dlmf.nist.gov/LaTeXML/]].
+[fn:130] See [[http://dlmf.nist.gov/LaTeXML/]].
-[fn:130]
[[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2
Specification]]
+[fn:131]
[[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2
Specification]]
-[fn:131] See the =<table:table-template>= element of the
+[fn:132] See the =<table:table-template>= element of the
OpenDocument-v1.2 specification.
-[fn:132] See the attributes =table:template-name=,
+[fn:133] See the attributes =table:template-name=,
=table:use-first-row-styles=, =table:use-last-row-styles=,
=table:use-first-column-styles=, =table:use-last-column-styles=,
=table:use-banding-rows-styles=, and =table:use-banding-column-styles=
of the =<table:table>= element in the OpenDocument-v1.2 specification.
-[fn:133] If the publishing directory is the same as the source
+[fn:134] If the publishing directory is the same as the source
directory, =file.org= is exported as =file.org.org=, so you probably
do not want to do this.
-[fn:134] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
+[fn:135] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
-[fn:135] Actually, the constructs =call_<name>()= and =src_<lang>{}=
+[fn:136] Actually, the constructs =call_<name>()= and =src_<lang>{}=
are not evaluated when they appear in a keyword line---i.e. lines
starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]].
-[fn:136] Due to the way this header argument is implemented, it
+[fn:137] Due to the way this header argument is implemented, it
implies ":results file". Therefore if it is set for multiple blocks
at once (by a subtree or buffer property for example), all blocks are
forced to produce file results. This is seldom desired behavior, so
@@ -21363,60 +21367,60 @@ it is recommended to set this header only on a
per-block basis. It is
possible that this aspect of the implementation might change in the
future.
-[fn:137] C++ language is handled in =ob-C.el=. Even though the
+[fn:138] C++ language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =C++=, you activate it by loading
the C language.
-[fn:138] D language is handled in =ob-C.el=. Even though the
+[fn:139] D language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =D=, you activate it by loading
the C language.
-[fn:139] For Noweb literate programming details, see
+[fn:140] For Noweb literate programming details, see
http://www.cs.tufts.edu/~nr/noweb/.
-[fn:140] For more information, please refer to the commentary section
+[fn:141] For more information, please refer to the commentary section
in =org-tempo.el=.
-[fn:141] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
+[fn:142] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
wraps long lines (including headlines) correctly indented.
-[fn:142] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
+[fn:143] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
for indenting and wrapping long lines of headlines or text. This
minor mode handles ~visual-line-mode~ and directly applied settings
through ~word-wrap~.
-[fn:143] Also see the variable ~org-adapt-indentation~.
+[fn:144] Also see the variable ~org-adapt-indentation~.
-[fn:144] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
+[fn:145] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
on.
-[fn:145] If Emacs is configured for safe storing of passwords, then
+[fn:146] If Emacs is configured for safe storing of passwords, then
configure the variable, ~org-mobile-encryption-password~; please read
the docstring of that variable.
-[fn:146] An alternative is to use a WebDAV server. MobileOrg
+[fn:147] An alternative is to use a WebDAV server. MobileOrg
documentation has details of WebDAV server configuration. Additional
help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ
entry]].
-[fn:147] Symbolic links in ~org-directory~ need to have the same name
+[fn:148] Symbolic links in ~org-directory~ need to have the same name
as their targets.
-[fn:148] While creating the agendas, Org mode forces ID properties on
+[fn:149] While creating the agendas, Org mode forces ID properties on
all referenced entries, so that these entries can be uniquely
identified if MobileOrg flags them for further action. To avoid
setting properties configure the variable
~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
on outline paths, assuming they are unique.
-[fn:149] Checksums are stored automatically in the file
+[fn:150] Checksums are stored automatically in the file
=checksums.dat=.
-[fn:150] The file will be empty after this operation.
+[fn:151] The file will be empty after this operation.
-[fn:151] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
+[fn:152] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
-[fn:152] If the =TBLFM= keyword contains an odd number of dollar
+[fn:153] If the =TBLFM= keyword contains an odd number of dollar
characters, this may cause problems with Font Lock in LaTeX mode. As
shown in the example you can fix this by adding an extra line inside
the =comment= environment that is used to balance the dollar
@@ -21424,9 +21428,9 @@ expressions. If you are using AUCTeX with the
font-latex library,
a much better solution is to add the =comment= environment to the
variable ~LaTeX-verbatim-environments~.
-[fn:153] The ~agenda*~ view is the same as ~agenda~ except that it
+[fn:154] The ~agenda*~ view is the same as ~agenda~ except that it
only considers /appointments/, i.e., scheduled and deadline items that
have a time specification =[h]h:mm= in their time-stamps.
-[fn:154] Note that, for ~org-odd-levels-only~, a level number
+[fn:155] Note that, for ~org-odd-levels-only~, a level number
corresponds to order in the hierarchy, not to the number of stars.
--
2.19.0
Nicolas Goaziou <address@hidden> writes:
Hello,
Dominik Schrempf <address@hidden> writes:
Oh thanks,
I thought it would be good to add a comment to the Org mode manual although
it
is of course not really Org mode related.
I decided that a good location would be
https://orgmode.org/manual/Math-formatting-in-HTML-export.html#Math-formatting-in-HTML-export
A proposed patch is attached, please let me know what you think.
Thank you.
Please use a proper commit message and add TINYCHANGE if you haven't
signed FSF papers.
--- org-manual.org 2018-09-17 18:48:17.868785307 +0200
+++ org-manual.org.new 2018-09-17 18:48:09.708751068 +0200
@@ -12655,7 +12655,9 @@
#+vindex: org-html-mathjax-template
See the docstring of ~org-html-mathjax-options~ for all supported
variables. The MathJax template can be configure via
-~org-html-mathjax-template~.
+~org-html-mathjax-template~. Please note that formulas will be part
I suggest to use the present tense instead of the future, per (info
"(elisp) Documentation Tips") and put this in a footnote since this is
not directly Org-related, as you point out.
+of an HTML document, and that signs such as =<=, =>=, or =&= have
+special meanings (see
[[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax
TeX and LaTeX support]]).
Regards,