summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2014-04-05 09:50:20 +0200
committerNicolas Goaziou <n.goaziou@gmail.com>2014-04-05 09:50:20 +0200
commit7de492a0c434797934c12522a75aa58e720f445c (patch)
tree7ae809bb7691aed8be8e61b7e8b606ef6b50018d
parenta6485af3e4c6e1942fa6c19d3629fc4fb165693a (diff)
downloadorg-mode-7de492a0c434797934c12522a75aa58e720f445c.tar.gz
Update docstrings
* lisp/org.el (org-latex-packages-alist, org-latex-default-packages-alist): Update docstrings.
-rw-r--r--lisp/org.el32
1 files changed, 22 insertions, 10 deletions
diff --git a/lisp/org.el b/lisp/org.el
index 6d6fbeb..318d95a 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -3874,10 +3874,18 @@ Org mode to function properly:
Therefore you should not modify this variable unless you know
what you are doing. The one reason to change it anyway is that
you might be loading some other package that conflicts with one
-of the default packages. Each cell is of the format
-\( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
-the package also needs to be included when compiling LaTeX
-snippets into images for inclusion into non-LaTeX output."
+of the default packages. Each element is either a cell or
+a string.
+
+A cell is of the format:
+
+ \( \"options\" \"package\" SNIPPET-FLAG).
+
+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.
+
+A string will be inserted as-is in the header of the document."
:group 'org-latex
:group 'org-export-latex
:set 'org-set-packages-alist
@@ -3895,18 +3903,22 @@ snippets into images for inclusion into non-LaTeX output."
"Alist of packages to be inserted in every LaTeX header.
These will be inserted after `org-latex-default-packages-alist'.
-Each cell is of the format:
+Each element is either a cell or a string.
- \(\"options\" \"package\" snippet-flag)
+A cell is of the format:
-SNIPPET-FLAG, when t, indicates that this package is also needed
-when turning LaTeX snippets into images for inclusion into
+ \(\"options\" \"package\" SNIPPET-FLAG)
+
+SNIPPET-FLAG, when non-nil, indicates that this package is also
+needed when turning LaTeX snippets into images for inclusion into
non-LaTeX output.
+A string will be inserted as-is in the header of the document.
+
Make sure that you only list packages here which:
- - you want in every file
- - do not conflict with the setup in `org-format-latex-header'.
+ - you want in every file;
+ - do not conflict with the setup in `org-format-latex-header';
- do not conflict with the default packages in
`org-latex-default-packages-alist'."
:group 'org-latex