mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-12-02 08:22:16 +00:00
Code

Improve docstrings regarding latex_compiler

Browse Source 
* org.el (org-latex-default-packages-alist):
* ox-latex.el (org-latex-compiler, org-latex-compilers)
  (org-latex-compiler-file-string, org-latex-bib-compiler)
  (org-latex--remove-packages): Improve docstring wrt. latex_compiler.
This commit is contained in:
Rasmus 2015-10-03 15:34:24 +02:00
parent 984b1ff0ab
commit 45b01819e0
2 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lisp/org.el
View File

@ -4123,11 +4123,14 @@ a string.
A cell is of the format
(\"options\" \"package\" SNIPPET-FLAG)
(\"options\" \"package\" SNIPPET-FLAG COMPILERS)
If SNIPPET-FLAG is non-nil, the package also needs to be included
when compiling LaTeX snippets into images for inclusion into
non-LaTeX output.
non-LaTeX output. COMPILERS is a list of compilers that should
include the package, see `org-latex-compiler'. If the document
compiler is not in the list, and the list is non-nil, the package
will not be inserted in the final document.
A string will be inserted as-is in the header of the document."
:group 'org-latex

26
lisp/ox-latex.el
View File

@ -1041,7 +1041,8 @@ during latex export it will output
;;;; Compilation
(defcustom org-latex-compiler-file-string "%% Indented LaTeX compiler: %s\n"
"LaTeX program format-string."
"LaTeX compiler format-string.
See also `org-latex-compiler'."
:group 'org-export-latex
:type '(choice
(const :tag "Comment" "%% Indented LaTeX compiler: %s\n")
@ -1052,26 +1053,31 @@ during latex export it will output
:package-version '(Org . "9.0"))
(defcustom org-latex-compiler "pdflatex"
"LaTeX program to use. Must be an element in `org-latex-compilers'."
"LaTeX compiler to use.
Must be an element in `orgg-latex-compilers' or the empty quote.
Can also be set in buffers via #+LATEX_COMPILER. See also
`org-latex-compiler-file-string'."
:group 'org-export-latex
:type '(choice
(const :tag "pdfLaTeX" "pdflatex")
(const :tag "XeLaTeX" "xelatex")
(const :tag "LuaLaTeX" "lualatex"))
(const :tag "LuaLaTeX" "lualatex")
(const :tag "Unset" ""))
:version "25.1"
:package-version '(Org . "9.0"))
(defconst org-latex-compilers '("pdflatex" "xelatex" "lualatex")
"Known LaTeX programs.")
"Known LaTeX compilers.
See also `org-latex-compiler'.")
(defcustom org-latex-bib-compiler "bibtex"
"Command used to process a LaTeX files bibliography.
"Command to process a LaTeX file's bibliography.
The shorthand %bib in `org-latex-pdf-process' is replaced with
this value.
A better approach is to use a compiler suit such as `latexmk'.
"
A better approach is to use a compiler suit such as `latexmk'."
:group 'org-export-latex
:type '(choice (const :tag "BibTeX" "bibtex")
(const :tag "Biber" "biber")
@ -1365,10 +1371,10 @@ Return the new header."
t t header 0)))))
(defun org-latex--remove-packages (pkg-alist info)
"Remove packages based on the current LaTeX program.
"Remove packages based on the current LaTeX compiler.
If the fourth argument of an element is set in pkg-alist, and it
is not a member of the LaTeX program of the document, the packages
is not a member of the LaTeX compiler of the document, the packages
is removed. See also `org-latex-compiler'.
Return modified pkg-alist."
@ -1559,7 +1565,7 @@ holding export options."
;; Time-stamp.
(and (plist-get info :time-stamp-file)
(format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
;; LaTeX program.
;; LaTeX compiler.
(let ((compiler (plist-get info :latex-compiler)))
(and (org-string-nw-p org-latex-compiler-file-string)
(string-match-p (regexp-opt org-latex-compilers) (or compiler ""))