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.tex109
1 files changed, 98 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
index d3caca95ce7..5d1b7fec2a3 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
@@ -22,6 +22,8 @@
\input{pgfplots.preamble.tex}
%\RequirePackage[german,english,francais]{babel}
+\pgfplotsmanualexternalexpensivetrue
+
%\usetikzlibrary{external}
%\tikzexternalize[prefix=figures/]{pgfplots}
@@ -30,7 +32,7 @@
{\small Version \pgfplotsversion}\\
{\small\href{http://sourceforge.net/projects/pgfplots}{http://sourceforge.net/projects/pgfplots}}}
-%\includeonly{pgfplots.reference}
+%\includeonly{pgfplots.libs}
\begin{document}
@@ -69,36 +71,118 @@
}%
\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, piecewise constant plots, bar plots and area plots. 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, 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.
\end{abstract}
\tableofcontents
\section{Introduction}
-This package provides tools to generate plots and labeled axes easily. It draws normal plots, logplots and semi-logplots. Axis ticks, labels, legends (in case of multiple plots) can be added with key-value options. It can cycle through a set of predefined line/marker/color specifications. In summary, its purpose is to simplify the generation of high-quality function plots, especially for use in scientific contexts (logplots).
+This package provides tools to generate plots and labeled axes easily. It draws normal plots, logplots and semi-logplots, in two and three dimensions. Axis ticks, labels, legends (in case of multiple plots) can be added with key-value options. It can cycle through a set of predefined line/marker/color specifications. In summary, its purpose is to simplify the generation of high-quality function and/or data plots, and solving the problems of
+\begin{itemize}
+ \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 interdocument 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.
-It is build completely on \Tikz\ and \PGF\ and may be used as \Tikz\ library.
+\PGFPlots\ is build completely on \Tikz/\PGF. Knowledge of \Tikz\ will simplify the work with \PGFPlots, although it is not required.
\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.
+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}
+\PGFPlots\ comes with two components:
+\begin{enumerate}
+ \item the plotting component (which you are currently reading) and
+ \item the \PGFPlotstable\ component which simplifies number formatting and postprocessing of numerical tables. It comes as a separate package and has its own manual \href{file:pgfplotstable.pdf}{pgfplotstable.pdf}.
+\end{enumerate}
+
\subsection{Upgrade remarks}
-This release provides a lot of improvements which can be found in all detail in \texttt{ChangeLog} for interested readers. However, some attention is useful with respect to the following changes:
+This release provides a lot of improvements which can be found in all detail in \texttt{ChangeLog} for interested readers. However, some attention is useful with respect to the following changes.
+
+\subsubsection{New Optional Features}
\begin{enumerate}
- \item Due to a small math bug in \PGF\ $2.00$: you \emph{can't} write `|-x^2|' -- use `|0-x^2|' instead. The same holds for
- `|exp(-x^2)|' -- use `|exp(0-x^2)|' instead.
+ \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.
+
+ Since this affects the spacing, it is not enabled be default.
+
+ Use
+\begin{codeexample}[code only]
+\usepackage{pgfplots}
+\pgfplotsset{compat=newest}
+\end{codeexample}
+ in your preamble to benefit from the improved spacing\footnote{The |compat=newest| 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.
+\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=newest}| together with |x dir=reverse| to switch to the new version.
+\end{enumerate}
+
+\subsubsection{Old Features Which May Need Attention}
+\begin{enumerate}
+ \item The |scatter/classes| feature produces proper legends as of version 1.3. This may change the appearance of existing legends of plots with |scatter/classes|.
+
+ \item Due to a small math bug in \PGF\ $2.00$, you \emph{can't} use the math expression `|-x^2|'. It is necessary to use `|0-x^2|' instead. The same holds for
+ `|exp(-x^2)|'; use `|exp(0-x^2)|' instead.
+
+ This will be fixed with \PGF\ $>2.00$.
\item Starting with \PGFPlots\ $1.1$, |\tizkstyle| 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.
-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.
+\begin{pgfplotskey}{compat=\mchoice{newest,pre 1.3,default} (initially default)}
+ The preamble configuration
+\begin{codeexample}[code only]
+\usepackage{pgfplots}
+\pgfplotsset{compat=newest}
+\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:
+ \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.
+
+ Older versions used |xlabel absolute|, i.e.\ an absolute distance between the axis and axis labels (now matter how large or small tick labels are).
+
+ The initial setting \emph{keeps backwards compatibility}.
+
+ You are encouraged to use
+\begin{codeexample}[code only]
+\usepackage{pgfplots}
+\pgfplotsset{compat=newest}
+\end{codeexample}
+ in your preamble.
+
+ \item Version 1.3 fixes a bug with |anchor=south west| which occured 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
+
+ |\pgfplotsset{compat/anchors=pre 1.3}|\pgfmanualpdflabel{/pgfplots/compat/anchors}{}
+
+ to disable the bug fix.
+ \end{enumerate}
+
+ Use |\pgfplotsset{compat=default}| to restore the factory settings.
+\end{pgfplotskey}
\subsection{The Team}
-\PGFPlots\ has been written by Christian Feuersänger and Pascal Wolkotte as a spare time project. We hope it is useful and provides valueable plots.
+\PGFPlots\ has been written mainly by Christian Feuersänger with many improvements of Pascal Wolkotte and Nick Papior Andersen as a spare time project. We hope it is useful and provides valueable plots.
+
+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, author of package |pgfgraph|, who joined development and contributed code for axis lines and tick alignment. Furthermore, I thank Dr.~Schweitzer for many fruitful discussions and Dr.~Meine for his ideas and suggestions.
+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. Furthermore, I thank Dr.~Schweitzer for many fruitful discussions and Dr.~Meine for his ideas and suggestions.
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.
@@ -108,9 +192,12 @@ Last but not least, I thank Till Tantau and Mark Wibrow for their excellent grap
\include{pgfplots.libs}%
\include{pgfplots.resources}%
\include{pgfplots.importexport}%
+\include{pgfplots.basic.reference}%
\printindex
\bibliographystyle{abbrv} %gerapali} %gerabbrv} %gerunsrt.bst} %gerabbrv}% gerplain}
+\nocite{pgfplotstable}
+\nocite{programmingnotes}
\bibliography{pgfplots}
\end{document}