diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex index 7d217a22b3a..a1fb65fa6bc 100644 --- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex +++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.libs.units.tex @@ -5,7 +5,7 @@ \begin{pgfplotslibrary}{units} A library which allows to use automatic typesetting of units in labels. The library utilizes different keys to typeset the final output in a consistent way. - Calling one of the commands automatically sets the key `|use units=true|' so one has not to worry of this. + Calling one of the commands automatically sets the key `|use units=true|' so one does not have to worry about this. \end{pgfplotslibrary} \PGFPlots\ has the capability of supporting units. This provides quick customization of the plot as well as the addition of units in labels. @@ -18,20 +18,20 @@ First the key which enables you to switch on/off the unit system. determine whether the unit library should be used in plots. \end{pgfplotskey} \begin{pgfplotsxykey}{\x\ unit=\marg{unit} (initially empty)} - These keys sets the unit in their respective axis. In SI units you could for instance set the |x unit| in Newton as |x unit=N|. + These keys set the unit in their respective axis. In SI units you could for instance set the |x unit| in Newton as |x unit=N|. \end{pgfplotsxykey} \begin{pgfplotsxykey}{\x\ unit prefix=\marg{prefix} (initially empty)} - These keys sets the prefix of the unit. If a value on the |y axis| is in kilo you would set the |y unit prefix=k|. Prefix will be typeset in front of the unit. + These keys set the prefix of the unit. If a value on the |y axis| is in kilo you would set the |y unit prefix=k|. Prefix will be typeset in front of the unit. This command will not intervene with the basis of the axis system. I.e. a prefix as just mentioned will not divide every |y axis| number by 1000. - In order to do this see key \meta{axis}| SI prefix|, see Section \ref{sec:SI:prefix}. + In order to do this, see key \meta{axis}| SI prefix|, see Section \ref{sec:SI:prefix}. Notice that if the \meta{axis}| unit| isn't set the entire unit will not be typeset. - \paragraph{Remarks:} Remember that all typesetting of labels occur within a \$\$ environment. Therefore one can use \textbackslash|frac| + \paragraph{Remarks:} Remember that all typesetting of labels occur within math mode (i.e.\ within \$\$ delimiters). Therefore one can use \textbackslash|frac| and other mathematics commands. \end{pgfplotsxykey} -Often one just have to utilize the above mentioned keys. It is the basis of the unit typesetting system provided by \PGFPlots. +Often one just has to utilize the above mentioned keys. It is the basis of the unit typesetting system provided by \PGFPlots. % \usepgfplotslibrary{units} \begin{codeexample}[] \begin{tikzpicture} @@ -51,7 +51,7 @@ Often one just have to utilize the above mentioned keys. It is the basis of the \end{tikzpicture} \end{codeexample} -Below is an example of what would be yielded according to the styles +Below is an example of what would be obtained according to the styles \begin{codeexample}[code only] % x label becomes ``Temperature [T]'', y label becomes ``Nothing'' \pgfplotsset{use units,x unit=T,xlabel=Temperature,ylabel=Nothing} @@ -64,7 +64,7 @@ typesetting of the labels should be done. For typesetting the units one can also change the appearance. For instance one might not like the square brackets which surround the unit. These can luckily be changed using the below keys. \begin{pgfplotskeylist}{unit marking pre=\marg{pre} (initially \textbackslash left[),unit marking post=\marg{post} (initially \textbackslash right]),unit markings=\mchoice{parenthesis,square brackets,slash space} (initially square brackets)} - These keys sets the surroundings of the unit. The initial yields $\left[\frac{1}{2}\right]$ such that you can typeset fractions in units. Be aware that + These keys set the surroundings of the unit. The initial yields $\left[\frac{1}{2}\right]$ such that you can typeset fractions in units. Be aware that you can only obtain large fractions if you use \textbackslash|dfrac|. These can easily be set using the option key |unit markings| where the options typesets as the following \begin{codeexample}[code only] \pgfplotsset{x unit=T,unit markings=parenthesis} % x unit becomes `` \left(T\right)'' @@ -78,7 +78,7 @@ luckily be changed using the below keys. One will typically typeset the unit with a specific font. To do so an option of changing the typesetting command is supplied. \begin{pgfplotscodetwokey}{unit code}%\textbackslash mathrm\{\})} - This can be utilized to great extend. As a default the typesetting of the units is as |\mathrm{|\meta{unit prefix}\meta{unit}|}|. But if one for instance + This can be utilized to great extent. By default, units are typeset as |\mathrm{|\meta{unit prefix}\meta{unit}|}|. But if one for instance wishes to utilize the package |siunitx|, which has great capabilities in typesetting both units, numbers and angles, one can just set the key as \begin{codeexample}[code only] \pgfplotsset{unit code/.code 2 args={\si{#1#2}}} |