Browse Source

Better documentation of the variable `org-format-latex-options'

Carsten Dominik 11 years ago
parent
commit
dbd63e9723
4 changed files with 21 additions and 1 deletions
  1. 6 0
      doc/ChangeLog
  2. 6 0
      doc/org.texi
  3. 5 0
      lisp/ChangeLog
  4. 4 1
      lisp/org.el

+ 6 - 0
doc/ChangeLog

@@ -1,3 +1,9 @@
+2009-09-26  Carsten Dominik  <carsten.dominik@gmail.com>
+
+	* org.texi (Processing LaTeX fragments): Document that the size of
+	images can be changes using the variable
+	`org-format-latex-options'.
+
 2009-09-21  Carsten Dominik  <carsten.dominik@gmail.com>
 
 	* org.texi (The date/time prompt, Timestamps): Be more accurate

+ 6 - 0
doc/org.texi

@@ -7971,6 +7971,12 @@ process the entire buffer.
 Remove the overlay preview images.
 @end table
 
+@vindex org-format-latex-options
+You can customize the variable @code{org-format-latex-options} to influence
+some aspects of the preview. In particular, the @code{:scale} (and for HTML
+export, @code{:html-scale}) property can be used to adjust the size of the
+preview images.
+
 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
 converted into images and inlined into the document if the following
 setting is active:

+ 5 - 0
lisp/ChangeLog

@@ -1,3 +1,8 @@
+2009-09-26  Carsten Dominik  <carsten.dominik@gmail.com>
+
+	* org.el (org-format-latex): Mention `org-format-latex-options' in
+	the docstring.
+
 2009-09-25  Carsten Dominik  <carsten.dominik@gmail.com>
 
 	* org.el (org-agenda-get): New function.

+ 4 - 1
lisp/org.el

@@ -14127,7 +14127,9 @@ The images can be removed again with \\[org-ctrl-c-ctrl-c]."
   "Regular expressions for matching embedded LaTeX.")
 
 (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
-  "Replace LaTeX fragments with links to an image, and produce images."
+  "Replace LaTeX fragments with links to an image, and produce images.
+Some of the options can be changed using the variable
+`org-format-latex-options'."
   (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
   (let* ((prefixnodir (file-name-nondirectory prefix))
 	 (absprefix (expand-file-name prefix dir))
@@ -14205,6 +14207,7 @@ The images can be removed again with \\[org-ctrl-c-ctrl-c]."
 (defvar org-export-latex-packages-alist) ;; defined in org-latex.el
 ;; This function borrows from Ganesh Swami's latex2png.el
 (defun org-create-formula-image (string tofile options buffer)
+  "This calls dvipng."
   (require 'org-latex)
   (let* ((tmpdir (if (featurep 'xemacs)
 		     (temp-directory)