summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex77
1 files changed, 61 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
index e32eac2e7af..4c79e5d593c 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
@@ -22,6 +22,30 @@
\input{pgfplots.preamble.tex}
%\RequirePackage[german,english,francais]{babel}
+\def\matlabcolormaptext{This colormap is similar to one shipped with Matlab (tm) under a similar name.}
+
+\IfFileExists{tikzlibraryspy.code.tex}{%
+\usetikzlibrary{spy}
+}{%
+ \message{ERROR: tikz SPY library NOT available. The manual will only compile partially.^^J}%
+}%
+
+\usepgfplotslibrary{%
+ ternary,
+ smithchart,
+ patchplots,
+ polar,
+ colormaps,
+}
+\pgfqkeys{/codeexample}{%
+ every codeexample/.append style={
+ /pgfplots/every ternary axis/.append style={
+ /pgfplots/legend style={fill=graphicbackground},
+ }
+ },
+ tabsize=4,
+}
+
\pgfplotsmanualexternalexpensivetrue
%\usetikzlibrary{external}
@@ -29,8 +53,10 @@
\title{%
Manual for Package \PGFPlots\\
- {\small Version \pgfplotsversion}\\
- {\small\href{http://sourceforge.net/projects/pgfplots}{http://sourceforge.net/projects/pgfplots}}}
+ {\small 2D/3D Plots in \LaTeX, Version \pgfplotsversion}\\
+ {\small\href{http://sourceforge.net/projects/pgfplots}{http://sourceforge.net/projects/pgfplots}}
+ %\\{\small Attention: you are using an unstable development version.}
+}
%\includeonly{pgfplots.libs}
@@ -71,7 +97,7 @@
}%
\maketitle
\begin{abstract}%
-\PGFPlots\ draws high--quality function plots in normal or logarithmic scaling with a user-friendly interface directly in \TeX. The user supplies axis labels, legend entries and the plot coordinates for one or more plots and \PGFPlots\ applies axis scaling, computes any logarithms and axis ticks and draws the plots, supporting line plots, scatter plots, piecewise constant plots, bar plots, area plots, mesh-- and surface plots and some more. It is based on Till Tantau's package \PGF/\Tikz.
+\PGFPlots\ draws high--quality function plots in normal or logarithmic scaling with a user-friendly interface directly in \TeX. The user supplies axis labels, legend entries and the plot coordinates for one or more plots and \PGFPlots\ applies axis scaling, computes any logarithms and axis ticks and draws the plots. It supports line plots, scatter plots, piecewise constant plots, bar plots, area plots, mesh-- and surface plots, patch plots, contour plots, quiver plots, histogram plots, polar axes, ternary diagrams, smith charts and some more. It is based on Till Tantau's package \PGF/\Tikz.
\end{abstract}
\tableofcontents
\section{Introduction}
@@ -80,15 +106,18 @@ This package provides tools to generate plots and labeled axes easily. It draws
\item consistency of document and font type and font size,
\item direct use of \TeX\ math mode in axis descriptions,
\item consistency of data and figures (no third party tool necessary),
- \item inter document consistency using preamble configurations and styles.
+ \item inter-document consistency using preamble configurations and styles.
\end{itemize}
Although not necessary, separate |.pdf| or |.eps| graphics can be generated using the |external| library developed as part of \Tikz.
-\PGFPlots\ is build completely on \Tikz/\PGF. Knowledge of \Tikz\ will simplify the work with \PGFPlots, although it is not required.
+You are invited to use \PGFPlots\ for visualization of medium sized data sets in two and three dimensions.
+
\section[About PGFPlots: Preliminaries]{About {\normalfont\PGFPlots}: Preliminaries}
This section contains information about upgrades, the team, the installation (in case you need to do it manually) and troubleshooting. You may skip it completely except for the upgrade remarks.
+\PGFPlots\ is built completely on \Tikz/\PGF. Knowledge of \Tikz\ will simplify the work with \PGFPlots, although it is not required.
+
However, note that this library requires at least \PGF\ version $2.00$. At the time of this writing, many \TeX-distributions still contain the older \PGF\ version $1.18$, so it may be necessary to install a recent \PGF\ prior to using \PGFPlots.
\subsection{Components}
@@ -103,6 +132,8 @@ This release provides a lot of improvements which can be found in all detail in
\subsubsection{New Optional Features}
\begin{enumerate}
+ \item \PGFPlots\ 1.4 has fixed several smaller bugs which might produce differences of about $1$--$2\text{pt}$ compared to earlier releases. If you experience problems, use |\pgfplotsset{compat=1.3}|.
+
\item \PGFPlots\ 1.3 comes with user interface improvements. The technical distinction between ``behavior options'' and ``style options'' of older versions is no longer necessary (although still fully supported).
\item \PGFPlots\ 1.3 has a new feature which allows to \emph{move axis labels tight to tick labels} automatically.
@@ -112,17 +143,17 @@ This release provides a lot of improvements which can be found in all detail in
Use
\begin{codeexample}[code only]
\usepackage{pgfplots}
-\pgfplotsset{compat=1.3}
+\pgfplotsset{compat=1.4}
\end{codeexample}
in your preamble to benefit from the improved spacing\footnote{The |compat=1.3| setting is necessary for new features which move axis labels around like reversed axis. However, \PGFPlots\ will still work as it does in earlier versions, your documents will remain the same if you don't set it explicitly.}.
Take a look at the next page for the precise definition of |compat|.
- \item \PGFPlots\ 1.3 now supports reversed axes. It is no longer necessary to use work--arounds with negative units.
+ \item \PGFPlots\ 1.3 now supports reversed axes. It is no longer necessary to use workarounds with negative units.
\pgfkeys{/pdflinks/search key prefixes in/.add={/pgfplots/,}{}}
Take a look at the |x dir=reverse| key.
- Existing work--arounds will still function properly. Use |\pgfplotsset{compat=1.3}| together with |x dir=reverse| to switch to the new version.
+ Existing workarounds will still function properly. Use |\pgfplotsset{compat=1.3}| together with |x dir=reverse| to switch to the new version.
\end{enumerate}
\subsubsection{Old Features Which May Need Attention}
@@ -136,19 +167,23 @@ This release provides a lot of improvements which can be found in all detail in
\item Starting with \PGFPlots\ $1.1$, |\tikzstyle| should \emph{no longer be used} to set \PGFPlots\ options.
- Although |\tikzstyle| is still supported for some older \PGFPlots\ options, you should replace any occurance of |\tikzstyle| with |\pgfplotsset{|\meta{style name}|/.style={|\meta{key-value-list}|}}| or the associated |/.append style| variant. See section~\ref{sec:styles} for more detail.
+ Although |\tikzstyle| is still supported for some older \PGFPlots\ options, you should replace any occurance of |\tikzstyle| with |\pgfplotsset{|\meta{style name}|/.style={|\meta{key-value-list}|}}| or the associated |/.append style| variant. See Section~\ref{sec:styles} for more detail.
\end{enumerate}
I apologize for any inconvenience caused by these changes.
-\begin{pgfplotskey}{compat=\mchoice{1.3,pre 1.3,default,newest} (initially default)}
+\begin{pgfplotskey}{compat=\mchoice{1.5,1.4,1.3,pre 1.3,default,newest} (initially default)}
The preamble configuration
\begin{codeexample}[code only]
\usepackage{pgfplots}
-\pgfplotsset{compat=1.3}
+\pgfplotsset{compat=1.4}
\end{codeexample}
allows to choose between backwards compatibility and most recent features.
- \PGFPlots\ version 1.3 comes with new features which may lead to different spacings compared to earlier versions:
+ \PGFPlots\ version 1.5 with |compat=1.5| or |compat=newest| enables |log origin=0|. Older versions keep |log origin=infty|.
+
+ \PGFPlots\ version 1.4 with |compat=1.4| or |compat=newest| fixes some small bugs related to axis scaling. This might lead to differences of $1$--$2\text{pt}$ compared to earlier versions. Use the choice |1.3| (or earlier) to disable these fixes.
+
+ \PGFPlots\ version 1.3 with |compat=1.3| comes with new features which may lead to significiantly different spacings compared to earlier versions:
\begin{enumerate}
\item Version 1.3 comes with the |xlabel near ticks| feature which places (in this case $x$) axis labels ``near'' the tick labels, taking the size of tick labels into account.
@@ -159,20 +194,30 @@ I apologize for any inconvenience caused by these changes.
You are encouraged to use
\begin{codeexample}[code only]
\usepackage{pgfplots}
-\pgfplotsset{compat=1.3}
+\pgfplotsset{compat=1.4}
\end{codeexample}
in your preamble.
\item Version 1.3 fixes a bug with |anchor=south west| which occurred mainly for reversed axes: the anchors where upside--down. This is fixed now.
- If you have written some work--around and want to keep it going, use
+ If you have written some workaround and want to keep it going, use
|\pgfplotsset{compat/anchors=pre 1.3}|\pgfmanualpdflabel{/pgfplots/compat/anchors}{}
to disable the bug fix.
\end{enumerate}
+ Occasionally, you might want to use different versions in the same document. Then, provide
+\begin{codeexample}[code only]
+\begin{figure}
+ \pgfplotsset{compat=1.4}
+ ...
+ \caption{...}
+\end{figure}
+\end{codeexample}
+ \noindent in order to restrict the compatibility setting to the actual context (in this case, the |figure| environment.
+
Use |\pgfplotsset{compat=default}| to restore the factory settings.
The setting |\pgfplotsset{compat=newest}| will always use features of the most recent version. This might result in small changes in the document's appearance.
@@ -184,9 +229,9 @@ I apologize for any inconvenience caused by these changes.
If you are interested in writing something but don't know how, consider reading the auxiliary manual \href{file:TeX-programming-notes.pdf}{TeX-programming-notes.pdf} which comes with \PGFPlots. It is far from complete, but maybe it is a good starting point (at least for more literature).
\subsection{Acknowledgements}
-I thank God for all hours of enjoyed programming. I thank Pascal Wolkotte and Nick Papior Andersen for their programming efforts and contributions as part of the development team. I thank Stefan Tibus, who contributed the |plot shell| feature. I thank Tom Cashman for the contribution of the |reverse legend| feature. Special thanks go to Stefan Pinnow whose tests of \PGFPlots\ lead to numerous quality improvements. Furthermore, I thank Dr.~Schweitzer for many fruitful discussions and Dr.~Meine for his ideas and suggestions. Thanks as well to the many international contributors who provided feature requests or identified bugs or simply manual improvements!
+I thank God for all hours of enjoyed programming. I thank Pascal Wolkotte and Nick Papior Andersen for their programming efforts and contributions as part of the development team. I thank Stefan Tibus, who contributed the |plot shell| feature. I thank Tom Cashman for the contribution of the |reverse legend| feature. Special thanks go to Stefan Pinnow whose tests of \PGFPlots\ lead to numerous quality improvements. Furthermore, I thank Dr.~Schweitzer for many fruitful discussions and Dr.~Meine for his ideas and suggestions. Special thanks go to Markus B\"ohning for proof-reading all the manuals of \PGF, \PGFPlots, and \PGFPlotstable. Thanks as well to the many international contributors who provided feature requests or identified bugs or simply improvements of the manual!
-Last but not least, I thank Till Tantau and Mark Wibrow for their excellent graphics (and more) package \PGF\ and \Tikz\ which is the base of \PGFPlots.
+Last but not least, I thank Till Tantau and Mark Wibrow for their excellent graphics (and more) package \PGF\ and \Tikz, which is the base of \PGFPlots.
\include{pgfplots.install}%
\include{pgfplots.intro}%