beamer / doc / beamerug-compatibility.tex

% Copyright 2003, 2004 by Till Tantau <tantau@users.sourceforge.net>.
%
% This program can be redistributed and/or modified under the terms
% of the GNU Public License, version 2.

\subsection{Compatibility with Other Packages and Classes}

When using certain packages or classes together with the |beamer|
class, extra options or precautions may be necessary.

\begin{package}{{AlDraTex}}
  Graphics created using AlDraTex must be treated like verbatim
  text. The reason is that DraTex fiddles with catcodes and spaces
  much like verbatim does. So, in order to insert a picture, either
  add the |containsverbatim| option to the frame or use the
  |\defverbatim| command to create a box containing the picture.
\end{package}

\begin{package}{{alltt}}
  Text in an |alltt| environment must be treated like verbatim
  text. So add the |containsverbatim| option to frames containing this
  environment or use |\defverbatim|.
\end{package}

\begin{package}{{amsthm}}
  This package is automatically loaded since \beamer\ uses it for
  typesetting theorems. If you do not wish it to be loaded, which can
  be necessary especially in |article| mode if the package is
  incompatible with the document class, you can use the class option
  |noamsthm| to suppress its loading. See
  Section~\ref{section-theorems} for more details.
\end{package}

\begin{package}{{babel}|[|\declare{|french|}|]|}
  When using the |french| style, certain features that clash with the
  functionality of the \beamer\ class will be turned off. For example,
  enumerations are still produced the way the theme dictates, not the
  way the |french| style does.
\end{package}

\begin{package}{{babel}|[|\declare{|spanish|}|]|}
  \beamernote
  When using the |spanish| style, certain features that clash with the
  functionality of the \beamer\ class will be turned off. In particular,
  the special behaviour of the pointed brackets |<| and |>| is
  deactivated. 

  \articlenote
  To make the characters |<| and |>| active in |article| mode, pass
  the option |activeospeccharacters| to the package
  |beamerbasearticle|. This will lead to
  problems with overlay specifications.
\end{package}

\begin{package}{{color}}
  \beamernote
  The |color| package is automatically loaded by |beamer.cls|. This
  makes it impossible to pass options to |color| in the preamble of
  your document. To pass a \meta{list of options} to |color|, you must
  use the following class option:

  \begin{classoption}{color={\normalfont\meta{list of options}}}
    Causes the \meta{list of options} to be passed on to the |color|
    package. If the \meta{list of options} contains more than one
    option you must enclose it in curly brackets.
  \end{classoption}

  \articlenote
  The |color| package is not loaded automatically if
  |beamerarticle| is loaded with the |noxcolor| option.
\end{package}

\begin{package}{{CJK}}
  \beamernote
  When using the |CJK| package for using Asian fonts, you must use the
  class option \declare{|CJK|}. See |beamerexample4.tex| for an
  example. 
\end{package}

\begin{package}{{deluxetable}}
  \beamernote
  The caption generation facilities of |deluxetable| are
  deactivated. Instead, the caption template is used.
\end{package}

\begin{package}{{DraTex}}
  See |AlDraTex|.
\end{package}

\begin{package}{{enumerate}}
  \articlenote
  This package is loaded automatically in the |presentation| modes, but not
  in the |article| mode. If you use its features, you have to load the
  package ``by hand'' in the |article| mode.
\end{package}

\begin{class}{{foils}}
  If you wish to emulate the |foils| class using \beamer, please see
  Section~\ref{section-foiltex}.
\end{class}

\begin{package}{{fontenc}|[|\declare{|T1|}|]|}
  Use this option only with fonts that have outline fonts available in
  the T1 encoding like Times or the |lmodern| fonts. In a standard
  installation the standard Computer Modern fonts (the fonts Donald
  Knuth originally designed and which are used by default) are
  \emph{not} available in the T1 encoding. Using this  option with
  them will result in very poor rendering of your presentation when
  viewed with \pdf\ viewer applications like Acrobat or |xpdf|. To use
  the Computer Modern fonts with the T1 encoding, use the package
  |lmodern|.  See also Section~\ref{section-font-encoding}.
\end{package}

\begin{package}{{fourier}}
  The package switches to a T1~encoding, but it does not redefine all
  fonts such that outline fonts (non-bitmapped fonts) are used by
  default. For example, the sans-serif text and the typewriter text
  are not replaced. To use outline fonts for these, write
  |\usepackage{lmodern}| \emph{before} including the |fourier|
  package. 
\end{package}

\begin{package}{{HA-prosper}}
  You cannot use this package with \beamer. However, you might try to
  use the package |beamerprosper| instead, see
  Section~\ref{section-prosper}. 
\end{package}

\begin{package}{{hyperref}}
  \beamernote
  The |hyperref| package is automatically loaded by |beamer.cls| and
  certain options are setup. In order pass additional options to
  |hyperref| or to override options, you can use the following class
  option: 

  \begin{classoption}{hyperref={\normalfont\meta{list of options}}}
    Causes the \meta{list of options} to be passed on to the |hyperref|
    package.

    \example |\documentclass[hyperref={bookmarks=false}]{beamer}|
  \end{classoption}

  Alternatively, you can also use the |\hypersetup| command.

  \articlenote
  In the |article| version, you must include |hyperref| manually if
  you want to use it. It is not included automatically.
\end{package}

\begin{package}{{inputenc}|[|\declare{|utf8|}|]|}
  \beamernote
  When using Unicode, you may wish to use one of the following class
  options: 
  \begin{classoption}{ucs}
    Loads the package |ucs| and passes the correct Unicode options to
    |hyperref|. Also, it preloads the Unicode code pages zero and
    one.
  \end{classoption}
  
  \begin{classoption}{utf8}
    Same as the option |ucs|, but also sets the input encoding to
    |utf8|. You could also use the option |ucs| and say
    |\usepackage[utf8]{inputenc}| in the preamble.
  \end{classoption}

  If you use a Unicode character outside the first two code pages
  (which includes the Latin alphabet and the extended Latin alphabet)
  in a section or subsection heading, you have to use the command
  |\PreloadUnicodePage{|\meta{code  page}|}| to give |ucs| a chance to
  preload these code pages. You will know that a character has not
  been preloaded, if you get a message like ``Please insert into
  preamble.'' The code page of a character is given by the unicode
  number of the character divided by 256.
\end{package}

\begin{package}{{listings}}
  \beamernote
  Note that you must treat |lstlisting| environments exactly the same
  way as you would treat |verbatim| environments. When using
  |\defverbatim| that contains a colored |lstlisting|, use the
  |colored| option of |\defverbatim|.
\end{package}

\begin{package}{{msc}}
  \beamernote
  Since this packages uses |pstricks| internally, everything that
  applies to pstricks also applies to |msc|.
\end{package}

\begin{package}{{musixtex}}
  When using  MusiX\TeX\ to typeset musical scores, your document must
  be compiled with |pdfelatex| or |elatex| instead of |pdflatex| or
  |latex|.  

  Inside  a |music| environment, the |\pause| is redefined to match
  MusiX\TeX's definition (a rest during one quarter of a whole). You can
  use the |\beamerpause| command  to create overlays in this
  environment.  
\end{package}

\begin{package}{{pdfpages}}
  Commands like |\includepdf| only work \emph{outside} frames as they
  produce pages ``by themselves.'' You may also wish to say
  |\usebackgroundtemplate{}| when you use such a command since the
  background (even a white background) will otherwise be printed over
  the image you try to include.

  \example
\begin{verbatim}
\begin{document}
\begin{frame}
  \titlepage
\end{frame}

{
  \usebackgroundtemplate{}
  \includepdf{somepdfimages.pdf}
}

\begin{frame}
  A normal frame.
\end{frame}
\end{document}
\end{verbatim}
\end{package}

\begin{package}{{\normalfont\meta{professional font package}}}
  \beamernote
  If you use a professional font package, \beamer's internal
  redefinition of how variables are typeset may interfere with the
  font package's superior way of typesetting them. In this case, you
  should use the class option |professionalfont| to suppress any font
  substitution. See Section~\ref{section-substition} for details.
\end{package}

\begin{class}{{prosper}}
  If you wish to (partly) emulate the |prosper| class using \beamer,
  please see Section~\ref{section-prosper}.
\end{class}

\begin{package}{{pstricks}}
  You should add the option |xcolor=pst| to make |xcolor| aware of the
  fact that you are using |pstricks|.
\end{package}

\begin{class}{{seminar}}
  If you wish to emulate the |seminar| class using \beamer, please see
  Section~\ref{section-seminar}.
\end{class}

\begin{package}{{texpower}}
  You cannot use this package with \beamer. However, you might try to
  use the package |beamertexpower| instead, see
  Section~\ref{section-texpower}.  
\end{package}

\begin{package}{{textpos}}
  \beamernote
  \beamer\ automatically installs a white background behind
  everything, unless you install a different background
  template. Because of this, you must use the |overlay| option when
  using |textpos|, so that it will place boxes \emph{before}
  everything. Alternatively, you can install an empty background
  template, but this may result in an incorrect display in certain
  situtations with older versions of the Acrobat Reader. 
\end{package}

\begin{package}{{ucs}}
  See |\usepackage[utf8]{inputenc}|.
\end{package}


\begin{package}{{xcolor}}
  \beamernote
  The |xcolor| package is automatically loaded by |beamer.cls|. The
  same applies as to |color|.

  \begin{classoption}{xcolor={\normalfont\meta{list of options}}}
    Causes the \meta{list of options} to be passed on to the |xcolor|
    package.
  \end{classoption}

  When using \beamer\ together with the |pstricks| package, be sure to
  pass the |xcolor=pst| option to \beamer\ (and hence to |xcolor|).

  \articlenote
  The |color| package is not loaded automatically if
  |beamerarticle| is loaded with the |noxcolor| option.
\end{package}




%%% Local Variables: 
%%% mode: latex
%%% TeX-master: "beameruserguide"
%%% End: 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.