code.delx.au - gnu-emacs-elpa/blob - packages/auctex/tex-style.el

   1 ;;; tex-style.el --- Customizable variables for AUCTeX style files
   2
   3 ;; Copyright (C) 2005  Free Software Foundation, Inc.
   4
   5 ;; Author: Reiner Steib <Reiner.Steib@gmx.de>
   6 ;; Keywords: tex, wp, convenience
   7
   8 ;; This file is free software; you can redistribute it and/or modify
   9 ;; it under the terms of the GNU General Public License as published by
  10 ;; the Free Software Foundation; either version 3, or (at your option)
  11 ;; any later version.
  12
  13 ;; This file is distributed in the hope that it will be useful,
  14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 ;; GNU General Public License for more details.
  17
  18 ;; You should have received a copy of the GNU General Public License
  19 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  20 ;; the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21 ;; Boston, MA 02110-1301, USA.
  22
  23 ;;; Commentary:
  24
  25 ;; This file provides customizable variables for AUCTeX style files.
  26
  27 ;;; Code:
  28
  29 (defgroup LaTeX-style nil
  30   "Support for special LaTeX style files in AUCTeX."
  31   :group 'LaTeX-macro)
  32
  33 ;; Note: We don't have any defcustom in plain TeX style files yet.  Else we
  34 ;; should also create a TeX-style group.
  35
  36 ;; style/amsmath.el
  37
  38 (defcustom LaTeX-amsmath-label nil
  39   "Default prefix to amsmath equation labels.
  40
  41 Amsmath equations include \"align\", \"alignat\", \"xalignat\",
  42 \"multline\", \"flalign\" and \"gather\".  If it is nil,
  43 `LaTeX-equation-label' is used."
  44   :group 'LaTeX-label
  45   :type '(choice (const :tag "Use `LaTeX-equation-label'" nil)
  46                  (string)))
  47
  48 ;; style/beamer.el
  49
  50 (defcustom LaTeX-beamer-section-labels-flag nil
  51   "If non-nil section labels are added"
  52   :type 'boolean
  53   :group 'LaTeX-style)
  54
  55 (defcustom LaTeX-beamer-item-overlay-flag t
  56   "If non-nil do prompt for an overlay in itemize-like environments."
  57   :type 'boolean
  58   :group 'LaTeX-style)
  59
  60 (defcustom LaTeX-beamer-themes 'local
  61   "Presentation themes for the LaTeX beamer package.
  62 It can be a list of themes or a function.  If it is the symbol
  63 `local', search only once per buffer."
  64   :group 'LaTeX-style
  65   :type
  66   '(choice
  67     (const :tag "TeX search" LaTeX-beamer-search-themes)
  68     (const :tag "Search once per buffer" local)
  69     (function :tag "Other function")
  70     (list
  71      :value
  72      ;; Work around (bug in customize?), see
  73      ;; <news:v9is48jrj1.fsf@marauder.physik.uni-ulm.de>
  74      ("Antibes" "Bergen" "Berkeley" "Berlin" "Boadilla" "Copenhagen"
  75       "Darmstadt" "Dresden" "Frankfurt" "Goettingen" "Hannover"
  76       "Ilmenau" "JuanLesPins" "Luebeck" "Madrid" "Malmoe" "Marburg"
  77       "Montpellier" "PaloAlto" "Pittsburgh" "Rochester" "Singapore"
  78       "Szeged" "Warsaw")
  79      (set :inline t
  80           (const "Antibes")
  81           (const "Bergen")
  82           (const "Berkeley")
  83           (const "Berlin")
  84           (const "Boadilla")
  85           (const "Copenhagen")
  86           (const "Darmstadt")
  87           (const "Dresden")
  88           (const "Frankfurt")
  89           (const "Goettingen")
  90           (const "Hannover")
  91           (const "Ilmenau")
  92           (const "JuanLesPins")
  93           (const "Luebeck")
  94           (const "Madrid")
  95           (const "Malmoe")
  96           (const "Marburg")
  97           (const "Montpellier")
  98           (const "PaloAlto")
  99           (const "Pittsburgh")
 100           (const "Rochester")
 101           (const "Singapore")
 102           (const "Szeged")
 103           (const "Warsaw"))
 104      (repeat :inline t
 105              :tag "Other"
 106              (string)))))
 107
 108 (defcustom LaTeX-beamer-inner-themes 'local
 109   "Presentation inner themes for the LaTeX beamer package.
 110 It can be a list of themes or a function.  If it is the symbol
 111 `local', search only once per buffer."
 112   :group 'LaTeX-style
 113   :type '(choice
 114     (const :tag "TeX search" LaTeX-beamer-search-inner-themes)
 115     (const :tag "Search once per buffer" local)
 116     (function :tag "Other function")
 117     (list
 118      :value ("circles" "default" "inmargin" "rectangles" "rounded")
 119      (set :inline t
 120           (const "circles")
 121           (const "default")
 122           (const "inmargin")
 123           (const "rectangles")
 124           (const "rounded"))
 125      (repeat :inline t
 126              :tag "Other"
 127              (string)))))
 128
 129 (defcustom LaTeX-beamer-outer-themes 'local
 130   "Presentation outer themes for the LaTeX beamer package.
 131 It can be a list of themes or a function.  If it is the symbol
 132 `local', search only once per buffer."
 133   :group 'LaTeX-style
 134   :type
 135   '(choice
 136     (const :tag "TeX search" LaTeX-beamer-search-outer-themes)
 137     (const :tag "Search once per buffer" local)
 138     (function :tag "Other function")
 139     (list
 140      :value
 141      ("default" "infolines" "miniframes" "shadow" "sidebar" "smoothbars"
 142       "smoothtree" "split" "tree")
 143      (set :inline t
 144           (const "default")
 145           (const "infolines")
 146           (const "miniframes")
 147           (const "shadow")
 148           (const "sidebar")
 149           (const "smoothbars")
 150           (const "smoothtree")
 151           (const "split")
 152           (const "tree"))
 153      (repeat :inline t
 154              :tag "Other"
 155              (string)))))
 156
 157 (defcustom LaTeX-beamer-color-themes 'local
 158   "Presentation color themes for the LaTeX beamer package.
 159 It can be a list of themes or a function.  If it is the symbol
 160 `local', search only once per buffer."
 161   :group 'LaTeX-style
 162   :type
 163   '(choice
 164     (const :tag "TeX search" LaTeX-beamer-search-color-themes)
 165     (const :tag "Search once per buffer" local)
 166     (function :tag "Other function")
 167     (list
 168      :value
 169      ("albatross" "beetle" "crane" "default" "dolphin" "dove" "fly" "lily"
 170       "orchid" "rose" "seagull" "seahorse" "sidebartab" "structure" "whale")
 171      (set :inline t
 172           (const "albatross")
 173           (const "beetle")
 174           (const "crane")
 175           (const "default")
 176           (const "dolphin")
 177           (const "dove")
 178           (const "fly")
 179           (const "lily")
 180           (const "orchid")
 181           (const "rose")
 182           (const "seagull")
 183           (const "seahorse")
 184           (const "sidebartab")
 185           (const "structure")
 186           (const "whale"))
 187      (repeat :inline t
 188              :tag "Other"
 189              (string)))))
 190
 191 (defcustom LaTeX-beamer-font-themes 'local
 192   "Presentation font themes for the LaTeX beamer package.
 193 It can be a list of themes or a function.  If it is the symbol
 194 `local', search only once per buffer."
 195   :group 'LaTeX-style
 196   :type
 197   '(choice
 198     (const :tag "TeX search" LaTeX-beamer-search-font-themes)
 199     (const :tag "Search once per buffer" local)
 200     (function :tag "Other function")
 201     (list
 202      :value
 203      ("default" "professionalfonts" "serif" "structurebold"
 204       "structureitalicserif" "structuresmallcapsserif")
 205      (set :inline t
 206           (const "default")
 207           (const "professionalfonts")
 208           (const "serif")
 209           (const "structurebold")
 210           (const "structureitalicserif")
 211           (const "structuresmallcapsserif"))
 212      (repeat :inline t
 213              :tag "Other"
 214              (string)))))
 215
 216 ;; style/comment.el
 217
 218 (defcustom LaTeX-comment-env-list '("comment")
 219   "List of environment names defined with comment.sty.
 220 Setting this variable does not take effect unless you
 221 reinitialize affected buffers."
 222   :type '(repeat string)
 223   :group 'LaTeX-style)
 224
 225 ;; style/csquotes.el
 226
 227 (defcustom LaTeX-csquotes-quote-after-quote nil
 228   "Initial value of `TeX-quote-after-quote' for `csquotes.el'"
 229   :type 'boolean
 230   :group 'LaTeX-style)
 231
 232 (defcustom LaTeX-csquotes-open-quote ""
 233   "Opening quotation mark to be used with the csquotes package.
 234 The specified string will be used for `TeX-open-quote' (and override
 235 any language-specific setting) only if both `LaTeX-csquotes-open-quote'
 236 and `LaTeX-csquotes-close-quote' are non-empty strings."
 237   :type 'string
 238   :group 'LaTeX-style)
 239
 240 (defcustom LaTeX-csquotes-close-quote ""
 241   "Closing quotation mark to be used with the csquotes package.
 242 The specified string will be used for `TeX-close-quote' (and override
 243 any language-specific setting) only if both `LaTeX-csquotes-open-quote'
 244 and `LaTeX-csquotes-close-quote' are non-empty strings."
 245   :type 'string
 246   :group 'LaTeX-style)
 247
 248 ;; style/emp.el
 249
 250 (defcustom LaTeX-write18-enabled-p t
 251   "*If non-nil, insert automatically the \\write18 calling metapost.
 252 When disabled, you have to use mpost on the mp files automatically
 253 produced by emp.sty and then re-LaTeX the document."
 254   :type 'boolean
 255   :group 'LaTeX-style)
 256
 257 ;; style/graphicx.el
 258
 259 (defcustom LaTeX-includegraphics-extensions
 260   '("eps" "jpe?g" "pdf" "png")
 261   "Extensions for images files used by \\includegraphics."
 262   :group 'LaTeX-style
 263   :type '(list (set :inline t
 264                     (const "eps")
 265                     (const "jpe?g")
 266                     (const "pdf")
 267                     (const "png"))
 268                (repeat :inline t
 269                        :tag "Other"
 270                        (string))))
 271
 272 (defcustom LaTeX-includegraphics-options-alist
 273   '((0 width)
 274     ;; (1 width height clip)
 275     ;; (2 width height keepaspectratio clip)
 276     (4) ;; --> (4 nil)
 277     (5 trim)
 278     (16
 279      ;; Table 1 in epslatex.ps: ``includegraphics Options''
 280      height totalheight width scale angle origin bb
 281      ;; Table 2 in epslatex.ps: ``cropping Options''
 282      viewport trim
 283      ;; Table 3 in epslatex.ps: ``Boolean Options''
 284      ;; [not implemented:] noclip draft final
 285      clip keepaspectratio
 286      ;; Only for PDF:
 287      page))
 288   "Controls for which optional arguments of \\includegraphics you get prompted.
 289
 290 An alist, consisting of \(NUMBER . LIST\) pairs.  Valid elements of LIST are
 291 `width', `height', `keepaspectratio', `clip', `angle', `totalheight', `trim'
 292 and `bb' \(Bounding Box\).
 293
 294 The list corresponding to 0 is used if no prefix is given.  Note that 4 \(one
 295 \\[universal-argument]\) and 16 \(two \\[universal-argument]'s\) are easy to
 296 type and should be used for frequently needed combinations."
 297   :group 'LaTeX-style
 298   :type '(repeat (cons (integer :tag "Argument")
 299                        (list (set :inline t
 300                                   (const height)
 301                                   (const totalheight)
 302                                   (const width)
 303                                   (const scale)
 304                                   (const angle)
 305                                   (const origin)
 306                                   (const :tag "Bounding Box" bb)
 307                                   ;;
 308                                   (const viewport)
 309                                   (const trim)
 310                                   ;;
 311                                   (const clip)
 312                                   (const keepaspectratio))))))
 313
 314 (defcustom LaTeX-includegraphics-strip-extension-flag t
 315   "Non-nil means to strip known extensions from image file name."
 316   :group 'LaTeX-style
 317   :type 'boolean)
 318
 319 (defcustom LaTeX-includegraphics-read-file
 320   'LaTeX-includegraphics-read-file-TeX
 321   "Function for reading \\includegraphics files.
 322
 323 `LaTeX-includegraphics-read-file-TeX' lists all graphic files
 324 found in the TeX search path.
 325
 326 `LaTeX-includegraphics-read-file-relative' lists all graphic files
 327 in the master directory and its subdirectories and inserts the
 328 relative file name.  This option does not work with Emacs 21 or
 329 XEmacs.
 330
 331 The custom option `simple' works as
 332 `LaTeX-includegraphics-read-file-relative' but it lists all kind of
 333 files.
 334
 335 Inserting the subdirectory in the filename (as
 336 `LaTeX-includegraphics-read-file-relative') is discouraged by
 337 `epslatex.ps'."
 338 ;; ,----[ epslatex.ps; Section 12; (page 26) ]
 339 ;; | Instead of embedding the subdirectory in the filename, there are two
 340 ;; | other options
 341 ;; |   1. The best method is to modify the TeX search path [...]
 342 ;; |   2. Another method is to specify sub/ in a \graphicspath command
 343 ;; |      [...].  However this is much less efficient than modifying the
 344 ;; |      TeX search path
 345 ;; `----
 346 ;; See "Inefficiency" and "Unportability" in the same section for more
 347 ;; information.
 348   :group 'LaTeX-style
 349   :type '(choice (const :tag "TeX" LaTeX-includegraphics-read-file-TeX)
 350                  (const :tag "relative"
 351                         LaTeX-includegraphics-read-file-relative)
 352                  (const :tag "simple" (lambda ()
 353                                         (file-relative-name
 354                                          (read-file-name "Image file: ")
 355                                          (TeX-master-directory))))
 356                  (function :tag "other")))
 357
 358 ;; style/shortvrb.el
 359
 360 (defcustom LaTeX-shortvrb-chars '(?|)
 361   "List of characters toggling verbatim mode."
 362   :group 'LaTeX-style
 363   :type '(repeat character))
 364
 365 (provide 'tex-style)
 366
 367 ;;; tex-style.el ends here