diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/README | 12 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.pdf | bin | 0 -> 191151 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex | 231 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.pdf | bin | 0 -> 39292 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.png | bin | 0 -> 70761 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.tex | 72 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pgfmanual-en-macros.tex | 943 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/pdfmarginpar/pgfplots-macros.tex | 390 |
8 files changed, 1648 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/README b/Master/texmf-dist/doc/latex/pdfmarginpar/README new file mode 100644 index 00000000000..101df793948 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/README @@ -0,0 +1,12 @@ +pdfmarginpar provides the \pdfmarginpar command which is +similar in spirit to \marginpar. How- +ever, it creates pdf-annotations which can be viewed with +Adobe Reader instead of normal text margins: +small icons indicate the in-text position where the message +originates, popups provide detailed messages. +The advantage over \marginpar is that bugfixes and +communication is clearly visible together with its +text source and the document as such is not obscured. + +Author's name: Christian Feuersänger +License type: lppl diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.pdf b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.pdf Binary files differnew file mode 100644 index 00000000000..9e2d505b37f --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.pdf diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex new file mode 100644 index 00000000000..d386db78475 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginpar.tex @@ -0,0 +1,231 @@ +\documentclass[a4paper]{ltxdoc} + +\usepackage{ifpdf} +\ifpdf + \usepackage[pdftex]{hyperref} +\else + \usepackage[dvipdfm]{hyperref} +\fi +\hypersetup{pdfborder={0 0 0}} + +\def\choicesep{$\vert$}% +\def\choicearg#1{\texttt{#1}} + + +\usepackage{textcomp} + +\usepackage{calc} +\usepackage[formats]{listings} +%\usepackage{courier} % don't use it - the '^' character can't be copy-pasted in courier + +%-------------------------------------------------- +% \usepackage{array} +%-------------------------------------------------- +\lstset{% +% basicstyle=\ttfamily, +% language=[LaTeX]tex, % Seems as if \lstset{language=tex} must be invoked BEFORE loading tikz!? + tabsize=4, +% breaklines=true, + breakindent=0pt + backgroundcolor=\color{codebackground}, + columns=fullflexible, + emph={\pdfmarginpar},emphstyle={\color{yellow}}, + basicstyle=\normalfont\ttfamily\footnotesize\frenchspacing, + language=, +} + +\ifpdf + \pdfinfo { + /Author (Christian Feuersaenger) + } +\fi + +\usepackage{tikz} + +\usepackage[a4paper,left=2.25cm,right=2.25cm,top=2.5cm,bottom=2.5cm,nohead]{geometry} +\usepackage{amsmath,amssymb} +\usepackage{xxcolor} +\usepackage{pifont} +\usepackage{makeidx} +\usepackage[latin1]{inputenc} +\usepackage{amsmath} +\usepackage{eurosym} + +\input pgfplots-macros.tex + +\pgfqkeys{/codeexample}{% + every codeexample/.style={ + width=8cm, + }, + tabsize=4, +} + +\usetikzlibrary{backgrounds,patterns} +% Global styles: +\tikzset{ + shape example/.style={ + color=black!30, + draw, + fill=yellow!30, + line width=.5cm, + inner xsep=2.5cm, + inner ysep=0.5cm} +} + +\newcommand{\FIXME}[1]{\textcolor{red}{(FIXME: #1)}} + +% fuer endvironment 'sidewaysfigure' bspw +% \usepackage{rotating} + +\newcommand\PDFMRG{\textsc{pdfmarginpar}} + + +\makeindex + +% Fix overful hboxes automatically: +\tolerance=2000 +\emergencystretch=10pt + +\usepackage{pdfmarginpar} + +\author{% + Christian Feuers\"anger\footnote{\url{http://wissrech.ins.uni-bonn.de/people/feuersaenger}}\\% + Institut f\"ur Numerische Simulation\\ + Universit\"at Bonn, Germany} + +\title{ + Manual for Package \PDFMRG\\ + {\small Version 0.8}} + +\begin{document} +\maketitle +\begin{abstract}% +\PDFMRG\ provides the |\pdfmarginpar| command which is similar in spirit to |\marginpar|. However, it creates \pdf-annotations which can be viewed with Adobe Reader instead of normal text margins: small icons\pdfmarginpar[Comment]{As they are provided by the viewer application} indicate the in-text position where the message originates, popups provide detailed messages. The advantage over |\marginpar| is that bugfixes and communication is clearly visible together with its text source and the document as such is not obscured. +\end{abstract} +\tableofcontents +\section{Introduction} +This package provides a debugging tool which is more comfortable and powerful than |\marginpar|. It employs \pdf\ annotations\pdfmarginpar[Note]{These annotations are a PDF Feature, together with their appearance options.} as they can be generated with the commercial Adobe Acrobat program, making them clearly visible and as detailed as needed while still avoiding obscured documents or problems with small margins. + +The package is also useful as communication device for articles written by multiple authors. Often, one would like to use Adobe Reader to insert, edit and write pdf annotations as this does not require to exchange all \TeX-sources. There has been a lot of discussion of this problem recently in web forums. As far as I know, the result was always the same: create the \pdf\ document with the commercial Adobe Acrobat, then (and only then) is it possible to insert, edit and save \pdf\ annotations. This package is a light-weight free tool to create \emph{read-only} annotations which can be viewed with Adobe Reader. Despite this limitations of Acrobat Reader I guess it is still useful for interactions between multiple authors because it's not so difficult\footnote{I admit, version control still requires attention.} to exchange |.tex| files along with the |.pdf| files. + +\paragraph{Hint:} View this document in Adobe Reader as it contains several annotations. + +\section{Installation and Requirements} +The package is very small. In fact, it is nothing but a light-weight command which invokes the |pdflatex| primitive |\pdfannot| with a high-level user interface which encapsulates all supported \pdf\ annotation parameters with key-value options. + +Simply copy |pdfmarginpar.sty| somewhere into your \TeX\ search path (or the article's directory). + +\paragraph{Requirements:} The package relies on |pdflatex| primitives, so it is necessary to translate the document with |pdflatex| (|dvips| or |dvipdfm| combinations are \emph{not} supported yet). As far as I know, only Adobe Reader views annotations properly. + +\section{Usage} +Simply write +\begin{codeexample}[code only] +\usepackage{pdfmarginpar} +\end{codeexample} +\noindent into your preable. Then, write |\pdfmarginpar|\marg{Annotation Contents} into your |.tex| file whereever you want annotations and translate the document with |pdflatex|. + +\begin{command}{\pdfmarginpar\oarg{Options}\marg{Annotation Contents}} + This command creates a text annotation with \marg{Annotation Contents}. A small mark will be placed just where the command occurs and a popup window appears after clicking on it. + +\lstinputlisting[ + backgroundcolor=\color{codebackground}, + columns=fullflexible, + emph={\pdfmarginpar},emphstyle={\color{yellow}}, + basicstyle=\normalfont\ttfamily\footnotesize\frenchspacing, + language=, +]{pdfmarginparexample.tex} + +\colorbox{graphicbackground}{\includegraphics[width=12cm]{pdfmarginparexample}} +\end{command} + +\subsection{Configuration options} +It is possible to customize annotation appearance either per annotation or once for all annotations. + +All options have a key prefix, |/pdfmarginpar/|. This prefix is optional (it has technical relevance when used with |\pgfkeys|) and can be ignored. + +\begin{command}{\pdfmarginparset\marg{Options}} + This command can be used to set options for all annotations (for example, in the document's preamble). +\begin{codeexample}[] +\pdfmarginparset{Open=true,color={[0.5 0.5 0.5]}} + +This is an example already opened annotations with gray color +\pdfmarginpar{This is an example already opened annotations with gray color.}. +\end{codeexample} + + It is \emph{not} necessary to prefix every option with |/pdfmarginpar/|, see above. +\end{command} + + +\begin{key}{/pdfmarginpar/Name=\mchoice{Comment,Key,Note,Help,NewParagraph,Paragraph,Insert} (initially Comment)} + Allows to choose a different type of annotation. +\begin{codeexample}[] +Comment Annotation\pdfmarginpar[Comment]{Comment}\end{codeexample} +\begin{codeexample}[] +Key Annotation\pdfmarginpar[Key]{Key}\end{codeexample} +\begin{codeexample}[] +Note Annotation\pdfmarginpar[Note]{Note}\end{codeexample} +\begin{codeexample}[] +Help Annotation\pdfmarginpar[Help]{Help}\end{codeexample} +\begin{codeexample}[] +NewParagraph +Annotation\pdfmarginpar[NewParagraph]{NewParagraph}\end{codeexample} +\begin{codeexample}[] +Paragraph +Annotation\pdfmarginpar[Paragraph]{Paragraph}\end{codeexample} +\begin{codeexample}[] +Insert Annotation\pdfmarginpar[Insert]{Insert}\end{codeexample} + +If |Name=| is omitted, the annotation is chosen directly -- and some more style options take place. For example, the |Comment| annotation will be raised somewhat and the |Insert| Annotation will be moved somewhat. Using |Name=Comment| will just select the |Comment| annotation without any further modifications. +\end{key} + +\begin{key}{/pdfmarginpar/Open=\mchoice{true,false} (initially false)} + Defines whether annotation popups shall be opened at start-up. +\end{key} + +\begin{keylist}{ + /pdfmarginpar/C=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 0 0]), + /pdfmarginpar/color=\oarg{\meta{R} \meta{G} \meta{B}} (initially [1 0 0])} + Defines the annotation's color with \meta{R},\meta{G},\meta{B}$ \in [0,1]$. +\end{keylist} + +\begin{keylist}{ + /pdfmarginpar/CA=\marg{opacity} (initially 0.5), + /pdfmarginpar/opacity=\marg{opacity} (initially 0.5)} + Sets the annotation's opacity as a number between $1$ (not transparent) and $0$ (transparent). +\end{keylist} + +\begin{keylist}{ + /pdfmarginpar/Subj=\marg{Subject} (initally Comment), + /pdfmarginpar/Subject=\marg{Subject} (initally Comment)} + Sets the annotations title line. +\end{keylist} + +\begin{key}{/pdfmarginpar/voffset=\marg{dimension}} + Specifies a vertical shift for the annotation. This parameter is set automatically if |Comment| instead of |Name=Comment| is specified. +\end{key} +\begin{key}{/pdfmarginpar/hoffset=\marg{dimension}} + Specifies a horizontal shift for the annotation. This parameter is set automatically if |Comment| instead of |Name=Comment| is specified. +\end{key} + +\begin{key}{/pdfmarginpar/Subtype=\marg{Type} (initially Text)} + This option is here for future developments. I intended only |Text| (although it should be possible to use any other supported |Subtype| as found in the pdf reference). +\end{key} + +\subsection{Implementation note} +All these variables boil down to the |pdflatex| primitive + +\noindent +|\pdfannot { | + + |/Subtype /|\meta{the Subtype} |/Open [|\mchoice{true,false}|]| + + |/Name /|\meta{the Type's Name} + + |/C |\meta{color} |/CA |\meta{the opacity} + + |/Subj (|\meta{the Subject}|)| |/Contents (|\meta{the Annotation's contents}|) }| + +\noindent +which results in a \pdf-object together with |/Rect [* * * *]| and |/Type /Annot|. + +\end{document} diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.pdf b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.pdf Binary files differnew file mode 100644 index 00000000000..a34328f162f --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.pdf diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.png b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.png Binary files differnew file mode 100644 index 00000000000..3bca8f43920 --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.png diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.tex b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.tex new file mode 100644 index 00000000000..0f8542b076c --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pdfmarginparexample.tex @@ -0,0 +1,72 @@ +\documentclass[a4paper]{article} + +% This paper (extract) has been generated by http://pdos.csail.mit.edu/scigen/ + +\usepackage{pdfmarginpar} \author{Max Mustermann} \title{Improving Telephony and the +Location-Identity Split} + +\begin{document} \maketitle + +\pdfmarginpar[Paragraph]{Insert Abstract here} \section{Introduction} + +The exploration of redundancy is a technical grand challenge. The effect on machine learning of this +result has been bad\pdfmarginpar{improve formulation}. To put this in perspective, consider the fact +that infamous statisticians often use Scheme to answer this quandary. The construction of local-area +networks would greatly degrade heterogeneous information. + +Virtual methodologies are particularly natural when it comes to embedded archetypes. +ClegTourn\pdfmarginpar[Help]{What's that for a name!?} evaluates online algorithms. This is crucial +to the success of our work. Contrarily, this approach is always considered private. In the opinion +of electrical engineers, though conventional wisdom states that this question is generally overcame +by the investigation of model checking, we believe that a different solution is necessary. Combined +with the simulation of thin clients, such a hypothesis explores new unstable algorithms. + +ClegTourn, our new algorithm for journaling file systems, is the solution to all of these +challenges. The basic tenet of this approach is the deployment of replication. Although conventional +wisdom states that this obstacle is usually answered by the visualization of the lookaside buffer, +we believe that a different approach is necessary. The basic tenet of this solution is the +improvement of multi-processors. We view steganography as following a cycle of four phases: +refinement, improvement, allowance, and management. + +In this paper we motivate the following contributions in detail. We verify not only that replication +can be made low-energy, concurrent, and peer-to-peer, but that the same is true for DNS. we +disconfirm that while the seminal probabilistic algorithm for the study of model checking by O. E. +Zheng runs in O(n2)\pdfmarginpar[Insert]{Math-Mode} time, the well-known classical algorithm for the +private unification of telephony and B-trees by Bose [34] is recursively enumerable. On a similar +note, we demonstrate not only that randomized algorithms can be made "fuzzy", decentralized, and +peer-to-peer, but that the same is true for local-area networks. Lastly, we use client-server +modalities to prove that the much-touted scalable algorithm for the analysis of architecture by A.J. +Perlis et al. is NP-complete [1,34,29]\pdfmarginpar{check references}. + +The rest of this paper is organized as follows. We motivate the need for spreadsheets. Further, to +fulfill this goal, we discover how systems can be applied to the unfortunate unification of 802.11 +mesh networks and massive multiplayer online role-playing games. Third, we argue the visualization +of evolutionary programming. Ultimately, we conclude. + +\section{Related Work} + +In this section, we consider alternative frameworks\pdfmarginpar[Key]{This is a key concept!} as +well as related work. The choice of linked lists in [19] differs from ours in that we visualize only +confusing technology in our system [36]. Jones proposed several efficient solutions, and reported +that they have great impact on multimodal models [30]. ClegTourn also evaluates Markov models, but +without all the unnecssary complexity. Despite the fact that we have nothing against the related +solution by Nehru et al., we do not believe that method is applicable to cryptoanalysis [32,5]. + +The original solution to this quandary by Sato and Bhabha [1] was promising; on the other hand, such +a hypothesis did not completely realize this objective [3,22,24,12,17,12,35]. However, the +complexity of their approach grows linearly as the improvement of telephony grows. Recent work by +Wilson [25] suggests a methodology for observing certifiable models, but does not offer an +implementation [31]. Next, Sasaki [31,26,15,28,20,24,24] and P. Wilson et al. introduced the first +known instance of wireless models [4].\pdfmarginpar[NewParagraph]{Insert a new paragraph?} Instead +of improving virtual technology [10], we realize this ambition simply by studying unstable +symmetries [29,33,13]. Ultimately, the methodology of A.J. Perlis is a key choice for Scheme +[20,14]. A comprehensive survey [9] is available in this space. + +We now compare our method to previous wearable technology approaches [6]. Similarly, a novel +approach for the analysis of the location-identity split [36] proposed by Zhao fails to address +several key issues that our methodology does address [7]. All of these methods conflict with our +assumption that random algorithms and the understanding of massive multiplayer online role-playing +games are essential [18,8]\pdfmarginpar[Note]{This should be discussed in more depth.}. + +\end{document} + diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pgfmanual-en-macros.tex b/Master/texmf-dist/doc/latex/pdfmarginpar/pgfmanual-en-macros.tex new file mode 100644 index 00000000000..e4efc70dcfa --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pgfmanual-en-macros.tex @@ -0,0 +1,943 @@ +% Copyright 2006 by Till Tantau +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% +% See the file doc/generic/pgf/licenses/LICENSE for more details. + +% $Header: /cvsroot/pgfplots/pgfplots/doc/latex/pgfplots/pgfmanual-en-macros.tex,v 1.1 2008/05/24 12:09:27 ludewich Exp $ + + +\providecommand\href[2]{\texttt{#1}} + + +\colorlet{examplefill}{yellow!80!black} +\definecolor{graphicbackground}{rgb}{0.96,0.96,0.8} +\definecolor{codebackground}{rgb}{0.8,0.8,1} + +\newenvironment{pgfmanualentry}{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}}{\endlist} +\newcommand\pgfmanualentryheadline[1]{\itemsep=0pt\parskip=0pt\item\strut{#1}\par\topsep=0pt} +\newcommand\pgfmanualbody{\parskip3pt} + + + +\newenvironment{pgflayout}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\texttt{\string\pgfpagesuselayout\char`\{\declare{#1}\char`\}}\oarg{options}} + \index{#1@\protect\texttt{#1} layout}% + \index{Page layouts!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{command}[1]{ + \begin{pgfmanualentry} + \extractcommand#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +%% MW: START MATH MACROS +\def\mvar#1{{\rmfamily\textit{#1}}} + +\makeatletter + +\def\extractmathfunctionname#1{\extractmathfunctionname@#1(,)\tmpa\tmpb} +\def\extractmathfunctionname@#1(#2)#3\tmpb{\def\mathname{#1}} + +\def\extractmathoperatorname{\begingroup\def\mvar##1{}\def\ {}\extractmathoperatorname@} +\def\extractmathoperatorname@#1{\xdef\mathname{#1}\endgroup} + +\makeatother + +\newenvironment{math-function}[1]{ + \begin{pgfmanualentry} + \extractmathfunctionname{#1} + \pgfmanualentryheadline{\texttt{#1}}% + \index{\mathname @\protect\texttt{\mathname} math function}% + \index{Math functions!\mathname @\protect\texttt{\mathname}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{math-operator}[1]{ + \begin{pgfmanualentry} + \extractmathoperatorname{#1} + \pgfmanualentryheadline{\texttt{#1}}% + \index{\mathname @\protect\texttt{\mathname} math operator}% + \index{Math operators!\mathname @\protect\texttt{\mathname}} + \pgfmanualbody +} +{% + \end{pgfmanualentry} +} + +\newenvironment{math-constant}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\texttt{#1}}% + \index{#1@\protect\texttt{#1} math constant}% + \index{Math constants!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\calcname{\textsc{calc}} +%% MW: END MATH MACROS + + +\def\extractcommand#1#2\@@{% + \pgfmanualentryheadline{\declare{\texttt{\string#1}}#2}% + \removeats{#1}% + \index{\strippedat @\protect\myprintocmmand{\strippedat}}} + + +% \begin{environment}{{name}\marg{arguments}} +\renewenvironment{environment}[1]{ + \begin{pgfmanualentry} + \extractenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractenvironement#1#2\@@{% + \pgfmanualentryheadline{{\ttfamily\char`\\begin\char`\{\declare{#1}\char`\}}#2}% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\char`\\end\char`\{\declare{#1}\char`\}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}}} + + +\newenvironment{plainenvironment}[1]{ + \begin{pgfmanualentry} + \extractplainenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractplainenvironement#1#2\@@{% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\#1}}#2}% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\end#1}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}}} + + +\newenvironment{contextenvironment}[1]{ + \begin{pgfmanualentry} + \extractcontextenvironement#1\@@ + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractcontextenvironement#1#2\@@{% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\start#1}}#2}% + \pgfmanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% + \pgfmanualentryheadline{{\ttfamily\declare{\char`\\stop#1}}}% + \index{#1@\protect\texttt{#1} environment}% + \index{Environments!#1@\protect\texttt{#1}}} + + +\newenvironment{shape}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{Shape {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} shape}% + \index{Shapes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{handler}[1]{ + \begin{pgfmanualentry} + \extracthandler#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\gobble#1{} +\def\extracthandler#1#2\@nil{% + \pgfmanualentryheadline{Key handler \meta{key}{\ttfamily/\declare{#1}}#2}% + \index{\gobble#1@\protect\texttt{#1} handler}% + \index{Key handlers!#1@\protect\texttt{#1}} +} + + +\makeatletter + + +\newenvironment{stylekey}[1]{ + \begin{pgfmanualentry} + \def\extrakeytext{style, } + \extractkey#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +% \begin{key}{/path/x=value} +% \begin{key}{/path/x=value (initially XXX)} +% \begin{key}{/path/x=value (default XXX)} +\newenvironment{key}[1]{ + \begin{pgfmanualentry} + \def\extrakeytext{} + %\def\altpath{\emph{\color{gray}or}}% + \extractkey#1\@nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\extractkey#1\@nil{% + \pgfutil@in@={#1}% + \ifpgfutil@in@% + \extractkeyequal#1\@nil + \else% + \pgfutil@in@{(initial}{#1}% + \ifpgfutil@in@% + \extractequalinitial#1\@nil% + \else + \pgfmanualentryheadline{{\ttfamily\declare{#1}}\hfill(\extrakeytext no value)}% + \def\mykey{#1}% + \def\mypath{}% + \def\myname{}% + \firsttimetrue% + \decompose#1/\nil% + \fi + \fi% +} + +\def\extractkeyequal#1=#2\@nil{% + \pgfutil@in@{(default}{#2}% + \ifpgfutil@in@% + \extractdefault{#1}#2\@nil% + \else% + \pgfutil@in@{(initial}{#2}% + \ifpgfutil@in@% + \extractinitial{#1}#2\@nil% + \else + \pgfmanualentryheadline{{\ttfamily\declare{#1}=}#2\hfill(\extrakeytext no default)}% + \fi% + \fi% + \def\mykey{#1}% + \def\mypath{}% + \def\myname{}% + \firsttimetrue% + \decompose#1/\nil% +} + +\def\extractdefault#1#2(default #3)\@nil{% + \pgfmanualentryheadline{{\ttfamily\declare{#1}\opt{=}}\opt{#2}\hfill (\extrakeytext default {\ttfamily#3})}% +} + +\def\extractinitial#1#2(initially #3)\@nil{% + \pgfmanualentryheadline{{\ttfamily\declare{#1}=}#2\hfill (\extrakeytext no default, initially {\ttfamily#3})}% +} + +\def\extractequalinitial#1 (initially #2)\@nil{% + \pgfmanualentryheadline{{\ttfamily\declare{#1}}\hfill (\extrakeytext initially {\ttfamily#2})}% + \def\mykey{#1}% + \def\mypath{}% + \def\myname{}% + \firsttimetrue% + \decompose#1/\nil% +} + +% Introduces a key alias '/#1/<name of current key>' +% to be used inside of \begin{key} ... \end{key} +\def\keyalias#1{\vspace{-3pt}\item{\small alias {\ttfamily/#1/\myname}}\vspace{-2pt}\par} + +\newif\iffirsttime + +\makeatother + +\def\decompose/#1/#2\nil{% + \def\test{#2}% + \ifx\test\empty% + % aha. + \index{#1@\protect\texttt{#1} key}% + \index{\mypath#1@\protect\texttt{#1}}% + \def\myname{#1}% + \else% + \iffirsttime + \def\mypath{#1@\protect\texttt{/#1/}!}% + \firsttimefalse + \else + \expandafter\def\expandafter\mypath\expandafter{\mypath#1@\protect\texttt{#1/}!}% + \fi + \def\firsttime{} + \decompose/#2\nil% + \fi% +} + +\newenvironment{predefinedmethod}[1]{ + \begin{pgfmanualentry} + \extractpredefinedmethod#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractpredefinedmethod#1(#2)\@nil{% + \pgfmanualentryheadline{Method \declare{\ttfamily #1}\texttt(#2\texttt) \hfill(predefined for all classes)} + \index{#1@\protect\texttt{#1} method}% + \index{Methods!#1@\protect\texttt{#1}} +} + + +\newenvironment{ooclass}[1]{ + \begin{pgfmanualentry} + \def\currentclass{#1} + \pgfmanualentryheadline{Class \declare{\texttt{#1}}} + \index{#1@\protect\texttt{#1} class}% + \index{Class #1@Class \protect\texttt{#1}}% + \index{Classes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{method}[1]{ + \begin{pgfmanualentry} + \extractmethod#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractmethod#1(#2)\@nil{% + \def\test{#1} + \ifx\test\currentclass + \pgfmanualentryheadline{Constructor \declare{\ttfamily #1}\texttt(#2\texttt)} + \else + \pgfmanualentryheadline{Method \declare{\ttfamily #1}\texttt(#2\texttt)} + \fi + \index{#1@\protect\texttt{#1} method}% + \index{Methods!#1@\protect\texttt{#1}} + \index{Class \currentclass!#1@\protect\texttt{#1}}% +} + +\newenvironment{attribute}[1]{ + \begin{pgfmanualentry} + \extractattribute#1\@nil + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\def\extractattribute#1=#2;\@nil{% + \def\test{#2}% + \ifx\test\@empty + \pgfmanualentryheadline{Private attribute \declare{\ttfamily #1} \hfill (initially empty)} + \else + \pgfmanualentryheadline{Private attribute \declare{\ttfamily #1} \hfill (initially {\ttfamily #2})} + \fi + \index{#1@\protect\texttt{#1} attribute}% + \index{Attributes!#1@\protect\texttt{#1}} + \index{Class \currentclass!#1@\protect\texttt{#1}}% +} + + + +\newenvironment{predefinednode}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{Predefined node {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} node}% + \index{Predefined node!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{coordinatesystem}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{Coordinate system {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} coordinate system}% + \index{Coordinate systems!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{snake}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{Snake {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} snake}% + \index{Snakes!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{decoration}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{Decoration {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} decoration}% + \index{Decorations!#1@\protect\texttt{#1}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\def\pgfmanualbar{\char`\|} +\makeatletter +\newenvironment{pathoperation}[3][]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textcolor{gray}{{\ttfamily\char`\\path}\ + \ \dots} + \declare{\texttt{#2}}#3\ \textcolor{gray}{\dots\texttt{;}}}% + \def\pgfmanualtest{#1}% + \ifx\pgfmanualtest\@empty% + \index{#2@\protect\texttt{#2} path operation}% + \index{Path operations!#2@\protect\texttt{#2}}% + \fi% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\makeatother + +\def\extractcommand#1#2\@@{% + \pgfmanualentryheadline{\declare{\texttt{\string#1}}#2}% + \removeats{#1}% + \index{\strippedat @\protect\myprintocmmand{\strippedat}}} + +\def\doublebs{\texttt{\char`\\\char`\\}} + + +\newenvironment{package}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usepackage\char`\{\declare{#1}\char`\}\space\space \char`\%\space\space \LaTeX}} + \index{#1@\protect\texttt{#1} package}% + \index{Packages and files!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\input \declare{#1}.tex\space\space\space \char`\%\space\space plain \TeX}} + \pgfmanualentryheadline{{\ttfamily\char`\\usemodule[\declare{#1}]\space\space \char`\%\space\space Con\TeX t}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{pgfmodule}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usepgfmodule\char`\{\declare{#1}\char`\}\space\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space and pure pgf}} + \index{#1@\protect\texttt{#1} module}% + \index{Modules!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\usepgfmodule[\declare{#1}]\space\space \char`\%\space\space Con\TeX t\space and pure pgf}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{pgflibrary}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usepgflibrary\char`\{\declare{#1}\char`\}\space\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space and pure pgf}} + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\usepgflibrary[\declare{#1}]\space\space \char`\%\space\space Con\TeX t\space and pure pgf}} + \pgfmanualentryheadline{{\ttfamily\char`\\usetikzlibrary\char`\{\declare{#1}\char`\}\space\space + \char`\%\space\space \LaTeX\space and plain \TeX\space when using \tikzname}} + \pgfmanualentryheadline{{\ttfamily\char`\\usetikzlibrary[\declare{#1}]\space + \char`\%\space\space Con\TeX t\space when using \tikzname}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{tikzlibrary}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usetikzlibrary\char`\{\declare{#1}\char`\}\space\space \char`\%\space\space \LaTeX\space and plain \TeX}} + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% + \pgfmanualentryheadline{{\ttfamily\char`\\usetikzlibrary[\declare{#1}]\space \char`\%\space\space Con\TeX t}} + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + + +\newenvironment{filedescription}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{File {\ttfamily\declare{#1}}}% + \index{#1@\protect\texttt{#1} file}% + \index{Packages and files!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\newenvironment{packageoption}[1]{ + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\char`\\usepackage[\declare{#1}]\char`\{pgf\char`\}}} + \index{#1@\protect\texttt{#1} package option}% + \index{Package options for \textsc{pgf}!#1@\protect\texttt{#1}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + + +\newcommand\opt[1]{{\color{black!50!green}#1}} +\newcommand\ooarg[1]{{\ttfamily[}\meta{#1}{\ttfamily]}} + +\def\opt{\afterassignment\pgfmanualopt\let\next=} +\def\pgfmanualopt{\ifx\next\bgroup\bgroup\color{black!50!green}\else{\color{black!50!green}\next}\fi} + + + +\def\beamer{\textsc{beamer}} +\def\pdf{\textsc{pdf}} +\def\pgfname{\textsc{pgf}} +\def\tikzname{Ti\emph{k}Z} +\def\pstricks{\textsc{pstricks}} +\def\prosper{\textsc{prosper}} +\def\seminar{\textsc{seminar}} +\def\texpower{\textsc{texpower}} +\def\foils{\textsc{foils}} + +{ + \makeatletter + \global\let\myempty=\@empty + \global\let\mygobble=\@gobble + \catcode`\@=12 + \gdef\getridofats#1@#2\relax{% + \def\getridtest{#2}% + \ifx\getridtest\myempty% + \expandafter\def\expandafter\strippedat\expandafter{\strippedat#1} + \else% + \expandafter\def\expandafter\strippedat\expandafter{\strippedat#1\protect\printanat} + \getridofats#2\relax% + \fi% + } + + \gdef\removeats#1{% + \let\strippedat\myempty% + \edef\strippedtext{\stripcommand#1}% + \expandafter\getridofats\strippedtext @\relax% + } + + \gdef\stripcommand#1{\expandafter\mygobble\string#1} +} + +\def\printanat{\char`\@} + +\def\declare{\afterassignment\pgfmanualdeclare\let\next=} +\def\pgfmanualdeclare{\ifx\next\bgroup\bgroup\color{red!75!black}\else{\color{red!75!black}\next}\fi} + + +\let\textoken=\command +\let\endtextoken=\endcommand + +\def\myprintocmmand#1{\texttt{\char`\\#1}} + +\def\example{\par\smallskip\noindent\textit{Example: }} +\def\themeauthor{\par\smallskip\noindent\textit{Theme author: }} + + +\def\indexoption#1{% + \index{#1@\protect\texttt{#1} option}% + \index{Graphic options and styles!#1@\protect\texttt{#1}}% +} + +\def\itemcalendaroption#1{\item \declare{\texttt{#1}}% + \index{#1@\protect\texttt{#1} date test}% + \index{Date tests!#1@\protect\texttt{#1}}% +} + + + +\def\class#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% +\extractclass#1@\par\topsep=0pt} +\def\endclass{\endlist} +\def\extractclass#1#2@{% +\item{{{\ttfamily\char`\\documentclass}#2{\ttfamily\char`\{\declare{#1}\char`\}}}}% + \index{#1@\protect\texttt{#1} class}% + \index{Classes!#1@\protect\texttt{#1}}} + +\def\partname{Part} + +\makeatletter +\def\index@prologue{\section*{Index}\addcontentsline{toc}{section}{Index} + This index only contains automatically generated entries. A good + index should also contain carefully selected keywords. This index is + not a good index. + \bigskip +} +\c@IndexColumns=2 + \def\theindex{\@restonecoltrue + \columnseprule \z@ \columnsep 29\p@ + \twocolumn[\index@prologue]% + \parindent -30pt + \columnsep 15pt + \parskip 0pt plus 1pt + \leftskip 30pt + \rightskip 0pt plus 2cm + \small + \def\@idxitem{\par}% + \let\item\@idxitem \ignorespaces} + \def\endtheindex{\onecolumn} +\def\noindexing{\let\index=\@gobble} + + + +\newcommand\symarrow[1]{ + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}} + \texttt{#1}& yields thick + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} +\newcommand\symarrowdouble[1]{ + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}} + \texttt{#1}& yields thick + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} + and thin + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture}, double + \begin{tikzpicture}[arrows={#1-#1},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and + \begin{tikzpicture}[arrows={#1-#1},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\sarrow[2]{ + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}} + \index{#2@\protect\texttt{#2} arrow tip}% + \index{Arrow tips!#2@\protect\texttt{#2}} + \texttt{#1-#2}& yields thick + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\sarrowdouble[2]{ + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}} + \index{#2@\protect\texttt{#2} arrow tip}% + \index{Arrow tips!#2@\protect\texttt{#2}} + \texttt{#1-#2}& yields thick + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and thin + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture}, double + \begin{tikzpicture}[arrows={#1-#2},thick,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} and + \begin{tikzpicture}[arrows={#1-#2},thin,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1cm,2ex); + \draw[double,double equal sign distance] (0pt,.5ex) -- (1cm,.5ex); + \end{tikzpicture} +} + +\newcommand\carrow[1]{ + \index{#1@\protect\texttt{#1} arrow tip}% + \index{Arrow tips!#1@\protect\texttt{#1}} + \texttt{#1}& yields for line width 1ex + \begin{tikzpicture}[arrows={#1-#1},line width=1ex,baseline] + \useasboundingbox (0pt,-0.5ex) rectangle (1.5cm,2ex); + \draw (0pt,.5ex) -- (1.5cm,.5ex); + \end{tikzpicture} +} +\def\myvbar{\char`\|} +\newcommand\plotmarkentry[1]{% + \index{#1@\protect\texttt{#1} plot mark}% + \index{Plot marks!#1@\protect\texttt{#1}} + \texttt{\char`\\pgfuseplotmark\char`\{\declare{#1}\char`\}} & + \tikz\draw[color=black!25] plot[mark=#1,mark options={fill=examplefill,draw=black}] coordinates{(0,0) (.5,0.2) (1,0) (1.5,0.2)};\\ +} +\newcommand\plotmarkentrytikz[1]{% + \index{#1@\protect\texttt{#1} plot mark}% + \index{Plot marks!#1@\protect\texttt{#1}} + \texttt{mark=\declare{#1}} & \tikz\draw[color=black!25] + plot[mark=#1,mark options={fill=examplefill,draw=black}] + coordinates {(0,0) (.5,0.2) (1,0) (1.5,0.2)};\\ +} + + + +\ifx\scantokens\@undefined + \PackageError{pgfmanual-macros}{You need to use extended latex + (elatex) or (pdfelatex) to process this document}{} +\fi + +% Define \find@example such that it doesn't destroy catcodes: +\begingroup +\catcode`|=0 +\catcode`[= 1 +\catcode`]=2 +\catcode`\{=12 +\catcode `\}=12 +\catcode`\\=12 |gdef|find@example#1\end{codeexample}[|endofcodeexample[#1]] +|endgroup + +% define \returntospace. +% +% It should define NEWLINE as {}, spaces and tabs as \space. +\begingroup +\catcode`\^=7 +\catcode`\^^M=13 +\catcode`\^^I=13 +\catcode`\ =13% +\gdef\returntospace{\catcode`\ =13\def {\space}\catcode`\^^I=13\def^^I{\space}\catcode`\^^M=13\def^^M{}}% +\endgroup + +\begingroup +\catcode`\%=13 +\catcode`\^^M=13 +\gdef\commenthandler{\catcode`\%=13\def%{\@gobble@till@return}} +\gdef\@gobble@till@return#1^^M{} +\gdef\@gobble@till@return@ignore#1^^M{\ignorespaces} +\gdef\typesetcomment{\catcode`\%=13\def%{\@typeset@till@return}} +\gdef\@typeset@till@return#1^^M{{\def%{\char`\%}\textsl{\char`\%#1}}\par} +\endgroup + +% Define tab-implementation functions +% \codeexample@tabinit@replacementchars@ +% and +% \codeexample@tabinit@catcode@ +% +% They should ONLY be used in case that tab replacement is active. +% +% This here is merely a preparation step. +% +% Idea: +% \codeexample@tabinit@catcode@ will make TAB active +% and +% \codeexample@tabinit@replacementchars@ will insert as many spaces as +% /codeexample/tabsize contains. +{ +\catcode`\^^I=13 +% ATTENTION: do NOT use tabs in these definitions!! +\gdef\codeexample@tabinit@replacementchars@{% + \begingroup + \count0=\pgfkeysvalueof{/codeexample/tabsize}\relax + \toks0={}% + \loop + \ifnum\count0>0 + \advance\count0 by-1 + \toks0=\expandafter{\the\toks0\ }% + \repeat + \xdef\codeexample@tabinit@replacementchars@@{\the\toks0}% + \endgroup + \let^^I=\codeexample@tabinit@replacementchars@@ +}% +\gdef\codeexample@tabinit@catcode@{\catcode`\^^I=13}% +}% + +% Called after any options have been set. It assigns +% \codeexample@tabinit@catcode +% and +% \codeexample@tabinit@replacementchars +% which are used inside of +%\begin{codeexample} +% ... +%\end{codeexample} +% +% \codeexample@tabinit@catcode is either \relax or it makes tab +% active. +% +% \codeexample@tabinit@replacementchars is either \relax or it inserts +% a proper replacement sequence for tabs (as many spaces as +% configured) +\def\codeexample@tabinit{% + \ifnum\pgfkeysvalueof{/codeexample/tabsize}=0\relax + \let\codeexample@tabinit@replacementchars=\relax + \let\codeexample@tabinit@catcode=\relax + \else + \let\codeexample@tabinit@catcode=\codeexample@tabinit@catcode@ + \let\codeexample@tabinit@replacementchars=\codeexample@tabinit@replacementchars@ + \fi +} + +\pgfqkeys{/codeexample}{% + width/.code= {\setlength\codeexamplewidth{#1}}, + graphic/.code= {\colorlet{graphicbackground}{#1}}, + code/.code= {\colorlet{codebackground}{#1}}, + execute code/.is if=code@execute, + code only/.code= {\code@executefalse}, + pre/.code= {\def\code@pre{#1}}, + post/.code= {\def\code@post{#1}}, + vbox/.code= {\def\code@pre{\vbox\bgroup\setlength{\hsize}{\linewidth-6pt}}\def\code@post{\egroup}}, + ignorespaces/.code= {\let\@gobble@till@return=\@gobble@till@return@ignore}, + leave comments/.code= {\def\code@catcode@hook{\catcode`\%=12}\let\commenthandler=\relax\let\typesetcomment=\relax}, + tabsize/.initial=0, + every codeexample/.style={width=4cm+7pt}, +} + +\def\code@pre{} +\def\code@post{} +\def\code@catcode@hook{} + +\newdimen\codeexamplewidth +\newif\ifcode@execute +\newbox\codeexamplebox +\def\codeexample[#1]{% + \begingroup% + \code@executetrue + \pgfqkeys{/codeexample}{every codeexample,#1}% + \codeexample@tabinit% assigns \codeexample@tabinit@[catcode,replacementchars] + \parindent0pt + \begingroup% + \par% + \medskip% + \let\do\@makeother% + \dospecials% + \obeylines% + \@vobeyspaces% + \catcode`\%=13% + \catcode`\^^M=13% + \code@catcode@hook% + \codeexample@tabinit@catcode + \relax% + \find@example} +\def\endofcodeexample#1{% + \endgroup% + \ifcode@execute% + \setbox\codeexamplebox=\hbox{% + {% + {% + \returntospace% + \commenthandler% + \xdef\code@temp{#1}% removes returns and comments + }% + \colorbox{graphicbackground}{\color{black}\ignorespaces% + \code@pre\expandafter\scantokens\expandafter{\code@temp\ignorespaces}\code@post\ignorespaces}% + }% + }% + \ifdim\wd\codeexamplebox>\codeexamplewidth% + \def\code@start{\par}% + \def\code@flushstart{}\def\code@flushend{}% + \def\code@mid{\parskip2pt\par\noindent}% + \def\code@width{\linewidth-6pt}% + \def\code@end{}% + \else% + \def\code@start{% + \linewidth=\textwidth% + \parshape \@ne 0pt \linewidth + \leavevmode% + \hbox\bgroup}% + \def\code@flushstart{\hfill}% + \def\code@flushend{\hbox{}}% + \def\code@mid{\hskip6pt}% + \def\code@width{\linewidth-12pt-\codeexamplewidth}% + \def\code@end{\egroup}% + \fi% + \code@start% + \noindent% + \begin{minipage}[t]{\codeexamplewidth}\raggedright + \hrule width0pt% + \footnotesize\vskip-1em% + \code@flushstart\box\codeexamplebox\code@flushend% + \vskip-1ex + \leavevmode% + \end{minipage}% + \else% + \def\code@mid{\par} + \def\code@width{\linewidth-6pt} + \def\code@end{} + \fi% + \code@mid% + \colorbox{codebackground}{% + \begin{minipage}[t]{\code@width}% + {% + \let\do\@makeother + \dospecials + \frenchspacing\@vobeyspaces + \normalfont\ttfamily\footnotesize + \typesetcomment% + \codeexample@tabinit@replacementchars + \@tempswafalse + \def\par{% + \if@tempswa + \leavevmode \null \@@par\penalty\interlinepenalty + \else + \@tempswatrue + \ifhmode\@@par\penalty\interlinepenalty\fi + \fi}% + \obeylines + \everypar \expandafter{\the\everypar \unpenalty}% + #1} + \end{minipage}}% + \code@end% + \par% + \medskip + \end{codeexample} +} + +\def\endcodeexample{\endgroup} + + +\makeatother + + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "beameruserguide" +%%% End: diff --git a/Master/texmf-dist/doc/latex/pdfmarginpar/pgfplots-macros.tex b/Master/texmf-dist/doc/latex/pdfmarginpar/pgfplots-macros.tex new file mode 100644 index 00000000000..fbb96fa537d --- /dev/null +++ b/Master/texmf-dist/doc/latex/pdfmarginpar/pgfplots-macros.tex @@ -0,0 +1,390 @@ + +\def\eps{\textsc{eps}} + +\input pgfmanual-en-macros.tex + +\def\pgfmanualbar{\char`\|} +\makeatletter +\newenvironment{addplotoperation}[3][]{ + \begin{pgfmanualentry} + {% + \let\ltxdoc@marg=\marg + \let\ltxdoc@oarg=\oarg + \let\ltxdoc@parg=\parg + \let\ltxdoc@meta=\meta + \def\marg##1{{\normalfont\ltxdoc@marg{##1}}}% + \def\oarg##1{{\normalfont\ltxdoc@oarg{##1}}}% + \def\parg##1{{\normalfont\ltxdoc@parg{##1}}}% + \def\meta##1{{\normalfont\ltxdoc@meta{##1}}}% + \pgfmanualentryheadline{\textcolor{gray}{{\ttfamily\char`\\addplot\ }}% + \declare{\texttt{#2}} \texttt{#3;}}% + \unskip + \nobreak + \pgfmanualentryheadline{\textcolor{gray}{{\texttt{\char`\\addplot}\oarg{style options} \texttt{plot}\oarg{behavior options}}\ }% + \declare{\texttt{#2}} \texttt{#3} \textcolor{gray}{\meta{trailing path commands}}\texttt{;}}% + \def\pgfmanualtest{#1}% + \ifx\pgfmanualtest\@empty% + \index{#2@\protect\textcolor{gray}{\protect\texttt{plot}}\protect\texttt{ #2}}% + \index{Plot operations!plot #2@\protect\texttt{plot #2}}% + \fi% + }% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{codekey}[1]{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\declare{#1}\textcolor{gray}{/.code}=\marg{...}}\hfill}% + \def\mykey{#1}% + \def\mypath{}% + \def\myname{}% + \firsttimetrue% + \decompose#1/\nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{pgfplotscodekey}[1]{% + \begin{codekey}{/pgfplots/#1}% +} +{ + \end{codekey} +} +\newenvironment{pgfplotscodetwokey}[1]{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\declare{/pgfplots/#1}\textcolor{gray}{/.code 2 args}=\marg{...}}\hfill}% + \def\mykey{/pgfplots/#1}% + \def\mypath{}% + \def\myname{}% + \firsttimetrue% + \decompose/pgfplots/#1/\nil% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\newenvironment{pgfplotsxycodekeylist}[1]{% + \begingroup + \let\oldpgfmanualentryheadline=\pgfmanualentryheadline + \def\pgfmanualentryheadline##1{% + \pgfmanualentryheadline@##1\pgfplots@EOI + }% + \def\pgfmanualentryheadline@##1\hfill##2\pgfplots@EOI{% + \oldpgfmanualentryheadline{{\ttfamily\declare{##1}\textcolor{gray}{/.code}=\marg{...}}\hfill}% + } + \begin{pgfplotsxykeylist}{#1}% +} +{ + \end{pgfplotsxykeylist} + \endgroup +} + +\newenvironment{pgfplotskey}[1]{% + \begin{key}{/pgfplots/#1}% +} +{ + \end{key} +} + +\def\choicesep{$\vert$}% +\def\choicearg#1{\texttt{#1}} + +\newif\iffirstchoice +\newcommand\mchoice[1]{% + \begingroup + \firstchoicetrue + \foreach \mchoice@ in {#1} {% + \iffirstchoice + \global\firstchoicefalse + \else + \choicesep + \fi + \choicearg{\mchoice@}% + }% + \endgroup +}% + +% \begin{xykey}{/path/\x label=value} +% \end{xykey} +% +% has same features with 'default', 'initially' etc as key environment +\newenvironment{xykey}[2][]{% + \begin{pgfmanualentry} + \def\extrakeytext{} + \insertpathifneeded{#2}{#1}% + \expandafter\pgfutil@in@\expandafter=\expandafter{\mykey}% + \ifpgfutil@in@% + \expandafter\xykey@eq\mykey\@nil + \else + \expandafter\xykey@noeq\mykey\@nil + \fi + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +% \begin{xystylekey}{/path/\x label=value} +% \end{xystylekey} +% +% has same features with 'default', 'initially' etc as key environment +\newenvironment{xystylekey}[2][]{% + \begin{pgfmanualentry} + \def\extrakeytext{style, } + \insertpathifneeded{#2}{#1}% + \expandafter\pgfutil@in@\expandafter=\expandafter{\mykey}% + \ifpgfutil@in@% + \expandafter\xykey@eq\mykey\@nil + \else + \expandafter\xykey@noeq\mykey\@nil + \fi + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +% \insertpathifneeded{a key}{/pgfplots} -> assign mykey={/pgfplots/a key} +% \insertpathifneeded{/tikz/a key}{/pgfplots} -> assign mykey={/tikz/a key} +% +% #1: the key +% #2: a default path (or empty) +\def\insertpathifneeded#1#2{% + \def\insertpathifneeded@@{#2}% + \ifx\insertpathifneeded@@\empty + \def\mykey{#1}% + \else + \insertpathifneeded@#2\@nil + \ifpgfutil@in@ + \def\mykey{#2/#1}% + \else + \def\mykey{#1}% + \fi + \fi +}% +\def\insertpathifneeded@#1#2\@nil{% + \def\insertpathifneeded@@{#1}% + \def\insertpathifneeded@@@{/}% + \ifx\insertpathifneeded@@\insertpathifneeded@@@ + \pgfutil@in@true + \else + \pgfutil@in@false + \fi +}% + +% \begin{keylist}[default path] +% {/path/option 1=value,/path/option 2=value2} +% \end{keylist} +\newenvironment{keylist}[2][]{% + \begin{pgfmanualentry} + \def\extrakeytext{}% + \foreach \xx in {#2} {% + \expandafter\insertpathifneeded\expandafter{\xx}{#1}% + \expandafter\extractkey\mykey\@nil% + }% + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +\newenvironment{pgfplotskeylist}[1]{% + \begin{keylist}[/pgfplots]{#1}% +}{% + \end{keylist}% +} + +% \begin{xykeylist}[default path] +% {/path/option \x1=value,/path/option \x2=value2,/path/option \x3=value} +% \end{xykeylist} +\newenvironment{xykeylist}[2][]{% + \begin{pgfmanualentry} + \def\extrakeytext{} + \foreach \xx in {#2} {% + \expandafter\insertpathifneeded\expandafter{\xx}{#1}% + \expandafter\pgfutil@in@\expandafter=\expandafter{\mykey}% + \ifpgfutil@in@% + \expandafter\xykey@eq\mykey\@nil + \else + \expandafter\xykey@noeq\mykey\@nil + \fi + }% + \pgfmanualbody +}{% + \end{pgfmanualentry} +}% + +\newif\ifxykeyfound + +\def\xykey@eq#1=#2\@nil{% + \def\x{x}% + \xdef\mykey{#1}% + \def\xykey@@{#1}% + \ifx\xykey@@\mykey + \xykeyfoundfalse + \else + \xykeyfoundtrue + \fi + \expandafter\extractkey\mykey=#2\@nil% + \ifxykeyfound + \def\x{y}% + \xdef\mykey{#1}% + \expandafter\extractkey\mykey=#2\@nil% + \fi +} +\def\xykey@noeq#1\@nil{% + \def\x{x}% + \xdef\mykey{#1}% + \def\xykey@@{#1}% + \ifx\xykey@@\mykey + \xykeyfoundfalse + \else + \xykeyfoundtrue + \fi + \expandafter\extractkey\mykey\@nil% + \ifxykeyfound + \def\x{y}% + \xdef\mykey{#1}% + \expandafter\extractkey\mykey\@nil% + \fi +} + +% \begin{pgfplotsxykey}{\x label=value} +% \end{pgfplotsxykey} +% +% It introduces the path /pgfplots/ automatically. +% +% has same features with 'default', 'initially' etc as key environment +\newenvironment{pgfplotsxykey}[1]{% + \begin{xykey}[/pgfplots]{#1}% +}{% + \end{xykey}% +} + + +\newenvironment{pgfplotsxykeylist}[1]{% + \begin{xykeylist}[/pgfplots]{#1}% +}{% + \end{xykeylist}% +} + + +\newenvironment{plottype}[1]{% + \begin{key}{/tikz/#1}% + \end{key} + \begin{pgfmanualentry} + \pgfmanualentryheadline{\textcolor{gray}{{\ttfamily\char`\\addplot+[\declare{#1}]}}}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + +\def\index@prologue{\section*{Index}\addcontentsline{toc}{section}{Index} +} + +\newenvironment{pgfplotstablecolumnkey}{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\textcolor{gray}{/pgfplots/table/}\declare{columns/\meta{column name}}\textcolor{gray}{/.style}=\marg{key-value-list}}\hfill}% + \pgfplotsmanualkeyindex{/pgfplots/table/columns}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\newenvironment{pgfplotstabledisplaycolumnkey}{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\textcolor{gray}{/pgfplots/table/}\declare{display columns/\meta{index}}\textcolor{gray}{/.style}=\marg{key-value-list}}\hfill}% + \pgfplotsmanualkeyindex{/pgfplots/table/display columns}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\newenvironment{pgfplotstablealiaskey}{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\textcolor{gray}{/pgfplots/table/}\declare{alias/\meta{col name}}\textcolor{gray}{/.initial}=\marg{real col name}}\hfill}% + \pgfplotsmanualkeyindex{/pgfplots/table/alias}% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} + + +\def\pgfplotsmanualkeyindex#1{% + \def\mypath{#1}% + \def\myname{}% + \firsttimetrue% + \decompose#1/\nil% +} +\newenvironment{pgfplotstablecreateonusekey}{% + \begin{pgfmanualentry} + \pgfmanualentryheadline{{\ttfamily\textcolor{gray}{/pgfplots/table/}\declare{create on use/\meta{col name}}\textcolor{gray}{/.style}=\marg{create options}}\hfill}% + \def\mykey{/pgfplots/table/create on use}% + \pgfmanualbody + \pgfplotsmanualkeyindex{/pgfplots/table/create on use}% +} +{ + \end{pgfmanualentry} +} + +\def\pgfplotsassertcmdkeyexists#1{% + \pgfkeysifdefined{/pgfplots/#1/.@cmd}\relax{% + \pgfplots@error{DOCUMENTATION ERROR: command key /pgfplots/#1 does not exist!}% + }% +}% + +{ +\catcode`\ =12% +\gdef\makespaceexpandable{\def\ { }}}% + +\def\pgfplotsassertXYcmdkeyexists#1{% + {\makespaceexpandable\def\x{x}\edef\pgfplotsassertXYcmdkeyexists@tmp{#1}% + \pgfkeysifdefined{/pgfplots/\pgfplotsassertXYcmdkeyexists@tmp/.@cmd}\relax{% + \pgfplots@error{DOCUMENTATION ERROR: command key /pgfplots/#1 does not exist!}% + }}% + {\makespaceexpandable\def\x{y}\edef\pgfplotsassertXYcmdkeyexists@tmp{#1}% + \pgfkeysifdefined{/pgfplots/\pgfplotsassertXYcmdkeyexists@tmp/.@cmd}\relax{% + \pgfplots@error{DOCUMENTATION ERROR: command key /pgfplots/#1 does not exist!}% + }}% +}% + +\def\pgfplotsshortstylekey #1=#2;{% + \pgfplotsassertcmdkeyexists{#1}% + \pgfplotsassertcmdkeyexists{#2}% + \begin{pgfplotskey}{#1=\marg{key-value-list}} + An abbreviation for \texttt{#2/.append style=}\marg{key-value-list}. + \end{pgfplotskey} +} +\def\pgfplotsshortxystylekey #1=#2;{% + \pgfplotsassertXYcmdkeyexists{#1}% + \pgfplotsassertXYcmdkeyexists{#2}% + \begin{pgfplotsxykey}{#1=\marg{key-value-list}} + An abbreviation for {\def\x{x}\texttt{#2/.append style=}}\marg{key-value-list} (or the respective style for $y$, {\def\x{y}\texttt{#2}}). + \end{pgfplotsxykey} +} +\def\pgfplotsshortstylekeys #1,#2=#3;{% + \pgfplotsassertcmdkeyexists{#1}% + \pgfplotsassertcmdkeyexists{#2}% + \pgfplotsassertcmdkeyexists{#3}% + \begin{pgfplotskeylist}{% + #1=\marg{key-value-list}, + #2=\marg{key-value-list}} + Different abbreviations for \texttt{#3/.append style=}\marg{key-value-list}. + \end{pgfplotskeylist} +} +\def\pgfplotsshortxystylekeys #1,#2=#3;{% + \pgfplotsassertXYcmdkeyexists{#1}% + \pgfplotsassertXYcmdkeyexists{#2}% + \pgfplotsassertXYcmdkeyexists{#3}% + \begin{pgfplotsxykeylist}{% + #1=\marg{key-value-list}, + #2=\marg{key-value-list}} + Different abbreviations for {\def\x{x}\texttt{#3/.append style=}}\marg{key-value-list} (or the respective style for $y$, {\def\x{y}\texttt{#3}}). + \end{pgfplotsxykeylist} +} + +\makeatother |
