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.tex44
1 files changed, 33 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
index 0196ebbe729..c010a3c790c 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.tex
@@ -19,7 +19,9 @@
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% SEE pgfplots-macros.tex as well!
\input{pgfplots.preamble.tex}
+
%\RequirePackage[german,english,francais]{babel}
\def\matlabcolormaptext{This colormap is similar to one shipped with Matlab (\textregistered) under a similar name.}
@@ -60,7 +62,7 @@
%\\{\small Attention: you are using an unstable development version.}
}
-%\includeonly{pgfplots.libs}
+%\includeonly{pgfplots.reference,pgfplots.basic.reference}
\begin{document}
@@ -120,7 +122,7 @@ This section contains information about upgrades, the team, the installation (in
\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.
+However, note that this library requires at least \PGF\ version $2.10$. 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:
@@ -138,12 +140,16 @@ This release provides a lot of improvements which can be found in all detail in
Any new features or bugfixes which cause backwards compatibility problems need to be activated \emph{manually} and \emph{explicitly}. In order to do so, you should use
\begin{codeexample}[code only]
\usepackage{pgfplots}
-\pgfplotsset{compat=1.5.1}
+\pgfplotsset{compat=1.6}
\end{codeexample}
\noindent in your preamble. This will configure the compatibility layer.
+You should have at least |compat=1.3|. The suggested value is printed to the |.log| file after running \TeX.
+
Here is a list of changes introduced in recent versions of \PGFPlots:
\begin{enumerate}
+ \item \PGFPlots\ 1.6 added new options for more accurate scaling and more scaling options for |\addplot3 graphics|. These are enabled with |compat=1.6| or higher.
+
\item \PGFPlots\ 1.5.1 interpretes circle- and ellipse radii as \PGFPlots\ coordinates (older versions used \pgfname\ unit vectors which have no direct relation to \PGFPlots). In other words: starting with version 1.5.1, it is possible to write |\draw circle[radius=5]| inside of an axis. This requires |\pgfplotsset{compat=1.5.1}| or higher.
Without this compatibility setting, circles and ellipses use low--level canvas units of \pgfname\ as in earlier versions.
@@ -160,7 +166,7 @@ Here is a list of changes introduced in recent versions of \PGFPlots:
Since this affects the spacing, it is not enabled be default.
- \item \PGFPlots\ 1.3 now supports reversed axes. It is no longer necessary to use workarounds with negative units.
+ \item \PGFPlots\ 1.3 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.
@@ -178,11 +184,11 @@ Here is a list of changes introduced in recent versions of \PGFPlots:
\end{enumerate}
I apologize for any inconvenience caused by these changes.
-\begin{pgfplotskey}{compat=\mchoice{1.5.1,1.5,1.4,1.3,pre 1.3,default,newest} (initially default)}
+\begin{pgfplotskey}{compat=\mchoice{1.6,1.5.1,1.5,1.4,1.3,pre 1.3,default} (initially default)}
The preamble configuration
\begin{codeexample}[code only]
\usepackage{pgfplots}
-\pgfplotsset{compat=1.5.1}
+\pgfplotsset{compat=1.6}
\end{codeexample}
allows to choose between backwards compatibility and most recent features.
@@ -196,12 +202,20 @@ I apologize for any inconvenience caused by these changes.
\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 the output of your |.log| file to see the suggested value for |compat|.
- 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. Note that it is generally a good idea to select the most recent version which is compatible with your document. This ensures that future changes will still be compatible with your document.
+ Use |\pgfplotsset{compat=default}| to restore the factory settings.
Although typically unnecessary, it is also possible to activate only selected changes and keep compatibility to older versions in general:
- \begin{pgfplotskeylist}{compat/path replacement=\meta{version},compat/labels=\meta{version},compat/scaling=\meta{version},compat/general=\meta{version}}
+ \begin{pgfplotskeylist}{%
+ compat/path replacement=\meta{version},%
+ compat/labels=\meta{version},%
+ compat/scaling=\meta{version},%
+ compat/scale mode=\meta{version},%
+ compat/empty line=\meta{version},%
+ compat/plot3graphics=\meta{version},%
+ compat/general=\meta{version}%
+ }
Let us assume that we have a document with |\pgfplotsset{compat=1.3}| and you want to keep it this way.
In addition, you realized that version 1.5.1 supports circles and ellipses. Then, use
@@ -225,12 +239,20 @@ I apologize for any inconvenience caused by these changes.
The |compat/labels| key controls how axis labels are aligned: either uses adjacent to ticks or with an absolute offset.
- The |compat/scaling| key controls some bugfixes introduced in version 1.4: they might introduce slight scaling differences in order to improve the accuracy.
+ The |compat/scaling| key controls some bugfixes introduced in version 1.4 and 1.6: they might introduce slight scaling differences in order to improve the accuracy.
+
+ The |compat/plot3graphics| controls new features for |\addplot3 graphics|.
+
+ The |compat/scale mode| allows to enable/disable the warning ``The content of your 3d axis has CHANGED compared to previous versions'' because the |axis equal| and |unit vector ratio| features where broken for all versions before~1.6 and have been fixed in~1.6.
+
+ The |compat/empty line| allows to write empty lines into input files in order to generate a jump. This requires |compat=1.4| or newer. See |empty line| for details.
The |compat/general| key currently only activates |log origin|.
The detailed effects can be seen on the beginning of this section.
\end{pgfplotskeylist}
+
+ The value \meta{version} can be |default|, |pre 1.3|, |1.3|, |1.4|, |1.5|, |1.5.1|, |1.6|, and |newest|. The value |default| is the same as |pre 1.3| (up to insignificant changes). The use of |newest| is strongly \emph{discouraged}: it might cause changes in your document, depending on the current version of \PGFPlots. Please inspect your |.log| file to see suggestions for the best possible version.
\end{pgfplotskey}
\subsection{The Team}
@@ -239,7 +261,7 @@ 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. 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!
+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 J\"urnjakob Dugge for his contribution of |hist/density|, matlab scripts for \verbpdfref{\addplot3} |graphics|, excellent user forum help and helpful bug reports. 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.