From 407a6acf4d615b38ce6c9ae87c441133f21abc2d Mon Sep 17 00:00:00 2001 From: Nicolas Goaziou Date: Tue, 16 Apr 2013 12:54:05 +0200 Subject: [PATCH] ox/ox-latex: Fix docstrings * lisp/ox-latex.el: Remove instructions since everything is documented in Org manual. * lisp/ox.el (org-export-with-smart-quotes): Use LATEX instead of LaTeX for keywords, the latter being hard to type, somewhat difficult to read, and overall just pedantic. --- lisp/ox-latex.el | 90 +----------------------------------------------- lisp/ox.el | 2 +- 2 files changed, 2 insertions(+), 90 deletions(-) diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index daefb2971..4d095795c 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -20,95 +20,7 @@ ;;; Commentary: ;; -;; This library implements a LaTeX back-end for Org generic exporter. -;; -;; Depending on the desired output format, three commands are provided -;; for export: `org-latex-export-as-latex' (temporary buffer), -;; `org-latex-export-to-latex' ("tex" file) and -;; `org-latex-export-to-pdf' ("pdf" file). Also, two publishing -;; functions are available: `org-latex-publish-to-latex' and -;; `org-latex-publish-to-pdf'. -;; -;; The library introduces four new buffer keywords: "LATEX_CLASS", -;; "LATEX_CLASS_OPTIONS", "LATEX_HEADER" and "LATEX_HEADER_EXTRA" (the -;; latter will not be used to build LaTeX snippets). It also -;; introduces a new OPTIONS item: "textht". -;; -;; Table export can be controlled with a number of attributes (through -;; ATTR_LATEX keyword). -;; -;; - The main one is the `:mode' attribute, which can be set to -;; `table', `math', `inline-math' and `verbatim'. In particular, -;; when in `math' or `inline-math' mode, every cell is exported -;; as-is, horizontal rules are ignored and the table will be wrapped -;; in a math environment. Also, contiguous tables sharing the same -;; math mode will be wrapped within the same environment. Default -;; mode is stored in `org-latex-default-table-mode'. -;; -;; - The second most important attribute is `:environment'. It is the -;; environment used for the table and defaults to -;; `org-latex-default-table-environment' value. It can be set to -;; anything, including "tabularx", "longtable", "array", "tabu", -;; "bmatrix"... -;; -;; - `:float' attribute defines a float environment for the table. -;; Possible values are `sidewaystable', `multicolumn' and `table'. -;; If unspecified, a table with a caption will have a `table' -;; environment. Moreover, `:placement' attribute can specify the -;; positioning of the float -;; -;; - `:align', `:font' and `:width' attributes set, respectively, the -;; alignment string of the table, its font size and its width. They -;; only apply on regular tables. -;; -;; - `:spread' is a boolean attribute specific to the "tabu" and -;; "longtabu" environments, and only takes effect when used in -;; conjunction with the `:width' attribute. When `:spread' is -;; non-nil, the table will be spread or shrunk by the value of -;; `:width'. -;; -;; - `:booktabs', `:center' and `:rmlines' values are booleans. They -;; toggle, respectively "booktabs" usage (assuming the package is -;; properly loaded), table centering and removal of every horizontal -;; rule but the first one (in a "table.el" table only). -;; -;; - `:math-prefix', `:math-suffix' and `:math-arguments' are string -;; which will be inserted, respectively, before the table within the -;; math environment, after the table within the math environment, -;; and between the macro name and the contents of the table. The -;; latter attribute is necessary to matrix macros that require more -;; than one argument (i.e. "qbordermatrix"). -;; -;; Plain lists accept two optional attributes: `:environment' and -;; `:options'. The first one allows to use a non-standard environment -;; (i.e. "inparaenum"). The second one allows to specify optional -;; arguments for that environment (square brackets are not mandatory). -;; -;; Images accept `:float', `:placement', `:comment-include', `:width', -;; and `:height', and `:options' as attributes. `:float' accepts -;; a symbol among `wrap', `multicolumn', and `figure', which defines -;; the float environment for the image (if unspecified, an image with -;; a caption will be set in a "figure" environment). -;; `:comment-include' is a boolean that toggles whether to comment out -;; the code which actually includes the image. `:placement' is -;; a string that will be used as argument for the environment chosen. -;; `:width' and `:height' control the width and height of the image. -;; `:options' is a string that will be used as the optional argument -;; for "includegraphics" macro or, in the case of tikz images, used as -;; the optional argument for a `tikzpicture' environment which will -;; surround the "\input" picture code. -;; -;; Special blocks accept `:options' as attribute. Its value will be -;; appended as-is to the opening string of the environment created. -;; -;; Source blocks accept `:long-listing' attribute, which prevents the -;; block to be wrapped within a float when non-nil. -;; -;; This back-end also offers enhanced support for footnotes. Thus, it -;; handles nested footnotes, footnotes in tables and footnotes in item -;; descriptions. -;; -;; Smart quotes are activated by default. +;; See Org manual for details. ;;; Code: diff --git a/lisp/ox.el b/lisp/ox.el index 31b1907c0..d35f0a9a1 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -588,7 +588,7 @@ When setting this to non-nil, you need to take care of using the correct Babel package when exporting to LaTeX. E.g., you can load Babel for french like this: -#+LaTeX_HEADER: \\usepackage[french]{babel}" +#+LATEX_HEADER: \\usepackage[french]{babel}" :group 'org-export-general :version "24.4" :package-version '(Org . "8.0")