diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/mfpic/mfpman.tex')
-rw-r--r-- | Master/texmf-dist/doc/generic/mfpic/mfpman.tex | 6648 |
1 files changed, 4210 insertions, 2438 deletions
diff --git a/Master/texmf-dist/doc/generic/mfpic/mfpman.tex b/Master/texmf-dist/doc/generic/mfpic/mfpman.tex index 7f93ed20e27..5a0e1955663 100644 --- a/Master/texmf-dist/doc/generic/mfpic/mfpman.tex +++ b/Master/texmf-dist/doc/generic/mfpic/mfpman.tex @@ -1,28 +1,45 @@ %%% File: mfpman.tex -%%% A part of mfpic 0.7a beta 2004/04/16 +%%% A part of mfpic 0.9 2006/05/26 %%% % Documentation of mfpic macros \documentclass[letterpaper]{article} -\usepackage{pslatex} +% Fonts: TimesRoman, CM Sans serif, and LuxiMono for TeX commands. +\usepackage[T1]{fontenc} +\usepackage{mathptmx} +\usepackage[scaled=.85]{luximono} +\renewcommand\sfdefault{cmss} -\usepackage{mfpdoc} +% Fake chapters (really sections): +\usepackage[chapters]{mfpdoc} \pagestyle{mfpdoc} -\usepackage{verbatim} + \usepackage{makeidx} \makeindex +\usepackage{graphics} + \ifpdf -\usepackage[pdftex,colorlinks,pdfpagemode=none,pdfstartview=FitH,% -plainpages=false,hypertexnames=true]{hyperref} -\pdfstringdefDisableCommands{\def\cs#1{\otherbackslash#1}% - \def\opt#1{#1}\def\prog#1{#1}} +\expandafter\usepackage\expandafter + [\mfpHyOpts,pdfpagelabels=true,hyperindex]{hyperref} +\expandafter\pdfstringdefDisableCommands\expandafter + {\mfpHyDisable} \fi -\title{\Mfp: Pictures in \TeX\\ with Metafont and MetaPost} -\author{Dr Thomas E. Leathrum -\and Geoffrey Tobin\thanks{\email{G.Tobin@latrobe.edu.au}} -\and Daniel H. Luecking\thanks{\email {luecking@uark.edu}}} +\stepcounter{secnumdepth} + +\title{\Mfp{}: Pictures in \TeX{}\\ with Metafont and +MetaPost\thanks{Copywrite 2002--2006, Daniel H. Luecking}} + + +\author{% +Daniel H. Luecking% + \thanks{\email {luecking@uark.edu}: Communications regarding \mfp{} + should be sent to this author. Any first-person references in this + manual refer to Dr.~Luecking.} +\and Dr Thomas E. Leathrum +\and Geoffrey Tobin} + \date{\mfpdate} \begin{document} @@ -34,65 +51,62 @@ plainpages=false,hypertexnames=true]{hyperref} \clearpage \pagenumbering{arabic} -\section{Introduction}\label{introduction} +\chapter{Introduction}\label{introduction} +\thispagestyle{plain} -\subsection{Why?}\label{why} +\section{Why?}\label{why} -Tom got the idea for \mfp% - \footnote{If you're wondering how to pronounce `\mfp': I always say - `em-eff-\textbf{pick}', speaking the first two letters. ---DHL.} % +Tom got the idea for \mfp{}% + \footnote{`\Mfp{}' is pronounced by spelling the first two letters: + `em-eff-pick'.} mostly out of a feeling of frustration. Different output mechanisms for printing or viewing \TeX{} DVI files each have their own ways to include pictures. More often than not, there are provisions for including graphic objects into a \prog{DVI} file using \TeX{} \cs{special}'s. -However, this technique seemed far from \TeX's ideal of -device independence because different \TeX{} output drivers recognize -different \cs{special's}, and handle them in different ways. +However, this technique seemed far from \TeX{}'s ideal of device +independence because different \TeX{} output drivers recognize different +\cs{special's}, and handle them in different ways. -\LaTeX's \env{picture} environment has a hopelessly limited supply of +\LaTeX{}'s \env{picture} environment has a hopelessly limited supply of available objects to draw---if you want to draw a graph of a polynomial curve, you're out of luck. -There was, of course, \PiCTeX, which is wonderfully flexible and general, -but its most obvious feature was its speed---or rather lack of it. -Processing a single picture in \PiCTeX{} could often take several seconds. +There was, of course, \PiCTeX{}, which was wonderfully flexible and +general, but its most obvious feature was its speed---or rather lack of +it. Processing a single picture in \PiCTeX{} (in those days) could often +take several seconds. It occurred to Tom that it might be possible to take advantage of the fact that \MF{} is \emph{designed} for drawing things. The result of -pursuing this idea is \mfp, a set of macros for \TeX{} and -\MF{} which incorporate \MF-drawn pictures into a \TeX{} file. +pursuing this idea was \mfp{}, a set of macros for \TeX{} and +\MF{} which incorporate \MF{}-drawn pictures into a \TeX{} file. With the creation of \MP{} by John Hobby, and the almost universal availability of free \PS{} interpreters like \GS, some \mfp{} users -wanted to run their \mfp{} output through \MP, to produce \PS{} -pictures. Moreover, users wanted to be able to use \pdfTeX, which does -not get along well with PK fonts, but is quite happy with \MP{} -pictures. Unfortunately \file{grafbase.mf}, which contained the \MF{} -macros responsible for processing \mfp's output, was far too -pixel-oriented for \MP. A new file, \file{grafbase.mp} was created, -based very heavily on \file{grafbase.mf} but compatible with \MP. Now -when an \mfp{} output file says \mfc{input grafbase}, either \MF{} or -\MP{} may be run on it, and each program will select its own macros, and -produce (nearly) the same picture. This gets us away from device -independence, but many users were not so much concerned with that as -with having a convenient way to have text and pictures described in the -same document. +wanted to run their \mfp{} output through \MP{}, to produce \PS{} +pictures. Moreover, users wanted to be able to use \pdfTeX{}, which did +not get along well with PK fonts, but was quite happy with \MP{} +pictures. So \MP{} support was added to \mfp{}. This got us a little bit +away from device independence, but many users were not much concerned +with that: they just wanted a convenient way to have text and pictures +described in the same document file. With the extra capabilities of \PS{} (e.g., color) and the corresponding -abilities of \MP, there was a demand for some \mfp{} interface to +abilities of \MP{}, there was a demand for some \mfp{} interface to access them. Consequently, switches (options) have been added to access some of them. When these are used, output files may no longer be -compatible with \MF. +compatible with \MF{}. -\subsection{Who?}\label{author} +\section{Who?}\label{author} -\Mfp{} was written primarily by Tom Leathrum during the late -(northern hemisphere) spring and summer of 1992, while at Dartmouth -College. Different versions were being written and tested for nearly two -years after that, during which time Tom finished his Ph.D. and took a -job at Berry College, in Rome, GA. Between fall of 1992 and fall of -1993, much of the development was carried out by others. Those who -helped most in this process are credited in the Acknowledgements. +The original \Mfp{} (and the core of the current version) was written +primarily by Tom Leathrum during the late (northern hemisphere) spring +and summer of 1992, while at Dartmouth College. Different versions were +being written and tested for nearly two years after that, during which +time Tom finished his Ph.D. and took a job at Berry College, in Rome, +GA. Between fall of 1992 and fall of 1993, much of the development was +carried out by others. Those who helped most in this process are +credited in the Acknowledgements. Somewhere in the mid 1990's the development passed to Geoffrey Tobin who kept things going for several years. @@ -102,56 +116,104 @@ The addition of \MP{} support was carried out by Dan Luecking around since then, with help from Geoffrey and a few others mentioned in the Acknowledgements. -\subsection{What?}\label{manifest} - -See \file{README.txt} for a list and a brief explanation of each of -the files. Only five are actually needed for full access to -\mfp's capabilities: \file{mfpic.tex}, \file{mfpic.sty} (the -latter needed only for \LaTeX's \cs{usepackage}), \file{grafbase.mf} -(needed only if \MF{} will be processing the figures), -\file{grafbase.mp} and \file{dvipsnam.mp} (needed only if \MP{} will be -the processor). - -The readme file that accompanies \mfp{} gives some guidence on the -proper location for the installation of these files. - -\subsection{How?}\label{process} - -Setting up \TeX{} and \MF{} to process these files will, to an extent, -depend on your local installation. The biggest problem you are likely to -have, regardless of your installation, will be convincing \TeX{} and its -output drivers to find \MF's output files. You should do whatever is -necessary (perhaps nothing!) to insure that \TeX{} looks in the current -directory for \file{.tfm} files, and that your dvi driver/viewer looks -in the current directory for \file{.pk} files. If you process your -pictures with \MP{} there is nothing to do in this regard. +\section{What?}\label{manifest} + +See the \file{README} file for a list of files in the distribution and a +brief explanation of each. Only four are actually needed for full access +to \mfp{}'s capabilities: \file{mfpic.dtx}, \file{mfpic.ins}, +\file{grafbase.dtx} and \file{mfppatch.tex}. Running \LaTeX{} on +\file{mfpic.ins} creates the only required files: +\begin{display} + \file{mfpic.tex} and \file{mfpic.sty}, the latter required only for + \LaTeX{}.\\ + \file{grafbase.mf}, required only if \MF{} will be processing + figures.\\ + \file{grafbase.mp} and \file{dvipsnam.mp}, needed only if \MP{} will + be the processor.\\ + \file{mfppatch.tex} is used to distribute simple bug fixes. It does + nothing after a major update, but if it is not installed and a + previous one is, a warning will be issued. +\end{display} +The README file also gives some guidence on the proper location for the +installation of these files. + +\section{How?}\label{process} + +Some guidance on writing files that contain \mfp{} figures can be found +in the accompanying file \file{mfpguide.pdf}. If you use \mfp{} to +produce \MP{} figures the process is straightforward: run \TeX{} (or +\LaTeX), then \MP{}, then \TeX{} again. If there are no errors, then +\prog{dvips} or other DVI-to-PS converter can be run to produce +viewable\slash printable output. You can also run \prog{dvipdfm} to obtain PDF +output, or even use \pdfTeX{} instead of \TeX{} (or \pdfLaTeX{} instead +of \LaTeX{}) to get PDF output directly. Here is an example of the process: for the sample file -\file{pictures.tex}% - \footnote{Read \file{mfpguide.pdf} for examples of minimal \mfp{} - input files.}, % -first run \TeX{} on it (or run \LaTeX{} on \file{lapictures.tex}). You -may see a message from \mfp{} that there is no file \file{pics.tfm}, but -\TeX{} will continue processing the file anyway. When \TeX{} is -finished, you will now have a file called \file{pics.mf}. This is the -\MF{} file containing the descriptions of the pictures for -\file{pictures.tex}. You need to run \MF{} on \file{pics.mf}, with -\cs{mode:=localfont} set up. (Read your \MF{} manual to see how to do +\file{pictures.tex}, first run \TeX{} on it (or run \LaTeX{} on +\file{lapictures.tex}). You may see a message from \mfp{} that there is +no file \file{pics.1}, but \TeX{} will continue processing the file +anyway. When \TeX{} is finished, you will now have a file called +\file{pics.mp}. This is the \MP{} file containing the descriptions of +the pictures for \file{pictures.tex}. You need to run \MP{} on +\file{pics.mp} (Read your \MF{} manual to see how to do this.% - \footnote{If you are new to running \MF, the document - \textit{Metafont for Beginners}, by \hbox{Geoffrey Tobin}, is a good - start. Fetch \file{CTAN/info/metafont-for-beginners.tex}. - `\file{CTAN}' means the Comprehensive \TeX{} Archive Network. You - can find the mirror nearest you by pointing your browser at - \file{http://www.ctan.org/}.}) % + \footnote{The document \textit{Some experiences on running Metafont + and MetaPost}, by Peter Wilson, can be useful for beginners. Fetch + \file{CTAN/info/metafp.pdf}. `\file{CTAN}' means the Comprehensive + \TeX{} Archive Network. You can find the mirror nearest you by + pointing your browser at \file{http://www.ctan.org/}.}) % Typically, you just type \begin{verbatim} - mf pics.mf +mpost pics.mp +\end{verbatim} +(or possibly "\verb$mp pics.mp$"). + +This produces files \file{pics.1}, \file{pics.2}, etc., the number of +files depending on the version of \file{pictures.tex}. You then +reprocessing \file{pictures.tex} with \TeX{} to produce a DVI file. This +file can then be processed with \prog{dvips} (for example) to produce +\PS{} output which can be printed or viewed. One can also process the +DVI with \prog{dvipdfm} to produce a PDF file. + +If \pdfTeX{} is used instead of \TeX{} on the second run, you should be +able to view the resulting PDF file immediately, without any further +processing. + +If instead you use \mfp{} to produce \MF{} figures, things are a little +less straightforward. The process is \TeX{}, then \MF{}, then +\prog{gftopk}, then \TeX{} again. After this, \TeX{}'s DVI output ought +to be viewable and printable by most DVI viewers or printer drivers. For +a few \TeX{} systems there may be some prior setup needed. One needs to +convince \TeX{} and its output drivers to find \MF{}'s output files. You +should do whatever is necessary (perhaps nothing!) to insure that \TeX{} +looks in the current directory for \file{.tfm} files, and that your DVI +drivers look in the current directory for \file{.pk} files. There may +also be some setup needed to ensure that the \file{.pk} files are +created at a resolution that matches your printer's. See the discussion +in \file{mfpguide.pdf}. + +If you want to test this process on the supplied sample files, edit +\file{pictures.tex} removing the \cs{usemetapost} command (or edit +\file{lapictures.tex}, removing the \opt{metapost} option). After that, +run \TeX{} on \file{pictures.tex} (or run \LaTeX{} on +\file{lapictures.tex}). You may see a message from \mfp{} that there is +no file \file{pics.tfm}, but \TeX{} will continue processing the file. +When \TeX{} is finished, you will now have a file called \file{pics.mf}. +This is the \MF{} file containing the descriptions of the pictures for +\file{pictures.tex}. You need to run \MF{} on \file{pics.mf}, with +\texttt{mode:=localfont} set up. +(Read your \MF{} manual to see how to do this.% + \footnote{If you are new to running \MF{}, the document + \textit{Metafont for Beginners}, by Geoffrey~Tobin, is a good + start. Fetch \file{CTAN/info/metafont-for-beginners.tex}.}) % +Typically, you just type +\begin{verbatim} +mf pics.mf \end{verbatim} or, to use a particular printer mode such as \texttt{ljfour}, possibly something like \begin{verbatim} - mf '\mode:=ljfour; input pics.mf' +mf '\mode:=ljfour; input pics.mf' \end{verbatim} This produces a \file{pics.tfm} file and a GF file with a name something like \file{pics.600gf}. The actual number may be different and the @@ -159,39 +221,17 @@ extension may get truncated on some file systems. Then you run \prog{gftopk} on the GF file to produce a PK font file. (Read your \prog{gftopk} manual on how to do this.) Typically, you just run \begin{verbatim} - gftopk pics.600gf +gftopk pics.600gf \end{verbatim} -(or possibly \ \verb$gftopk pics.600gf pics.600pk$ \ or \ -\verb$gftopk pics.600gf pics.pk$ ). +(or possibly ``\verb$gftopk pics.600gf pics.600pk$'' or +``\verb$gftopk pics.600gf pics.pk$''). -Now you have the font (the \file{.pk} file) and font metric file (the -\file{.tfm}) generated by \MF, reprocess the file \file{pictures.tex} -with \TeX. The resulting DVI file should now be complete, and you should +Now that you have the font (the \file{.pk} file) and font metric file (the +\file{.tfm}) generated by \MF{}, reprocess the file \file{pictures.tex} +with \TeX{}. The resulting DVI file should now be complete, and you should be able to print and view it at your computer (assuming your viewer and print driver have been set up to be able to find the PK font generated -from \file{pics.mf}). You can delete \file{pics.600gf} and -\file{pics.log}. - -If you use \mfp{} with the \opt{metapost} option (this would require you -to edit \file{pictures.tex} or \file{lapictures.tex}. See -chapter~\ref{options} for how to do this), then \file{pics.mp} is -produced, and you need to replace the \MF/\prog{gftopk} steps with the -single step of running \MP. (Read your \MP{} documentation on how to do -this.% - \footnote{The document \textit{Some experiences on running Metafont - and MetaPost}, by Peter Wilson, can be useful for beginners. Fetch - \file{CTAN/info/metafp.pdf}.}) % -Typically just -\begin{verbatim} - mpost pics.mp -\end{verbatim} -or possibly \ \verb$mp pics.mp$ . - -After reprocessing \file{pictures.tex} with \TeX{} you should then be -able to run dvips on the resulting DVI file and print or view its \PS{} -output. It \pdfTeX{} is used instead of \TeX{} on the second run, you -should be able to view the resulting PDF file with the pictures -included. +from \file{pics.mf}). It is not advisable to rely on automatic font generation to create the \file{.tfm} and \file{.pk} files. (Different systems do this in @@ -199,60 +239,76 @@ different ways, so here I will try to give a generic explanation.) The reason: later editing of a figure will require new files to be built, and most automatic systems will \emph{not} remake the files once they have been created. This is not so much a problem with the \file{.tfm}, -as \mfp{} never tries to load the font if the \file{.tfm} is absent and -therefore no automatic \file{.tfm}-making should ever be triggered. +because \mfp{} never tries to load the font if the \file{.tfm} is absent +and therefore no automatic \file{.tfm}-making should ever be triggered. However, if you forget to run \prog{gftopk}, then try to view your resulting file, you may have to search your system and delete some -automatically generated \file{.pk} file (they can turn up in -unpredictable places) before you can see any later changes. It might -be wise to write a shell script (batch file) that (1)~runs \MF, (2)~runs -\prog{gftopk} if step~1 returns no error, (3)~deletes the \file{.tfm} if -the \file{.pk} file does not exist. That way, if anything goes wrong, -the \file{.dvi} will not contain the font (\mfp{} will draw a rectangle -and the figure number in place of the figure). - -These processing steps---processing with \TeX, processing with -\MF/\prog{gftopk}, and reprocessing with \TeX---may not always be +automatically generated \file{.pk} file (they can turn up in far-away +places) before you can see any later changes. It might be wise to write +a shell script (batch file) that runs both \MF{} and \prog{gftopk}. It +should also do some error checking and delete the \file{.tfm} if the +\file{.pk} file is not produced. That way, if anything goes wrong, the +\file{.dvi} will not contain the font (\mfp{} will draw a rectangle and +the figure number in place of the figure). + +These processing steps---processing with \TeX{}, processing with +\MF{}\slash\prog{gftopk} or \MP{}, and reprocessing with \TeX{}---may not always be necessary. In particular, if you change the \TeX{} document without making any changes at all to the pictures, then there will be no need to repeat the \MF{} or \MP{} steps. There are also somewhat subtle circumstance under which you can skip the -second \TeX{} step after editing a file that has gone through the above -process. Listing the exact cirumstances is rather involved, so it is -recommended that you always repeat the \TeX{} step if changes have been -made. +second \TeX{} step after editing a figure if the file has already gone +through the above process. Delineating the exact cirumstances is rather +involved, so it is recommended that you always repeat the \TeX{} step if +changes have been made to any figure. What makes \mfp{} work? When you run \TeX{} on the file -\file{pictures.tex}, the \mfp{} macros issue \TeX{} \cs{write -commands}, writing \MF{} (or \MP) commands to a file \file{pics.mf} (or -\file{pics.mp}). The user should never have to read or change the -file \file{pics.mf} directly---the \mfp{} macros take care of it. +\file{pictures.tex}, the \mfp{} macros issue \TeX{} \cs{write} commands, +writing \MF{} (or \MP{}) commands to a file \file{pics.mf} (or +\file{pics.mp}). The user should never have to read or change the file +\file{pics.mf} directly---the \mfp{} macros take care of it. The enterprising user can determine by examining the \mfp{} source and -the resulting \MF{} file, that \mfp{} drawing macros translate almost -directly into similar \MF/\MP{} commands, defined in one of the files -\file{grafbase.mf} or \file{grafbase.mp}. The labels and -captions, however, are placed on the graph by \TeX{} using box -placement techniques similar to those used in \LaTeX's \env{picture} -environment (except when option \opt{mplabels} is in effect, in which -case \MP{} places the labels). +the resulting \file{.mf} or \file{.mp} file, that \mfp{} drawing macros +translate almost directly into similar \MF{}\slash\MP{} commands, +defined in one of the files \file{grafbase.mf} or \file{grafbase.mp}. +The labels and captions, however, are placed on the graph by \TeX{} +using box placement techniques similar to those used in \LaTeX{}'s +\env{picture} environment (except when option \opt{mplabels} is in +effect, in which case the labels are written to the \file{.mp} file and +handled by \MP{}). + +\smallskip +\emph{Note}: In this manual, when describing \mfp{} operations, we will +often refer to ``\MF{}'' when we really mean ``\MF{} or \MP{}''. This +will especially be the case whenever we need to refer to commands in the +two languages which are substantially the same, but occasionally we will +even talk about ``running \MF{}'' when we mean running one or the other +program \texttt{mf} or \texttt{mpost} to process the figures. If we need +to discriminate between the two processors, (for example when they have +different behavior) we will make the difference explicit. +A similar shorthand is used when referring to ``\TeX{}''. It should not be +taken to mean ``plain \TeX{}'', but rather whatever version of \TeX{} is used +to process the source file: plain \TeX{}, \LaTeX{}, \pdfTeX{}, or +\pdfLaTeX{}. Also \AmSTeX{}, \prog{eplain} and some other variants. When +last tried, \mfp{} didn't work with \ConTeXt{}. \clearpage -\section{Options.}\label{options} - -There are now several options to the \mfp{} package. These can be listed -in the standard \LaTeX{} \cs{usepackage} optional argument, or can be -turned on with certain provided commands (the only possibility for plain -\TeX). Some options can be switched off and on throughout the document. -Here we merely list them and provide a general description of their -purpose. More details may be found later in the discussion of the -features affected. The headings below give the option name, the -alternative macro and, if available, the command for turning off the -option. Any option not among those given below will be passed on to the -\prog{graphics} package, provided the \opt{metapost} option has been -used. +\chapter{Options.}\label{options} + +There are several options to the \mfp{} package. These options can be +turned on with certain provided commands, but under \LaTeX{} they can +also be used in the standard \LaTeX{} \cs{usepackage} optional argument. +Some options can be switched off and on throughout the document. Here we +merely list them and provide a general description of their purpose. +More details may be found later in the discussion of the features +affected. The headings below give the option name, the alternative macro +and, if available, the command for turning off the option. Any option +in the \cs{usepackage} command not among those given below will be +passed on to the \prog{graphics} package, provided the \opt{metapost} +option has been used. If the file \file{mfpic.cfg} exists, it will be input just before all options are processed. You can create such a file containing an @@ -260,16 +316,24 @@ options are processed. You can create such a file containing an have as default. Actual options to \cs{usepackage} will override these defaults, of course. And so will any of the commands below. -If the file \file{mfpic.usr} exists, it will be input at the end of the -loading of \mfp. The user can create such a file containing any of the -commands of this section that he would like to have as default. +If a file named \file{mfpic.usr} can be found, it will be input at the +end of the loading of \mfp{}. The user can create such a file containing +any of the commands of this section that he would like to have as +default. + +Finally, if the file \file{mfppatch.tex} can be found, it will be input +slightly before the end of loading \mfp{}. It is part of the \mfp{} +distribution, and will be used to implement minor corrections when bugs +are found. The user should \emph{not} modify this file unless +he really knows what he is doing. -\subsection{\opt{metapost}, \cs{usemetapost}}\label{metapost} -\index{metapost@\opt{metapost}}\index{usemetapost@\cs{usemetapost}} +\section{\opt{metapost}, \cs{usemetapost}.}\label{metapost} +\index{metapost@\opt{metapost}}% +\index{usemetapost@\cs{usemetapost}} Selects \MP{} as the figure processor and makes specific features available. It changes the extension used on the output file to -\file{.mp} to signal that it can no longer be processed with \MF. There +\file{.mp} to signal that it can no longer be processed with \MF{}. There is also a \opt{metafont} option (command \cs{usemetafont}), but it is redundant, as \MF{} is the default. Either command must come before the \cs{opengraphsfile} command (see section~\ref{files}). They should not @@ -284,35 +348,38 @@ package), when \pdfLaTeX{} is used \mfp{} should be loaded and \cs{usemetapost} (if used) declared before \prog{babel} is loaded. -\subsection{\opt{mplabels}, \cs{usemplabels}, -\cs{nomplabels}}\label{mplabels} -\index{mplabels@\opt{mplabels}}\index{usemplabels@\cs{usemplabels}}% +\section{\opt{mplabels}, \cs{usemplabels}, +\cs{nomplabels}.}\label{mplabels} +\index{mplabels@\opt{mplabels}}% +\index{usemplabels@\cs{usemplabels}}% \index{nomplabels@\cs{nomplabels}} Causes all label creation commands to write their contents to the output -file. It has no effect on the \cs{tcaption} command. In this case labels -are handled by \MP{} and can be rotated. It requires \MP, and will be be -ignored without it (\MF{} cannot handle labels). It may also produce an -error either from \TeX{} or \MF. Otherwise the commands can come -anywhere and affect subsequent \cs{tlabel} commands. When this is in -effect, the labels become part of the figure and, in the default -handling, they may be clipped off or covered up by later drawing -elements. But see the next section on the \opt{overlaylabels} option. -Labels added to a picture contribute to the bounding box even if -\opt{truebbox} is not in effect. +file. It effects only labels on the figure, not a caption added by the +\cs{tcaption} command (see section~\ref{text}). In this case labels are +handled by \MP{} and can be rotated. It requires \MP{}, and will be be +ignored without it (\MF{} cannot handle labels). Using this option +without the \opt{metapost} option may also produce an error message +either from \TeX{} or \MF{}. The commands forms can be placed anywhere +and they affect subsequent \cs{tlabel} commands. When this is in effect, +the labels become part of the figure and, in the default handling, they +may be clipped off or covered up by later drawing elements. But see the +next section on the \opt{overlaylabels} option. Labels added to a +picture contribute to the bounding box even if \opt{truebbox} is not in +effect. The user is responsible for adding the appropriate \mfc{verbatimtex} header to the output file if necessary. For this purpose, there is the -\cs{mfpverbtex} command, see section~\ref{labels}. If -the label text contains only valid plain \TeX{} macros, there is -generally no need for a \mfc{verbatimtex} preamble at all. If you add a -\mfc{verbatimtex} preamble of \LaTeX{} code take care to make sure \MP{} -calls \LaTeX{} (for example, by setting the environmental variable -\texttt{TEX} to \texttt{latex} in the command shell of your operating -system.). +\cs{mfpverbtex} command, see section~\ref{labels}. If the label text +contains only valid plain \TeX{} macros, there is generally no need for +a \mfc{verbatimtex} preamble at all. If you add a \mfc{verbatimtex} +preamble of \LaTeX{} code take care to make sure \MP{} calls \LaTeX{} +(for example, the \texttt{mpost} command may take an option for this +purpose, or an environmental variable named \texttt{TEX} may be set +equal to \texttt{latex} in the command shell of your operating system.). -\subsection{\opt{overlaylabels}, \cs{overlaylabels}, \cs{nooverlaylabels}} +\section{\opt{overlaylabels}, \cs{overlaylabels}, \cs{nooverlaylabels}.} \label{overlaylabels} \index{overlaylabels@\opt{overlaylabels}}% \index{overlaylabels@\cs{overlaylabels}}% @@ -333,16 +400,17 @@ With the \opt{metapost} option, but without \opt{mplabels} it has been decided to keep the same behavior (and the same code) as under the \opt{metafont} option. However, when \opt{mplabels} is used, there is the possibility for special effects with text, and it has always been -the behavior before this version to simply place the labels as they +the behavior before version 0.7 to simply place the labels as they occurred. It turns out that placing the labels at the end is cleaner and simpler to code, so I experimented with it and rejected it as a default, but now offer it as an option. With this option, \mfp{} labels have almost the same behavior with or without \opt{mplabels}. -\subsection{\opt{truebbox}, \cs{usetruebbox}, -\cs{notruebbox}}\label{truebbox} -\index{truebbox@\opt{truebbox}}\index{usetruebbox@\cs{usetruebbox}}% +\section{\opt{truebbox}, \cs{usetruebbox}, +\cs{notruebbox}.}\label{truebbox} +\index{truebbox@\opt{truebbox}}% +\index{usetruebbox@\cs{usetruebbox}}% \index{notruebbox@\cs{notruebbox}} Normally \MP{} outputs an EPS file with the actual bounding box of the @@ -350,15 +418,16 @@ figure. By default, \mfp{} \emph{overrides} this and sets the bounding box to the dimensions specified by the \cs{mfpic} command that produced it. (This used to be needed for \TeX{} is to handle \cs{tlabel} commands correctly. Now, it is just for backward compatability, and for -compatability with \MF's behavior.) It is reasonable to let \MP{} have +compatability with \MF{}'s behavior.) It is reasonable to let \MP{} have its way, and that is what this option does. If one of the command forms is used in an \env{mfpic} environment, it affects only that environment, otherwise it affects all subsequent figures. This option currently has -no effect with \MF, but should cause no errors. +no effect with \MF{}, but should cause no errors. -\subsection{\opt{clip}, \cs{clipmfpic}, \cs{noclipmfpic}}\label{clip} -\index{clip@\opt{clip}}\index{clipmfpic@\cs{clipmfpic}}% +\section{\opt{clip}, \cs{clipmfpic}, \cs{noclipmfpic}.}\label{clip} +\index{clip@\opt{clip}}% +\index{clipmfpic@\cs{clipmfpic}}% \index{noclipmfpic@\cs{noclipmfpic}} Causes all parts of the figure outside the rectangle specified by the @@ -368,14 +437,14 @@ only. Otherwise all subsequent figures are affected. Note: this is a rather rudimentary option. It has an often unexpected interaction with truebbox. When both are in effect, \MP{} will produce a bounding box that is the intersection of two rectangles: the true one \emph{without -clipping}, and the box specified in the \cs{mfpic} command. It is -possible that the actual figure will be much smaller (even empty!). This -is a property of the \MP{} \gbc{clip} command and we know of no way to -avoid it. +clipping}, and the clipping rectangle (i.e., the one specified in the +\cs{mfpic} command). It is possible for the actual figure to be much +smaller than this bounding box (even empty!). This is a property of the +\MP{} \gbc{clip} command and we know of no way to avoid it. -\subsection{\opt{centeredcaptions}, \cs{usecenteredcaptions}, -\cs{nocenteredcaptions}}\label{centeredcaptions} +\section{\opt{centeredcaptions}, \cs{usecenteredcaptions}, +\cs{nocenteredcaptions}.}\label{centeredcaptions} \index{centeredcaptions@\opt{centeredcaptions}}% \index{usecenteredcaptions@\cs{usecenteredcaptions}}% \index{nocenteredcaptions@\cs{nocenteredcaptions}} @@ -385,26 +454,47 @@ centered. This has no effect on the normal \LaTeX{} \cs{caption} command.% \footnote{This writer [DHL] feels that \cs{tcaption} is too limited and users ought to apply the caption by other means, such as - \LaTeX's \cs{caption} command, outside the \env{mfpic} - environment.} % + \LaTeX{}'s \cs{caption} command, outside the \env{mfpic} + environment.}% + +The commands can be issued anywhere. If inside an \env{mfpic} +environment they should come before the \cs{tcaption} command and affect +only it, otherwise they affect all subsequent figures. They should not +be used in the argument of a \cs{tcaption} command. + +\section{\opt{raggedcaptions}, \cs{useraggedcaptions}, +\cs{noraggedcaptions}.}\label{raggedcaptions} +\index{raggedcaptions@\opt{raggedcaptions}}% +\index{useraggedcaptions@\cs{useraggedcaptions}}% +\index{noraggedcaptions@\cs{noraggedcaptions}} + +Causes multiline captions created by \cs{tcaption} to have all lines +raggedright. If \opt{centeredcaptions} is on, both sides will be ragged. +The command \cs{noraggedcaptions} restores the default: all lines except +the last justified. The last is either centered or flush left according +to whether \opt{centeredcaptions} is on or off. + The commands can be issued anywhere. If inside an \env{mfpic} environment they should come before the \cs{tcaption} command and affect -only it, otherwise they affect all subsequent figures. +only it, otherwise they affect all subsequent figures. They should not +be used in the argument of a \cs{tcaption} command. -\subsection{\opt{debug}, \cs{mfpicdebugtrue}, -\cs{mfpicdebugfalse}}\label{debug} -\index{debug@\opt{debug}}\index{mfpicdebugtrue@\cs{mfpicdebugtrue}}% +\section{\opt{debug}, \cs{mfpicdebugtrue}, +\cs{mfpicdebugfalse}.}\label{debug} +\index{debug@\opt{debug}}% +\index{mfpicdebugtrue@\cs{mfpicdebugtrue}}% \index{mfpicdebugfalse@\cs{mfpicdebugfalse}} Causes \mfp{} to write a rather large amount of information to the \file{.log} file and sometimes to the terminal. Debug information generated by \file{mfpic.tex} \emph{while loading} is probably of interest only to developers, but can be turned on by giving a definition -to the command \cs{mfpicdebug} prior to loading. +to the command \cs{mfpicdebug} prior to loading. Any definition will +work because \prog{mfpic} only checks whether it is defined. -\subsection{\opt{clearsymbols}, \cs{clearsymbols}, \cs{noclearsymbols}} -\index{clearsymbols@\opt{clearsymbols}} -\index{clearsymbols@\cs{clearsymbols}} +\section{\opt{clearsymbols}, \cs{clearsymbols}, \cs{noclearsymbols}.} +\index{clearsymbols@\opt{clearsymbols}}% +\index{clearsymbols@\cs{clearsymbols}}% \index{noclearsymbols@\cs{noclearsymbols}} \Mfp{} has two commands, \cs{point} and \cs{plotsymbol} that place a @@ -415,7 +505,7 @@ behavior of \cs{point} in the case of \cs{pointfillfalse} is to erase the interior of the disk in addition to drawing its circumference. The second command \cs{plotsymbol} can place a variety of shapes, some -open, some not. Its behavior until now was always simply to draw the +open, some not. Its behavior before version 0.7 was to always draw the shape without erasing the interior. Two other commands that placed these symbols, \cs{plotnodes} and \cs{plot}, had the same behavior. With this option, two of these, \cs{plotsymbol} and \cs{plotnodes}, will erase the @@ -427,29 +517,32 @@ interior of the open symbols before drawing them. Thus this option. -\subsection{\opt{draft}, \opt{final}, \opt{nowrite}, \cs{mfpicdraft}, - \cs{mfpicfinal}, \cs{mfpicnowrite}}\label{draft} -\index{draft@\opt{draft}}\index{final@\opt{final}}% -\index{nowrite@\opt{nowrite}}\index{mfpicdraft@\cs{mfpicdraft}}% -\index{mfpicfinal@\cs{mfpicfinal}}\index{mfpicnowrite@\cs{mfpicnowrite}} +\section{\opt{draft}, \opt{final}, \opt{nowrite}, \cs{mfpicdraft}, + \cs{mfpicfinal}, \cs{mfpicnowrite}.}\label{draft} +\index{draft@\opt{draft}}% +\index{final@\opt{final}}% +\index{nowrite@\opt{nowrite}}% +\index{mfpicdraft@\cs{mfpicdraft}}% +\index{mfpicfinal@\cs{mfpicfinal}}% +\index{mfpicnowrite@\cs{mfpicnowrite}} Under the \opt{metapost} option, the various macros that include the \EPS{} files emit rather large amounts of confusing error messages when -the files don't exist (especially in \LaTeX). For this reason, before -each picture is placed, \mfp{} checks for the existence of the -graphic before trying to include it. However, on some systems checking -for the existence of a nonexistent file can be very slow because the -entire \TeX{} search path will need to be checked. Therefore, \mfp{} -doesn't even attempt any inclusion on the first run. The first run is -detected by the non-existence of \file{\meta{file}.1}, where \meta{file} -is the name given in the \cs{opengraphsfile} command (but see also +the files don't exist (especially in \LaTeX{}). For this reason, before +each picture is placed, \mfp{} checks for the existence of the graphic +before trying to include it. However, on some systems checking for the +existence of a nonexistent file can be very slow because the entire +\TeX{} search path will need to be checked. Therefore, \mfp{} doesn't +even attempt any inclusion on the first run. The first run is detected +by the non-existence of \file{\meta{file}.1}, where \meta{file} is the +name given in the \cs{opengraphsfile} command (but see also section~\ref{files}). These options can be used to override this -automatic detection. All the command versions should come \emph{before} +automatic detection. All the command versions \emph{should} come before the \cs{opengraphsfile} command. The \cs{mfpicnowrite} command \emph{must} come before it. These options might be used if, for example, the first figure has an -error and is not created by \MP, but you would like \mfp{} to go +error and is not created by \MP{}, but you would like \mfp{} to go ahead and include the remaining figures. Then use \opt{final}. It can also be used to override a \LaTeX{} global \opt{draft} option. Or if \file{\meta{file}.1} exists, but other figures still have errors and you @@ -461,11 +554,29 @@ debugged, some time might be saved (with either \opt{metafont} or \opt{metapost}) by not writing the output file again, then \opt{nowrite} can be used. +\section{\opt{mfpreadlog}, \cs{mfpreadlog}.}\label{readlog} +\index{mfpreadlog@\opt{mfpreadlog}}% +\index{mfpreadlog@\cs{mfpreadlog}} -\subsection{Option Scoping Rules}\label{scoping} +From version 0.8, there exists a scheme to allow \MF{} or \MP{} to pass +information back to the \file{.tex} file. This is done by writing code +to the figure file requesting \MF{} to place that information in the +\file{.log} file it produces. This option instructs \mfp{} to +read through that log file line-by-line looking for such information. +Since such log files can be potentially quite lengthy, this is made an +option. If the command form \cs{mfpreadlog} is used, it must come before +the \cs{opengraphsfile} command, since that is when the file will be +examined. At the present time, the only \mfp{} facility that requires +this two-way communication is \cs{assignmfvalue} (see +subsection~\ref{misc}). If this is used, the filename given to +\cs{opengraphsfile} should not be the same as the \TeX{} source file in +which this occurs, as then the wrong \file{.log} may be read. + + +\section{Scoping Rules.}\label{scoping} Some of these options merely change \TeX{} behavior, others write -information to the output file for \MF{} or \MP. Changes in \TeX{} +information to the output file for \MF{} or \MP{}. Changes in \TeX{} behavior obey the normal \TeX{} grouping rules, the information written to the output file obeys \MF{} grouping rules. Since each \env{mfpic} environment is both a \TeX{} group and (corresponds to) a \MF{} group, @@ -479,73 +590,166 @@ commands are exceptions; they obey all \TeX{} scoping rules. We have also tried to make all other \mfp{} commands for changing the various parameters follow this rule: local inside \env{mfpic} -environment, global outside. However, as of this writing I don't -claim to have caught every one. +environment, global outside. If this is ever untrue, and I don't +document that fact, please let me know. The following are special: +\begin{display} \cs{usemetapost}\index{usemetapost@\cs{usemetapost}}, \cs{usemetafont}\index{usemetafont@\cs{usemetafont}}, \cs{mfpicdraft}\index{mfpicdraft@\cs{mfpicdraft}}, \cs{mfpicfinal}\index{mfpicfinal@\cs{mfpicfinal}}, +\cs{mfpicnowrite}\index{mfpicnowrite@\cs{mfpicnowrite}},\\ and -\cs{mfpicnowrite}\index{mfpicnowrite@\cs{mfpicnowrite}}. -Their effects are always global, partly because they should occur prior -to the initialization command \cs{opengraphsfile} (described in -section~\ref{files}). Note that \cs{usemetapost} may cause a file of +\cs{mfpreadlog}\index{mfpreadlog@\cs{mfpreadlog}}. +\end{display} +\noindent Their effects are always global, partly because they should +occur prior to the initialization command \cs{opengraphsfile} (described +in section~\ref{files}). Note that \cs{usemetapost} may cause a file of graphic inclusion macros to be input. If this command is issued inside a group, some definitions in that file may be lost, breaking the graphic inclusion code. + \clearpage -\section{The Macros.}\label{macros} - -In these descriptions we will often refer to `\MF{}' when we really mean -`\MF{} or \MP{}'. This will especially be the case whenever we need to -refer to commands in the two languages which are substantially the same, -but occasionally we will even talk about running `\MF{}' when we mean -running one or the other to process the figures. If we need to -discriminate between the two processors, (for example when they have -different behavior) we will make the difference explicit. +\chapter{\CMF{} Data Types.}\label{types} + +Since the arguments of most \mfp{} drawing commands are sent to \MF{} to +be interpreted, it's useful to know something about \MF{} concepts. In +this chapter we will discuss some of the data types \MF{} supports. +Even the casual user should know how coordinates and colors are treated +and so should at least skim the next two sections. The last +section can be read when the user wants to manipulate more complex +objects. + +\CMF{} permits several different data types, and we will mainly be +concerned with six of these: numeric, pair, color (\MP{} only), path, +picture and boolean.% + \footnote{For the curious, there are a total of eight + types (nine for \MP{}). The other three are string, transform and pen. + \MF{} also permits expressions that produce nothing, which is sometimes + called the vacuous type, but doesn't allow for (or need) variables of + this type.} + +A \emph{variable} is a symbolic name such as \mfc{A} or +\mfc{incenter}. Any sequence of letters and underscores is permitted +as a variable name. Numeric indexes are also allowed, provided all +variables that differ only in the index have the same type. Thus +\mfc{A1}, \mfc{A2}, etc., might be variables which are all of type pair. +Quite a lot more is permited for variable names, but the rules are +rather complex and easy to violate. \Mfp{} has commands for creating +both simple variables and indexed variables (called \emph{arrays}) but +the casual user can get quite a lot of use out of \mfp{} without ever +creating or using a \MF{} variable. + +\CMF{} also has something akin to functions. For example, \mfc{sin(1.57)} +might represent a function named \mfc{sin} receiving the parameter +$1.57$ as input and returning the appropriate value. Functions +can take any number of parameters and return any of the data types that +\MF{} supports.% + \footnote{Including the vacuous type.} + + +\section{\CMF{} numerics and pairs.}\label{pairs} + +\CMF{} has numeric quantities. These include lengths, such as the radius +of a circle, as well as dimension units such as \mfc{in} (inches) +and \mfc{pt} (points). In fact it understands all the same units that +\TeX{} does. Numeric quantities can be constants (explicit numbers) or +variables (symbolic names). In fact, \mfc{in} and \mfc{pt} are symbolic +names for numeric quantities. + +\CMF{} also has \mfc{pair} objects, which may be constants or variables. +Pair constants have the form \mfc{($x$,$y$)} where $x$ and $y$ are +numbers, for example \mfc{(0,0)}. Pairs are two-dimensional quantities +used for representing either points or vectors in a rectangular +(Cartesian) coordinate system. + +In this manual we often represent each pair by a brief name, such as +\meta{p} or \meta{v}, the meanings of which are usually obvious in the +context of the macro. These are intended to be replaced in actual use by +either a pair constant or variable. The succinctness of this notation +helps us to think geometrically rather than only of coordinates. + + +\section{\CMP{} colors.}\label{MPcolors} + +\CMP{} has the same concepts as \MF, but also has color objects, which +may also be constants or variables. Color constants have the form +\mfc{($r$,$g$,$b$)} where $r$, $g$, and $b$ are numbers between $0$ and +$1$ determining the relative proportions of red, green and blue in the +color (the ``rgb'' model). A color variable is a name, like +\mfc{red}, \mfc{blue} (both predefined by \MP) or \gbc{magenta} +(predefined by \mfp{}). + + +\section{\CMF{} paths, pictures and booleans.}\label{paths} + +Most of the things that \mfp{} is designed to draw are paths. Examples +of paths are circles, rectangles, other polygons, graphs of +functions and splines. Because we tend to want to draw these (or fill +them, or render them in other ways) we call the \mfp{} commands that +produce them \emph{figure macros}. Although they are much more complex +than numerics, pairs, or colors, they can still be stored in symbolic +names. + +Normally in \mfp{} we want to create a picture, usually by rendering one +or more paths. It is possible in \MF{} to store a picture in a symbolic +name without actually drawing it. However, because of their complexity, +picture objects require somewhat more care than paths or other data +types. Do not expect to use stored pictures in the same way as stored +paths. In fact, one should use picture variables only in those command +that are explicitely designed for them. In \mfp{} to date these are only +\cs{tile...}\cs{endtile} and \cs{mfpimage} to store pictures, and +\cs{putmfpimage} to draw copies of one. There is also \cs{tess}, but it +is used only to fill a region with copies of a picture created by +\cs{tile}. + +The boolean data type is one of the values \mfc{true} or \mfc{false}. +Boolean variables are symbolic names that can take either of these two +values. Usually these are used to influence the behavior of some command +by setting a relevant boolean variable to one or the other value. -A similar shorthand is used when referring to \TeX{}. It should not be -taken to mean plain\TeX, but rather whatever version of \TeX{} is used -to process the source file: \LaTeX, \pdfTeX, \pdfLaTeX, etc. + +\clearpage +\chapter{The Macros.}\label{macros} Many of the commands of \mfp{} have optional arguments. These are -denoted just as in \LaTeX, with square brackets. Thus, the command for +denoted just as in \LaTeX{}, with square brackets. Thus, the command for drawing a circle can be given -\begin{ex} - \cs{circle}\marg{(0,0),1} -\end{ex} +\begin{verbatim} +\circle{(0,0),1} +\end{verbatim} having only the mandatory argument, or -\begin{ex} - \cs{circle}\oarg{p}\marg{(0,0),1} -\end{ex} +\begin{verbatim} +\circle[p]{(0,0),1} +\end{verbatim} Whenever an optional argument is omitted, the behavior is equivalent to some choice of the optional argument. In this example, the two forms have exactly the same behavior, drawing a circle centered at $(0,0)$ -with radius $1$. In this case we will say that \oarg{p} is the -\emph{default}. Another example is \cs{point}\marg{(1,0)} versus +with radius $1$. In this case we will say ``\oarg{p} is the +\emph{default}''. Another example is \cs{point}\marg{(1,0)} versus \cs{point}\oarg{3pt}\marg{(1,0)}. They both place a dot at the point -$(1,0)$. The second one explicitly request that it have diameter +$(1,0)$. The second one explicitly requests that it have diameter \dim{3pt}; the first will examine the length command \cs{pointsize}, which the user can change, but it is initialized to \dim{2pt}. In this -case we will say the default is the value of \cs{pointsize}, -\emph{initially \dim{2pt}}. +case we will say ``the default is the value of \cs{pointsize}, +\emph{initially} \dim{2pt}''. -Optional arguments for \mfp{} commands may consist of empty brackets -(completely empty, no spaces) and the default will be used. This is -useful only for commands that have two optional arguments and one only -wants to change from the defaults in the second one. An optional -argument should normally not contain any spaces. Even when the argument -contains more than one piece of data, spaces should not separate the -parts. In many cases (perhaps most) this will cause no harm, but it -would be better to avoid doing it altogether. +If an \mfp{} command that takes an optional argument finds only empty +brackets (completely empty, no spaces), then it will use the default +value. This is useful for commands that have two optional arguments and +one wants the default value in the first one and some nondefault value +in the second. An optional argument should normally not contain any +spaces. Even when the argument contains more than one piece of data, +spaces should not separate the parts. In some cases (perhaps most) this +will cause no harm, but it would be better to avoid doing it altogether, +because it will cause wrong results or error messages in some cases. -\subsection{Files and Environments.}\label{files} +\section{Files and Environments.}\label{files} -\begin{cd} +\begin{cd}\pagelabel{opengraphsfile} \cs{opengraphsfile}\marg{\meta{file}}\\ \ $\ldots$\\ \cs{closegraphsfile}% @@ -558,7 +762,7 @@ the pictures to be included in this document. The name of the file will be \file{\meta{file}.mf} (or \file{\meta{file}.mp}). Do \emph{not} specify the extension, which is added automatically. -\emph{Note}: This command will cause \file{\meta{file}.mf} or +\emph{Note}: This command may cause \file{\meta{file}.mf} or \file{\meta{file}.mp} to be overwritten if it already exists, so be sure to consider that when selecting the name. Repeating the running of \TeX{} will overwrite the file created on previous runs, but that should @@ -571,51 +775,74 @@ file and open another, and even to change between \opt{metapost} and \opt{metafont} in between. If anything goes wrong with this, contact the maintainer and it might be fixed in some later version. -\begin{cd} +\begin{cd}\pagelabel{mfpic} \cs{mfpic}\oarg{\meta{xscale}}\oarg{\meta{yscale}}% \marg{\meta{xmin}}\marg{\meta{xmax}}\marg{\meta{ymin}}\marg{\meta{ymax}}\\ \ $\ldots$\\ \cs{endmfpic}% -\index{mfpic@\cs{mfpic}}\index{endmfpic@\cs{endmfpic}} -\end{cd} - -These macros open and close the \env{mfpic} environment in which most of -the rest of the macros make sense. The \cs{mfpic} macro also sets up the -local coordinate system for the picture. The \meta{xscale} and +\index{mfpic@\cs{mfpic}}% +\index{endmfpic@\cs{endmfpic}} +\end{cd} + +These macros open and close the \env{mfpic} environment% + \footnote{We use the term `environment' loosely. However, in + \LaTeX{} one may use an actual \env{mfpic} environment. See + page~\pageref{envusage}.} +in which the drawing macros make sense. While many \mfp{} commands can +be used inside or outside this environment, those that actually produce +visible output are required to be inside. The \cs{mfpic} macro also sets +up the local coordinate system for the picture. The \meta{xscale} and \meta{yscale} parameters establish the length of a coordinate system unit, as a multiple of the \TeX{} dimension \cs{mfpicunit}. If neither -is specified, both are taken to be 1 (i.e., each coordinate system unit -is 1 \cs{mfpicunit}). If only one is specified, then they are assumed to -be equal. The \meta{xmin} and \meta{xmax} parameters establish the lower +is specified, both are taken to be 1 and each coordinate system unit is +1 \cs{mfpicunit}. If only one is specified, then they are assumed to be +equal. Note that some drawing commands require equal scales to work as +expected: if you try to draw a circle with different scales you will get +an ellipse. + +The \meta{xmin} and \meta{xmax} parameters establish the lower and upper bounds for the $x$-axis coordinates; similarly, \meta{ymin} and \meta{ymax} establish the bounds for the $y$-axis. These bounds are expressed in local units---in other words, the actual width of the picture will be $(\meta{xmax}-\meta{xmin})\cdot\meta{xscale}$ times \cs{mfpicunit}, its height $(\meta{ymax}-\meta{ymin})\cdot\meta{yscale}$ -times \cs{mfpicunit}, and its depth zero. One can scale all pictures -uniformly by changing \cs{mfpicunit}, and scale an individual picture by -changing \meta{xscale} and \meta{yscale}. After loading \mfp, -\cs{mfpicunit} has the value \dim{1pt}. One \texttt{pt} is a -\emph{printer's point}, which equals 1/72.27 inches or 0.35146 -millimeters. +times \cs{mfpicunit}, and its depth zero. + +Most of \mfp{}'s drawing macros accept parameters which are +\emph{coordinate pairs}. A coordinate pair is a pair of numbers $(x,y)$ +enclosed in parentheses, with $\meta{xmin} \le x \le \meta{xmax}$ and +$\meta{ymin} +\le y \le \meta{ymax}$.% + \footnote{These inequalities can be violated, usually causing + something to be drawn outside the desired borders of the figure.} +We will call these \emph{graph coordinates} and refer to the numbers $x$ +and $y$ as being \emph{in graph units}. Things like the thickness of +lines and the lengths of arrowheads are required to be expressed in +actual lengths such as \dim{1pt} or \dim{3mm}. These will be referred to as +\emph{absolute} units. + +One can scale all pictures uniformly by changing \cs{mfpicunit}, and +scale an individual picture by changing \meta{xscale} and \meta{yscale}. +After loading \mfp{}, \cs{mfpicunit} has the value \dim{1pt}. One +\texttt{pt} is a \emph{printer's point}, which equals 1/72.27 inches or +0.35146 millimeters. \emph{Note}: Changing \cs{mfpicunit} or the optional parameters will -scale the coordinate system, but not the values of certain parameters -that are defined in absolute units. Examples of these are the default -width of the drawing pen, the default lengths of arrowheads, the default -sizes of dashes and dots, etc. If you wish, you can set these to -multiples of \cs{mfpicunit}, but it is difficult (and probably unwise) -to get them to scale along with the scale parameters. +scale the coordinate system, but not the values of parameters that are +defined in absolute units. If you wish, you can set these to multiples +of \cs{mfpicunit}, but it is difficult (and almost certainly unwise) to +get the thickness of lines (for example) to scale along with the scale +parameters. In addition to establishing the coordinate system, these scales and bounds are used to establish the metric for the \MF{} character or bounding box for the \MP{} figure described within the environment. If -any of these parameters are changed, the \file{.tfm} file (\MF) or the -bounding box (\MP) will be affected, so you will have to be sure to +any of these parameters are changed, the \file{.tfm} file (\MF{}) or the +bounding box (\MP{}) will be affected, so you will have to be sure to reprocess the \TeX{} file after processing the \file{.mf} or \file{.mp} file, even if no other changes are made in the figure. -\begin{cd} +\begin{cd}\pagelabel{mfpicnumber} \cs{mfpicnumber}\marg{\meta{num}}% \index{mfpicnumber@\cs{mfpicnumber}} \end{cd} @@ -637,106 +864,111 @@ option, this command should come before \cs{opengraphsfile}, as that command checks for the existence of the first numbered figure to determine if there are figures to be included. -\begin{cd} +\begin{cd}\pagelabel{everymfpic} +\cs{everymfpic}\marg{\meta{commands}}\\ +\cs{everyendmfpic}\marg{\meta{commands}}% +\index{everymfpic@\cs{everymfpic}}% +\index{everyendmfpic@\cs{everyendmfpic}}% +\end{cd} + +These commands store the \meta{commands}. The first arranges for these +commands to be issued first thing in every \env{mfpic} environment and +the second arranges for its commands to be issued as the last thing in +every such environment. These could be any commands that make sense +inside that environment. Their purpose is mainly to save typing if there +is identical setup being performed in every picture. + +\begin{cd}\pagelabel{envusage} \cs{begin}\marg{mfpic}\texttt{...}\cs{end}\marg{mfpic}% \index{begin@\cs{begin}\marg{mfpic}} \end{cd} -In \LaTeX, instead of \cs{mfpic} and \cs{endmfpic}, you may prefer to -use \cs{begin}\marg{mfpic} and \cs{end}\marg{mfpic}. This is by no means -required: in \LaTeX{} \cs{begin}\marg{command} invokes \cs{command}, and -\cs{end}\marg{command} invokes \cs{endcommand}, for any environment -\env{command}. - -The sample file \file{lapictures.tex} provided with \mfp{} -illustrates this use of an \env{mfpic} environment in \LaTeX. +In \LaTeX{} you may prefer to use \cs{begin}\marg{mfpic} and +\cs{end}\marg{mfpic} (instead of \cs{mfpic} and \cs{endmfpic}). This is +by no means required. The sample file \file{lapictures.tex} provided +with \mfp{} illustrates this use of an \env{mfpic} environment in +\LaTeX{}. \medskip -The rest of the \mfp{} macros do not affect the font metric file -(\file{\meta{file}.tfm}), and so if these commands are changed or added -in your document, you will not have to repeat the third step of -processing (reprocessing with \TeX) to complete your \TeX{} document. -The same is true when option \opt{metapost} is selected without the -\opt{truebbox} option, except under \pdfTeX{} or \pdfLaTeX. Those \TeX{} -programs will embed the figures right in the \file{.pdf} output. For -normal \LaTeX{} + \prog{dvips}, the figures are embedded by -\prog{dvips}, which must always be repeated. +A word about \TeX{} groups inside \env{mfpic} environments. These can be +useful to limit the scope of declarations or of changes to some +variables. However, they do not limit the scope of changes to the figure +file that is being written, so there is a danger that \TeX{} and \MF{} +will have different values. There are also some \mfp{} command that need +to be at the outermost level. Thus, grouping should generaly be avoided +except for those groups provided by \mfp{} commands. \medskip For the remainder of the macros, the numerical parameters are expressed -in the units of the local coordinate system specified by \cs{mfpic}, -unless otherwise indicated. - - -\subsection{Figures.}\label{figures} - -\subsubsection{\CMF{} Pairs.}\label{pairs} - -Since many of the arguments of the \mfp{} drawing commands are -sent to \MF{} to be interpreted, it's useful to know something about -\MF{} concepts. - -In particular, \MF{} has \mfc{pair} objects, which may be constants or -variables. Pair constants have the form \mfc{($x$,$y$)}. Pairs are -two-dimensional rectangular (cartesian) quantities, and are clearly -useful for representing both points and vectors on the plane. - -Moreover, we herein often represent each pair by a brief name, such as -$p$, $v$ or $c$, the meanings of which are usually obvious in the -context of the macro. The succinctness of this notation also helps us to -think geometrically rather than only of coordinates. - -\CMP{} has these same concepts, but also has color objects, which may -also be constants or variables. Color constants have the form -\mfc{($r$,$g$,$b$)} where $r$, $g$, and $b$ are numbers between $0$ and -$1$ determining the relative proportions of red, green and blue in the -color (rgb model). A color variable is a name, like \mfc{magenta} or -\mfc{RoyalBlue} (predefined). There are also color functions like -\mfc{cmyk($x$,$y$,$z$,$w$)} which is defined to convert cmyk values into -\MP's native rgb model. - -Some commands depend on the value of separately defined parameters. All +in graph units, the units of the local coordinate system specified by +\cs{mfpic}, unless otherwise indicated. + +\section{Common objects.}\label{figures} + +The \mfp{} macros that draw things can be roughly divided into two +classes. +\begin{enumerate} + \item Those that simply cause something to be drawn. Examples of these + are the \cs{point} command, which places a dot at a list of + coordinates, and \cs{gridlines}, which draw coordinate lines with + specified separation. + \item Those that both \emph{define} and draw a \emph{path}. The macros + \cs{circle}, \cs{rect}, and \cs{polyline} are examples of these. +\end{enumerate} + +Macros of type 2 are referred to hereafter as \emph{figure macros}, for +lack of a better term. With them one can use \emph{prefix +macros}\index{prefix macro} to modify various aspects of the path and +how it is drawn. For example, +\begin{verbatim} +\polyline{(1,2),(3,4)} +\end{verbatim} +draws a line from $(1,2)$ to $(3,4)$, but +\begin{verbatim} +\dotted\polyline{(1,2),(3,4)} +\end{verbatim} +produces a dotted version, and +\begin{verbatim} +\arrow\polyline{(1,2),(3,4)} +\end{verbatim} +draws it with an arrowhead at the tip. This is not possible with +\cs{gridlines}, for example. As \mfp{} and the accompanying \MF{} +package \grafbase{} are currently written, prefix macros can only be +applied to single paths, and \cs{gridlines} produces a whole set of +lines. In this manual, as each macro is introduced, if it is a figure +macro, this will be explicitly stated. + +Some commands depend on the value of separately defined parameters. all these parameters are initialized when \mfp{} is loaded. In the following descriptions we give the initial value of all the relevant parameters. When \MP{} output is selected, figures can be drawn in any color. -Several of the above mentioned parameters are colors. \Mfp{} provides -commands to change any of these parameters. - +several of the above mentioned parameters are colors. \mfp{} provides +commands to change any of these parameters. To save repetition: all +special colors for figures are initialized to \mfc{black} except +\mfc{background}, which is white. -\subsubsection{Points, Lines, and Rectangles.}\label{points} -\begin{cd} -\cs{pointdef}\marg{\meta{name}}\texttt{($x$,$y$)}% -\index{pointdef@\cs{pointdef}} -\end{cd} +\subsection{Points, lines, and rectangles}\label{points} -Defines a symbolic name for points and their coordinates. \meta{name} is -any legal \TeX{} command name \emph{without} the backslash; $x$ and $y$ -are any numbers. For example, after the command -\cs{pointdef}\marg{A}\texttt{(1,3)}, \cs{A} expands to \texttt{(1,3)}, while -\cs{Ax} and \cs{Ay} expand to \texttt{1} and \texttt{3}, respectively. Because -of the way \cs{tlabel} is defined (see section~\ref{labels} below), one -cannot use \cs{A} to specify where to place a label (unless -\opt{mplabels} is in effect), but must use \texttt{ (\cs{Ax},\cs{Ay})}. In -most other commands, one can use \cs{A} where a pair or point is -required. - -\begin{cd} -\cs{point}\oarg{\meta{ptsize}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% +\begin{cd}\pagelabel{point} +\cs{point}\oarg{\meta{size}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% \index{point@\cs{point}} \end{cd} -Draws small disks centered at the points \meta{$p_0$}, \meta{$p_1$}, and -so on. If the optional argument \meta{ptsize} is present, it determines -the diameter of the disks, which otherwise equals the \TeX{} dimension -\cs{pointsize}, initially \dim{2pt}. The disks have a filled interior if -the command \cs{pointfilltrue} has been issued (the initial value), -\cs{pointfillfalse} causes the interior to be erased and an outline -drawn. The color of the circles is the value of the predefined variable -\gbc{pointcolor}, and the inside of the open circles is the value of -\mfc{background}. - -\begin{cd} +Draws small disks centered at the points specified in the list of +ordered pairs. The optional argument \meta{size} is an absolute +dimension that determines the diameter of the disks. The default is the +\TeX{} dimension \cs{pointsize}, initially \dim{2pt}. The disks have a +filled interior if the command \cs{pointfilltrue} has been issued (the +initial behavior). After the command \cs{pointfillfalse}, \cs{point} +commands will produce outlined circles with the interiors erased. The +color of the circles is the value of the predefined variable +\gbc{pointcolor}, and the color inside of the open circles is the value +of the variable \mfc{background}.% + \footnote{\MP{} cannot actually erase. The illusion of erasing is + created by painting over with \mfc{background}.} + +\begin{cd}\pagelabel{plotsymbol} \cs{plotsymbol}\oarg{\meta{size}}\marg{\meta{symbol}}% \marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% \index{plotsymbol@\cs{plotsymbol}} @@ -744,36 +976,55 @@ drawn. The color of the circles is the value of the predefined variable Draws small symbols centered at the points \meta{$p_0$}, \meta{$p_1$}, and so on. The symbols must be given by name, and the available symbols -are +are: +\begin{display} \gbc{Asterisk}\index{Asterisk@\gbc{Asterisk}}, \gbc{Circle}\index{Circle@\gbc{Circle}}, \gbc{Diamond}\index{Diamond@\gbc{Diamond}}, \gbc{Square}\index{Square@\gbc{Square}}, \gbc{Triangle}\index{Triangle@\gbc{Triangle}}, \gbc{Star}\index{Star@\gbc{Star}}, -\gbc{SolidCircle}\index{SolidCircle@\gbc{SolidCircle}}, +\gbc{SolidCircle}\index{SolidCircle@\gbc{SolidCircle}},\\ \gbc{SolidDiamond}\index{SolidDiamond@\gbc{SolidDiamond}}, \gbc{SolidSquare}\index{SolidSquare@\gbc{SolidSquare}}, \gbc{SolidTriangle}\index{SolidTriangle@\gbc{SolidTriangle}}, \gbc{SolidStar}\index{SolidStar@\gbc{SolidStar}}, \gbc{Cross}\index{Cross@\gbc{Cross}} and \gbc{Plus}\index{Plus@\gbc{Plus}}. -The names should be self-explanatory. Under \opt{metapost}, symbols are -drawn in \gbc{pointcolor}. The \meta{size} defaults to \cs{pointsize} as -in \cs{point} above. \gbc{Asterisk} consists of six -line segments while \gbc{Star} is the standard closed, ten-sided -polygon. The name `\cs{plotsymbol}' comes from the fact that the \cs{plot} -command, which was written first, utilizes these same symbols. The command -\cs{symbol} was already taken (standard \LaTeX). +\end{display} +The names should be self-explanatory, the `\gbc{Solid}' ones are filled +in, the others are outlines. Under \opt{metapost}, symbols are drawn in +\gbc{pointcolor}. The \meta{size} defaults to \cs{pointsize} as in +\cs{point} above. \gbc{Asterisk} consists of six line segments while +\gbc{Star} is the standard five-pointed star formed from ten straight +line segments. \gbc{Cross} is a $\times$ shape. The name +`\cs{plotsymbol}' comes from the fact that the \cs{plot} command (see +subsection~\ref{drawing}), which was written first, utilizes these same +symbols. The command \cs{symbol} was already taken (standard \LaTeX{}). + +While one would rarely want to use them for this purpose, the following +symbols are also available: +\begin{display} +\gbc{Arrowhead}\index{Arrowhead@\gbc{Arrowhead}}, +\gbc{Crossbar}\index{Crossbar@\gbc{Crossbar}}, +\gbc{Leftbar}\index{Leftbar@\gbc{Leftbar}}, +\gbc{Rightbar}\index{Rightbar@\gbc{Rightbar}}, +\gbc{Lefthook}\index{Lefthook@\gbc{Lefthook}}, +\gbc{Righthook}\index{Righthook@\gbc{Righthook}}, +\gbc{Leftharpoon}\index{Leftharpoon@\gbc{Leftharpoon}},\\ +\gbc{Rightharpoon}\index{Rightharpoon@\gbc{Rightharpoon}}. +\end{display} +These are mainly intended for making arrows. See subsection~\ref{arrows} +for a further description. The difference between \cs{pointfillfalse}\cs{point}$\ldots$ and \cs{plotsymbol}\marg{Circle}$\ldots$ is that the inside of the circle -will not be erased in the second version (i.e., whatever else has already -been drawn in that area will remain visible). This is the default (for +will not be erased in the second version, so whatever else has already +been drawn in that area will remain visible. This is the default (for backward compatibility), but that can be changed with the commands below. -\begin{cd} +\begin{cd}\pagelabel{clearsymbols} \cs{clearsymbols}\\ \cs{noclearsymbols}% \index{clearsymbols@\cs{clearsymbols}}% @@ -788,91 +1039,121 @@ subsection~\ref{drawing}) also responds to the settings made by these commands. The \cs{plot} command (also in subsection~\ref{drawing}) does not. -\begin{cd} +You can design your own `symbols'. See the discussion of arrowheads in +subsection~\ref{arrows}, and of storing paths in +subsection~\ref{transformation}. + +\begin{cd}\pagelabel{pointdef} +\cs{pointdef}\marg{\meta{name}}\texttt{(\meta{xcoord},\meta{ycoord})}% +\index{pointdef@\cs{pointdef}} +\end{cd} + +Defines a symbolic name for an ordered pair and the coordinates it +contains. \meta{name} is any legal \TeX{} command name \emph{without} +the backslash; \meta{xcoord} and \meta{ycoord} are any numbers. For +example, after the command \cs{pointdef}\marg{A}\texttt{(1,3)}, \cs{A} +expands to \texttt{(1,3)}, while \cs{Ax} and \cs{Ay} expand to +\texttt{1} and \texttt{3}, respectively. If \opt{mplabels} is in effect +one can use \cs{A} to specify where to place a text label, but if \TeX{} +is placing labels one must use \texttt{ (\cs{Ax},\cs{Ay})}. In most +other cases, one can use \cs{A} where a pair or point is required. + +\begin{cd}\pagelabel{polyline} \cs{polyline}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ \cs{lines}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% -\index{polyline@\cs{polyline}}\index{lines@\cs{lines}} +\index{polyline@\cs{polyline}}% +\index{lines@\cs{lines}} \end{cd} -Draws the line segment with endpoints at \meta{$p_0$} and \meta{$p_1$}, -then the line segment with endpoints at \meta{$p_1$} and \meta{$p_2$}, -etc. The result is an open polygonal path through the specified points, -in the specified order. \cs{polyline} and \cs{lines} mean the same -thing. +The figure macro \cs{polyline} produces connected line segments from +\meta{$p_0$} to \meta{$p_1$}, and from there to \meta{$p_2$}, etc. The +result is an open polygonal path through the specified points, in the +specified order. The macro \cs{lines} is an alias for \cs{polyline}. -\begin{cd} -\cs{polygon}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% -\index{polygon@\cs{polygon}} +\begin{cd}\pagelabel{polygon} +\cs{polygon}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ +\cs{closedpolyline}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% +\index{polygon@\cs{polygon}}% +\index{closedpolyline@\cs{closedpolyline}} \end{cd} -Draws a closed polygon with vertices at the specified points in the -specified order. +The figure macros \cs{polygon} produces a closed polygon with vertices +at the specified points in the specified order. It works exactly like +\cs{polyline} except the last point in the list is also joined to the +first. The macro \cs{closedpolyline} is an alias for \cs{polygon}. -\begin{cd} +\begin{cd}\pagelabel{rect} \cs{rect}\marg{\meta{$p_0$},\meta{$p_1$}}% \index{rect@\cs{rect}} \end{cd} -Draws the rectangle specified by the points \meta{$p_0$} and -\meta{$p_1$}, these being either pair of opposite corners of the -rectangle in any order. +This figure macro produces the closed rectangle with horizontal and +vertical sides, having the points \meta{$p_0$} and \meta{$p_1$} as +diagonally opposite corners. The same rectangle can be specified in four +different ways: either pair of opposite corners in either order. It is occasionally helpful to know that connected paths like those -produced by \cs{polyline} or \cs{rect} have a \emph{sense} (a -direction). The sense of \cs{polyline} is the direction determined by -the order of the points. For \cs{rect} the sense may be clockwise or -anticlockwise depending on the corners used: it begins at the first of -the two points and goes horizontally from there. - -\begin{cd} +produced by \cs{polyline} or \cs{rect} have a \emph{start} and an +\emph{end} as well as \emph{sense} (or direction). The path produced by +\cs{polyline} starts at the first listed pint and ends at last, having +the direction determined by the order of the points. For \cs{rect} the +sense may be clockwise or anticlockwise depending on the corners used: +it starts by moving horizontally from the first listed point. +Several \mfp{} macros (such as those that add arrowheads) treat the +beginning and the end of a path differently, or adjust their behavior +according to the sense of the curve. + +\begin{cd}\pagelabel{regpolygon} \cs{regpolygon}\marg{\meta{num}}\marg{\meta{name}}% -\marg{\meta{eqn$_1$}}\marg{\meta{eqn$_2$}}% + \marg{\meta{eqn$_1$}}\marg{\meta{eqn$_2$}}% \index{regpolygon@\cs{regpolygon}} \end{cd} -This produces a regular polygon with \meta{num} sides. The second -argument, \meta{name} is a symbolic name. It can be used to refer to the -vertices later. The last two arguments should be equations that position -two of the vertices or one vertex and the center. The center is refered -to by \meta{name}\gbc{0} and the vertices by \meta{name}\gbc{1} -\meta{name}\gbc{2}, etc., going anticlockwise around the polygon. The -\meta{name} itself (without a number) will be a \MF{} variable assigned -the value of \meta{num}. For example, -\begin{ex} -\cs{regpolygon}\marg{5}\marg{Meg}\marg{Meg0=(0,1)}\marg{Meg1=(2,0)} -\end{ex} +This figure macro produces a closed regular polygon with \meta{num} +sides. The second argument, \meta{name} is a symbolic name. It can be +used to refer to the vertices later. The last two arguments should be +equations that position two of the vertices or one vertex and the +center. The center is referred to by \meta{name}\gbc{0} and the vertices +by \meta{name}\gbc{1} \meta{name}\gbc{2}, etc., going anticlockwise +around the polygon. The \meta{name} itself (without a number suffixed) +will be a \MF{} variable assigned the value of \meta{num}. For example, +\begin{verbatim} +\regpolygon{5}{Kay}{Kay0=(0,1)}{Kay1=(2,0)} +\end{verbatim} will produce a regular pentagon with its center at $(0,1)$ and its first vertex at $(2,0)$. One could later draw a star inside it with -\begin{ex} -\cs{polygon}\marg{Meg1,Meg3,Meg5,Meg2,Meg4} -\end{ex} -Moreover, \gbc{Meg} will equal $5$. -The name given becomes a \MF{} variable and care should be taken to make -the name distinctive so as not to redefine some internal variable. +\begin{verbatim} +\polygon{Kay1,Kay3,Kay5,Kay2,Kay4} +\end{verbatim} +Moreover, \gbc{Kay} will equal $5$. The name given becomes a \MF{} +variable and care should be taken to make the name distinctive so as not +to redefine some internal variable. -\subsubsection{A Word on List Arguments}\label{list} +\subsection{A word about list arguments}\label{list} We have seen already four \mfp{} macros that take a mandatory argument -consisting of a list of coordinate pairs. There are many more, and some -that take a comma-separated lists of other types of items. If the lists -are long, especially if they are generated by a program, it might be -more convenient if one could simply refer to an external file for the -data. This is possible, and one does it the following way: instead of -\cs{lines}\marg{\meta{list}}, one can write\index{datafile@\cs{datafile}} +consisting of an arbitrary number of coordinate pairs, separated by +commas. There are many more, and some that take a comma-separated list +of items of other types. If the lists are long, especially if they are +generated by a program, it might be more convenient if one could simply +refer to an external file for the data. This is possible, and one does +it the following way: instead of \cs{polyline}\marg{\meta{list}}, one +can write\index{datafile@\cs{datafile}} \begin{ex} -\cs{lines}\cs{datafile}\marg{\meta{filename}} + \cs{polyline}\cs{datafile}\marg{\meta{filename}} \end{ex} where \meta{filename} is the full name of the file containing the data. The required format of this file and the details of this usage can be found in subsection~\ref{external}. This method is available for any -command that takes a comma-separated list of data as its last argument, -\emph{with the exception of those commands that adds text to the -picture}. Examples of the latter are \cs{plottext} and \cs{axislabels} -(subsection~\ref{text}). +command that takes a comma-separated list of data (of arbitrary length) +as its last argument, \emph{with the exception of those commands that +add text to the picture}. Examples of the latter are \cs{plottext} and +\cs{axislabels} (subsection~\ref{text}). -\subsubsection{Axes, Axis Marks, and Grids.}\label{axes} -\begin{cd} +\subsection{Axes, axis marks, and grids}\label{axesthings} + +\begin{cd}\pagelabel{axes} \cs{axes}\oarg{\meta{hlen}}\\ \cs{xaxis}\oarg{\meta{hlen}}\\ \cs{yaxis}\oarg{\meta{hlen}}% @@ -893,40 +1174,63 @@ macro (section~\ref{modifier}). The color of the head is the value of \gbc{headcolor}, the shaft is \gbc{drawcolor}. Unlike other commands that produce lines or curves, these do not respond -to the prefix macros of sections \ref{modifier}~and \ref{rendering}. -They always draw a solid line (with an arrowhead unless \cs{axisheadlen} -is \dim{0pt}). They \emph{do} respond to changes in the pen thickness -(see \cs{penwd} in section~\ref{parameters}) but that is pretty much the -only possibility for variation. +to prefix macros. They always draw a solid line (with an arrowhead +unless \cs{axisheadlen} is \dim{0pt}). They \emph{do} respond to changes +in the pen thickness (see \cs{penwd} in section~\ref{parameters}) but +that is pretty much the only possibility for variation. -\begin{cd} +\begin{cd}\pagelabel{axis} \cs{axis}\oarg{\meta{hlen}}\marg{\meta{one-axis}}\\ \cs{doaxes}\oarg{\meta{hlen}}\marg{\meta{axis-list}}% -\index{axis@\cs{axis}} -\index{doaxes@\cs{doaxes}} +\index{axis@\cs{axis}}% +\index{doaxes@\cs{doaxes}}% \end{cd} These produce any of 6 different axes. The parameter \meta{one-axis} can -be \texttt{x} or \texttt{y}, to produce (almost) the equivalent of \cs{xaxis} -and \cs{yaxis}; or it can be \texttt{l}, \texttt{b}, \texttt{r}, or \texttt{t} to -produce an axis on the border of the picture (left, bottom, right or -top, respectively). \cs{doaxes} takes a list of any or all of the six -letters (with either spaces or nothing in between) and produces the -appropriate axes. Example: \cs{doaxes}\marg{lbrt}. The optional argument -sets the length of the arrowhead. In the case of axes on the edges, the -default is the value of \cs{sideheadlen}, which \mfp{} -initializes to \dim{0pt}. For the $x$- and $y$-axis the default is -\cs{axisheadlen} as in \cs{xaxis} and \cs{yaxis} above. +be \texttt{x} or \texttt{y}, to produce (almost) the equivalent of +\cs{xaxis} and \cs{yaxis}; or it can be \texttt{l}, \texttt{b}, +\texttt{r}, or \texttt{t} to produce an axis on the border of the +picture (left, bottom, right or top, respectively). \cs{doaxes} takes a +list of any or all of the six letters (with either spaces or nothing in +between) and produces the appropriate axes. Example: +\cs{doaxes}\marg{lbrt}. The optional argument sets the length of the +arrowhead. In the case of axes on the edges, the default is the value of +\cs{sideheadlen}, which \mfp{} initializes to \dim{0pt}. For the $x$- +and $y$-axis the default is \cs{axisheadlen} as in \cs{xaxis} and +\cs{yaxis} above. The commands \cs{axis}\marg{x}, \cs{axis}\marg{y}, and \cs{doaxes}\marg{xy} differ from the old \cs{xaxis}, \cs{yaxis} and -\cs{axes} in that these new versions respond to changes made by -\cs{setrender} (see subsection~\ref{default}). Moreover, prefix macros -may be applied to \cs{axis} without error (see sections -\ref{modifier}~and \ref{rendering}): \cs{dotted}\cs{axis}\marg{x} draws -a dotted $x$-axis, but \cs{dotted}\cs{xaxis} produces a \MF{} error. A -prefix macro applied to \cs{doaxes} generates no error, but only the -first axis in the list will be affected. +\cs{axes} in that these new versions respond to prefix macros. The +\cs{arrow} prefix previously mentioned is an exception: these macros add +an arrowhead automatically. For example, the sequence +\cs{dotted}\cs{axis}\marg{x} draws a dotted $x$-axis, but +\cs{dotted}\cs{xaxis} produces a \MF{} error. A prefix macro applied to +\cs{doaxes} generates no error, but only the first axis in the list will +be affected. + +\begin{cd}\pagelabel{axisline} +\cs{axisline}\marg{\meta{one-axis}}\\ +\cs{border}% +\index{axisline@\cs{axisline}}% +\index{border@\cs{border}}% +\end{cd} + +These are figure macros that draw the line or lines that an \cs{axis} +command would draw. An \cs{axis} command is almost the equivalent of +\begin{display} +\cs{arrow}\oarg{l\meta{hlen}}\cs{axisline}\marg{\meta{one-axis}}. +\end{display} +The \cs{axisline} command is provided as a figure macro for maximum +flexibility. For example, one can use the star-form of the \cs{arrow} +command if desired or decorate it with ones own choice of arrowhead (see +subsection~\ref{arrows}). + +Also a figure macro, \cs{border} produces the rectangle which, if drawn, +is visibly the same as the four border \cs{axisline}\,s (without heads). +It is a closed path and could easily be drawn with a \cs{rect} command, +but the \cs{border} command automatically adjusts for the margins set by +the commands below. The side axes are drawn by default with a pen stroke along the very edge of the picture (as determined by the parameters to \cs{mfpic}). This can @@ -934,47 +1238,52 @@ be changed with the command \cs{axismargin} described below. Axes on the edges are drawn so that they don't cross each other. \cs{doaxes}\marg{lbrt}, for example, produces a perfect rectangle. If the -$x$- and $y$-axis are drawn with \cs{axis} or \cs{doaxis}, then they +$x$- and $y$-axis are drawn with \cs{axis} or \cs{doaxes}, then they will not cross the side axes. For this to work properly, all the following margin settings have to be done before the axes are drawn. -\begin{cd} -\cs{axismargin}\marg{\meta{axis}}\marg{\meta{num}}\\ -\cs{setaxismargins}\marg{\meta{num}}\marg{\meta{num}}\marg{\meta{num}}\marg{\meta{num}}\\ +\begin{cd}\pagelabel{axismargin} +\cs{axismargin}\marg{\meta{one-axis}}\marg{\meta{num}}\\ +\cs{setaxismargins}% + \marg{\meta{num}}\marg{\meta{num}}\marg{\meta{num}}\marg{\meta{num}}\\ \cs{setallaxismargins}\marg{\meta{num}}% \index{axismargin@\cs{axismargin}}% \index{setaxismargins@\cs{setaxismargins}}% -\index{setallaxismargins@\cs{setallaxismargins}} +\index{setallaxismargins@\cs{setallaxismargins}}% \end{cd} -The \meta{axis} is one of the letters \texttt{l}, \texttt{b}, \texttt{r}, or \texttt{ -t}. \cs{axismargin} causes the given axis to be shifted \emph{inward} by -the \meta{num} specified (in \emph{graph} coordinates). The second -command \cs{setaxismargins} takes 4 arguments, using them to set the -margins starting with the left and proceeding anticlockwise. The last -command sets all the axis margins to the same value. +The parameter \meta{one-axis} is one of the letters \texttt{l}, +\texttt{b}, \texttt{r}, or \texttt{ t}, and \cs{axismargin} causes the +given axis to be shifted \emph{inward} by the \meta{num} specified (in +\emph{graph} units). The second command \cs{setaxismargins} takes +4 arguments, using them to set the margins starting with the left and +proceeding anticlockwise. The last command sets all the axis margins to +the same value. A change to an axis margin affects not only the axis at that edge but also the three axes perpendicular to it. For example, if the margins are $M_{\mathrm{lft}}$, $M_{\mathrm{bot}}$, $M_{\mathrm{rt}}$ and -$M_{\mathrm{top}}$, then -\cs{axis b} draws a line starting $M_{\mathrm{lft}}$ graph units from the -left edge and ending $M_{\mathrm{rt}}$ units from the right edge. Of course, -the entire line is $M_{\mathrm{bot}}$ units above the bottom edge. The -margins are also respected by the $x$- and $y$-axis, but only when drawn -with \cs{axis}. The old \cs{xaxis}, \cs{yaxis} and \cs{axes} ignore -them. +$M_{\mathrm{top}}$, then \cs{axis}\marg{b} draws a line starting +$M_{\mathrm{lft}}$ graph units from the left edge and ending +$M_{\mathrm{rt}}$ units from the right edge. Of course, the entire line +is $M_{\mathrm{bot}}$ units above the bottom edge. The margins are also +respected by the $x$- and $y$-axis, but only when drawn with \cs{axis}. +The old \cs{xaxis}, \cs{yaxis} and \cs{axes} ignore them. Special effects can be achieved by lying to one axis about the other -margins. +margins. That is, axes can be draw in separate commands with changes to +the declared margins in between. Be aware that various other commands +are affected by the margin values. Examples are the already mentioned +\cs{border}, as well as \cs{grid} and \cs{gridlines} +(page~\pageref{grid} in this subsection). -\begin{cd} +\begin{cd}\pagelabel{axismarks} \cs{xmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ -\cs{tmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ -\cs{bmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ \cs{ymarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ \cs{lmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ +\cs{bmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ \cs{rmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ +\cs{tmarks}\oarg{\meta{len}}\marg{\meta{numberlist}}\\ \cs{axismarks}\marg{\meta{axis}}\oarg{\meta{len}}\marg{\meta{numberlist}}% \index{xmarks@\cs{xmarks}}% \index{tmarks@\cs{tmarks}}% @@ -995,31 +1304,40 @@ changed (see below). The commands may be repeated as often as desired. (The timing of drawing commands can make a difference as outlined in appendix~\ref{mpconsiderations}.) The command \cs{axismarks}\marg{x} is equivalent to \cs{xmarks} and so on for each of the six axes. (I would -have used \cs{marks}, but e\kern-.16em\TeX{} makes that a primitive.) +have used the shorter name \cs{marks}, but that name was already taken +by e\kern-.16em\TeX{}.) The \meta{numberlist} is normally a comma-separated list of numbers. In place of this, one can give a starting number, an increment and an ending number as in the following example: -\begin{ex} - \cs{xmarks}\marg{-2 step 1 until 2} -\end{ex} +\begin{verbatim} +\xmarks{-2 step 1 until 2} +\end{verbatim} is the equivalent of -\begin{ex} - \cs{xmarks}\marg{-2,-1,0,1,2} -\end{ex} +\begin{verbatim} +\xmarks{-2,-1,0,1,2} +\end{verbatim} -One must use exactly the words \mfc{step} and \mfc{until}. There must be -spaces between, but the number of spaces is not +One must use exactly the words \mfc{step} and \mfc{until}. Spaces are +not needed unless a variable name is used in place of one of the +numbers (see subsection~\ref{variables}). The number of spaces is not significant.% \footnote{Experienced \MF{} programmers may recognize that anything - can be used that is permitted in \MF's \meta{forloop} syntax. Thus + can be used that is permitted in \MF{}'s \meta{forloop} syntax. Thus the given example can also be reworded \cs{xmarks}\marg{-2 upto 2}, - or even \cs{xmarks}\marg{2 downto -2}} % -Users should be aware that if any of the numbers are non-integral then -due to natural round-off effects, the last value might be overshot and a -mark not printed there. + or even \cs{xmarks}\marg{2 downto -2}. See subsection~\ref{loops} + for more on for-loops in \mfp{}.} % +Users of this syntax should be aware that if any of the numbers is not +an integer then, because of natural round-off effects, the last value +might be overshot and a mark not printed there. For example, to ensure +that a mark is printed at the point $1.0$ on the $x$-axis, the second +line below is better than the first. +\begin{verbatim} +\xmarks{0 step .2 until 1.0} +\xmarks{0 step .2 until 1.1} +\end{verbatim} -\begin{cd} +\begin{cd}\pagelabel{setaxismarks} \cs{setaxismarks}\marg{\meta{axis}}\marg{\meta{pos}}\\ \cs{setbordermarks}\marg{\meta{lpos}}\marg{\meta{bpos}}\marg{\meta{rpos}}\marg{\meta{tpos}}\\ \cs{setallbordermarks}\marg{\meta{pos}}\\ @@ -1045,22 +1363,21 @@ value. The last two commands are abbreviations for Not all combinations make sense (for example, \cs{setaxismarks}\marg{r}\marg{ontop}). In these cases, no error message -is produced: \gbc{ontop} and \gbc{onleft} are considered to be -equivalent, as are \gbc{onbottom} and \gbc{onright}. The parameters -\gbc{inside} and \gbc{outside} make no sense for the $x$- and $y$-axes, -but if they are used then \gbc{inside} means \gbc{ontop} for the -$x$-axis and \gbc{onright} for the $y$-axis. These words are actually -\MF{} numeric variables defined in the file \file{grafbase.mf}, and the -variables \gbc{ontop} and \gbc{onleft}, for example, are given the same -value. - -\begin{cd} -\cs{grid}\oarg{\meta{ptsize}}\marg{\meta{xsep},\meta{ysep}}\\ -\cs{gridpoints}\oarg{\meta{ptsize}}\marg{\meta{xsep},\meta{ysep}}\\ -\cs{lattice}\oarg{\meta{ptsize}}\marg{\meta{xsep},\meta{ysep}}\\ +is produced: \gbc{ontop} and \gbc{onleft} give the same results, as do +\gbc{onbottom} and \gbc{onright}. The parameters \gbc{inside} and +\gbc{outside} make no sense for the $x$- and $y$-axes, but if they are +used then \gbc{inside} means \gbc{ontop} for the $x$-axis and +\gbc{onright} for the $y$-axis. These words are actually \MF{} numeric +variables and the variables \gbc{ontop} and \gbc{onleft}, for example, +have the same value. + +\begin{cd}\pagelabel{grid} +\cs{grid}\oarg{\meta{size}}\marg{\meta{xsep},\meta{ysep}}\\ +\cs{gridpoints}\oarg{\meta{size}}\marg{\meta{xsep},\meta{ysep}}\\ +\cs{lattice}\oarg{\meta{size}}\marg{\meta{xsep},\meta{ysep}}\\ \cs{hgridlines}\marg{\meta{ysep}}\\ \cs{vgridlines}\marg{\meta{xsep}}\\ -\cs{gridlines}\marg{\meta{xsep},\meta{ysep}} +\cs{gridlines}\marg{\meta{xsep},\meta{ysep}}% \index{grid@\cs{grid}}% \index{gridpoints@\cs{gridpoints}}% \index{lattice@\cs{lattice}}% @@ -1072,26 +1389,29 @@ value. \cs{grid} draws a dot at every point for which the first coordinate is an integer multiple of the \meta{xsep} and the second coordinate is an integer multiple of \meta{ysep}. The diameter of the dot is determined -by \meta{ptsize}. The default is \dim{.5bp} and is hard coded in the -\MF{} macros that ultimately do the drawing. Under the \opt{metapost} -option, the color of the dot is \gbc{pointcolor}. The commands -\cs{gridpoints and \cs{lattice}} are synonyms for \cs{grid}. +by \meta{size}. The default is the value of \cs{griddotsize}, +initially \dim{0.5pt}. Under the \opt{metapost} option, the color of the +dot is \gbc{pointcolor}. The commands \cs{gridpoints and \cs{lattice}} +are synonyms for \cs{grid}. \cs{hgridlines} draws the horizontal and \cs{vgridlines} the vertical lines through these same points. \cs{gridlines} draws both sets of lines. The thickness of the lines is set by \cs{penwd}. Authors are recommended to either reduce the pen width or change \gbc{drawcolor} to -a lighter color for grids. Or omit them entirely: well-designed graphs -usually don't need them and almost never should both horizontals and -verticals be used. +a lighter color for grid lines. Or omit them entirely: well-designed +graphs usually don't need them and almost never should both horizontals +and verticals be used. -\begin{cd} +The above commands draw their dots and lines within the margins set by the +axis margin commands on page~\pageref{axismargin}. + +\begin{cd}\pagelabel{plrgrid} \cs{plrgrid}\marg{\meta{rsep},\meta{anglesep}}\\ \cs{gridarcs}\marg{\meta{rsep}}\\ \cs{gridrays}\marg{\meta{anglesep}}\\ \cs{plrpatch}\marg{\meta{rmin},\meta{rmax},\meta{rsep},% \meta{tmin},\meta{tmax},\meta{tsep}}\\ -\cs{plrgridpoints}\marg{\meta{rsep},\meta{anglesep}}% +\cs{plrgridpoints}\oarg{\meta{size}}\marg{\meta{rsep},\meta{anglesep}}% \index{plrgrid@\cs{plrgrid}}% \index{plrpatch@\cs{plrpatch}}% \index{gridarcs@\cs{gridarcs}}% @@ -1101,14 +1421,17 @@ verticals be used. \cs{plrgrid} fills the graph with circular arcs and radial lines. \cs{gridarcs} draws only the arcs, \cs{gridrays} only the radial lines. -\cs{plrgridpoints} places a dot at all the places the rays and arcs -would intersect. - -The arcs are centered at $(0,0)$ and the lines emanate from $(0,0)$ -(even if $(0,0)$ is not in the graph space). The corresponding \MF{} -commands actually draw enough to cover the graph area and then clip them -to the graph boundaries. If you don't want them clipped, use -\cs{plrpatch}. +\cs{plrgridpoints} places a dot (diameter \meta{size}) at all the places +the rays and arcs would intersect. It takes an optional argument for the +size of the dots, the default being \cs{griddotsize}, the same as the +\cs{grid} command. + +The arcs lie on circles centered at $(0,0)$ and the rays would all meet +at $(0,0)$ if extended. The corresponding \MF{} commands actually draw +just enough to cover the graph area and then clip them to the graph +boundaries. If you don't want them clipped, use \cs{plrpatch}. Unlike +the rectangular coordinate grid commands, these do not respect the axis +margins (rectangular margins don't really belong with polar coordinates). \cs{plrpatch} draws arcs with radii starting at \meta{rmin}, stepping by \meta{rsep} and ending with \meta{rmax}. Each arc goes from angle @@ -1126,80 +1449,283 @@ the boundary rays will be drawn. If \meta{rsep} is larger than drawn. The color used for rays and arcs is \gbc{drawcolor}, and for dots -\gbc{pointcolor}. The advice about \cs{gridlines} holds for \cs{plrgrid} -as well. +\gbc{pointcolor}. The advice about color and use of \cs{gridlines} holds +for \cs{plrgrid} and its relatives as well. + +\begin{cd}\pagelabel{vectorfield} +\cs{vectorfield}\oarg{\meta{hlen}}\marg{\meta{xsp},\meta{ysp}}% +\marg{\meta{formula}}\marg{\meta{restriction}}\\ +\cs{plrvectorfield}\oarg{\meta{hlen}}\marg{\meta{rsp},\meta{tsp}}% +\marg{\meta{formula}}\marg{\meta{restriction}}% +\index{vectorfield@\cs{vectorfield}}% +\index{plrvectorfield@\cs{plrvectorfield}} +\end{cd} + +These commande draw a field of vectors (arrows). The optional argument +is the length of the arrowhead, the default being the dimension +\cs{headlen}, initially \dim{3pt}. + +For \cs{vectorfield}, an arrow is drawn starting from each point $(x,y)$ +where $x$ is an integer multiple of \meta{xsp} and $y$ is an integer +multiple of \meta{ysp}. The vector field is given by \meta{formula}, +which should be a pair-valued expression in the literal variables +\mfc{x} and \mfc{y}. Typically that would be a pair of numeric +expressions enclosed in parentheses and separated by a comma. The last +argument is a boolean expression in the literal variables \mfc{x} and +\mfc{y}, used to restrict the domain. That is, if the expression is +false for some $(x,y)$, no arrow is drawn at that point. If you do not +wish to restrict the domain, type \texttt{true} for the restriction. + +For \cs{plrvectorfield}, an arrow is drawn starting from each point with +polar coordinates $(r,\theta)$ if $r$ is an integer multiple of +\meta{rsp} and $\theta$ is an integer multiple of \meta{tsp}. In this +case, the \meta{formula} must be a pair-valued expression in the literal +variables \mfc{r} and \mfc{t}. This should be (or produce) a pair of $x$ +and $y$ coorinates, not a polar coordinate pair. If you have formulas +$R(r,\theta)$ for the length of each vector and $T(r,\theta)$ for the +angle, then the following will convert to $(x,y)$ pairs: +\begin{verbatim} +{polar (R(r,t),T(r,t))} +\end{verbatim} +The last argument is as in \cs{vectorfield}, except it should depend on +the literal variables \mfc{r} and \mfc{t}. +In either case, the arrow is not drawn if the starting point would lie +within the margins set with \cs{axismargins} and its relatives. -\subsubsection{Circles and Ellipses.}\label{circles} +The following draws a rotational field, omitting the inside of the +circle of radius $1$, where the arrows would be excessively long, and +especially avoiding $(0,0)$ where the vector field is undefined. +\begin{verbatim} +\vectorfield[2.5pt]{.25,.25}{.5*(-y,x)/(x**2 + y**2)}{x**2 + y**2 >= 1} +\end{verbatim} +The following is the same field, represented by arrows whose locations +are regularly spaced in polar coordinates. +\begin{verbatim} +\plrvectorfield[2.5pt]{.25,20}{polar(.5/r,t+90)}{r >= 1} +\end{verbatim} -\begin{cd} + +\subsection{Circles, arcs and ellipses}\label{circles} + +\begin{cd}\pagelabel{circle} \cs{circle}\oarg{\meta{format}}\marg{\meta{specification}}% \index{circle@\cs{circle}}% \end{cd} -Draws a circle. Starting with \mfp{} version 0.7, there are 4 -different ways to specify a circle, so \cs{circle} can be given an -optional argument that determines what data is specified in the -mandatory argument. +This figure macro produces a circle. Starting with \mfp{} version 0.7, +there are more than one way to specify a circle. In version 0.8 and +later there are six ways, and one selects which one by giving +\cs{circle} an optional argument that signals what data will be +specified in the mandatory argument. \begin{cd} \cs{circle}\oarg{p}\marg{\meta{$c$},\meta{$r$}}\\ \cs{circle}\oarg{c}\marg{\meta{$c$},\meta{$p$}}\\ \cs{circle}\oarg{t}\marg{\meta{$p_1$},\meta{$p_2$},\meta{$p_3$}}\\ -\cs{circle}\oarg{s}\marg{\meta{$p_1$},\meta{$p_2$},\meta{$\theta$}}% +\cs{circle}\oarg{s}\marg{\meta{$p_1$},\meta{$p_2$},\meta{$\theta$}}\\ +\cs{circle}\oarg{r}\marg{\meta{$p_1$},\meta{$p_2$},\meta{$r$}}\\ +\cs{circle}\oarg{q}\marg{\meta{$p_1$},\meta{$p_2$},\meta{$r$}}% \index{circle@\cs{circle}}% \end{cd} The optional arguments produce circles according to the following descriptions. - \begin{description} \item[\oarg{p}] The \textit{Polar form} is the default. The data in the -mandatory argument should then be the center $c$ and radius $r$ of the -circle. +mandatory argument should then be the center \meta{c} and radius +\meta{r} of the circle. -\item[\oarg{c}] The \textit{Center-point form}. In this case the data +\item[\oarg{c}] The \textit{center-point form}. In this case the data should be the center and one point on the circumference. -\item[\oarg{t}] The \textit{Three-point form}. The data are three points +\item[\oarg{t}] The \textit{three-point form}. The data are three points that do not lie in a straight line. -\item[\oarg{s}] The \textit{point-sweep}. The data are two points on the +\item[\oarg{s}] The \textit{point-sweep form}. The data are two points on the circle, followed by the angle of arc between them. + +\item[\oarg{r}] The \textit{point-radius form}. The data are two points on the +circle, followed by the radius. There are two circles with this data. +The one that makes the angle from the first to the second point positive +and less than 180 degrees is produced. + +\item[\oarg{q}] The \textit{alternate point-radius form}. The data are +the same as for the \oarg{r} case, except the other circle is produced. \end{description} These optional arguments are also used in the \cs{arc} command (see -subsection~\ref{arcs}). The \cs{circle} command draws the whole circle -which the equivalent \cs{arc} command draws only part of. The sense of -the circle produced is anticlockwise except in the case \texttt{[t]}, -where it is the direction determined by the order of the three points, -and the case \texttt{[s]}, where it is determined by \meta{$\theta$}: -clockwise if negative, anticlockwise if positive. +below). The \cs{circle} command draws the whole circle of which the +corresponding \cs{arc} command draws only a part. The sense of the +circle produced is anticlockwise except in the case \texttt{[t]}, where +it is the direction determined by the order of the three points, and the +case \texttt{[s]}, where it is determined by \meta{$\theta$}: clockwise +if negative, anticlockwise if positive. +\begin{cd}\pagelabel{arc} +\cs{arc}\oarg{\meta{format}}\marg{\meta{specification}}\\ +\cs{arc*}\oarg{\meta{format}}\marg{\meta{specification}}% +\index{arc@\cs{arc}}% +\end{cd} + +This figure macro produces a circular arc specified as determined by the +\meta{format} optional parameter. As with \cs{circle}, the optional +\meta{format} parameter determines the format of the other parameter, as +indicated below. The user is responsible for ensuring that the parameter +values make geometric sense. The starting point of each arc is at the +first specified angle or point and the ending point is at the last one. + +The star-form produces the complementary arc. That is, instead of the +arc described below, it produces the rest of the circle from the ending +point to the starting point of the arc described. + \begin{cd} +\cs{arc}\oarg{s}\marg{\meta{$p_0$},\meta{$p_1$},\meta{$\theta$}}\\ +\cs{arc}\oarg{p}\marg{\meta{$c$},\meta{$\theta_1$},\meta{$\theta_2$},\meta{$r$}}\\ +\cs{arc}\oarg{a}\marg{\meta{$c$},\meta{$r$},\meta{$\theta_1$},\meta{$\theta_2$}}\\ +\cs{arc}\oarg{c}\marg{\meta{$c$},\meta{$p_1$},\meta{$\theta$}}\\ +\cs{arc}\oarg{t}\marg{\meta{$p_0$},\meta{$p_1$},\meta{$p_2$}}\\ +\cs{arc}\oarg{r}\marg{\meta{$p_0$},\meta{$p_1$},\meta{$r$}}\\ +\cs{arc}\oarg{q}\marg{\meta{$p_0$},\meta{$p_1$},\meta{$r$}}% +\index{arc@\cs{arc}}% +\end{cd} + +The optional arguments produce arcs according to the following +descriptions. +\begin{description} +\item[\oarg{s}] The \textit{point-sweep form} is the default format. It +draws the circular arc starting from the point \meta{$p_0$}, ending at +the point \meta{$p_1$}, and covering an arc angle of \meta{$\theta$} +degrees, measured anticlockwise around the center of the circle. If, +for example, the points \meta{$p_0$} and \meta{$p_1$} lie on a +horizontal line with \meta{$p_0$} to the \emph{left}, and \meta{$\theta$} +is between 0~and 360 (degrees), then the arc will sweep \emph{below} the +horizontal line (in order for the arc to be anticlockwise). A +negative value of \meta{$\theta$} gives a clockwise arc from \meta{$p_0$} +to \meta{$p_1$}. + +\item[\oarg{p}] The \textit{polar form} draws the arc of a circle with +center \meta{$c$} starting at the angle \meta{$\theta_1$} and ending at +the angle \meta{$\theta_2$}, with radius \meta{$r$}. Both angles are +measured anticlockwise from the positive $x$ axis. + +\item[\oarg{a}] The \textit{alternate polar form} draws the arc of a +circle with center \meta{$c$} and radius \meta{$r$}, starting at the +angle \meta{$\theta_1$} and ending at the angle \meta{$\theta_2$}. Both +angles are measured anticlockwise from the positive $x$ axis. This is +provided because it seems a more reasonable order of arguments, and +matches the order \cs{sector} requires (see below). The \texttt{p} +option is retained for backward compatibility. + +\item[\oarg{c}] The \textit{center-point-angle form} draws the circular +arc with center \meta{$c$}, starting at the point \meta{$p_1$}, and +sweeping an angle of \meta{$\theta$} around the center from that point. +(This and the point sweep form are the basic methods of handling +arcs---the previous three formats are translated to one of these two +before drawing.) + +\item[\oarg{t}] The \textit{three-point form} draws the circular arc +which passes through all three points given, in the order given. +Internally, this is converted to two applications of the point-sweep +form. + +\item[\oarg{r}] The \textit{point-radius form} draws the circular arc +starting at the point \meta{$p_0$}, ending at \meta{$p_1$}, +with radius \meta{$r$}. Of the four possible arcs on two possible +circles, it produces the one that covers an arc angle $\theta$ +no more than $180$ degrees measured anticlockwise around the center +of the circle. To get the similar arc on the other circle, reverse the +order of the points. + +\item[\oarg{q}] The \textit{alternate point-radius form} is the same as +\oarg{r} except it produces the arc that covers an angle $\theta$ +\emph{no less than} $180$ degrees measured anticlockwise around the +center of the circle. To get the similar arc on the other circle, +reverse the order of the points. + +For both options \oarg{r} and \oarg{q}, if the radius is less than half +the distance between the points, then no such arc exists. In this case, +the command uses a radius equal to half the distance. The difference +between negating the radius and reversing the points is the sense of +the resulting path: it always starts at the first point and ends at the +second. +\end{description} + +\begin{cd}\pagelabel{sector} +\cs{sector}\marg{\meta{$c$},\meta{$r$},\meta{$\theta_1$},\meta{$\theta_2$}}% +\index{sector@\cs{sector}}% +\end{cd} + +This figure macro produces the sector of the circle with center at the +point \meta{$c$} and radius \meta{$r$}, from the angle \meta{$\theta_1$} +to the angle \meta{$\theta_2$}. Both angles are measured in degrees +anticlockwise from the direction parallel to the $x$ axis. The sector +forms a closed path. \emph{Note}: \cs{sector} and \cs{arc}\oarg{p} have +the same parameters, but \emph{in a different order}.% + \footnote{This apparently was unintended, but we now have to live + with it so as not to break existing \file{.tex} files.} + + +\begin{cd}\pagelabel{ellipse} \cs{ellipse}\oarg{\meta{$\theta$}}\marg{\meta{$c$},\meta{$r_x$},\meta{$r_y$}}% \index{ellipse@\cs{ellipse}}% \end{cd} -Draws an ellipse with the $x$ radius \meta{$r_x$} and $y$ radius -\meta{$r_y$}, centered at the point \meta{$c$}. The optional parameter -\meta{$\theta$} provides a way of rotating the ellipse by -\meta{$\theta$} degrees anticlockwise around its center. +This figure macro produces an ellipse with the $x$ radius \meta{$r_x$} +and $y$ radius \meta{$r_y$}, centered at the point \meta{$c$}. The +optional parameter \meta{$\theta$} provides a way of rotating the +ellipse by \meta{$\theta$} degrees anticlockwise around its center. +Ellipses may also be created by differentially scaling a circle and +perhaps rotating the result. See subsection~\ref{transformation}. -\subsubsection{Curves.}\label{curves} +When dealing with arcs and circles, it is useful to work in polar +coordinates: -\begin{cd} -\cs{curve}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% +\begin{cd}\pagelabel{plr} +\cs{plr}\marg{(\meta{$r_0$},\meta{$\theta_0$}),% + (\meta{$r_1$},\meta{$\theta_1$}), $\ldots$}% +\index{plr@\cs{plr}}% +\end{cd} + +The macro \cs{plr} causes \MF{} to replace the specified list of polar +coordinate pairs by the equivalent list of rectangular (cartesian) +coordinate pairs. Through \cs{plr}, commands designed for rectangular +coordinates can be applied to data represented in polar coordinates. It +must be cautioned that this wholesale conversion of a list applies only +to commands that take a list consisting of an arbitrary number of +points, such as \cs{polyline}. + +The effect of \cs{plr} is to apply a \MF{} command, \gbc{polar}, to each +point in the list, producing a new list. This \MF{} command can also be +used separately in any situation where a \MF{} point is required. For +example, to connect the point $(2,3)$ to the point with polar +coordinates $(1, 135)$ write +\begin{verbatim} +\polyline{(2,3),polar(1,135)} +\end{verbatim} + + +\subsection{Curves}\label{curves} + +\begin{cd}\pagelabel{curve} +\cs{curve}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ +\cs{cyclic}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ +\cs{closedcurve}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% \index{curve@\cs{curve}}% +\index{cyclic@\cs{cyclic}} +\index{closedcurve@\cs{closedcurve}}% \end{cd} -Draws a smooth path through the specified points, in the specified -order. It is `smooth' in two ways: it never changes direction abruptly -(no `corners' or `cusps' on the curve), and it tries to make turns that are -not too sharp. This latter property is acheived by specifying (to \MF) that -the tangent to the curve at each listed point is to be parallel to the -line from that point's predecessor to its successor. +These figure macros produce a smooth path through the specified points, +in the specified order. It is `smooth' in two ways: it never changes +direction abruptly (no `corners' or `cusps' on the curve), and it tries +to make turns that are not too sharp. This latter property is acheived +by specifying (to \MF{}) that the tangent to the curve at each listed +point is to be parallel to the line from that point's predecessor to its +successor. The \cs{cyclic} variant arranges for the last point to be +connected (smoothly) to the first, and produces a closed \MF{} B\'ezier +curve. The command \cs{closedcurve} is an alias for \cs{cyclic}. The optional \meta{tension} influences \emph{how} smooth the curve is. The special value \mfc{infinity} (in fact, usually anything greater than @@ -1209,7 +1735,7 @@ the flatter the portions in between. \CMF{} requires the tension to be larger than 0.75. The default value of the tension is $1$ when \mfp{} is loaded, but that can be changed with the following command. -\begin{cd} +\begin{cd}\pagelabel{settension} \cs{settension}\marg{\meta{num}}% \index{settension@\cs{settension}} \end{cd} @@ -1217,164 +1743,81 @@ loaded, but that can be changed with the following command. This sets the default tension for all commands that take an optional tension parameter. -\begin{cd} -\cs{cyclic}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% -\index{cyclic@\cs{cyclic}}% +Sometimes one would like a convex set of points to produce a convex +curve. This will not always be the case with \cs{curve} or \cs{cyclic}. +You can verify this with the following example, where the list of points +traces a rectangle: +\begin{verbatim} +\cyclic{(0,0),(0,1),(1,1),(2,1),(2,0),(0,0)} +\end{verbatim} +To produce a convex curve, use one of the following: + +\begin{cd}\pagelabel{convexcurve} +\cs{convexcurve}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ +\cs{convexcyclic}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}\\ +\cs{closedconvexcurve}\oarg{\meta{tension}}\marg{\meta{$p_0$},\meta{$p_1$},$\ldots$}% +\index{convexcurve@\cs{convexcurve}}% +\index{convexcyclic@\cs{convexcyclic}}% +\index{closedconvexcurve@\cs{closedconvexcurve}}% \end{cd} -Draws a cyclic (i.e., closed) \MF{} B\'ezier curve through the specified -points, in the specified order. It uses the same procedure as -\cs{curve}, but treats the first listed point as having the last as its -predecessor and the last point has the first as its successor. The -\meta{tension} is as in the \cs{curve} command. +These figure macros can be used even if the list of points is not +convex, and the result will be convex where possible. The third one is +an alias for for the second one. \medskip Occasionally it is necessary to specify a sequence of points with -\emph{increasing} $x$ coordinates and draw a curve through them. One +\emph{increasing} $x$-coordinates and draw a curve through them. One would then like the resulting curve both to be smooth \textit{and} to represent a function (that is, the curve always has increasing $x$ coordinate, never turning leftward). This cannot be guaranteed with the \cs{curve} command unless the tension is \texttt{infinity}. -\begin{cd} +\begin{cd}\pagelabel{fcncurve} \cs{fcncurve}\oarg{\meta{tension}}\marg{($x_0$,$y_0$),($x_1$,$y_1$),$\ldots$}% \index{fcncurve@\cs{fcncurve}}% \end{cd} -Draws a curve through the points specified. If the points are listed -with increasing (or decreasing) $x$ coordinates, the curve will also -have increasing (resp., decreasing) $x$ coordinates. The \meta{tension} -is a number equal to or greater than $1.0$ which controls how tightly +This figure macro produces a curve through the points specified. If the +points are listed with increasing (or decreasing) $x$ coordinates, the +curve will also have increasing (resp., decreasing) $x$ coordinates. The +\meta{tension} is a number greater than $1/3$ which controls how tightly the curve is drawn. Generally, the larger it is, the closer the curve is -to the polyline through the points. The default tension is typically $1.2$ -(actually $1.2$ times the value set with \cs{settension}). For those who -know something about \MF, this `tension' is not the same as the \MF{} -notion of tension, the tension in the \cs{curve} command, but it -functions in a similar fashion. In this case it can be any positive -number, but only values greater than or equal to $1$ guarantee the -property of never doubling back. - - -\subsubsection{Circular Arcs.}\label{arcs} - -\begin{cd} -\cs{arc}\oarg{\meta{format}}\marg{\meta{specification}}% -\index{arc@\cs{arc}}% -\end{cd} - -Draws a circular arc specified as determined by the \meta{format} -optional parameter. This macro and \cs{circle} are unusual in that the -optional \meta{format} parameter determines the format of the other -parameter, as indicated below. The user is responsible for ensuring that -the parameter values make geometric sense. - -\begin{cd} -\cs{arc}\oarg{s}\marg{\meta{$p_0$},\meta{$p_1$},\meta{sweep}}\\ -\cs{arc}\oarg{t}\marg{\meta{$p_0$},\meta{$p_1$},\meta{$p_2$}}\\ -\cs{arc}\oarg{p}\marg{\meta{$c$},\meta{$\theta_1$},\meta{$\theta_2$},\meta{$r$}}\\ -\cs{arc}\oarg{a}\marg{\meta{$c$},\meta{$r$},\meta{$\theta_1$},\meta{$\theta_2$}}\\ -\cs{arc}\oarg{c}\marg{\meta{$c$},\meta{$p_1$},\meta{$\theta$}}% -\index{arc@\cs{arc}}% -\end{cd} - -The optional arguments produce arcs according to the following -descriptions. -\begin{description} -\item[\oarg{s}] The \textit{point-Sweep form} is the default format. It -draws the circular arc starting from the point \meta{$p_0$}, ending at -the point \meta{$p_1$}, and covering an arc angle of \meta{sweep} -degrees, measured anticlockwise around the center of the circle. If, -for example, the points \meta{$p_0$} and \meta{$p_1$} lie on a -horizontal line with \meta{$p_0$} to the \emph{left}, and \meta{sweep} -is between 0~and 360 (degrees), then the arc will sweep \emph{below} the -horizontal line (in order for the arc to be anticlockwise). A -negative value of \meta{sweep} gives a clockwise arc from \meta{$p_0$} -to \meta{$p_1$}. - -\item[\oarg{t}] The \textit{Three-point form} draws the circular arc -which passes through all three points given, in the order given. -Internally, this is converted to two applications of the point-sweep -form. - -\item[\oarg{p}] The \textit{Polar form} draws the arc of a circle with -center \meta{$c$} starting at the angle \meta{$\theta_1$} and ending at -the angle \meta{$\theta_2$}, with radius \meta{$r$}. Both angles are -measured anticlockwise from the positive $x$ axis. - -\item[\oarg{a}] The \textit{Alternate polar form} draws the arc of a -circle with center \meta{$c$} and radius \meta{$r$}, starting at the -angle \meta{$\theta_1$} and ending at the angle \meta{$\theta_2$}. Both -angles are measured anticlockwise from the positive $x$ axis. This is -provided because it seems a more reasonable order of arguments, and -matches the order \cs{sector} requires (see subsection~\ref{other} -below). The \texttt{p} option is retained for backward compatibility. - -\item[\oarg{c}] The \textit{Center-point form} draws the circular arc with -center \meta{$c$}, starting at the point \meta{$p_1$}, and sweeping an -angle of \meta{$\theta$} around the center from that point. (This and -the point sweep form are the basic methods of handling arcs---the -previous three formats are translated to one of these two before drawing.) -\end{description} - - -\subsubsection{Other Figures.}\label{other} - -\begin{cd} +to the polyline through the points. The default tension is that set with +\cs{settension}, initially $1$. For those who know something about +\MF{}, this `tension' is not the same as the \MF{} notion of tension, +the tension in the \cs{curve} command, but it functions in a similar +fashion. In this case it can actually be any positive number, but only +values greater than $1/3$ guarantee the property of never doubling back. + +\begin{cd}\pagelabel{turtle} \cs{turtle}\marg{\meta{$p_0$},\meta{$v_1$},\meta{$v_2$},$\ldots$}% \index{turtle@\cs{turtle}}% \end{cd} -Draws a line segment, starting from the point \meta{$p_0$}, and -extending along the (2-dimen\-sional vector) displacement \meta{$v_1$}. -It then draws a line segment from the previous segment's endpoint, along -displacement \meta{$v_2$}. This continues for all listed displacements, -a process similar to `turtle graphics'. - -\begin{cd} -\cs{sector}\marg{\meta{$c$},\meta{$r$},\meta{$\theta_1$},\meta{$\theta_2$}}% -\index{sector@\cs{sector}}% -\end{cd} - -Draws the sector, from the angle \meta{$\theta_1$} to the angle -\meta{$\theta_2$} inside the circle with center at the point \meta{$c$} -and radius \meta{$r$}, where both angles are measured in degrees -anticlockwise from the direction parallel to the $x$ axis. The sector -forms a closed path. \emph{Note}: \cs{sector} and \cs{arc}\oarg{p} have -the same parameters, but \emph{in a different -order}.% - \footnote{This apparently was unintended, but we now have to live - with it so as not to break existing \file{.tex} files.} - -\begin{cd} -\cs{makesector} -\index{makesector@\cs{makesector}} -\end{cd} -The \cs{sector} command requires the center of the arc as one of its -arguments. But if one doesn't know that center (say one only knows three -points the arc connects) then even though the arc can be drawn, -\cs{sector} cannot. The \cs{makesector} command, when followed by any -\cs{arc} command, will find the center and connect it to the two ends of -the arc. It will actually attempt to do the same with any path that -follows, but the `center' it finds (if it finds one) will usually be -meaningless. +This figure macro produces a a sequence of line segments starting from +the point \meta{$p_0$}, and extending along the (2-dimen\-sional vector) +displacement \meta{$v_1$}. The next segment is from the previous +segment's endpoint, along displacement \meta{$v_2$}. This continues for +all listed displacements, a process similar to `turtle graphics'. -\subsubsection{Bar Charts and Pie Charts.}\label{charts} +\subsection{Bar charts and pie charts}\label{charts} -\begin{cd} -\cs{barchart}\oarg{\meta{start},\meta{sep},\meta{r}}\marg{\meta{h-or-v}}\marg{\meta{list}}\\ -\cs{bargraph}$\ldots$\\ -\cs{gantt}$\ldots$\\ -\cs{histogram}$\ldots$\\ -\cs{chartbar}\marg{\meta{num}}\\ -\cs{graphbar}\marg{\meta{num}}\\ -\cs{histobar}\marg{\meta{num}}% +\begin{cd}\pagelabel{barchart} +\cs{barchart}\oarg{\meta{start},\meta{sep},\meta{r}}% + \marg{\meta{h-or-v}}\marg{\meta{list}}\\ +\cs{bargraph}\dots\\ +\cs{gantt}\dots\\ +\cs{histogram}\dots\\ +\cs{mfpbarchart}\dots\\ +\cs{mfpbargraph}\dots\\ +\cs{mfpgantt}\dots\\ +\cs{mfphistogram}\dots \index{barchart@\cs{barchart}}% \index{bargraph@\cs{bargraph}}% \index{histogram@\cs{histogram}}% -\index{chartbar@\cs{chartbar}}% -\index{graphbar@\cs{graphbar}}% -\index{histobar@\cs{histobar}}% +\index{gantt@\cs{gantt}}% \end{cd} The macro \cs{barchart} computes a bar chart or a Gantt chart. It does @@ -1385,12 +1828,20 @@ below). Since bar charts have many names, \cs{bargraph} and synonym; whether a Gantt chart or bar chart is created depends on the data. +Since \cs{barchart} never draws anything, there is no particular reason +it needs to be inside an \env{mfpic} environment. Starting with version +0.9 of \mfp{} this is no longer required, but the command name +\cs{mfpbarchart} must be used outside (in case some other package also +defines \cs{barchart}). One can use any of the four synonyms listed that +start with `\cs{mfp}'. The command to draw the bars is still required to +be inside an \env{mfpic} environment. + \meta{h-or-v} should be \texttt{v} if you want the ends of the bars to be measured vertically from the $x$-axis, or \texttt{h} if they should be measured horizontally from the $y$-axis. \meta{list} should be a -comma-separated list of numbers and/or pairs giving the coordinates of -the end(s) of each bar. A number $c$ is interpreted as the pair $(0,c)$; -a pair $(a,b)$ is interpreted as an interval giving the ends of the bar +comma-separated list of numbers and ordered pairs giving the +end(s) of each bar. A number $c$ is interpreted as the pair $(0,c)$; a +pair $(a,b)$ is interpreted as an interval giving the ends of the bar (for Gantt diagrams). The rest of this description refers to the \texttt{h} case; the \texttt{v} case is analogous. @@ -1408,93 +1859,96 @@ Notice the bars are numbered in order from bottom to top. You can reverse them by making \meta{sep} negative, and making \meta{start} the top edge of the first bar. -The fraction \meta{r} should be between -1 and 1. A negative value +The fraction \meta{r} should be between $-1$ and $1$. A negative value reverses the direction from the `leading edge' of the bar to the `trailing edge'. For example, if one bar chart is created with \begin{ex} - \cs{barchart}\oarg{1,1,-.4}\marg{h}\marg{..} + \cs{barchart}\oarg{1,1,-.4}\marg{h}\marg{$\ldots$} \end{ex} and another with \begin{ex} - \cs{barchart}\oarg{1,1,.4}\marg{h}\marg{..} + \cs{barchart}\oarg{1,1,.4}\marg{h}\marg{$\ldots$} \end{ex} both having the same number of bars, then the first will have its first bar from $y = 1$ to $y = 1 -.4 = .6$, while the second will have its -first bar adjacent to that one, from $1$ to $1 + .4$. Similarly the next +first bar on top of that one, from $1$ to $1 + .4$. Similarly the next bars will be above and below $y=2$, etc. This makes it easy to draw bars next to one another for comparison. -The macro \cs{chartbar} (synonyms \cs{graphbar}, \cs{ganttbar}, and -\cs{histobar}) takes a number from $1$ to the number of elements in the -\meta{list} and draws the rectangular path. This behaves just like any -other figure macro, and the prefix macros from section~\ref{rendering} -may be used to give adjacent bars contrasting colors, fills, etc. +\begin{cd}\pagelabel{chartbar} +\cs{chartbar}\marg{\meta{num}}\\ +\cs{graphbar}\marg{\meta{num}}\\ +\cs{histobar}\marg{\meta{num}}\\ +\cs{ganttbar}\marg{\meta{num}}% +\index{chartbar@\cs{chartbar}}% +\index{graphbar@\cs{graphbar}}% +\index{histobar@\cs{histobar}}% +\index{ganttbar@\cs{ganttbar}}% +\end{cd} + +The figure macro \cs{chartbar} (synonyms \cs{graphbar}, \cs{ganttbar}, +and \cs{histobar}) takes a number from $1$ to the number of elements in +the list of data of the most recent \cs{barchart} command and produces +the corresponding rectangular path computed by that command. This +behaves just like any other figure macro, and the prefix macros from +section~\ref{rendering} may be used to give adjacent bars contrasting +colors, fills, etc. -\begin{cd} +\begin{cd}\pagelabel{piechart} \cs{piechart}\oarg{\meta{dir}\meta{angle}}\marg{\meta{$c$},\meta{$r$}}% \marg{\meta{list}}\\ -\cs{piewedge}\oarg{\meta{spec}\meta{trans}}\marg{\meta{num}}% +\cs{mfppiechart}\dots \index{piechart@\cs{piechart}}% -\index{piewedge@\cs{piewedge}}% \end{cd} The macro \cs{piechart} also does not draw anything, but computes the \cs{piewedge} regions described below. The first part of the optional -parameter, \meta{dir}, is a single letter which may be either \texttt{c} or -\texttt{a} which stand for \emph{clockwise} or \emph{anticlockwise}, -respectively. It is common to draw piecharts with the largest wedge -starting at 12 o'clock (angle 90 degrees) and successive wedges -clockwise from there. This is the default. You can change the starting -angle from 90 with the \meta{angle} parameter, and the change the -direction to counter-clockwise by specifying \texttt{a} for \meta{dir}. It -is also traditional to arrange the wedges from largest to smallest, -except there is often a miscellaneous category which is usually last and -may be larger than some others. Therefore \cs{piechart} makes no attempt -to sort the data. The data is entered as a comma separated \meta{list} -of positive numbers in the second required parameter. These are only -used to determine the relative sizes of the wedges and are not printed -anywhere. The first required parameter should contain a pair \meta{c} -for the center and a positive number \meta{r} for the radius, separated -by a comma. - -After a \cs{piechart} command has been issued, the individual wedges may -be drawn, filled, etc., using \cs{piewedge}\marg{1}, -\cs{piewedge}\marg{2}, etc. Without the optional argument, the wedges -are located according to the arguments of the last \cs{piechart} -command. The optional argument to \cs{piewedge} can override this. The -parameter \meta{spec} is a single letter, which can be \texttt{x}, \texttt{s} -or \texttt{m}. The \texttt{x} stands for \emph{exploded} and it means the -wedge is moved directly out from the center of the pie a distance -\meta{trans}. \meta{trans} should then be a pure number and is -interpreted as a distance in graph units. The \texttt{s} stands for -\emph{shifted} and in this case \meta{trans} should be a pair of the -form \texttt{(\meta{dx},\meta{dy})} indicating the wedge should be shifted -\meta{dx} horizontally and \meta{dy} vertically (in graph units). The -\texttt{m} stands for \emph{move to}, and \meta{trans} is then the absolute -coordinates \texttt{(\meta{x},\meta{y})} in the graph where the point of -the wedge should be placed. - -\subsubsection{Polar Coordinates to Rectangular.}\label{polar} - -\begin{cd} -\cs{plr}\marg{(\meta{$r_0$},\meta{$\theta_0$}), -(\meta{$r_1$},\meta{$\theta_1$}), $\ldots$}% -\index{plr@\cs{plr}}% +parameter, \meta{dir}, is a single letter to indicate a direction: +`\texttt{c}' for \emph{clockwise} or `\texttt{a}' for \emph{anticlockwise}. +The \meta{angle} is the angle in degrees of the starting edge of the +first wedge. The defaults correspond to \oarg{c90}, which means the +first wedge starts at 12~o'clock and proceeds clockwise. + +The first required argument contains the center \meta{$c$} and radius +\meta{$r$} of the chart. The second required argument is the list of +data: positive numbers separated by commas. + +Since this command never actually draws anything, only defining the +wedges, it makes sense to have it available outside the drawing +environment. Starting with version 0.9 of \mfp{} that is the case, but +the command name is \cs{mfppiechart} (to avoid a name clash with some +other package's \cs{piechart} command). The command to draw wedges +(\cs{piewedge}, see below) is still required to be inside an \env{mfpic} +environment. + +\begin{cd}\pagelabel{piewedge} +\cs{piewedge}\oarg{\meta{spec}\meta{trans}}\marg{\meta{num}}% +\index{piewedge@\cs{piewedge}}% \end{cd} -Replaces the specified list of polar coordinate pairs by the equivalent -list of rectangular (cartesian) coordinate pairs. Through \cs{plr}, -commands designed for rectangular coordinates can be applied to data -represented in polar coordinates---and to data containing both -rectangular and polar coordinate pairs. - +This figure macro takes a number from $1$ to the number of elements in +the list of data of the most recent \cs{piechart} command and produces +the corresponding wedge-shaped path computed by that command. By +default, the path is positioned as computed by that \cs{piechart} +command, but The optional argument to \cs{piewedge} can override this. +The parameter \meta{spec} is a single letter, which can be \texttt{x}, +\texttt{s} or \texttt{m}. The \texttt{x} stands for \emph{exploded} and +it means the wedge is moved directly out from the center of the pie a +distance \meta{trans}. \meta{trans} should then be a pure number and is +interpreted as a distance in graph units. The \texttt{s} stands for +\emph{shifted} and in this case \meta{trans} should be a pair of the +form \texttt{(\meta{dx},\meta{dy})} indicating the wedge should be +shifted \meta{dx} horizontally and \meta{dy} vertically (in graph +units). The \texttt{m} stands for \emph{move to}, and \meta{trans} is +then the absolute coordinates \texttt{(\meta{x},\meta{y})} in the graph +where the point of the wedge should be placed. -\subsection{Colors}\label{colors} +\section{Colors.}\label{colors} -\subsubsection{Setting the Default Colors.}\label{defaultcolors} +\subsection{Setting the default colors}\label{defaultcolors} -\begin{cd} +\begin{cd}\pagelabel{drawcolor} \cs{drawcolor}\oarg{\meta{model}}\marg{\meta{colorspec}}\\ \cs{fillcolor}$\ldots$\\ \cs{hatchcolor}$\ldots$\\ @@ -1511,29 +1965,32 @@ rectangular and polar coordinate pairs. \index{backgroundcolor@\cs{backgroundcolor}}% \end{cd} -These macros set the default color for various drawing -elements. Any curve (with one exception, those drawn by \cs{plotdata}), -whether solid, dashed, dotted, or plotted in symbols, will be in the -color set by \cs{drawcolor}. Set the color used by \cs{gfill} with -\cs{fillcolor}. For all the hatching commands use \cs{hatchcolor}. For -the \cs{point}, \cs{plotsymbol} and \cs{grid} commands use -\cs{pointcolor}, and for arrowheads, \cs{headcolor}. When \opt{mplabels} -is in effect, the color of labels can be set with \cs{tlabelcolor}, and -one can set the color used by \cs{gclear} with \cs{backgroundcolor} (the -same color is used in the interior of unfilled points drawn with -\cs{point}). The optional \meta{model} may be one of \opt{rgb}, +These macros set the default color for various drawing elements. Any +curve (with one exception, those drawn by \cs{plotdata}), whether solid, +dashed, dotted, or plotted in symbols, will be in the color set by +\cs{drawcolor}. Set the color used by \cs{gfill} with \cs{fillcolor}. +For all the hatching commands use \cs{hatchcolor}. For the \cs{point}, +\cs{plotsymbol} and \cs{gridpoints} commands use \cs{pointcolor}, and for +arrowheads, \cs{headcolor}. One can set the color used by \cs{gclear} +with \cs{backgroundcolor} (the same color will also be used in the +interior of unfilled points that are drawn with \cs{point}) and, when +\opt{mplabels} is in effect, the color of labels can be set with +\cs{tlabelcolor}. The optional \meta{model} may be one of \opt{rgb}, \opt{RGB}, \opt{cmyk}, \opt{gray}, and \opt{named}. The \meta{colorspec} depends on the model, as outlined below. Each of these commands sets a corresponding \MP{} color variable with the same name (except -\cs{backgroundcolor} sets the color \mfc{background}). Thus one can set -the filling color to the drawing color with -\cs{fillcolor}\marg{drawcolor}. +\cs{backgroundcolor} sets the color \mfc{background}). Thus, after +\texttt{drawcolor} has been set, one can issue the command +\cs{fillcolor}\marg{drawcolor} to fill with the same color. + +As previously discussed, all these colors are initially set to +\mfc{black} except \mfc{background} is set to \mfc{white}. -\subsubsection{\CMP{} Colors.}\label{mpcolors} +\subsection{\CMP{} colors}\label{mpcolors} If the optional \meta{model} specification is omitted, the color -specification may be any expression recognized as a color by \MP. In -\MP, a color is a triple of numbers like \mfc{(1,.5,.5)}, with the +specification may be any expression recognized as a color by \MP{}. In +\MP{}, a color is a triple of numbers like \mfc{(1,.5,.5)}, with the coordinates between 0 and 1, representing red, green and blue levels, respectively. White is given by \mfc{(1,1,1)} and black by \mfc{(0,0,0)}. \CMP{} also has color variables and several have been @@ -1549,7 +2006,7 @@ color functions have been defined in \file{grafbase.mp}: \index{cmyk@\mfc{cmyk($c$,$m$,$y$,$k$)}} \end{cd} -Converts a \opt{cmyk} color specification to \MP's native \opt{rgb}. For +Converts a \opt{cmyk} color specification to \MP{}'s native \opt{rgb}. For example, the command \mfc{cmyk(1,0,0,0)} yields \mfc{(0,1,1)}, which is the definition of \mfc{cyan}. @@ -1583,20 +2040,20 @@ arguments to the 0--1 range, an unknown \meta{name} is converted to \medskip As an example of the use of these functions, one could conceivable write: -\begin{ex} - \cs{drawcolor}\marg{0.5*RGB(255,0,0)+0.5*cmyk(1,0,0,0)} -\end{ex} +\begin{verbatim} +\drawcolor{0.5*RGB(255,0,0)+0.5*cmyk(1,0,0,0)} +\end{verbatim} to have all curves drawn in a color halfway between red and cyan (which turns out to be the same as \gbc{gray(0.5)}). -\subsubsection{Color Models.}\label{colormodels} +\subsection{Color models}\label{colormodels} When the optional \meta{model} is specified in the color setting commands, it determines the format of the color specification: \medskip \halign{\quad#\hfil\quad&#\hfil\cr -{\sl Model:}& {\sl Specification:}\cr +{\slshape Model:}& {\slshape Specification:}\cr \opt{rgb}& Three numbers in the range 0 to 1 separated by commas.\cr \opt{RGB}& Three numbers in the range 0 to 255 separated by commas.\cr \opt{cmyk}& Four numbers in the range 0 to 1 separated by commas.\cr @@ -1607,22 +2064,22 @@ commands, it determines the format of the color specification: \medskip \Mfp{} translates -\begin{ex} - \cs{fillcolor}\oarg{cmyk}\marg{1,.3,0,.2} -\end{ex} +\begin{verbatim} +\fillcolor[cmyk]{1,.3,0,.2} +\end{verbatim} into the equivalent of -\begin{ex} - \cs{fillcolor}\marg{cmyk(1,.3,0,.2)}. -\end{ex} +\begin{verbatim} +\fillcolor{cmyk(1,.3,0,.2)}. +\end{verbatim} Note that when the optional model is specified, the color -specification must not be enclosed in parentheses. Note also that each +specification must \emph{not} be enclosed in parentheses. Note also that each model name is the name of a color function described in the previous subsection. That is how the models are implemented internally. -\subsubsection{Defining a Color Name.}\label{colorname} +\subsection{Defining a color name}\label{colorname} -\begin{cd} +\begin{cd}\pagelabel{mfpdefinecolor} \cs{mfpdefinecolor}\marg{\meta{name}}\marg{\meta{model}}\marg{\meta{colorspec}}% \index{mfpdefinecolor@\cs{mfpdefinecolor}} \end{cd} @@ -1636,175 +2093,290 @@ The mandatory \meta{model} and \meta{colorspec} are as above. A final caution, the colors of an \mfp{} figure are stored in the \file{.mp} output file, and are not related to colors used or defined by the \LaTeX{} \prog{color} package. In particular a color defined only by -\LaTeX's \cs{definecolor} command will remain unknown to \mfp. +\LaTeX{}'s \cs{definecolor} command will remain unknown to \mfp{}. Conversely, \LaTeX{} commands will not recognize any color defined only by \cs{mfpdefinecolor}. -\subsubsection{Color in \MF} +\subsection{Color in \MF{}}\label{MFcolor} \CMF{} was never meant to understand colors, but it certainly can be taught the difference between black and white and, to a limited extent, various grays. Starting with version 0.7, \mfp{} will no longer generate an error when a color-changing command is used under the \opt{metafont} option. Instead, when possible, the variables that represent colors in -\MP{} will be converted to a numeric value between 0 and 1 in \MF. When +\MP{} will be converted to a numeric value between 0 and 1 in \MF{}. When possible (for example, when a region is filled) the numeric will be interpreted as a gray level and shading (see subsection~\ref{filling}) will be used to approximate the gray. In other cases (drawing or dashing of curves, placing of points or symbols, filling with a pattern of hatch lines) the number will be interpreted as black or white: a value less -than 1 will cause the figure to be rendered (in black), while a value +than 1 will cause the figure to be rendered in black, while a value equal to 1 (white) will cause pixels corresponding to the figure to be erased. -This is still somewhat experimental and depends on adhering to certain -restrictions. \CMF's syntax does not recognize a triple of numbers as -any sort of data structure, but it does allow \emph{commands} to have -any number of parameters in parentheses. So colors must be specified -using the color commands such as \gbc{rgb(1,1,0)} or color names such as -\gbc{yellow}, and never as a bare triple. Also, as currently written, -the color names defined in \file{dvipsnam.mp} are not defined in \MF. -With these provisions the same \mfp{} code can often produce either gray -scale \MF{} pictures or \MP{} color pictures depending only on the -\opt{metapost} option. +This depends on adhering to certain restrictions. \CMF{}'s syntax +does not recognize a triple of numbers as any sort of data structure, +but it does allow \emph{commands} to have any number of parameters in +parentheses. So colors must be specified using the color commands such +as \gbc{rgb(1,1,0)} or color names such as \gbc{yellow}, and never as a +bare triple. Also, as currently written, the color names defined in +\file{dvipsnam.mp} are not defined in \MF{}. With these provisions the +same \mfp{} code can often produce either gray scale \MF{} pictures or +\MP{} color pictures depending only on the \opt{metapost} option. The commands \cs{shade} and \cs{gfill}\oarg{gray(.75)} (see subsection~\ref{filling} for their meaning) will produce a similar shade of gray, but there is a difference. The first simply adds small dots on top of whatever is already drawn. The second, however, tries to simulate the \MP{} effect, which is to cover up whatever is previously drawn. -Therefore, it first zeros all affected pixels before adding the dots to +Therefore, it first erases all affected pixels before adding the dots to simulate gray. In particular, \cs{gfill}\oarg{white} should have the same effect as \cs{gclear}. -\subsection{Shape-Modifier Macros.}\label{modifier} +\section{Modifying the figures.}\label{modifier} -Some \mfp{} macros operate as \emph{shape-modifier} macros---for -example, if you want to put an arrowhead on a line segment, you could -write: \cs{arrow}\cs{lines}\marg{(0,0),(1,0)}. These are always prefixed -to some figure drawing command, and apply only to the next following -figure macro (which can be rather far removed) provided that only other -prefix commands intervene. This is a rather long section, but even more -modification prefixes are documented in subsection~\ref{transformation}. +Some \mfp{} macros operate by \emph{modifying} a figure: if you want to +turn an open arc into a closed figure by adding a straight line, you can +write: \cs{lclosed}\cs{arc}\marg{(0,0),(1,0),45}. These are always +prefixed to some figure drawing command, and apply only to the next +following figure macro provided that only other prefix commands +intervene. This is a rather long section, but even more modification +prefixes are documented in subsection~\ref{transformation}. -For the purposes of these macros, a distinction must be made in the -figure macros between `open' and `closed' paths. A path that merely -returns to its starting point is \emph{not} automatically closed; such a -path is open, and must be explicitly closed, for example by \cs{lclosed} -(see below). The (already) closed paths are those that have -`\texttt{closed}' in their name plus: \cs{rect}, \cs{circle}, -\cs{ellipse}, \cs{sector}, \cs{cyclic}, \cs{polygon}, \cs{plrregion}, -\cs{chartbar}, \cs{piewedge}, \cs{tlabelrect}, \cs{tlabeloval}, -\cs{tlabelellipse}, \cs{tlabelcircle} and \cs{btwnfcn} (below). +The combination of a modifying macro, followed by a figure macro, can +usually be thought of as a new figure macro, to which further prefixes +might be prepended. -\subsubsection{Closure of Paths.}\label{closure} +More precisely: all prefix macros have an \emph{input}, an +\emph{output}, and a side effect. The input and output are alway paths. +The input is the path that is output by the \emph{following} prefix or +figure macro. The output is either the same as the input or a +modification of it. The side effect might be a drawing or filling of the +path or the addition of an arrowhead. -\begin{cd} -\cs{lclosed}$\ldots$% -\index{lclosed@\cs{lclosed}} -\end{cd} +We list here a classifications of prefix and figure macros that is +useful for understanding the \mfp{} system. -Makes each open path into a closed path by adding a line segment between -the endpoints of the path. +\begin{description} -\begin{cd} -\cs{bclosed}\oarg{\meta{tens}}$\ldots$ -\index{bclosed@\cs{bclosed}}% -\end{cd} +\item[Figure macros.] These\index{figure macro} have no input; they must + come last in a sequence. They output the path they were designed to + produce. Examples are \cs{circle}, \cs{rect} and \cs{polygon}. If + they have no prefixes, or are preceded only by appending macros (see + next), they invoke a default rendering of the path (usually a + drawing as a solid stroke) as the side effect. + +\item[Macros that append] These\index{prefix macro} pass their input + unchanged as their output. Their side effect is the appending of + some object such as an arrowhead. Currently only the various arrow + macros are appending macros (see subsection~\ref{arrows}). However, + \cs{reverse} (which technically modifies a path and has no side + effect) is coded as an appending macro so that it will work + correctly with arrows. Think of it as `appending' a new direction. + +\item[Macros that render] These\index{prefix macro} pass their + input unchanged as their output. They have the side effect of adding + or subtracting ink from a picture in the shape of the input path. + Examples are \cs{draw}, \cs{dotted}, \cs{gfill} and \cs{gclip}. + +\item[Macros that modify] These\index{prefix macro} output the result of + applying their intended modification to the input path. Examples are + macros that close the path if it was open, macros that apply a + transformation such as a rotation, and macros that return only a + part of a path. If they have no prefixes, or are preceded only by + appending macros (see above), they also invoke a default rendering + of the output path (usually a drawing as a solid stroke of the + modified path) as the side effect. -This macro is similar to \cs{lclosed}, except that it closes an open -path smoothly by drawing a B\'ezier curve. A B\'ezier is \MF's natural -way of connecting points into a curve, and \cs{bclosed} is the simplest -and most efficient closure next to \cs{lclosed}. Moreover it usually -gives a reasonably aesthetic result. Sometimes, however, one might wish -a tighter connection. If that is the case, use the optional argument -with a value of the tension \meta{tens} greater than $1$, the default. -The command \cs{settension} (see subsection~\ref{curves}) can be used to -change the default. +\end{description} -\begin{cd} +\subsection{Closure of paths}\label{closure} + +It should be pointed out that the closure macros will leave already +closed paths unchanged, so it is always safe to add one when uncertain. +Moreover, if the path is not closed but the endpoints are identical, +\cs{lclosed} will close it without adding the (trivial) line segment. + + +\begin{cd}\pagelabel{lclosed} +\cs{lclosed}$\ldots$\\ +\cs{bclosed}\oarg{\meta{tens}}$\ldots$\\ \cs{sclosed}\oarg{\meta{tens}}$\ldots$% +\index{lclosed@\cs{lclosed}} +\index{bclosed@\cs{bclosed}}% \index{sclosed@\cs{sclosed}} \end{cd} -This closes the curve by mimicking the definition of the \cs{curve} -command. That command tries to force the curve to pass through the $n$th -point in a direction parallel to the line from point $(n-1)$ to point -$(n+1)$. In order to close a curve in this way, the direction at the two -endpoints often has to be changed, and this changes the shape of the -first and last segments of the curve. Use \cs{bclosed} if you don't wish -this to happen. However, \cs{sclosed}\cs{curve} produces the same result -as \cs{cyclic} given the same points and tension valuse. The optional -tension argument is as in the \cs{bclosed} command. +These modifying macros all turn an open path into a closed one. If the +path is already closed, they do nothing. + +\cs{lclosed} makes an open path into a closed path by adding a line +segment between the endpoints of the path. In the special case where +the path ends exactly where it begins, all \cs{lclosed} does is change +the type of the path from open to closed. + +The \cs{bclosed} macro is similar to \cs{lclosed}, except that it closes +an open path smoothly by drawing a B\'ezier curve. A B\'ezier is \MF{}'s +natural way of connecting points into a curve, and \cs{bclosed} is the +simplest and most efficient closure next to \cs{lclosed}. Moreover it +usually gives a reasonably aesthetic result. Sometimes, however, one +might wish a tighter connection. If that is the case, use the optional +argument with a value of the tension \meta{tens} greater than $1$, the +default. The command \cs{settension} (see subsection~\ref{curves}) can +be used to change the default. + +\cs{sclosed} closes the curve by mimicking the definition of the +\cs{curve} command. That command tries to force the curve to pass +through the $n$th point in a direction parallel to the line from point +$(n-1)$ to point $(n+1)$. In order to close a curve in this way, the +direction at the two endpoints often has to be changed, and this changes +the shape of the first and last segments of the curve. Use \cs{bclosed} +if you don't wish this to happen. However, \cs{sclosed}\cs{curve} +produces a result almost identical to \cs{cyclic} given the same points +and tension values. The optional tension argument is as in the +\cs{bclosed} command. + +There are two other closure commands but, because they are associated +with particular types of paths (splines), we delay their discussion +until those are discussed (subsection~\ref{splines}). + +\begin{cd}\pagelabel{makesector} +\cs{makesector}\cs{arc}[\meta{fmt}]\marg{\meta{spec}}% +\index{makesector@\cs{makesector}} +\end{cd} +The modifying macro \cs{makesector} can be applied to any path, but it +make sense only if that path is an arc. It appends line segments from +the center of the arc's circle to the ends of the arc, producing a +closed path. It is useful if one doesn't know that center of the arc (a +required parameter of \cs{sector}). It works by selecting the first +point, a middle point, and the last point of the following path, then +calculates the center of the circle through those three points. -\subsubsection{Reversal, Connection and Subpaths.}\label{reversal} -\begin{cd} +\subsection{Reversal, connection and other path modifications}% +\label{reversal} + +\begin{cd}\pagelabel{reverse} \cs{reverse}$\ldots$% \index{reverse@\cs{reverse}} \end{cd} -Turns a path around, reversing its sense. This will affect both -the direction of arrows (e.g. bi-directional arrows can be coded with +This modifies the following path by reversing its sense. This will +affect the direction of arrows: bi-directional arrows can be coded with \cs{arrow}\cs{reverse}\cs{arrow}$\ldots$, where the first \cs{arrow} -modifier applies to the \emph{reversed} path), and the order of -endpoints for a \cs{connect}$\ldots$\cs{endconnect} environment (below). +prefix applies to the \emph{reversed} path. The order of endpoints for +the following \env{connect} environment will also be affected. -\begin{cd} -\cs{connect} $\ldots$ -\cs{endconnect}% -\index{connect@\cs{connect}} +\begin{cd}\pagelabel{connect} +\cs{connect} $\ldots$ \cs{endconnect}% +\index{connect@\cs{connect}}% \index{endconnect@\cs{endconnect}} \end{cd} -This pair of macros, acting as an environment, adds line segments from -the trailing endpoint of one path to the leading endpoint of the -next path, in the given order. The result is a connected, \emph{open} -path. +The macro \cs{connect} produces a connected path by joining all the +paths following it up to the matching \cs{endconnect} command. Line +segments are added from the end of one path to the start of the next. +The whole group acts as one figure macro, permitting any prefix macros +to come before. -\emph{Note}: In \LaTeX, this pair of macros can be used in the form of a -\LaTeX-style environment called \env{connect} ---as in -\cs{begin}\marg{connect}$\ldots$\cs{end}\marg{connect}. +In \LaTeX{}, instead of this pair of macros, an environment named +\env{connect} may be used. For example +\begin{verbatim} +\lclosed +\begin{connect} + \curve{(2,1),(1,2),(0,1)} + \polyline{(0,0),(2,0)} +\end{connect} +\end{verbatim} +produces a closed figure consisting of one smooth curve and three line +segments: the segment produced by \cs{polyline}, the segment added by +the \env{connect} environment, and the segment added by \cs{lclosed}. -\begin{cd} + +\begin{cd}\pagelabel{partpath} \cs{partpath}\marg{\meta{frac1},\meta{frac2}}\dots\\ \cs{subpath}\marg{\meta{num1},\meta{num2}}\dots% \index{partpath@\cs{partpath}}% \index{subpath@\cs{subpath}} \end{cd} -Both produce a part of the following path. In \cs{partpath} the -parameters \meta{frac1} and \meta{frac2} should be numbers between 0 and -1. The path produced travels the same course as the path that follows, -but starts at the point that is \meta{frac1} of the original length -along it, and ends at the point \meta{frac2} of its original length. If -\meta{frac1} is greater than \meta{frac2}, the sense of the path is -reversed. In \cs{subpath}, the two numbers should be between 0 and the -number of B\'ezier segments in the path. This is mainly for experienced -\MF ers and provides an \mfp{} interface to \MF's -`\mfc{subpath}' operation. - -As an example of \cs{partpath}, one can put an arrowhead (see next -subsection) in the middle of a path with something like the following. - +These macros modify the following path by producing only a part of it. In +\cs{partpath} the parameters \meta{frac1} and \meta{frac2} should be +numbers between 0 and 1. The path produced travels the same course as +the path that follows, but starts at the point that is the fraction +\meta{frac1} of the original length along it, and ends at the point +\meta{frac2} of its original length. If \meta{frac1} is greater than +\meta{frac2}, the sense of the path is reversed. In \cs{subpath}, the +two numbers should be between 0 and the number of B\'ezier segments in +the path. This is mainly for experienced \MF{}ers and provides an \mfp{} +interface to \MF{}'s `\mfc{subpath}' operation. + +\begin{cd}\pagelabel{parallelpath} +\cs{parallelpath}{\meta{dist}}$\ldots$ +\index{parallelpath@\cs{parallelpath}} +\end{cd} + +This modifying macro takes the following path and returns a path that +follows beside it, keeping a fixed distance \meta{dist} to the left. If +\meta{dist} is negative, it keeps to the right. Left or right is from +the point of view of a traveller following the given path from start to +finish. The distance is a pure number in \emph{graph} coordinates. Note: +this should be compared to the first optional argument of +\cs{doubledraw} (see subsection~\ref{drawing}), which requires an +absolute dimension like \dim{2pt}, even though it is implemented using +the internal code of \cs{parallelpath}. + +The calculation of the parallel path is approximate and rather +inefficient. It is likely to produce inexplicable small loops where it +tries to follow the inside of tight turns (radius less than +\meta{dist}). Actual corners, (which might be thought of as turns of +radius $0$) are usually detected and dealt with in a reasonable manner. +However, if the path is made up of segments of length \meta{dist} or +less, this is unlikely to work correctly at all. + +\begin{cd}\pagelabel{arccomplement} +\cs{arccomplement}\dots% +\index{arccomplement@\cs{arccomplement}} +\end{cd} + +This macro, to work properly, must be followed by an arc of a circle. It +produces the complementary arc. That is, it produces the circular arc, +which would, if appended to the following arc, complete the circle. The +complementary arc will have the same direction, clockwise or +anticlockwise, as the original. The arc that follows doesn't have to be +produced by \cs{arc}, as in the following example: \begin{ex} -\cs{arrow}\cs{partpath}\marg{0,.5}\cs{draw}\dots +\cs{draw}\oarg{blue}\cs{arccomplement}\\ +\ \cs{draw}\oarg{red}\cs{partpath}\marg{0,.333}\\ +\ \cs{circle}\marg{(0,0),1} \end{ex} +This will draw 1/3 of the circle in red and the rest in blue. +\CMF{} cannot check if a path is really a circular arc. The \MF{} code, +like that of \cs{makesector} (see subsection~\ref{closure}), selects +three key points on the arc, then it produces the rest of the circle +much the same way as the internal code of \cs{arc}\oarg{t} (the three +point option for \cs{arc}). Thus, it will produce \emph{some} arc from +the end of any following path to its beginning (or a straight line if +the three chosen points happen to lie in a straight line). However, the +result needn't bear any significant relation to the original path. -\subsubsection{Arrows.}\label{arrows} -\begin{cd} +\subsection{Arrows}\label{arrows} + +\begin{cd}\pagelabel{arrow} \cs{arrow}\oarg{l\meta{headlen}}\oarg{r\meta{rotate}}% + \oarg{b\meta{backset}}\oarg{c\meta{color}}$\ldots$\\ +\cs{arrow*}\oarg{l\meta{headlen}}\oarg{r\meta{rotate}}% \oarg{b\meta{backset}}\oarg{c\meta{color}}$\ldots$% \index{arrow@\cs{arrow}} \end{cd} -Draws an arrowhead at the endpoint of the open path (or at the last key -point of the closed path) that follows. The optional parameter +This macro adds an arrowhead at the endpoint of the open path (or at the +last key point of the closed path) that follows. The optional parameter \meta{headlen} determines the length of the arrowhead. The default is the value of the \TeX{} dimension \cs{headlen}, initially \dim{3pt}. The optional parameter \meta{rotate} allows the arrowhead to be rotated @@ -1813,23 +2385,178 @@ default is 0. The optional parameter \meta{backset} allows the arrowhead to be `set back' from its original point, thus allowing e.g. double arrowheads. This parameter is in the form of a \TeX{} dimension---its default value is \dim{0pt}. If an arrowhead is both rotated and set -back, the rotation affects the direction in which the arrowhead is set -back. The optional \meta{color} defaults to \gbc{headcolor}. The -optional parameters may appear in any order, but the indicated key -character for each parameter must always appear. +back, it is set back in the direction after the rotation. Actually, +except on a straight line, a better way to set an arrowhead back might +be something like +\begin{ex} + \cs{arrow}\cs{trimpath}\marg{0,5pt}\cs{draw}\dots +\end{ex} +See subsection~\ref{misc} for the \cs{trimpath} macro. The optional +\meta{color} defaults to \gbc{headcolor}. The optional parameters may +appear in any order, the indicated key character determining the meaning +of a parameter. The key letter \texttt{l} for `length' can be replaced +by \texttt{s} for `size'. And, oddly enough, \texttt{b} for `backset' +can be replaced by \texttt{f} for `forward' so that arrow tails (see +below) can share the same internal code for identifying the meaning of +the parameters. + +There is also a star-form: If \cs{arrow} is called as \cs{arrow*}, then +any part of the tip of the following curve that lies outside the +arrowhead shape is clipped off. Imagine a rectangle with one side +connecting the ends of the barbs and the opposite side passing through +the tip. Everything in that rectangle outside the arrowhead is erased, +so be careful using this (also see comments about \MP{}'s method of +`erasing' in the description of \cs{gclear} in +\cs{}subsection~\ref{filling}). One use of this is adding an arrowhead +to a figure rendered with \cs{doubledraw} (see the next section) or with +a rather large pen diameter (see section~\ref{parameters}). + +For the star-form to work, the head has to be added after the path is +drawn. What this means in practice is that the \cs{arrow*} command must +come before any drawing command in the list of prefixes. This is because +prefix macros add their elements to the result of everything that +follows. If you \cs{store} a curve in a path variable (see +subsection~\ref{transformation}), and draw the path and the arrowhead in +separate commands, then the arrow command must come \emph{after} the +drawing command. + +\begin{cd}\pagelabel{arrowhead} +\cs{arrowhead}\marg{\meta{symbol}}\oarg{l\meta{length}}\oarg{r\meta{rotate}}% + \oarg{b\meta{backset}}\oarg{c\meta{color}}$\ldots$\\ +\cs{arrowmid}\marg{\meta{symbol}}\oarg{l\meta{length}}\oarg{r\meta{rotate}}% + \oarg{f\meta{fraction}}\oarg{c\meta{color}}$\ldots$\\ +\cs{arrowtail}\marg{\meta{symbol}}\oarg{l\meta{length}}\oarg{r\meta{rotate}}% + \oarg{f\meta{forward}}\oarg{c\meta{color}}$\ldots$% +\index{arrowhead@\cs{arrowhead}}% +\index{arrowmid@\cs{arrowmid}}% +\index{arrowtail@\cs{arrowtail}} +\end{cd} + +These macros add some sort of symbol at different locations along a +path. The first adds an arrowhead, but the head can be any appropriately +designed symbol. It has been arranged that any of the symbols usable in +\cs{plotsymbol} (see subsection~\ref{points}) can be used: you can have +\gbc{Diamond}- or \gbc{Asterisk}-tipped arrows. The special symbol +\gbc{Arrowhead} produces the same shape as the head in the \cs{arrow} +command. In total eight special \meta{symbols} have been made available, +intended for use with \cs{arrowhead}, \cs{arrowmid} and \cs{arrowtail}. +Here is a list and description of all these symbols. +\begin{description} + \item[\gbc{Arrowhead}] The\index{Arrowhead@\gbc{Arrowhead}} shape that + would be drawn at the end of a path by \cs{arrow}. + \item[\gbc{Leftharpoon}] The\index{Leftharpoon@\gbc{Leftharpoon}} left + half of \gbc{Arrowhead}. + \item[\gbc{Rightharpoon}] The\index{Rightharpoon@\gbc{Rightharpoon}} + right half of \gbc{Arrowhead}. + \item[\gbc{Crossbar}] A\index{Crossbar@\gbc{Crossbar}} short + line crossing the path perpendicularly unless rotated. + \item[\gbc{Leftbar}] Essentially\index{Leftbar@\gbc{Leftbar}} the left + half of \gbc{Crossbar}. + \item[\gbc{Rightbar}] The\index{Rightbar@\gbc{Rightbar}} right half. + \item[\gbc{Lefthook}] An\index{Lefthook@\gbc{Lefthook}} open + semicircle with its open face in the direction of the path, added to + the left side of the path. + \item[\gbc{Righthook}] Like\index{Righthook@\gbc{Righthook}} + \gbc{Lefthook} but on the right side. +\end{description} +Here `left' and `right' are from the point of view of an observer facing +in the direction of the path. + +If the symbol is a closed path (see subsection~\ref{closure} for the +difference between a closed path and one that merely looks closed), the +head will be filled, otherwise its outline will be drawn. Thus +\cs{arrowhead}\marg{Diamond} draws an outline, and +\cs{arrowhead}\marg{SolidDiamond} draws a filled shape because +\gbc{Diamond} has been left open, while \gbc{SolidDiamond} has been +defined to be closed. + +It is possible, to get an outline drawn with the inside erased: +just place the solid version with color \mfc{white} and then the outline +version. This can produce a pleasing result. But recall that the prefix +macro nearest the figure macro is executed first. For example: +\begin{verbatim} +\arrowmid{Circle}\arrowmid{SolidCircle}[cwhite]\polyline{(0,0),(1,1)} +\end{verbatim} + +The symbol is always rotated so that it points in the direction of the +path (for this purpose, all symbols are initially assumed to point +straight upward) before the \oarg{r\meta{rotate}} parameter is applied. + +There is a star-form \cs{arrowhead*} that behaves like \cs{arrow*} (when +possible). The optional arguments are exactly as in \cs{arrow}, with the +same defaults for all of them. + +The second command, \cs{arrowmid}, places the symbol somewhere between +the start and the end of the path. In this case the optional parameter +\oarg{f\meta{fraction}} gives the location of the symbol as a fraction +of the length of the path. The default is \oarg{f0.5}, which places it +approximately in the middle. The other optional arguments have the same +meaning as for \cs{arrowhead}. As with \cs{arrowhead}, the symbol is +rotated to `point' in the direction of the path before the +\oarg{r\meta{rotate}} is applied. + +The third command \cs{arrowtail} places the symbol at the start of the +path. Otherwise it behaves as the other two commands, except the option +\oarg{f\meta{forward}} is an amount to shift the symbol forward from +that first point. + +One might be tempted to use \cs{arrowmid} with the \meta{fraction} equal +to $1$ or $0$ to get arrowheads or tails. This will work sometimes. +However, some shapes have a `tip', that is, a particular point +designated as the tip of the arrowhead. The \cs{arrowhead} and +\cs{arrowtail} commands pay attention to this, while \cs{arrowmid} does +not. Also, \cs{arrowmid} has no star-form. + +You can design your own \meta{symbol} for these commands: use \cs{store} +to store a path in a path variable (see +subsection~\ref{transformation}). These commands assume that the length +is $1$, that the symbol `points' up and that the `tip' (the `pointy +end') is at $(0,0)$ (unless the pair variable \meta{symbol}\gbc{.tip} is +defined, in which case that is taken to be the tip). So draw your symbol +pointing up with its tip at $(0,0)$ and its length equal to $1$ (graph +unit). For example the following produces a solid head with a common +shape: +\begin{verbatim} +\store{myAH}\polygon{(-.5,-1)(0,0),(0.5,-1),(0,-.7)} +\arrowhead{myAH}\arc{(-10,0),(10,0),90} +\end{verbatim} +If you replace the \cs{polygon} above with \cs{polyline}: +\begin{verbatim} +\store{myAH}\polyline{(-.5,-1)(0,0),(0.5,-1),(0,-.7),(-.5,-1)} +\end{verbatim} +the path will not be closed and so the arrowhead will not be filled in. +To make the star-form work with such self-defined symbols, one must also +define a closed path \gbc{myAH.clear} that gives the region to be +erased. In the above example: +\begin{verbatim} +\store{myAH.clear}\polygon{(-.5,-1),(-.5,0),(.5,0),(.5,-1),(0,-.7)} +\end{verbatim} -\subsection{Rendering macros}\label{rendering} -\subsubsection{Drawing.}\label{drawing} +\section{Rendering figures.}\label{rendering} -When \mfp{} is loaded, the initial way in which figures are drawn -is with a solid outline. That is, \cs{lines}\marg{(1,0),(1,1),(0,0)} -will draw two solid lines connecting the points. When the macros in this -section are used, any previously established default (see -subsection~\ref{default} below) is overridden. +When \mfp{} is loaded, the initial way in which figures are drawn is +with a solid outline. That is, \cs{polyline}\marg{(1,0),(1,1),(0,0)} will +draw two solid lines connecting the points. It is possible to establish +a different default (see \cs{setrender} in subsection~\ref{default}), +however that default is used only when no explicit rendering prefix is +present. That is, when the macros in this section are used, any +previously established default is overridden. -\begin{cd} +\begin{cd}\pagelabel{norender} +\cs{norender}$\ldots$% +\index{norender@\cs{norender}}% +\end{cd} + +This causes the following path not to be rendered at all. This can be +used to override \mfp{}'s automatic rendering rules. See +section~\ref{transformation}, page~\pageref{norenderexample} for an +example where one might need to do this. + +\subsection{Drawing}\label{drawing} + +\begin{cd}\pagelabel{draw} \cs{draw}\oarg{\meta{color}}$\ldots$% \index{draw@\cs{draw}} \end{cd} @@ -1839,65 +2566,81 @@ draw a curve and hatch its interior, \cs{draw}\cs{hatch} must be used. The default for \meta{color} is \gbc{drawcolor}. To save repetition, the color used for the following commands is also -\gbc{drawcolor}: \cs{dashed}, \cs{dotted}, \cs{plot}, \cs{plotnodes}, -and \cs{gendashed}, - -\begin{cd} +\gbc{drawcolor}: \cs{dashed}, \cs{dotted}, \cs{doubledraw}, \cs{plot}, +\cs{plotnodes}, and \cs{gendashed}, + +\begin{cd}\pagelabel{doubledraw} +\cs{doubledraw}\oarg{\meta{sep}}\oarg{\meta{color}}$\ldots$ +\index{doubledraw@\cs{doubledraw}} +\end{cd} + +This rendering macro draws the path with a double line. The default +separation (distance between centers of the two penstrokes) is twice the +pen diameter. This normally leaves one line thickness of white space +between. You can change this with the \oarg{\meta{sep}} argument. In +order to make the space between the lines transparent, this command is +implemented by calculating two curves that parallel the given curve and +drawing those. For technical reasons, that calculation is rather lengthy +so this is somewhat inefficient and users of slow machines might want to +avoid it. See also comments at \cs{parallelpath} in +subsection~\ref{reversal}. + +\begin{cd}\pagelabel{dashed} \cs{dashed}\oarg{\meta{length},\meta{space}}$\ldots$% \index{dashed@\cs{dashed}} \end{cd} -Draws dashed segments along the path specified in the next command. The -default length of the dashes is the value of the \TeX{} dimension +This rendering macro draws dashed segments along the path specified. +The default length of the dashes is the value of the \TeX{} dimension \cs{dashlen}, initially \dim{4pt}. The default space between the dashes is the value of the \TeX{} dimension \cs{dashspace}, initially \dim{4pt}. The dashes and the spaces between may be increased or -decreased by as much as ${1\over n}$ of their value, where $n$ is the -number of spaces appearing in the curve, in order to have the proper -dashes at the ends. The dashes at the ends are half of \cs{dashlen} -long. +decreased by as much as $1/n$ of their value, where $n$ is the number of +spaces appearing in the curve, in order to have the proper dashes at the +ends. The dashes at the ends are half of \cs{dashlen} long. -\begin{cd} +\begin{cd}\pagelabel{dotted} \cs{dotted}\oarg{\meta{size},\meta{space}}$\ldots$% \index{dotted@\cs{dotted}} \end{cd} -Draws dots along the specified path. The default size of the dots is the -value of the \TeX{} dimension \cs{dotsize}, initially \dim{0.5pt}. The -default space between the dots is the value of the \TeX{} dimension -\cs{dotspace}, initially \dim{3pt}. The size of the spaces may be -adjusted as in \cs{dashed}. +This rendering macro draws dots along the specified path. The default +size of the dots is the value of the \TeX{} dimension \cs{dotsize}, +initially \dim{0.5pt}. The default space between the dots is the value +of the \TeX{} dimension \cs{dotspace}, initially \dim{3pt}. The size of +the spaces may be adjusted as in \cs{dashed}. -\begin{cd} +\begin{cd}\pagelabel{plot} \cs{plot}\oarg{\meta{size},\meta{space}}\marg{\meta{symbol}}$\ldots$% \index{plot@\cs{plot}} \end{cd} -Similar to \cs{dotted} except copies of \meta{symbol} are drawn along -the path. Possible symbols are those listed under \cs{plotsymbol} in -subsection~\ref{points}. The default \meta{size} is \cs{pointsize} and -the default \meta{space} is \cs{symbolspace}, initially \dim{5pt}. +Similar to \cs{dotted}, this rendering macro draws copies of +\meta{symbol} along the path. Possible symbols are those listed under +\cs{plotsymbol} in subsection~\ref{points}. The default \meta{size} is +\cs{pointsize} (initially \dim{2pt}) and the default \meta{space} is +\cs{symbolspace} (initially \dim{5pt}). -\begin{cd} +\begin{cd}\pagelabel{plotnodes} \cs{plotnodes}\oarg{\meta{size}}\marg{\meta{symbol}}$\ldots$% \index{plotnodes@\cs{plotnodes}} \end{cd} -This places a symbol (same possibilities as in \cs{plotsymbol}, see -subsection~\ref{points}) at each node of the path that follows. A node -is one of the points through which \MF{} draws its curve. If one of the -macros \cs{polyline}\marg{$\ldots$} or \cs{curve}\marg{$\ldots$} -follows, each of the points listed is a node. In the \cs{datafile} -command (below), each of the data points in the file is. In the function -macros (below) the points corresponding to \meta{min}, \meta{max} and -each step in between are nodes. The optional \meta{size} defaults to -\cs{pointsize}. If the command \cs{clearsymbols} has been issued then -the interiors of the open symbols are erased. The effect of something -like the following is rather nice: - +This rendering macro places a symbol at each \emph{node} of the path +that follows. Possible symbols are those listed under \cs{plotsymbol} in +subsection~\ref{points}. A node is one of the points through which \MF{} +draws its curve. If one of the macros \cs{polyline}\marg{$\ldots$} or +\cs{curve}\marg{$\ldots$} follows, each of the points listed is a node. +In the \cs{datafile} command (subsection~\ref{external}), each of the +data points in the file is. In the function macros +(subsection~\ref{plotting}) the points corresponding to \meta{min}, +\meta{max} and each step in between are nodes. The optional \meta{size} +defaults to \cs{pointsize}. If the command \cs{clearsymbols} has been +issued then the interiors of the open symbols are erased. The effect of +something like the following is rather nice: \begin{verbatim} - \clearsymbols - \plotnodes{Circle}\draw\polyline{...} +\clearsymbols +\plotnodes{Circle}\draw\polyline{...} \end{verbatim} This will first draw the polyline with solid lines, and then the points listed will be plotted as open circles with the portion of the lines @@ -1905,107 +2648,197 @@ inside the circles erased. One sees a series of open circles connected one to the next by line segments -\begin{cd} +\begin{cd}\pagelabel{dashpattern} \cs{dashpattern}\marg{\meta{name}}% \marg{\meta{len1},\meta{len2},$\ldots$,\meta{len2k}}% \index{dashpattern@\cs{dashpattern}} \end{cd} For more general dash patterns than \cs{dashed} and \cs{dotted} provide, -there is a generalized dashing command. One must first establish a named -dashing pattern with this command. \meta{name} can be any sequence of -letters and underscores. Try to make it distinctive to avoid undoing -some internal variable. \meta{len1} through \meta{len2k} are an even -number of lengths. The odd ones determine the lengths of dashes, the -even ones the lengths of spaces. A dash of length \texttt{0pt} means a -dot. An alternating dot-dash pattern can be specified with - -\begin{ex} - \cs{dashpattern}\marg{dotdash}\marg{0pt,4pt,3pt,4pt}. -\end{ex} +\mfp{} offers a generalized dashing command. Before using it, one must +first establish a named dashing pattern with the above command. The +\meta{name} can be any sequence of letters and underscores. Try to make +it distinctive to avoid undoing some internal variable. \meta{len1} +through \meta{len2k} are an even number of lengths. The odd ones +determine the lengths of dashes, the even ones the lengths of spaces. A +dash of length \texttt{0pt} means a dot. An alternating dot-dash pattern +can be specified with +\begin{verbatim} +\dashpattern{dotdash}{0pt,4pt,3pt,4pt} +\end{verbatim} \emph{Note}: Since pens have some thickness, dashes look a little longer, and spaces a little shorter, than the numbers suggest. If one -wants dashes and space with the same length, one needs to take the size +wants dashes and spaces with the same length, one needs to take the size desired and increase the spaces by the thickness of the drawing pen -(normally \dim{0.5pt}) and decrease the dashes by the same amount. +(normally) \dim{0.5pt}) and decrease the dashes by the same amount.% + \footnote{Experienced \MP{} users could also set the \mfc{linecap} + variable to \mfc{butt}.} If \cs{dashpattern} is used with an odd number of entries, a space of length \dim{0pt} is appended. This makes the last dash in one copy of the pattern abut the first dash in the next copy. -\begin{cd} +\begin{cd}\pagelabel{gendashed} \cs{gendashed}\marg{\meta{name}}$\ldots$% \index{gendashed@\cs{gendashed}} \end{cd} Once a dashing pattern name has been defined, it can be used in this -command to draw the curve that follows it. Using a name not previously -defined will cause the curve to be drawn with a solid line, and generate -a \MF{} warning, but \TeX{} will not complain. If all the dimensions in -a dash pattern are 0, \cs{gendashed} responds by drawing a solid curve. -The same is true if the pattern has only one entry. +figure macro to draw the curve that follows it. Using a name not +previously defined will cause the curve to be drawn with a solid line, +and generate a \MF{} warning, but \TeX{} will not complain. If all the +dimensions in a dash pattern are 0, \cs{gendashed} responds by drawing a +solid curve. The same is true if the pattern has only one entry. + +\begin{cd}\pagelabel{zigzag} +\cs{zigzag}\marg{\meta{start},\meta{end},\meta{wl},\meta{amp}}\dots\\ +\cs{sinewave}\oarg{\meta{tens}}% + \marg{\meta{start},\meta{end},\meta{wl},\meta{amp}}\dots% +\index{zigzag@\cs{zigzag}}% +\index{sinewave@\cs{sinewave}} +\end{cd} + +These figure macros both draw a solid line that crosses from one +side of the path to the other. The \cs{zigzag} makes a jagged result +while the \cs{sinewave} makes a smooth one. The optional argument of +\cs{sinewave} is a `tension' and controls how smooth the result is. The +default tension is $1$. Higher values make a less smooth path, and +values of 10 or so produce a result almost indistinguishable from +\cs{zigzag}. Tension is required to be greater than $3/4$. + +The mandatory arguments consists of four dimensions separated by a comma. +The rendering produced by these macros actually follow the path a little +way at the start and end of the path. This is controlled by the +dimensions \meta{start} and \meta{end}. + +The third dimension, \meta{wl}, is the distance from one `peak' to the +next (the `wavelength'). The second, \meta{amp}, is the maximum distance +to either side of the true path (the `amplitude'). Reasonable values of +\meta{wl} and \meta{amp} are \dim{8pt} and \dim{2pt}, respectively. +These proportions (4 to 1) causes the zigzag and the sinewave to cross +the path at an angle of about 45 degrees, a rather pleasant result. +Those sizes are close to optimal: too much smaller and the rendering +just looks like a fuzzy line, too much larger, and bends in the path +will distort the zigzagging. + +The zigzags zig to the left first if \meta{amp} is positive, to the +right if it is negative. For closed curves, the beginning and end are +constructed to meet smoothly. It is always arranged that there are an +equal number of left zigs and right zags, so the \meta{wl} is only +approximate. + + +\begin{cd}\pagelabel{corkscrew} +\cs{corkscrew}\oarg{\meta{tens}}% + \marg{\meta{start},\meta{end},\meta{wl},\meta{amp}}\dots\\% +\cs{coil}\oarg{\meta{tens}}% + \marg{\meta{start},\meta{end},\meta{wl},\meta{amp}}\dots% +\index{corkscrew@\cs{corkscrew}}% +\index{coil@\cs{coil}} +\end{cd} + +This rendering macro draws a coil or corkscrew that coils around a +given path, something like this: \includegraphics{coil.mps} (the red +dots show the actual path). The \meta{tens} is a tension option that +controls how `loopy' the result will be (the higher the number the more +jagged). The mandatory argument contains four explicit dimensions. The +first two, \meta{start} and \meta{end} are as in \cs{zigzag}. The +\meta{wl} is the distance from one loop to the next, and \meta{amp} is +the distance from the true path to the tops (or bottoms) of the +loops. If \meta{amp} is positive, the tip of the loop is to the left +of the path, if negative it is to the right. The example at the start of +this paragraph was drawn using the following code: +\begin{verbatim} +\mfpic{0}{33}{0}{6.4} +\dotsize=1pt +\drawcolor{red} + \dotted\polyline{(0,3.2),(33,3.2)} +\drawcolor{black} + \coil[1.5]{3pt,3pt,4.8pt,3.2pt}\polyline{(0,3.2),(33,3.2)} +\endmfpic +\end{verbatim} -\subsubsection{Shading, Filling, Erasing, Clipping, -Hatching.}\label{filling} +\subsection{Shading, filling, erasing, clipping, hatching}\label{filling} -These macros can all be used to fill (or unfill) the interior of closed -paths, even if the paths cross themselves. Filling an open curve is -technically an error, but the \MF{} code responds by drawing the path -and not doing any filling. These macros replace the default rendering: -when they are used the outline will not be drawn unless an explicit -prefix to do so is present. +For the purposes of this section, a distinction must be made in the +figure macros between `open' and `closed' paths. A path that merely +returns to its starting point is \emph{not} automatically closed; such a +path might be open and may need to be explicitly closed, for example by +\cs{lclosed}. The (already) closed paths are those that have +`\texttt{closed}' or `\texttt{cyclic}' in their name plus: +\begin{display} + \cs{belowfcn}, \cs{border}, \cs{btwnfcn}, \cs{btwnplrfcn}, + \cs{chartbar} (and its aliases),\\ + \cs{circle}, \cs{ellipse}, \cs{levelcurve}, \cs{makesector}, + \cs{piewedge}, \cs{plrregion},\\ + \cs{polygon}, \cs{rect}, \cs{regpolygon}, \cs{sector}, + \cs{tlabelcircle}, \cs{tlabelellipse},\\ + \cs{tlabeloval}, and \cs{tlabelrect}. +\end{display} + +The macros of this section can all be used to fill (or unfill) the +interior of closed paths, even if the paths cross themselves. Filling an +open curve is technically an error, but the \MF{} code responds by +drawing the path and not doing any filling. Note that these macros +override the default rendering, so if you want some sort of fill pattern +\emph{and} an outline drawn, you need an explicit prefix for both. -\begin{cd} +\begin{cd}\pagelabel{gfill} \cs{gfill}\oarg{\meta{color}}$\ldots$% \index{gfill@\cs{gfill}} \end{cd} -Fills in the subsequent closed path. Under \MP{} it fills with -\meta{color}, which defaults to +This rendering macro fills in the subsequent closed path. Under \MP{} it +fills with \meta{color}, which defaults to \index{fillcolor@\gbc{fillcolor}}\gbc{fillcolor}. Under \MF{} it approximates the color with a shade of gray, clears the interior, and then fills with a pattern of black and white pixels simulating gray. -\begin{cd} +\begin{cd}\pagelabel{gclear} \cs{gclear}$\ldots$% \index{gclear@\cs{gclear}} \end{cd} -Erases everything \emph{inside} the subsequent closed path (except text -labels under some circumstances, see section~\ref{mplabels} and -\ref{overlaylabels}). Under \MP{} it actually fills with the -predefined color named \mfc{background}. Since \mfc{background} is normally -white, and so are most actual backgrounds, this is usually -indistinguishable from clearing. +This rendering macro erases everything \emph{inside} the subsequent +closed path (except text labels under some circumstances, see +section~\ref{mplabels} and \ref{overlaylabels}). Under \MP{} it actually +fills with the predefined color named \mfc{background}. Since +\mfc{background} is normally \mfc{white}, and so are most actual +backgrounds, this is usually indistinguishable from clearing. However, +if an \env{mfpic} environment utilzes \emph{background text} (see +subsection~\ref{text}), part of the background text may appear to be +`erased'. Unfortunately, there is little that can be done about this. -\begin{cd} +\begin{cd}\pagelabel{gclip} \cs{gclip}$\ldots$% \index{gclip@\cs{gclip}} \end{cd} -Erases everything \emph{outside} the subsequent closed path from the -picture (except text labels under some circumstances, see -section~\ref{mplabels} and \ref{overlaylabels}). +This rendering macro erases everything \emph{outside} the subsequent +closed path from the picture (except text labels under some +circumstances, see section~\ref{mplabels} and \ref{overlaylabels}). Note +that this is a true erasing, even in \MP{}. -\begin{cd} +\begin{cd}\pagelabel{shade} \cs{shade}\oarg{\meta{shadesp}}$\ldots$% \index{shade@\cs{shade}} \end{cd} -Shades the interior of the subsequent closed path with dots. The -diameter of the dots is the \MF{} variable \mfc{shadewd}, set by the -macro \cs{shadewd}\marg{\meta{size}}. Normally this is \dim{0.5pt}. The -optional argument specifies the spacing between (the centers of) the -dots, which defaults to the \TeX{} dimension \cs{shadespace}, initially -\dim{1pt}. If \cs{shadespace} is less than \mfc{shadewd}, the closed -path is filled with black, as if with \cs{gfill}. Under \MP{} this macro -actually fills the path's interior with a shade of gray. The shade to -use is computed based on \cs{shadespace} and \mfc{shadewd}. The default -values of these parameters correspond to a gray level of 75\% of white.% +This rendering macro shades the interior of the subsequent closed path +with dots. The diameter of the dots is the \MF{} variable \mfc{shadewd}, +set by the macro \cs{shadewd}\marg{\meta{size}}. Normally this is +\dim{0.5bp}. The optional argument specifies the spacing between (the +centers of) the dots, which defaults to the \TeX{} dimension +\cs{shadespace}, initially \dim{1pt}. If \cs{shadespace} is less than +\mfc{shadewd}, the closed path is filled with black, as if with +\cs{gfill}. Under \MP{} this macro actually fills the path's interior +with a shade of gray. The shade to use is computed based on +\cs{shadespace} and \mfc{shadewd}. The default values of these +parameters correspond to a gray level of about 78\% of white.% \footnote{If \cs{shadewd} is $w$ and \cs{shadespace} is $s$, then - the level of gray is $1 - (w/s)^2$, where $0$ denotes black and $1$ - white.} % + the level of gray is $1 - (.88w/s)^2$, where $0$ denotes black and + $1$ white.} % The \MF{} version attempts to optimize the dots to the pixel grid corresponding to the printers resolution (to avoid generating dither lines). Because this involves rounding, it will happen that values of @@ -2017,95 +2850,97 @@ parameters and particular printer resolutions cannot be predicted, and we even make no guarantee it will not change from one version of \mfp{} to another. -\begin{cd} +\begin{cd}\pagelabel{polkadot} \cs{polkadot}\oarg{\meta{space}}$\ldots$% \index{polkadot@\cs{polkadot}} \end{cd} -Fills the interior of a closed path with large dots. This is almost what -\cs{shade} does, but there are several differences. \cs{shade} is -intended solely to simulate a gray fill in \MF{} where the only color is -black. So it is optimized for small dots aligned to the pixel grid (in -\MF). In \MP{} all it does is fill with gray and is intended merely for -compatibility. The macro \cs{polkadot} is intended for large dots in any -color, and so it optimizes spacing (a nice hexagonal array) and makes no -attempt to align at the pixel level. The \meta{space} defaults to the -\TeX{} dimension \cs{polkadotspace}, initially \dim{10pt}. The diameter -of the dots is the value of the \MF{} variable \mfc{polkadotwd}, which -can be set with \cs{polkadotwd}\marg{\meta{size}}, and is initially -\dim{5pt}. The dots are colored with -\index{fillcolor@\gbc{fillcolor}}\gbc{fillcolor}. In \MF, nonblack -values of \gbc{fillcolor} will produce shaded dots. - -\begin{cd} +This rendering macro fills the interior of a closed path with large +dots. This is almost what \cs{shade} does, but there are several +differences. \cs{shade} is intended solely to simulate a gray fill in +\MF{} where the only color is black. So it is optimized for small dots +aligned to the pixel grid (in \MF{}). In \MP{} all it does is fill with +gray and is intended merely for compatibility. The macro \cs{polkadot} +is intended for large dots in any color, and so it optimizes spacing (a +nice hexagonal array) and makes no attempt to align at the pixel level. +The \meta{space} defaults to the \TeX{} dimension \cs{polkadotspace}, +initially \dim{10pt}. The diameter of the dots is the value of the \MF{} +variable \mfc{polkadotwd}, which can be set with +\cs{polkadotwd}\marg{\meta{size}}, and is initially \dim{5bp}. The dots +are colored with \index{fillcolor@\gbc{fillcolor}}\gbc{fillcolor}. In +\MF{}, nonblack values of \gbc{fillcolor} will produce shaded dots. + +\begin{cd}\pagelabel{thatch} \cs{thatch}\oarg{\meta{hatchsp},\meta{angle}}\oarg{\meta{color}}$\ldots$% \index{thatch@\cs{thatch}} \end{cd} -Fills a closed path with equally spaced parallel lines at the specified -angle. The thickness of the lines is set by the macro \cs{hatchwd}. In -the optional argument, \meta{hatchsp} specifies the space between lines, -which defaults to the \TeX{} dimension \cs{hatchspace}, initially -\dim{3pt}. The \meta{angle} defaults to 0. The \meta{color} defaults to -\gbc{hatchcolor}. If \cs{hatchspace} is less than the line thickness, -the closed path is filled with \meta{color}, as if with \cs{gfill}. If -the first optional argument appears, both parts must be present, -separated by a comma. For the color argument to be present, the other -optional argument must also be present. However, if one wishes only to -override the default color one can use an empty first optional argument -(completely empty, no spaces). - -\begin{cd} -\cs{lhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$% -\index{lhatch@\cs{lhatch}} +This rendering macro fills a closed path with equally spaced parallel +lines at the specified angle. The thickness of the lines is set by the +macro \cs{hatchwd}. In the optional argument, \meta{hatchsp} specifies +the space between lines, which defaults to the \TeX{} dimension +\cs{hatchspace}, initially \dim{3pt}. The \meta{angle} defaults to 0. +The \meta{color} defaults to \gbc{hatchcolor}. If \cs{hatchspace} is +less than the line thickness, the closed path is filled with +\meta{color}, as if with \cs{gfill}. If the first optional argument +appears, both parts must be present, separated by a comma. For the color +argument to be present, the other optional argument must also be +present. However, if one wishes only to override the default color one +can use an empty first optional argument (completely empty, no spaces or +comma). + +\begin{cd}\pagelabel{hatch} +\cs{lhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$\\ +\cs{rhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$\\ +\cs{hatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$\\ +\cs{xhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$% +\index{lhatch@\cs{lhatch}}% +\index{rhatch@\cs{rhatch}}% +\index{hatch@\cs{hatch}}% +\index{xhatch@\cs{xhatch}}% \end{cd} -Draws lines shading in the subsequent closed path in a left-oblique -hatched (upper left to lower right) pattern. It is exactly the same as +These rendering macros are just \cs{thatch} with predefined values of +the angle. \cs{lhatch} fills the region with left slanted lines (from +upper left to lower right). It is exactly the same as +\begin{display} \cs{thatch}\oarg{\meta{hatchsp},-45}\oarg{\meta{color}}$\ldots$ +\end{display} -\begin{cd} -\cs{rhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$% -\index{rhatch@\cs{rhatch}} -\end{cd} - -Draws lines shading in the subsequent closed path in a right-oblique -hatched (lower left to upper right) pattern. It is exactly the same as +\cs{rhatch} draws right slanted lines (lower left to upper right). It is +exactly the same as +\begin{display} \cs{thatch}\oarg{\meta{hatchsp},45}\oarg{\meta{color}}$\ldots$ +\end{display} -\begin{cd} -\cs{hatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$\\ -\cs{xhatch}\oarg{\meta{hatchsp}}\oarg{\meta{color}}$\ldots$% -\index{hatch@\cs{hatch}}% -\index{xhatch@\cs{xhatch}} -\end{cd} - -Draws lines shading in the subsequent closed path in a cross-hatched +\cs{hatch} (\cs{xhatch} is a synonym) draws lines in a cross-hatched pattern. It is exactly the same as \cs{rhatch} followed by \cs{lhatch} using the same \meta{hatchsp} and \meta{color}. Hatching should normally be used very sparingly, or never if -alternatives are available (color, shading). Hatching at two different -angles is, however, almost the only way to fill in two regions that -\emph{automatically} shows the overlapping region. +alternatives are available (color, shading). However, hatching or +polkadotting on top of another filling macro is almost the only way to +fill in two regions that \emph{automatically} shows the overlap area. +Hatching is at least less garish than polkadots. -\subsubsection{Changing the Default Rendering.}\label{default} +\subsection{Changing the default rendering}\label{default} \emph{Rendering} is the process of converting a geometric description -into a drawing. In \MF, this means producing a bitmap (\MF{} stores +into a drawing. In \MF{}, this means producing a bitmap (\MF{} stores these in \mfc{picture} variables), either by stroking (drawing) a path using a particular pen), or by filling a closed path. In \MP{} it means -producing a \PS{} description of strokes with pens, and fills +producing a \PS{} description of penstrokes and fills (with possible +clipping). -\begin{cd} +\begin{cd}\pagelabel{setrender} \cs{setrender}\marg{\meta{\TeX{} commands}}% \index{setrender@\cs{setrender}} \end{cd} Initially, \mfp{} uses the \cs{draw} command (stroking) as the default operation when a figure is to be rendered. However, this can be changed -to any combination of \mfp{} rendering commands and/or other \TeX{} +to any combination of \mfp{} rendering commands or indeed any \TeX{} commands, by using the \cs{setrender} command. This redefinition is local inside an \env{mfpic} environment, so it can be enclosed in braces to restrict its range. Outside an \env{mfpic} environment it is a global @@ -2115,35 +2950,37 @@ For example, after \cs{setrender}\marg{\cs{dashed}\cs{shade}} the command \cs{circle}\marg{(0,0),1} produces a shaded circle with a dashed outline. Any explicit rendering prefix overrides this default. -\subsubsection{Examples.}\label{examples} +\subsection{Examples}\label{examples} It may be instructive, for the purpose of understanding the syntax of \emph{shape-modifier and rendering prefixes}, to consider two examples: \begin{ex} - \cs{draw}\cs{shade}\cs{lclosed}\cs{lines}\marg{...} + \cs{draw}\cs{gfill}\oarg{red}\cs{lclosed}\cs{polyline}\marg{$\ldots$} \end{ex} -which shades inside a polygon and draws its outline; and +which fills inside a polygon and draws its outline; and \begin{ex} - \cs{shade}\cs{lclosed}\cs{draw}\cs{lines}\marg{...} + \cs{gfill}[red]\cs{lclosed}\cs{draw}\cs{polyline}\marg{$\ldots$} \end{ex} which draws all of the outline \emph{except} the line segment supplied -by \cs{lclosed}, then shades the interior. Thus, in the first case the -path is defined (by \cs{lines}) then closed, then the resulting closed -path is shaded, then drawn; while in the second case the order is: -defined, drawn, closed, shaded. In particular, what is drawn is the path -not yet closed. +by \cs{lclosed}, then fills the interior. Thus, in the first case the +path is first defined (by \cs{polyline}), then closed, then the resulting closed +path is filled, and finally drawn. In the second case the order is: +defined, drawn, closed, filled. In particular, what is drawn in the +second case is the path not yet closed. It should also be pointed out +that in the last case, the fill is placed last and will cover half +the thickness of the previously drawn outline. -\subsection{Functions and Plotting.}\label{functions} +\section{Functions and Plotting.}\label{functions} -In the following macros, expressions like $f(\mathtt{x})$, $g(\mathtt{t})$ +In the following macros, expressions like $f(\mathtt{x})$ or $g(\mathtt{t})$ stand for any legal \MF{} expression, in which the only unknown variables are those indicated (\texttt{x} in the first case, and \texttt{t} in the second). -\subsubsection{Defining Functions}\label{defining} +\subsection{Defining functions}\label{defining} -\begin{cd} +\begin{cd}\pagelabel{fdef} \cs{fdef}\marg{\meta{fcn}}\marg{\meta{param1},\meta{param2},$\ldots$}% \marg{\meta{mf-expr}}% \index{fdef@\cs{fdef}} @@ -2153,14 +2990,14 @@ Defines a \MF{} function \meta{fcn} of the parameters \meta{param1}, \meta{param2}, $\ldots$, by the \MF{} expression \meta{mf-expr} in which the only free parameters are those named. The return type of the function is the same as the type of the expression. What is allowed for -the function name \meta{fcn} is more restrictive than \MF's rule for +the function name \meta{fcn} is more restrictive than \MF{}'s rule for variable names. Roughly speaking, it should consist of letters and underscore characters only. (In particular, for those that know what -this means, the name should have no suffixes.) Try to make the names +this means, the name should have no suffixes.) Try to make the name distinctive to avoid redefining internal \MF{} commands. The expression \meta{mf-expr} is passed directly into the corresponding -\MF{} macro and interpreted there, so \MF's rules for algebraic +\MF{} macro and interpreted there, so \MF{}'s rules for algebraic expressions apply. If \cs{fdef} occurs inside an \env{mfpic} environment, it is local to that environment, otherwise it is available to all subsequent \env{mfpic} environments. @@ -2171,7 +3008,7 @@ place below where a \MF{} expression is required, you can use \mfc{x*x-x}. Operations available include \mfc{+}, \mfc{-}, \mfc{*}, \mfc{/}, and -\mfc{**} (\mfc{x**y}$=x^y$), with \mfc{(} and \mfc{)} for grouping. +\mfc{**} (\mfc{x**y}$=x^y$), with `\mfc{(}' and `\mfc{)}' for grouping. Functions already available include the standard \MF{} functions \mfc{round}, \mfc{floor}, \mfc{ceiling}, \mfc{abs}, \mfc{sqrt}, \mfc{sind}, \mfc{cosd}, \mfc{mlog}, and \mfc{mexp}. Note that in \MF{} @@ -2183,32 +3020,46 @@ so \mfc{x*y**z} means $(xy)^z$. Use parentheses liberally! \mfc{mexp} is its inverse.) You can also define the function \meta{fcn} by cases, using the \MF{} conditional expression \begin{ex} - \mfc{if~\meta{boolean}:~\meta{expr}~elseif - \meta{boolean}:~$\ldots$~else:~\meta{expr}~fi}. + \mfc{if~\meta{boolean}:~\meta{expr}~elseif + \meta{boolean}:~$\ldots$~else:~\meta{expr}~fi}. \end{ex} Relations available for the \meta{boolean} part of the expression include \mfc{=}, \mfc{<}, \mfc{>}, \mfc{<=}, \mfc{<>} and \mfc{>=}. Complicated functions can be defined by a compound expression, which is -a series of \MF{} statements, followed by an expression, all enclosed in -the commands \mfc{begingroup} and \mfc{endgroup}. The \cs{fdef} -command automatically supplies the grouping around the definition so -the user need not type them if the entire \meta{mf-expr} is one such -compound expression. \CMF{} functions can call \MF{} functions, -even recursively. - -Many common functions have been predefined in \file{grafbase}. These -include all the usual trig functions \mfc{tand}, \mfc{cotd}, \mfc{secd}, +a series of \MF{} statements, followed by an expression, all enclosed +between \mfc{begingroup} and \mfc{endgroup}. The \cs{fdef} command +automatically supplies these grouping commands around the definition so +if the entire \meta{mf-expr} is one such compound expression the user +need not type them. \CMF{} functions can call \MF{} functions, even +recursively. + +Many common functions have been predefined in \file{grafbase}, which is +a package of \MF{} macros that implement \prog{mfpic}'s drawing. These +include the rest of the trig functions \mfc{tand}, \mfc{cotd}, \mfc{secd}, \mfc{cscd}, which take angles in degrees, plus variants \mfc{sin}, \mfc{cos}, \mfc{tan}, \mfc{cot}, \mfc{sec}, and \mfc{csc}, which take angles in radians. Some inverse trig functions are also available, the following produce angles in degrees: \mfc{asin}, \mfc{acos}, and \mfc{atan}, and the following in radians: \mfc{invsin}, \mfc{invcos}, \mfc{invtan}. The exponential and hyperbolic functions: \mfc{exp}, -\mfc{sinh}, \mfc{cosh}, \mfc{tanh}, and their inverses \mfc{ln} (or -\mfc{log}), \mfc{asinh}, \mfc{acosh}, and \mfc{atanh} are also defined. +\mfc{sinh}, \mfc{cosh}, \mfc{tanh}, \mfc{coth}, \mfc{sech}, and +\mfc{csch}; and some of their inverses: \mfc{ln} (or \mfc{log}), +\mfc{asinh}, \mfc{acosh}, and \mfc{atanh} are also defined. + +There are also two conversion functions: \gbc{radians(t)} produces the +number of radians in \mfc{t} degrees and \gbc{degrees(t)} produces the +number of degrees in \mfc{t} radians. In these expressions the special +variable \gbc{pi} produces $\pi$, accurate to roughly 5 decimals. +(\CMF{} and \MP{} provide accuracy only to $\pm2^{-17} = \pm +.76\times10^{-5}$.) -\subsubsection{Plotting Functions}\label{plotting} +The integer functions \gbc{gcd(m,n)} and \gbc{lcm(n,m)} produce the +greatest common divisor and least common multiple of two integers +\gbc{m} and \gbc{n}. + + +\subsection{Plotting functions}\label{plotting} The plotting macros take two or more arguments. They have an optional first argument, \meta{spec}, which determines whether a function is @@ -2228,86 +3079,112 @@ steps, then round$((\meta{max}-\meta{min})/\meta{step})$ equal steps are used. One may have to experiment with the size of \meta{step}, since \MF{} merely connects the points corresponding to these steps with what \emph{it} considers to be a smooth curve. Smaller \meta{step} gives -better accuracy, but too small may cause the curve to exceed \MF's +better accuracy, but too small may cause the curve to exceed \MF{}'s capacity or slow down its processing. Increasing the tension may help keep the curve in line, but at the expense of reduced smoothness. There are one or more subsequent arguments, each of which is a \MF{} -function or expression as described above. +function or expression as described above. All the macros are figure +macros, defining a path to which prefixes may be applied. -\begin{cd} +\begin{cd}\pagelabel{function} \cs{function}\oarg{\meta{spec}}\marg{\meta{$x_{\mathrm{min}}$},% \meta{$x_{\mathrm{max}}$},\meta{$\Delta x$}}% \marg{$f(\mathtt{x})$}% \index{function@\cs{function}} \end{cd} -Plots $f(\mathtt{x})$, a \MF{} numeric function or expression of one -numeric argument, which must be denoted by a literal \texttt{x}. The -default \meta{spec} is \texttt{s}. For example -\begin{ex} -\cs{function}\marg{0,pi,pi/10}\marg{sin x} -\end{ex} +This figure macro produces the graph of $y = f(x)$, where $f$ is a \MF{} numeric +function or expression of one numeric argument, which must be denoted by +a literal \texttt{x}. The default \meta{spec} is \texttt{s}. For example +\begin{verbatim} +\function{0,pi,pi/10}{sin x} +\end{verbatim} draws the graph of $\sin x$ between 0 and $\pi$. -\begin{cd} +\begin{cd}\pagelabel{parafcn} \cs{parafcn}\oarg{\meta{spec}}\marg{\meta{$t_{\mathrm{min}}$},% \meta{$t_{\mathrm{max}}$},\meta{$\Delta t$}}% - \marg{\meta{pfcn}}% + \marg{($x(\mathtt{t}), y(\mathtt{t})$)}\\ +\cs{parafcn}\oarg{\meta{spec}}\marg{\meta{$t_{\mathrm{min}}$},% + \meta{$t_{\mathrm{max}}$},\meta{$\Delta t$}}% + \marg{\meta{pair-fcn}}% \index{parafcn@\cs{parafcn}} \end{cd} -Plots the parametric path determined by \meta{pfcn}, where \meta{pfcn} -is a \MF{} function or expression of one numeric argument \texttt{t}, -returning a \MF{} \emph{pair}. Or a pair of numeric expressions -$(x(\mathtt{t}),y(\mathtt{t}))$ enclosed in parentheses and separated by -a comma. The default \meta{spec} is \texttt{s}. For example -\begin{ex} -\cs{parafcn}\marg{0,1,.1}\marg{(2t, t + t*t)} -\end{ex} +This figure macro produces the parametric path determined by the last +argument. This can be a pair of expressions $x(\mathtt{t})$ and +$y(\mathtt{t})$ enclosed in parentheses and separated by a comma, with +the literal variable \texttt{t}. Alternatively, the last argument can be +a \MF{} function or expression in \texttt{t} that returns a pair.% + \footnote{There are very few of these. \CMF{} provides \mfc{dir t}, + which is essentially \mfc{(cosd t, sind t)}. \Mfp{} adds \gbc{cis + t}, which is the radian version \mfc{(cos t, sin t)}.} +The default \meta{spec} is \texttt{s}. For example +\begin{verbatim} +\parafcn{0,1,.1}{(2t, t+t*t)} +\end{verbatim} plots a smooth parabola from $(0,0)$ to $(2,2)$. -\begin{cd} +\begin{cd}\pagelabel{plrfcn} \cs{plrfcn}\oarg{\meta{spec}}\marg{\meta{$\theta_{\mathrm{min}}$},% \meta{$\theta_{\mathrm{max}}$},\meta{$\Delta\theta$}}% \marg{$f(\mathtt{t})$}% \index{plrfcn@\cs{plrfcn}} \end{cd} -Plots the polar function determined by $r=f(\theta)$, where $f$ is a -\MF{} numeric function or expression of one numeric argument, and -$\theta$ varies from \meta{$\theta_{\mathrm{min}}$} to -\meta{$\theta_{\mathrm{max}}$} in steps of \meta{$\Delta\theta$}. Each -$\theta$ value is interpreted as an angle measured in \emph{degrees}. In -the expression $f(\mathtt{t})$, the unknown \texttt{t} stands for -$\theta$. The default \meta{spec} is \texttt{s}. For example -\begin{ex} -\cs{plrfcn}\marg{0,90,5}\marg{sind (2t)} -\end{ex} -draws one loop of a 4-petal rosette. If one needs radian measures, use -something like the following. -\begin{ex} -\cs{plrfcn}\marg{0,pi*radian,pi*radian/18}\marg{sin (2t/radian)} -\end{ex} +This figure macro produces the graph of the polar coordinate equation +$r=f(\theta)$, where $f$ is a \MF{} numeric function or expression of +one numeric argument, and $\theta$ varies from +\meta{$\theta_{\mathrm{min}}$} to \meta{$\theta_{\mathrm{max}}$} in +steps of \meta{$\Delta\theta$}. Each $\theta$ value is interpreted as an +angle measured in \emph{degrees}. In the expression $f(\mathtt{t})$, the +unknown \texttt{t} stands for $\theta$. The default \meta{spec} is +\texttt{s}. For example +\begin{verbatim} +\plrfcn{0,90,5}{sind (2t)} +\end{verbatim} +draws one loop of a 4-petal rosette. Note that this function demands the +variable \mfc{t} be in degrees. The range and step size must be in +degrees and the function must operate on the numeric variable \gbc{t} in +degrees. If one needs to measure angles in radians, use the conversion +functions \gbc{degrees()} and \gbc{radians()}, as follows: +\begin{verbatim} +\plrfcn{0,degrees(pi/2),degrees(pi/36)}{sin (radians(2t))} +\end{verbatim} -\begin{cd} -\cs{btwnfcn}\oarg{\meta{spec}}\marg{\meta{$x_{\mathrm{min}}$},\meta{$x_{\mathrm{max}}$},\meta{$\Delta x$}}% - \marg{$f(\mathtt{x})$}\marg{$g(\mathtt{x})$}% -\index{btwnfcn@\cs{btwnfcn}} -\end{cd} - -Draws the region between the two functions $f(x)$ and $g(x)$, these -being numeric functions of one numeric argument \texttt{x}. The region is -bounded also by the vertical lines at \meta{$x_{\mathrm{min}}$} and \meta{$x_{\mathrm{max}}$}. -Unlike the previous function macros, the default \meta{spec} is -\texttt{p}---this macro is intended to be used for shading between drawn -functions, a task for which smoothness is usually unnecessary. -For example -\begin{ex} -\cs{shade}\cs{btwnfcn}\marg{0,180,5}\marg{0}\marg{sind x} -\end{ex} -shades the area between first crest of a sine wave and the x-axis. +\begin{cd}\pagelabel{btwnfcn} +\cs{btwnfcn}\oarg{\meta{spec}}\marg{\meta{$x_{\mathrm{min}}$},% + \meta{$x_{\mathrm{max}}$},\meta{$\Delta x$}}% + \marg{$f(\mathtt{x})$}\marg{$g(\mathtt{x})$}\\ +\cs{btwnplrfcn}\oarg{\meta{spec}}\marg{\meta{$\theta_{\mathrm{min}}$},% + \meta{$\theta_{\mathrm{max}}$},\meta{$\Delta \theta$}}% + \marg{$f(\mathtt{t})$}\marg{$g(\mathtt{t})$}% +\index{btwnfcn@\cs{btwnfcn}}% +\index{btwnplrfcn@\cs{btwnplrfcn}} +\end{cd} + +These are figure macros. The first one produces a closed path +surrounding the region between the graphs of the two functions. The +second one does the same for two polar functions. That is (in both +cases), the path follows the first function (in order or increasing $x$ +or $\theta$), thence along the straight line to the \emph{end} of the +second one, thence backwards along the second function (decreasing $x$ +or $\theta$) and finally along the straight line to the start. The last +two mandatory arguments, the functions, are specified exactly as in +\cs{function} and \cs{plrfcn}, being numeric functions of one numeric +argument \texttt{x} or \texttt{t}. Unlike the previous function macros, +the default \meta{spec} is \texttt{p}---these macros are intended to be +used for shading between drawn functions, a task for which smoothness is +usually unnecessary. For example, the first line below +\begin{verbatim} +\shade\btwnfcn{0,1,.1}{0}{x - x**2} +\btwnplrfcn[s]{-30,30,5}{1}{2*cosd 2t} +\end{verbatim} +shades the area between the $x$-axis and the given parabola. The second +draws the boundary of the region between the circle $r = 1$ and one loop +of the rosette $r = 2\cos 2\theta$. Note: the effect of \cs{btwnfcn} could also be accomplished with \begin{ex} @@ -2318,34 +3195,104 @@ Note: the effect of \cs{btwnfcn} could also be accomplished with \meta{$x_{\mathrm{max}}$},\meta{$\Delta x$}}\marg{$g(\mathtt{x})$}\\ \cs{endconnect} \end{ex} - -\begin{cd} +\cs{lclosed} was described in subsection~\ref{closure} and the +\cs{connect}\dots\cs{endconnect} pair was described in +subsection~\ref{reversal}. + +\begin{cd}\pagelabel{belowfcn} +\cs{belowfcn}\oarg{\meta{spec}}% + \marg{\meta{$x_{\mathrm{min}}$},\meta{$x_{\mathrm{max}}$},% + \meta{$\Delta x$}}\marg{$f(\mathtt{x})$}\\ \cs{plrregion}\oarg{\meta{spec}}% \marg{\meta{$\theta_{\mathrm{min}}$},\meta{$\theta_{\mathrm{max}}$},% \meta{$\Delta\theta$}}\marg{$f(\mathtt{t})$}% +\index{belowfcn@\cs{belowfcn}}% \index{plrregion@\cs{plrregion}} \end{cd} -Plots the polar region determined by $r=f(\theta)$, where $f$ is a \MF{} -numeric function of one numeric argument \texttt{t}. The $\theta$ -values are angles (measured in \emph{degrees}), varying from -\meta{$\theta_{\mathrm{min}}$} to \meta{$\theta_{\mathrm{max}}$} in -steps of \meta{$\Delta\theta$}. In the expression $f(\mathtt{t})$, the -\texttt{t} stands for $\theta$. The region is also bounded by the angles -\meta{$\theta_{\mathrm{min}}$} and \meta{$\theta_{\mathrm{max}}$}, i.e. -by the line segments joining the origin to the endpoints of the -function. The default \meta{spec} is \texttt{p} ---this macro is -intended to be used for shading a region with the boundary drawn, a task -for which smoothness is usually unnecessary. For example -\begin{ex} -\cs{shade}\cs{plrregion}\marg{0,90,5}\marg{sind (2t)} -\end{ex} -shades one loop of the 4-petal rosette. - - -\subsubsection{Plotting external data files}\label{external} - -\begin{cd} +These figure macros produce identical results to \cs{btwnfcn} and +\cs{btwnplrfcn} when the first function is just $0$. They are, however, +much more efficient. The first of these, \cs{belowfcn}, produces the +path surrounding the region bounded by the $x$-axis, the graph of +$y=f(x)$ and the two vertical lines $x=x_{\mathrm{min}}$ and $x = +x_{\mathrm{max}}$. (The region is not actually \emph{below} $y = f(x)$ +unless $f(x) \ge 0$ throughout the interval.) The second produces the +path surrounding the region bounded by the polar function $r = +f(\theta)$ and the two rays $\theta=\theta_{\mathrm{min}}$ and +$\theta=\theta_{\mathrm{max}}$. + +The arguments of these command are the same as the nonclosed versions, +\cs{function} and \cs{plrfcn}, except the default for the optional +agument is \texttt{[p]}. Again, this is because it is mainly for +shading. However, drawing the boundary is often needed: +\begin{verbatim} +\shade\plrregion{0,90,5}{sind (2t)} +\plrregion[s]{0,90,5}{sind (2t)} +\end{verbatim} +shades one loop of the 4-petal rosette, and then draws it.. + +\begin{cd}\pagelabel{levelcurve} +\cs{levelcurve}\oarg{\meta{spec}}\marg{\meta{seed},\meta{step}} + \marg{\meta{inequality}}% +\index{levelcurve@\cs{levelcurve}} +\end{cd} + +This figure macro produces a level curve of some function $F(x,y)$. +There are three requirements on the parameters for this to work +correctly. First, in order to obtain the curve satisfying $F(x,y) = C$, +the \marg{\meta{inequality}} must be either \verb${F(x,y) > C}$ or +\verb${F(x,y) < C}$.% + \footnote{A non-strict inequality such as \mfc{>=} can be + used, but the result will not be significantly different.} +Second, the level curve must surround the point given by the \meta{seed} +paramter, and third, the inequality must be true at this seed point. + +The command works by searching rightward from \meta{seed} until it +encounters the first point on the level curve. It then tries to find a +nearby point on the level curve and joins it to the first one, and +continues similarly until it finds it has returned near the starting +point. The meaning of ``nearby point on the level curve'' is the +intersection of the level curve with a circle of radius \meta{step} +centered at the previously found point. If the region defined by the +inequality extends beyond the bounds of the picture (as set by the +\cs{mfpic} command), the region is truncated and the resulting curve +will follow along the picture's border. + +Since the algorithm only approximates the level set, a tolerance (how +close the points are to actually being \emph{on} the level curve) is +chosen which gives two decimal places more accuracy than \meta{step}. +The value of \meta{step} is interpreted in \emph{graph} units and +so should be a pure number. The \oarg{\meta{spec}} is either \oarg{p}, +in which case the calculated points are joined with straight lines, or +\oarg{s\meta{tension}} as in \cs{function}. The default is +\oarg{s}: a smooth curve with the current default tension. + +In general, choosing a \meta{step} that corresponds to a few millimeters +works reasonably well. For example, if the graph unit is 1cm (for +example, \cs{mfpicunit=1cm} and no scaling is used), then +\meta{step}${}= 0.5$ might be a reasonable first choice. If the level +set is reasonably smooth and \oarg{s} is used, then the result will +match the actual curve to within .005cm, which is approximately .14pt, +which is less than half the thickness of the standard pen used to draw +it. If you \emph{only} intend to fill it, you might want a little more +accuracy. There is a lower limit: there should not be +more than 2000 steps in the curve. In a figure 10-by-10 graph units, a +level curve without too much oscillation could be about 80 units in +length and a step size of .04 would produce about 2000 steps. + +As a special case, if \meta{step} is 0, the maximum of width and height +of the figure (as given by the arguments to the \env{mfpic} environment) +is divided by 100. For example, in a 5-by-10 graph, giving a step size +of $0$ will actually select \meta{step}${}= 10/100 = 0.1$. + +The algorithm used will produce incorrect results if parts of the curve +that are distant (as measured \emph{along} the curve) are closer than +\meta{step} in actual distance. + + +\subsection{Plotting external data files}\label{external} + +\begin{cd}\pagelabel{datafile} \cs{datafile}\oarg{\meta{spec}}\marg{\meta{file}}\\ \cs{smoothdata}\oarg{\meta{tension}}\\ \cs{unsmoothdata}% @@ -2354,20 +3301,20 @@ shades one loop of the 4-petal rosette. \index{unsmoothdata@\cs{unsmoothdata}} \end{cd} -\cs{datafile} defines a curve connecting the points listed in the file -\meta{file}. (The context makes it clear whether this meaning of -\cs{datafile} or that of subsection~\ref{list} is meant.) The +The figure macro \cs{datafile} produces a curve connecting the points +listed in the file \meta{file}. (The context makes it clear whether this +meaning of \cs{datafile} or that of subsection~\ref{list} is meant.) The \meta{spec} may be \texttt{p} to produce a polygonal path, or \texttt{s} followed by a tension value (as in \cs{curve}) to produce a smooth path. If no \meta{spec} is given, the default is initially \texttt{p}, but \cs{smoothdata} may be used to change this. Thus, after the command -\cs{smoothdata}\oarg{\meta{tension}} the default \meta{spec} is changed -to \texttt{s\meta{tension}}. If the tension parameter is not supplied it -defaults to \mfc{1.0} (or the value set by the \cs{settension} command -if one has been used). +\cs{smoothdata}\oarg{\meta{tension}} the default \oarg{\meta{spec}} is +changed to \oarg{s\meta{tension}}. If the tension parameter is not +supplied it defaults to \mfc{1.0} (or the value set by the +\cs{settension} command if one has been used). -The command \cs{unsmoothdata} restores the default \meta{spec} to -\texttt{p}. +The command \cs{unsmoothdata} restores the default \oarg{\meta{spec}} to +\oarg{p}. By default, each non-blank line in the file is assumed to contain at least two numbers, separated by whitespace (blanks or tabs). The first @@ -2389,30 +3336,32 @@ external data file. For example, if a file \file{ptlist.dat} contains two or more numerical values per line separated by whitespace, then one can draw a dot at each of the points corresponding to the first pair of numbers on each line with the following. -\begin{ex} - \cs{point}\cs{datafile}\marg{ptlist.dat} -\end{ex} +\begin{verbatim} +\point\datafile{ptlist.dat} +\end{verbatim} In fact there is no essential difference between `\cs{datafile}\oarg{p}' and `\cs{polyline}\cs{datafile}', and no difference between `\cs{datafile}\oarg{s}' and `\cs{curve}\cs{datafile}'. - -Here is the full list of \mfp{} macros that allow this usage of -\cs{datafile}\index{datafile@\cs{datafile}}: - - \begin{raggedright} +Here is the full list (omitting aliases) of \mfp{} macros that allow +this usage of \cs{datafile}\index{datafile@\cs{datafile}}: \begin{itemize} -\item Numeric data: \cs{piechart}, \cs{barchart}, \cs{numericarray}, and +\raggedright +\item Numeric data: \cs{piechart}, \cs{barchart}, \cs{numericarray}, + \cs{dashpattern} and all the axis marks commands. -\item Point or vector data: \cs{point}, \cs{plotsymbol}, \cs{polyline}, - \cs{polygon}, \cs{fcncurve}, \cs{curve}, \cs{cyclic}, \cs{turtle}, - \cs{qspline}, \cs{closedqspline}, \cs{cspline}, \cs{closedcspline}, - \cs{mfbezier}, \cs{closedmfbezier}, \cs{qbeziers}, - \cs{closedqbeziers}, and \cs{pairarray}. +\item Point or vector data: + \cs{closedcomputedspline}, \cs{closedcspline}, \cs{closedmfbezier}, + \cs{closedqbeziers}, \cs{closedqspline}, \cs{computedspline}, + \cs{convexcurve}, \cs{convexcyclic}, \cs{cspline}, \cs{curve}, + \cs{cyclic}, \cs{fcncurve}, \cs{fcnspline}, \cs{mfbezier}, + \cs{pairarray}, \cs{periodicfcnspline}, \cs{plotsymbol}, \cs{point}, + \cs{polygon}, \cs{polyline}, \cs{putmfpimage} \cs{qbeziers}, \cs{qspline}, + \cs{turtle}, and \cs{pairarray}. \end{itemize} +In addition, \cs{setmfarray} and \cs{globalsetarray} can be used with +either numeric or pair data. - \end{raggedright} - -\begin{cd} +\begin{cd}\pagelabel{mfpdatacomment} \cs{mfpdatacomment}\cs{}\meta{char}% \index{mfpdatacomment@\cs{mfpdatacomment}} \end{cd} @@ -2421,7 +3370,7 @@ Changes \meta{char} to a comment character and changes the usual \TeX{} comment character \texttt{\%} to an ordinary character \emph{while reading a datafile for drawing}. -\begin{cd} +\begin{cd}\pagelabel{using} \cs{using}\marg{\meta{in-pattern}}\marg{\meta{out-pattern}}% \index{using@\cs{using}} \end{cd} @@ -2439,19 +3388,19 @@ curve. \CMF{} pair expressions can be used in the output portion of \cs{using}. For example \cs{using}\marg{\#1,\#2,\#3}\marg{(\#2,\#1)/10} or even \cs{using}\marg{\#1 \#2 \#3}\marg{polar(\#1,\#2)} if the data are polar coordinates. The default assumptions of the \cs{datafile} -command (i.e., space separated numbers, the first two determining each -point) correspond to the setting -\begin{ex} -\cs{using}\marg{\#1 \#2 \#3}\marg{(\#1,\#2)} -\end{ex} +command (numbers separated by spaces, with the first two determining the +$(x,y)$ pair) corresponds to the following setting. +\begin{verbatim} +\using{#1 #2 #3}{(#1,#2)} +\end{verbatim} The \cs{using} command cannot normally be used in the replacement text of another command. Or rather, it can be so used, but then each \texttt{\#} has to be doubled. If a \cs{using} declaration occurs in an \env{mfpic} environment it is local to that environment. Otherwise it affects all subsequent ones. -\begin{cd} -\cs{sequence}\index{sequence@\cs{sequence}} +\begin{cd}\pagelabel{sequence} +\cs{sequence}% \index{sequence@\cs{sequence}} \end{cd} @@ -2461,26 +3410,26 @@ position, with something like \cs{sequence} will take on the values \texttt{1}, \texttt{2}, etc. as lines are read from the file. -\begin{cd} +\begin{cd}\pagelabel{usingpairdefault} \cs{usingpairdefault}\\ \cs{usingnumericdefault}% \index{usingpairdefault@\cs{usingpairdefault}}% \index{usingnumericdefault@\cs{usingnumericdefault}} \end{cd} -The command \cs{usingpairdefault} restores the above default for pair -data. The command \cs{usingnumericdefault} is the equivalent of -\cs{using}\marg{\#1 \#2}\marg{\#1}. +The command \cs{usingpairdefault} restores the above described default +for pair data. The command \cs{usingnumericdefault} is the equivalent of +\cs{using}\marg{\#1 \#2}\marg{\#1}, a useful default for numeric data. Note that the default value of \cs{using} appears to reference three arguments. If there are only two numbers on a line separated by -whitespace, this will still work because of \TeX's argument matching -rules. \TeX's file reading mechanism normally converts the EOL to a +whitespace, this will still work because of \TeX{}'s argument matching +rules. \TeX{}'s file reading mechanism normally converts the EOL to a space, but there are exceptions so \mfp{} internally adds a space at the end of each line read in to be on the safe side. Then the default definition of \cs{using} reads everything up to the first space as \texttt{\#1} (whitespace is normally compressed to a single space by -\TeX's reading mechanism), then everything to the second space (the one +\TeX{}'s reading mechanism), then everything to the second space (the one added at the end of the line, perhaps) is \texttt{\#2}, then everything to the EOL is \texttt{\#3}. This might assign an empty argument to \texttt{\#3}, but it is discarded anyway. @@ -2489,28 +3438,36 @@ If the numerical data contain percentages with explicit \texttt{\%} signs, then choose another comment character with \cs{mfpdatacomment}. This will change \texttt{\%} to an ordinary character \emph{in the data file}. However, in your \cs{using} command it would still be read as a comment. -The following example shows how to overcome this: +The following allows one to overcome this. + +\begin{cd}\pagelabel{makepercentother} +\cs{makepercentother}\\ +\cs{makepercentcomment}% +\index{makepercentother@\cs{makepercentother}}% +\index{makepercentcomment@\cs{makepercentcomment}} +\end{cd} + +Here is an example or their use: \begin{verbatim} - \makepercentother - \using{#1% #2 #3}{(#1/100,#2)} - \makepercentcomment +\makepercentother +\using{#1% #2 #3}{(#1/100,#2)} +\makepercentcomment \end{verbatim} - -Here\index{makepercentother@\cs{makepercentother}}% -\index{makepercentcomment@\cs{makepercentcomment}} -is an analysis of the meaning of this example: everything in a line, up -to the first percent followed by a space is assigned to parameter -\texttt{\#1}, everything from there to the next space is assigned to -\texttt{\#2} and the rest of the line (which may be empty) is -\texttt{\#3}. On the output side in the above example, the percentage is -divided by 100 to convert it to a fraction, and plotted against the +Here is an analysis of the meaning of this example: everything in a +line, up to the first percent followed by a space is assigned to +parameter \texttt{\#1}, everything from there to the next space is +assigned to \texttt{\#2} and the rest of the line (which may be empty) +is \texttt{\#3}. On the output side in the above example, the percentage +is divided by 100 to convert it to a fraction, and plotted against the second parameter. Note: normal comments should not be used between \cs{makepercentother} and \cs{makepercentcomment}, for obvious reasons. +Moreover, the above construction will fail inside the argument of +another command. -\begin{cd} - \cs{plotdata}\oarg{\meta{spec}}\marg{\meta{file}}% - \index{plotdata@\cs{plotdata}} +\begin{cd}\pagelabel{plotdata} +\cs{plotdata}\oarg{\meta{spec}}\marg{\meta{file}}% +\index{plotdata@\cs{plotdata}} \end{cd} This plots several curves from a single file. The \meta{spec} and the @@ -2527,7 +3484,7 @@ etc., through a total of six different line types. A \cs{gendashed} command is used with predefined dash patterns named \mfc{dashtype0} through \mfc{dashtype5}. This behavior can be changed with: -\begin{cd} +\begin{cd}\pagelabel{coloredlines} \cs{coloredlines}\\ \cs{pointedlines}\\ \cs{datapointsonly}\\ @@ -2538,20 +3495,29 @@ through \mfc{dashtype5}. This behavior can be changed with: \index{dashedlines@\cs{dashedlines}} \end{cd} -The command \cs{coloredlines} changes to cycling through eight different -colors starting with black (hey, black is a color too). This has an -effect only for \MP. The sole exception to the general rule that all -curves are drawn in \gbc{drawcolor} is the \cs{plotdata} command after -\cs{coloredlines} has been issued. The command \cs{pointedlines} causes -\cs{plotdata} to use \cs{plot} commands, cycling through nine symbols. -The command \cs{datapointsonly} causes \cs{plotdata} to use -\cs{plotnodes}\marg{\meta{symbol}} commands to plot the data points -only. (See the Appendix for more details.) The command \cs{dashedlines} -restores the default. If, for some reason, you do not like the default -starting line style (say you want to start with a color other than -black), you can use one of the following commands. - -\begin{cd} +The command \cs{coloredlines} causes \cs{plotdata} to use the rendering +command \cs{draw} with a color option that cycles through eight +different colors starting with black (hey! black is a color too). The +command \cs{pointedlines} causes \cs{plotdata} to use the rendering +command \cs{plot}, cycling through nine symbols. The command +\cs{datapointsonly} causes \cs{plotdata} to use the rendering command +\cs{plotnodes}, cycling through the same nine symbols. The data points +become the nodes of the paths created and so only the data points are +plotted. The command \cs{dashedlines} restores the default. See +appendix~\ref{styles} for the details on the actual dash patterns, +colors and symbols used. + +The command \cs{coloredlines} will produce a warning under the +\opt{metafont} option and substitute \cs{dashedlines}. Under the +\opt{metapost} option, this is the sole exception to the general rule +that all curves are drawn in \gbc{drawcolor} by default: the +\cs{plotdata} command after \cs{coloredlines} has been issued. + +If, for some reason, you do not like the default starting line style +(say you want to start with a color other than black), you can use one +of the following commands. + +\begin{cd}\pagelabel{mfplinetype} \cs{mfplinetype}\marg{\meta{num}}, or\\ \cs{mfplinestyle}\marg{\meta{num}}% \index{mfplinetype@\cs{mfplinetype}}% @@ -2566,23 +3532,23 @@ $0$. If two or more \cs{plotdata} commands are used in the same \env{mfpic} environment, the numbering in each continues where the one before left off (unless you issue one of the commands above in between). \cs{mfplinestyle} means the same as \cs{mfplinetype}, and is included -for compatibility. See the Appendix to find out what dash pattern, +for compatibility. See appendix~\ref{styles} to find out what dash pattern, color or symbol corresponds to each number by default. The commands -below can be used to change the default dashess, colors, or symbols. +below can be used to change the default dashes, colors, or symbols. -\begin{cd} +\begin{cd}\pagelabel{reconfigureplot} \cs{reconfigureplot}\marg{dashes}\marg{\meta{pat$_1$},\dots,\meta{pat$_n$}}\\ \cs{reconfigureplot}\marg{colors}\marg{\meta{clr$_1$},\dots,\meta{clr$_n$}}\\ \cs{reconfigureplot}\marg{symbols}\marg{\meta{symb$_1$},\dots,\meta{symb$_n$}}% \index{reconfigureplot@\cs{reconfigureplot}} \end{cd} -The first argument of \cs{reconfigureplot} is the rendering method to -change: \texttt{dashes}, \texttt{colors}, or \texttt{symbols}. The +The first argument of \cs{reconfigureplot} is the rendering method to be +changed: \texttt{dashes}, \texttt{colors}, or \texttt{symbols}. The second argument is a list of dash patterns, colors, or symbols. The dash patterns should be names of patterns defined through the use of \cs{dashpattern}. The colors can be any color names already known to -\MP, or defined through \cs{mfpdefinecolor}. The symbols can be any of +\MP{}, or defined through \cs{mfpdefinecolor}. The symbols can be any of those listed with the \cs{plotsymbol} command (see subsection~\ref{points}), or any known \MF{} path variable. The colors can also be \MP{} expressions of type color, and the symbols can be @@ -2590,7 +3556,12 @@ expressions of type path. Within a \env{mfpic} environment, the changes made are local to that environment. Outside, they affect all subsequent environments. -\begin{cd} +Using \cs{reconfigureplot}\marg{colors} under the \opt{metafont} option +will have no effect, but may produce an error from \MF{} unless the +colors used conform to the guidelines in subsection~\ref{MFcolor}. +This also holds for \cs{defaultplot}\marg{colors} (below). + +\begin{cd}\pagelabel{defaultplot} \cs{defaultplot}\marg{dashes}\\ \cs{defaultplot}\marg{colors}\\ \cs{defaultplot}\marg{symbols} @@ -2605,51 +3576,55 @@ same meaning here (for \cs{plotdata}) as they do for \cs{datafile} (above). The sequence numbering for \cs{sequence} starts over with each new curve. -\subsection{Labels and Captions.}\label{labels} +\section{Labels and Captions.}\label{labels} -\subsubsection{Setting Text.}\label{text} +\subsection{Setting text}\label{text} If option \opt{metafont} is in effect macros \cs{tlabel}, \cs{tlabels}, \cs{axislabels} and \cs{tcaption} do not affect the \MF{} file -(\file{\meta{file}.mf}) at all, but are added to the picture by \TeX. If +(\file{\meta{file}.mf}) at all, but are added to the picture by \TeX{}. If \opt{metapost} is in effect but \opt{mplabels} is not, they do not affect the \MP{} file. In these cases, if these macros are the only changes or additions to your document, there is no need to repeat the processing with \MF{} or \MP{} nor the reprocessing with \TeX{} in order to complete your \TeX{} document. -\begin{cd} +\begin{cd}\pagelabel{tlabel} \cs{tlabel}\oarg{\meta{just}}\parg{\meta{x},\meta{y}}\marg{\meta{labeltext}}\\ \cs{tlabel}\oarg{\meta{just}}\marg{\meta{pair-list}}\marg{\meta{label text}}\\ \cs{tlabels}\marg{\meta{params$_1$} \meta{params$_2$} $\ldots$}% -\index{tlabel@\cs{tlabel}}\index{tlabels@\cs{tlabels}} +\index{tlabel@\cs{tlabel}}% +\index{tlabels@\cs{tlabels}} \end{cd} -Places \TeX{} labels on the graph. (Not to be confused with \LaTeX's -\cs{label} command.) The special form \cs{tlabels} (note the plural) -essentially just applies \cs{tlabel} to each set of parameters listed in -its argument. That is, each \meta{params$_k$} is a valid set of -parameters for a \cs{tlabel} command. These can be separated by spaces, -newlines, or nothing at all. They should \emph{not} be separated by -blank lines. +These place \TeX{} text or math on the graph. The special form +\cs{tlabels} (note the plural) essentially just applies \cs{tlabel} to +each set of parameters listed in its argument. That is, each +\meta{params$_k$} is a valid set of parameters for a \cs{tlabel} +command. These can be separated by spaces, newlines, or nothing at all. +They should \emph{not} be separated by blank lines. The last required parameter is ordinary \TeX{} text. The pair \parg{\meta{x},\meta{y}} gives the coordinates of a point in the graph -where the text will be placed. It may optionally be enclosed in braces. -In fact, the second syntax may be used if \opt{mplabels} is in effect, -where \meta{pair-list} is any expression recognized as a pair by \MP, or -a comma-separated list of such pairs. +where the text will be placed. It may optionally be enclosed in braces, +\verb${$ and \verb$}$. If braces are used, any number of coordinate +pairs may be listed, separated by commas. This is what is meant by +\meta{pair-list} in the above syntax. If \opt{mplabels} is in effect, +the \meta{pair-list} can be any list of expressions recognized as a pair +by \MP{}. The optional parameter \oarg{\meta{just}} specifies the \emph{justification}, the relative placement of the label with respect -to the point \parg{\meta{x},\meta{y}}. It is a two-character sequence -where the first character is one of \texttt{t} (top), \texttt{c} (center), -\texttt{b} (bottom), or \texttt{B} (Baseline), to specify vertical placement, -and the second character is one of \texttt{l} (left), \texttt{c} (center), or -\texttt{r} (right), to specify horizontal placement. These letters specify -what part of the \emph{text} is to be placed at the given point, so -\texttt{r} puts the right end of the text there---which means the text will be -left of the point. The default justification is \oarg{Bl}. +to the point with coordinates \parg{\meta{x},\meta{y}}. It is a +two-character sequence in which the first character is one of \texttt{t} +(top), \texttt{c} (center), \texttt{b} (bottom), or \texttt{B} +(Baseline), to specify vertical placement, and the second character is +one of \texttt{l} (left), \texttt{c} (center), or \texttt{r} (right), to +specify horizontal placement. These letters specify what part of the +\emph{text} is to be placed at the given point, so \texttt{r} puts the +right end of the text there---which means the text will be left of the +point. The default justification is \oarg{Bl}: the left end of the +baseline of the text is placed at the coordinates. When \opt{mplabels} is in effect, the two characters may optionally be followed by a number, specifying an angle in degrees to rotate the text @@ -2673,7 +3648,7 @@ very rudimentary feature. By default it left justifies the lines and causes \cs{tlabel} to redefine \bbsl. One can center a line by putting \cs{hfil} as the first thing in the line, and right justify by putting \cs{hfill} there (these are \TeX{} primitives). Redefining \bbsl{} can -interfere with \LaTeX's definition. For better control in \LaTeX{} use +interfere with \LaTeX{}'s definition. For better control in \LaTeX{} use \cs{shortstack} inside the label (or a \env{tabular} environment or some other environment which always initializes \bbsl{} with its own definition). @@ -2687,41 +3662,48 @@ If the \opt{mplabels} option is in effect, \cs{tlabel} will write a \mfc{btex $\ldots$ etex} group to the output file, allowing \MP{} to arrange for typesetting the label. Normally, the label becomes part of the picture, rather than being laid on top of it, and can be covered up -by any filling macros that follow, or clipped off by \cs{gclear} or -\cs{gclip}. However, under the \opt{overlaylabels} option (or after the -command \cs{overlaylabels}), labels are saved and added to the picture -at the very end. This may prevent some special effects, but it makes the +by any filling macros that follow, or clipped off by \cs{gclip}. +However, under the \opt{overlaylabels} option (or after the command +\cs{overlaylabels}), labels are saved and added to the picture at the +very end. This may prevent some special effects, but it makes the behavior of labels much more consistent through all the 12 permissable settings of the options \opt{metapost}, \opt{mplabels}, \opt{clip}, and \opt{truebbox}. -\begin{cd} -\cs{everytlabel}\marg{\meta{\TeX-code}}% +There is another command, \cs{startbacktext}, which also save the labels +and adds them later, but \emph{under} the rest of the picture as +background text. Thus, they will not be clipped, but may be covered up. +Since erasing regions with \cs{gclear} actually covers up those regions +with white, labels saved as background text may appear to have portions +erased. + +\begin{cd}\pagelabel{everytlabel} +\cs{everytlabel}\marg{\meta{\TeX{}-code}}% \index{everytlabel@\cs{everytlabel}} \end{cd} -One problem with multi-line \cs{tlabel}s is that each line of their +One problem with multiline \cs{tlabel}s is that each line of their contents constitutes a separate group. This makes it difficult to change the \cs{baselineskip} (for example) inside a label. The command \cs{everytlabel} saves it's contents in a token register and the code is issued in each \cs{tlabel}, as the last thing before the actual line(s) of text. Any switch you want to apply to every line can be supplied. For example -\begin{ex} - \cs{everytlabel}\marg{\cs{bf}\cs{baselineskip} 10pt} -\end{ex} +\begin{verbatim} +\everytlabel{\bf\baselineskip 10pt} +\end{verbatim} will make every line of every \cs{tlabel}'s text come out bold with 10 point baselines. The effect of \cs{everytlabel} is local to the -\env{mfpic} environment, if it is issued inside one. Note that the lines -of a tlabel are wrapped in a box, but the commands of \cs{everytlabel} -are outside all of them, so no actual text should be produced by these -commands. +\env{mfpic} environment, if it is issued inside one. Note that each line +of a tlabel is wrapped in a box, but the commands of \cs{everytlabel} +are outside all of them, so no actual text should be produced by the +contents of \cs{everytlabel}. Using \cs{tlabel} without an optional argument is equivalent to specifying \oarg{Bl}. Use the following command to change this behavior. -\begin{cd} +\begin{cd}\pagelabel{tlabeljustify} \cs{tlabeljustify}\marg{\meta{just}}% \index{tlabeljustify@\cs{tlabeljustify}} \end{cd} @@ -2732,35 +3714,47 @@ optional argument will be as specified in this command. For example, commands lacking an optional argument to be placed as if the argument \oarg{cr45} were used in each. If \opt{mplabels} is not in effect at the time of this command, the rotation part will be saved in case that -option is turned on later, but a warning message will be issued. Without -\opt{mplabels}, the rotation is ignored by \cs{tlabel} . +option is turned on later, but a warning message will be issued. If +\opt{mplabels} is not turned on later, that rotation will be ignored by +\cs{tlabel}. -\begin{cd} +\begin{cd}\pagelabel{tlabeloffset} \cs{tlabeloffset}\marg{\meta{hlen}}\marg{\meta{vlen}}\\ +\cs{tlpointsep}\marg{\meta{len}}\\ +\cs{tlpathsep}\marg{\meta{len}}\\ \cs{tlabelsep}\marg{\meta{len}}% \index{tlabeloffset@\cs{tlabeloffset}}% -\index{tlabelsep@\cs{tlabelsep}} +\index{tlabelsep@\cs{tlabelsep}}% +\index{tlpathsep@\cs{tlpathsep}}% +\index{tlpointsep@\cs{tlpointsep}} \end{cd} The first command causes all subsequent \cs{tlabel} commands to shift the label right by \meta{hlen} and up by \meta{vlen} (negative lengths cause it to be shifted left and down, respectively). -The \cs{tlabelsep} command causes labels to be shifted by the given +The \cs{tlpointsep} command causes labels to be shifted by the given amount in a direction that depends on the optional positioning parameter. For example, if the first letter is \texttt{t} the label is shifted down by the amount \meta{len} and if the second letter is -\texttt{l} it is also shifted right. In all cases it is shifted \emph{away} from -the point of placement (unless the dimension is negative). If \texttt{c} or -\texttt{B} is the first parameter, no vertical shift takes place, and if -\texttt{c} is the second, there is no horizontal shift. This is intended to -be used in cases where something has been drawn at that particular -point, in order to separate the text from the drawing, but the value is -also written to the output file for use by \cs{tlabelrect} -(subsection~\ref{surrounding}) and related -commands. - -\begin{cd} +\texttt{l} it is also shifted right. In all cases it is shifted +\emph{away} from the point of placement (unless the dimension is +negative). If \texttt{c} or \texttt{B} is the first parameter, no +vertical shift takes place, and if \texttt{c} is the second, there is no +horizontal shift. This is intended to be used in cases where something +has been drawn at that particular point, in order to separate the text +from the drawing. + +Prior to version 0.8, this separation also defined the separation +between the label and those curves designed to frame the label +such as \cs{tlabelrect} (subsection~\ref{surrounding}). Now the two +separations are independent and \cs{tlpathsep} is used to set the +separation between the label and such paths. + +For backward compatability, the command \cs{tlabelsep} is still +available and sets both separations to the same value. + +\begin{cd}\pagelabel{axislabels} \cs{axislabels}\marg{\meta{axis}}\oarg{\meta{just}}% \marg{\marg{\meta{text$_1$}}\meta{$n_1$},% \marg{\meta{text$_2$}}\meta{$n_2$},$\ldots$}% @@ -2771,7 +3765,7 @@ This command places the given \TeX{} text (\meta{text$_k$}) at the given positions (\meta{$n_k$}) on the given axis, \meta{axis}, which must be a single letter and one of \texttt{l}, \texttt{b}, \texttt{r}, \texttt{t}, \texttt{x}, or \texttt{y}. The text is placed as in \cs{tlabels} -(including the taking into account of \cs{tlabelsep} and +(including the taking into account of \cs{tlpointsep} and \cs{tlableoffset}), except that the default justification depends on the axis (the settings of \cs{tlabeljustify} are ignored). In the case of the border axes, the default is to place the label outside the axis and @@ -2784,74 +3778,132 @@ justification parameter. For example, to place the text strings `first', `second' and `third' just below the positions 1, 2 and 3 on the $x$-axis, rotated so they read upwards at a 90 degree angle, one can use \cs{axislabels}\marg{x}\oarg{cr90}\marg{\marg{first}1, -\marg{second}2, \marg{third}3} +\marg{second}2, \marg{third}3}. -\begin{cd} +\begin{cd}\pagelabel{plottext} \cs{plottext}\oarg{\meta{just}}\marg{\meta{text}}\marg{($x_0$,$y_0$), ($x_1$,$y_1$), $\ldots$}% \index{plottext@\cs{plottext}} \end{cd} Similar in effect to \cs{point} and \cs{plotsymbol} (but without -requiring \MF), \cs{plottext} places a copy of \meta{text} at each of -the listed points. It simply issues multiple \cs{tlabel} commands with -the same text and optional parameter, but at the different points -listed. This is intended to plot a set of points with a single letter or -font symbol (instead of a \MF{} generated shape). Like \cs{axislabels}, -this does not respond to the setting of \cs{tlabeljustify}. It has a -default setting of \oarg{cc} if the optional argument is omitted. The -points may be MetaPost pair expressions under \opt{mplabels}, but they -must \emph{not} be individually enclosed in braces. (This requirement is -new with version 0.7; prior to that pairs in braces didn't work reliably -anyway.) This command is actually unnecessary under \opt{mplabels} as -the plain \cs{tlabel} command can then be given a list of points. The -\cs{tlabel} command is more efficient, and \cs{plottext} is converted to -it internally. - -\begin{cd} -\cs{mfpverbtex}\marg{\meta{\TeX-cmds}}% +requiring \MF{}), \cs{plottext} places a copy of \meta{text} at each of +the listed points. Since version 0.9, when \cs{tlabel} was enhanced to +allow lists of points, it is implemented by an equivalent \cs{tlabel} +command and is only kept for backward compatibility. It differs from +\cs{tlabel} when the optional argument is absent: the default +justification is \oarg{cc} regardless of the setting of +\cs{tlabeljustify}. + +\begin{cd}\pagelabel{mfpverbtex} +\cs{mfpverbtex}\marg{\meta{\TeX{}-cmds}}% \index{mfpverbtex@\cs{mfpverbtex}} \end{cd} This writes a \mfc{verbatimtex} block to the \file{.mp} file. It makes -sense only if the \opt{mplabels} option is used and so only for \MP. The -\meta{\TeX-cmds} in the argument are written to the \file{.mp} file, -preceded by the \MP{} command \mfc{verbatimtex} and followed by -\mfc{etex}. Line breaks within the \meta{\TeX-cmd} are preserved. The +sense only if the \opt{mplabels} option is used and so only for \MP{}. +The \meta{\TeX{}-cmds} in the argument are written to the \file{.mp} +file, preceded by the \MP{} command \mfc{verbatimtex} and followed by +\mfc{etex}. Line breaks within the \meta{\TeX{}-cmd} are preserved. The \cs{mfpverbtex} command must come before any \cs{tlabel} that is to be affected by it. Any settings common to all \env{mfpic} environments should be in a \cs{mfpverbtex} command preceding all such environments. It may be issued at any point after \mfp{} is loaded, and any number of -times. If it issued before \cs{opengraphsfile}, its contents are saved -and written by that command. Because of the way \MP{} handles -\mfc{verbatimtex} material, the effects cannot be constrained by any -grouping unless one places \TeX{} grouping commands within -\meta{\TeX-cmds}. - -\begin{cd} +times. If it is issued before \cs{opengraphsfile}, its contents are +saved and written by that command. Therefore, it should occur only once +before the \cs{opengraphsfile} command. + +Because of the way \MP{} handles \mfc{verbatimtex} material, the effects +cannot be constrained by any grouping unless one places \TeX{} grouping +commands within \meta{\TeX{}-cmds}. However, \mfp{} itself places +grouping commands into the output file at the beginning and end of each +picture, so definitions written by a \cs{mfpverbtex} are local to any +picture in which it occurs. Prior to version 0.8, \mfp{} did not write +comments that occured within the \meta{\TeX{}-cmds}. Now they will be +preserved, and can be used to place the `\verb$%&latex$' line that some +\TeX{} distributions permit as a signal that latex should be run to +produce the labels. + +This command attempts a near-verbatim writing of the \meta{\TeX{}-cmds} +and, as with all verbatim-like commands, it should not be used in the +argument of another command. + +\begin{cd}\pagelabel{backtext} +\cs{startbacktext} \dots \cs{stopbacktext}% +\index{startbacktext@\cs{startbacktext}}% +\index{stopbacktext@\cs{stopbacktext}} +\end{cd} + +When \TeX{} adds labels (\cs{nomplabels}) they have to be positioned +either on top of a complete figure, or placed under a complete figure. +The most reasonable choice (and happily the easiest to implement) is to +put them on top. When \MP{} is placing labels (option \opt{mplabel}) the +same can be forced with the option \opt{overlaylabels}, but otherwise +they are placed as they occur, with later drawing commands perhaps +putting their results on top of the labels or clipping parts of them off. + +Sometimes it is useful to place some label as a background (not on top), +and yet not have it clipped by later commands. The effect of the command +\cs{startbacktext} is that \cs{tlabel} commands are saved in a special +place until the command \cs{stopbacktext}. Then, at \cs{endmfpic} the +rest of the figure is simply place on top of them. Since labels in \MP{} +files can only consist of characters from some font, if one wants to +include a graphic in the background (for example, via +\cs{includegraphics}), one needs to switch off \opt{mplabels}: +\begin{verbatim} +\nomplabels +\startbacktext + \tlabel[cc](0,0){\includegraphics{mygraph}} +\stopbacktext +\usemplabels +\end{verbatim} +As with other labels, it is permitted to switch \opt{mplabels} off and +on while creating background text. If there are both kinds of labels +within the background text area the ones handled by \TeX{} will be +further back than the ones handled by \MP{}. Within a given type, +earlier ones are further back than later ones. + +\Mfp{} normally uses a naming scheme like \cs{cmd} \dots \cs{endcmd} and +tries to arrange that \env{cmd} can be used as an environment. As +currently written, the extra grouping added by \cs{begin}\marg{cmd} and +\cs{end}\marg{cmd} would break the code that implements background text, +so we have named these in a different way to avoid suggesting this +possiblity. There should be at most one of these pairs in any +\env{mfpic} environment. It can occur anywhere in the environment, but +the two commands must not be inside any grouping. + +Under the \opt{metapost} option, the \cs{gclear} command doesn't really +clear a space, but rather paints the space over with white. Any +background text will not be visible through such `holes'. This is a +limitation of \MP{}. + +\begin{cd}\pagelabel{tcaption} \cs{tcaption}\oarg{\meta{maxwd},\meta{linewd}}\marg{\meta{caption text}}% \index{tcaption@\cs{tcaption}} \end{cd} Places a \TeX{} caption at the bottom of the graph. (Not to be confused -with \LaTeX's similar \cs{caption} command.) The macro will +with \LaTeX{}'s similar \cs{caption} command.) The macro will automatically break lines which are too much wider than the graph---if the \cs{tcaption} line exceeds \meta{maxwd} times the width of the graph, then lines will be broken to form lines at most \meta{linewd} times the width of the graph. The default settings for \meta{maxwd} and -\meta{linewd} are 1.2 and 1.0, respectively. \cs{tcaption} typesets its -argument twice (as does \LaTeX's \cs{caption}), the first time to test -its width, the second time for real. Therefore, the user is advised -\emph{not} to include any global assignments in the caption text. +\meta{linewd} are 1.2 and 1.0, respectively. \cs{tcaption} may typeset +its argument twice (as might \LaTeX{}'s \cs{caption}), the first time as +a single line to test its width, then again if that was too wide. +Therefore, the user is advised \emph{not} to include any global +assignments in the caption text. If the \cs{tcaption} and graph have different widths, the two are centered relative to each other. If the \cs{tcaption} takes multiple -lines, then the lines are both left- and right-justified (except for the -last line), but the first line is not indented. If the option +lines, then the default is to set lines both left- and right-justified +(except for the last line) with no indentation on the first line. If the +option \opt{raggedcaptions} is in effect, the lines are only +left-justified and ragged on the right. Finally, if the option \opt{centeredcaptions} is in effect, each line of the caption will be -centered. +centered (under \opt{raggedcaptions} they will be ragged on both sides). -In a \cs{tcaption}, Explicit line breaks may be specified by using the +In a \cs{tcaption}, explicit line breaks may be specified by using the \bbsl{} command. The separation between the bottom of the picture and the caption can be changed by increasing or decreasing the skip \cs{mfpiccaptionskip}\index{mfpiccaptionskip@\cs{mfpiccaptionskip}} @@ -2859,45 +3911,47 @@ the caption can be changed by increasing or decreasing the skip Many \mfp{} users find the \cs{tcaption} command too limiting (one cannot, for example, place the caption to the side of the figure). It is -common to use some other method (such as \LaTeX's \cs{caption} command +common to use some other method (such as \LaTeX{}'s \cs{caption} command in a \env{figure} environment). The dimensions \cs{mfpicheight} and \cs{mfpicwidth} (see section~\ref{parameters}) might be a convenience for plain \TeX{} users who want to roll their own caption macros. -\subsubsection{Curves surrounding text}\label{surrounding} +\subsection{Curves surrounding text}\label{surrounding} -\begin{cd} +\begin{cd}\pagelabel{tlabelrect} \cs{tlabelrect}\oarg{\meta{rad}}\oarg{\meta{just}}% \meta{pair}\marg{\meta{text}}\\ \cs{tlabelrect*...}% \index{tlabelrect@\cs{tlabelrect}} \end{cd} -This and the following two methods of surounding a bit of text with a -curve share some common characteristics which will be described here. -The commands all take an optional argument that can modify the shape of -the curve. After that come arguments exactly as for the \cs{tlabel} -command except that only a single point is permitted, not a list. (So -\meta{pair} is either of the form \parg{\meta{x},\meta{y}} or the same -enclosed in braces, or for \opt{mplabels} a pair expression in braces.) -After processing the surrounding curve, a \cs{tlabel} is applied to -those arguments unless a \texttt{*} is present. In order for the second -optional argument to be recognized as the second, the first optional -argument must also be present. An empty first optional argument is -permitted, causing the default value to be used. The default for the -justification parameter is \texttt{cc}, for compatibility with past -\mfp{} versions in which these commands all centered the figure around -the point and no justification parameter existed. This default can be -changed with the \cs{tlpathjustify} command below. +This figure macro and the following two methods of surounding a bit of +text with a curve share some common characteristics which will be +described here. The commands all take an optional argument that can +modify the shape of the curve. After that come arguments exactly as for +the \cs{tlabel} command except that only a single point is permitted, +not a list. (So \meta{pair} is either of the form +\parg{\meta{x},\meta{y}} or the same enclosed in braces, or for +\opt{mplabels} a pair expression in braces.) After processing the +surrounding curve, a \cs{tlabel} is applied to those arguments unless a +\texttt{*} is present. In order for the second optional argument (the +optional justification argument for the \cs{tlabel} command) to be +recognized as the second, the first optional argument must also be +present. An empty first optional argument is permitted, causing the +default value to be used. The default for the justification argument is +\texttt{cc}, for compatibility with past \mfp{} versions, in which these +commands all centered the figure around the point and no justification +parameter existed. This default can be changed with the +\cs{tlpathjustify} command below. The plain rectangle version produces a frame separated from the text on -all sides by the amount defined with \cs{tlabelsep}. All other versions +all sides by the amount defined with \cs{tlpathsep}. All other versions produce the smallest described curve that contains this rectangle. These commands may be preceded by prefix macros (see the sections \ref{modifier}~and \ref{rendering}, above). They all have a -`\texttt{*}-form' which produces the curve but omits placing the text. +`star-form' which produces the curve but omits placing the text. All have the effect of rendering the path \emph{before} placing any text. For example, \cs{gclear}\cs{tlabelrect}\dots\ will clear the rectangle and then place the following text in the cleared space. @@ -2911,34 +3965,36 @@ argument \meta{rad}: if the keyword `\texttt{roundends}' is used instead of a dimension, the radius will be chosen to make the nearest quarter circles just meet, so the narrow side of the rectangle is a half circle. -\begin{cd} +\begin{cd}\pagelabel{tlabeloval} \cs{tlabeloval}\oarg{\meta{mult}}\oarg{\meta{just}}% \meta{pair}\marg{\meta{text}}\\ \cs{tlabeloval*...}% \index{tlabeloval@\cs{tlabeloval}} \end{cd} -This is similar to \cs{tlabelrect}, except it draws an ellipse. The -ellipse is calculated to have the same ratio of width to height as the -rectangle mentioned above. The optional \meta{mult} is a multiplier that -increases or decreases this ratio. Values of \meta{mult} larger than 1 -increase the width and decrease the height. +This figure macro is similar to \cs{tlabelrect}, except it produces an +ellipse. The ellipse is calculated to have the same ratio of width to +height as the rectangle mentioned above. The optional \meta{mult} is a +multiplier that increases or decreases this ratio. Values of \meta{mult} +larger than 1 increase the width and decrease the height. -\begin{cd} +\begin{cd}\pagelabel{tlabelellipse} \cs{tlabelellipse}\oarg{\meta{ratio}}\oarg{\meta{just}}% \meta{pair}\marg{\meta{text}}\\ \cs{tlabelellipse*...}\\ \cs{tlabelcircle}\oarg{\meta{just}}\meta{pair}\marg{\meta{text}}\\ \cs{tlabelcircle*...}% -\index{tlabelellipse@\cs{tlabelellipse}}\index{tlabelcircle@\cs{tlabelcircle}} +\index{tlabelellipse@\cs{tlabelellipse}}% +\index{tlabelcircle@\cs{tlabelcircle}} \end{cd} -Draws the smallest ellipse centered at the point that encompasses the -rectangle defined above, and that has a ratio of width to height equal -to \meta{ratio} then places the text. The default ratio is $1$, which -produces a circle. We also provide the command \cs{tlabelcircle}, which -take only the \oarg{\meta{just}} optional argument. Internally, it just -processes any \texttt{*} and calls \cs{tlabelellipse} with parameter 1. +This figure macro produces the smallest ellipse centered at the point +that encompasses the rectangle defined above, and that has a ratio of +width to height equal to \meta{ratio}, then places the text. The default +ratio is $1$, which produces a circle. We also provide the command +\cs{tlabelcircle}, which takes only the \oarg{\meta{just}} optional +argument. Internally, it just processes any \texttt{*} and calls +\cs{tlabelellipse} with parameter 1. In the above \cs{tlabel...} curves, the optional parameter should be positive. If it is zero, all the curves silently revert to @@ -2947,8 +4003,8 @@ of \cs{tlabelrect} this causes the quarter-circles at the corners to be indented rather than convex. In the other cases, there is no visible effect, but in all cases the sense of the curve is reversed. -\begin{cd} -\cs{tlpathjustify}\marg{\meta{just}} +\begin{cd}\pagelabel{tlpathjustify} +\cs{tlpathjustify}\marg{\meta{just}}% \index{tlpathjustify@\cs{tlpathjustify}} \end{cd} @@ -2957,15 +4013,15 @@ and friends. The \meta{just} parameter is exactly as in \cs{tlabeljustify} in subsection~\ref{text}. -\subsection{Saving and Reusing an \mfp{} Picture.}\label{saving} +\section{Saving and Reusing an \mfp{} Picture.}\label{saving} These commands have been changed from versions prior to 0.3.14 in order -to behave more like the \LaTeX's \cs{savebox}, and also to allow the +to behave more like the \LaTeX{}'s \cs{savebox}, and also to allow the reuse of an allocated box. Past files that use \cs{savepic} will have to be edited to add \cs{newsavepic} commands that allocate the \TeX{} boxes. -\begin{cd} +\begin{cd}\pagelabel{newsavepic} \cs{newsavepic}\marg{\meta{picname}}\\ \cs{savepic}\marg{\meta{picname}}\\ \cs{usepic}\marg{\meta{picname}}% @@ -2974,9 +4030,10 @@ boxes. \index{usepic@\cs{usepic}} \end{cd} -\cs{newsavepic} allocates a box (like \LaTeX's \cs{newsavebox}) in which +\cs{newsavepic} allocates a box (like \LaTeX{}'s \cs{newsavebox}) in which to save a picture. As in \cs{newsavebox}, \meta{picname} is a control -sequence. Example: \cs{newsavepic}\marg{\cs{foo}}. +sequence. Example: \cs{newsavepic}\marg{\cs{foo}}. In a \LaTeX{} +document, \cs{newsavepic} is actually defined to be \cs{newsavebox}. \cs{savepic} saves the \emph{next} \cs{mfpic} picture in the named box, which should have been previously allocated with \cs{newsavepic}. (This @@ -2984,22 +4041,27 @@ command should not be used \emph{inside} an \env{mfpic} environment.) The next picture will not be placed, but saved in the box for later use. This is primarily intended as a convenience. One \emph{could} use \begin{ex} - \cs{savebox}\marg{\meta{picname}}\marg{\meta{entire \env{mfpic} environment}}, + \cs{savebox}\marg{\meta{picname}}\marg{\meta{entire + \env{mfpic} environment}}, \end{ex} but \cs{savepic} avoids having to place the \env{mfpic} environment in braces, and avoids one extra level of \TeX{} grouping. It also avoids reading the entire \env{mfpic} environment as a parameter, which would -nullify \mfp's efforts to preserve line breaks in parameters +nullify \mfp{}'s efforts to preserve line breaks in parameters written to the \MF{} output file. If you repeat \cs{savepic} with the same \meta{picname}, the old contents are replaced with the next picture. \cs{usepic} copies the picture that had been saved in the named box. This may be repeated as often as liked to create multiple copies of one -picture. +picture. The \cs{usepic} command is essentially a clone of the \LaTeX{} +\cs{usebox} command. Since the contents of the saved picture are only +defined during the \TeX{} run, \cs{usebox} cannot be used in the +\TeX-commands argument of the \cs{tlabel} command while \opt{mplabels} +is in effect. -\subsection{Picture frames.}\label{frames} +\section{Picture Frames.}\label{frames} When \TeX{} is run but before \MF{} or \MP{} has been run on the output file, \mfp{} detects that the \file{.tfm} file is missing or that @@ -3009,7 +4071,7 @@ dimensions equal to the nominal size of the picture, containing the figure name and number (and any \TeX{} labels). The command(s) used internally to do this are made available to the user. -\begin{cd} +\begin{cd}\pagelabel{mfpframe} \cs{mfpframe}\oarg{\meta{fsep}}% \meta{ material-to-be-framed }% \cs{endmfpframe}\\ @@ -3019,25 +4081,25 @@ internally to do this are made available to the user. \index{mfpframe@\cs{mfpframe}} \end{cd} -These surround their contents with a rectangular frame consisting of -lines with thickness \cs{mfpframethickness} separated from the contents -by the \meta{fsep} if specified, otherwise by the value of the dimension -\cs{mfpframesep}. The default value of the \TeX{} dimensions -\cs{mfpframesep} and \cs{mfpframethickness} are \dim{2pt} and +These commands surround their contents with a rectangular frame +consisting of lines with thickness \cs{mfpframethickness} separated from +the contents by the \meta{fsep} if specified, otherwise by the value of +the dimension \cs{mfpframesep}. The default value of the \TeX{} +dimensions \cs{mfpframesep} and \cs{mfpframethickness} are \dim{2pt} and \dim{0.4pt}, respectively. The \cs{mfpframe} $\ldots$ \cs{endmfpframe} version is preferred around \env{mfpic} environments or verbatim material since it avoids reading the enclosed material before -appropriate \cs{catcode} changes go into effect. In \LaTeX, one can also -use the \cs{begin}\marg{mfpframe} $\ldots$ \cs{end}\marg{mfpframe} +appropriate \cs{catcode} changes go into effect. In \LaTeX{}, one can +also use the \cs{begin}\marg{mfpframe} $\ldots$ \cs{end}\marg{mfpframe} syntax. An alternative way to frame \env{mfpic} pictures is to save them with \cs{savepic} (see previous section) and issue a corresponding -\cs{usepic} command inside any framing environment/command of the user's +\cs{usepic} command inside any framing environment or command of the user's choice or devising. -\subsection{Affine Transforms.}\label{transforms} +\section{Affine Transforms.}\label{transforms} Coordinate transformations that keep parallel lines in parallel are called \emph{affine transforms}. These include translation, rotation, @@ -3047,12 +4109,10 @@ system only---that is, for paths, but not for \cs{tlabel}'s (let alone affine transforms. -\subsubsection{Affine Transforms of the \MF{} Coordinate -System.}\label{affine} +\subsection{Transforming the \MF{} coordinate system}\label{affine} -\begin{cd} -\cs{coords} $\ldots$ -\cs{endcoords}% +\begin{cd}\pagelabel{coords} +\cs{coords} \dots \cs{endcoords}% \index{coords@\cs{coords}}% \index{endcoords@\cs{endcoords}} \end{cd} @@ -3060,80 +4120,72 @@ System.}\label{affine} All affine transforms are restricted to the innermost enclosing \cs{coords}$\ldots$\cs{endcoords} pair. If there is \emph{no} such enclosure, then the transforms will apply to the rest of the \env{mfpic} -environment - -\emph{Note}: In \LaTeX, a \env{coords} environment may be used. +environment. In \LaTeX{}, a \env{coords} environment may be used. \medskip -Transforms provided by \mfp. +\noindent Transforms provided by \mfp{}: -\medskip -\halign -{#\hfil&\quad#\hfil\cr +\nobreak +\begin{cd}\pagelabel{applyT}% +\begin{tabular}[b]{@{}ll@{}} \cs{rotate}\marg{\meta{$\theta$}}% \index{rotate@\cs{rotate}}% - & Rotates around origin by \meta{$\theta$} degrees \cr - \cs{rotatearound}\marg{\meta{point}}\marg{\meta{$\theta$}}% + & Rotate around origin by \meta{$\theta$} degrees.\\ + \cs{rotatearound}\marg{\meta{$p$}}\marg{\meta{$\theta$}}% \index{rotatearound@\cs{rotatearound}}% - & Rotates around point \meta{point} by \meta{$\theta$} degrees \cr - \cs{turn}\oarg{\meta{point}}\marg{\meta{$\theta$}}% + & Rotate around point \meta{$p$} by \meta{$\theta$} degrees.\\ + \cs{turn}\oarg{\meta{p}}\marg{\meta{$\theta$}}% \index{turn@\cs{turn}}% - & Rotates around point \meta{point} (origin is default) by - \meta{$\theta$} \cr - \cs{mirror}\marg{\meta{$p_1$}}\marg{\meta{$p_2$}}% - \index{mirror@\cs{mirror}}% - & Same as \cs{reflectabout}\cr + & Rotate around point \meta{p} (origin is default) by + \meta{$\theta$}.\\ \cs{reflectabout}\marg{\meta{$p_1$}}\marg{\meta{$p_1$}}% \index{reflectabout@\cs{reflectabout}}% - & Reflect about the line \meta{$p_1$}\texttt{--}\meta{$p_2$} \cr - \cs{shift}\marg{\meta{pair}}% + & Reflect in the line through points \meta{$p_1$} and \meta{$p_2$}.\\ + \cs{mirror}\marg{\meta{$p_1$}}\marg{\meta{$p_2$}}% + \index{mirror@\cs{mirror}}% + & Same as \cs{reflectabout}.\\ + \cs{shift}\marg{\meta{v}}% \index{shift@\cs{shift}}% - & Shifts origin by the vector \meta{pair} \cr + & Shift origin by the vector \meta{v}.\\ \cs{scale}\marg{\meta{s}}% \index{scale@\cs{scale}}% - & Scales uniformly by a factor of \meta{s} \cr + & Scale uniformly by a factor of \meta{s}.\\ \cs{xscale}\marg{\meta{s}}% \index{xscale@\cs{xscale}}% - & Scales only the X coordinates by a factor of \meta{s} \cr + & Scale only the $x$ coordinates by a factor of \meta{s}.\\ \cs{yscale}\marg{\meta{s}}% \index{yscale@\cs{yscale}}% - & Scales only the Y coordinates by a factor of \meta{s} \cr + & Scale only the $y$ coordinates by a factor of \meta{s}.\\ \cs{zscale}\marg{\meta{pair}}% \index{zscale@\cs{zscale}}% - & Scales uniformly by magnitude of \meta{pair}, and rotates by angle - of \meta{pair} \cr + & Scale by the magnitude of vector \meta{v}, and rotate by its + angle.\\ \cs{xslant}\marg{\meta{s}}% \index{xslant@\cs{xslant}}% - & Skew in $X$ direction by the multiple \meta{s} of $Y$ \cr + & Skew in $x$ direction by the multiple \meta{s} of $y$.\\ \cs{yslant}\marg{\meta{s}}% \index{yslant@\cs{yslant}}% - & Skew in $Y$ direction by the multiple \meta{s} of $X$ \cr + & Skew in $y$ direction by the multiple \meta{s} of $x$.\\ \cs{zslant}\marg{\meta{pair}}% \index{zslant@\cs{zslant}}% - & See \mfc{zslanted} in \file{grafdoc.tex} \cr + & See \mfc{zslanted} in \file{grafbase.dtx}.\\ \cs{boost}\marg{\meta{$\chi$}}% \index{boost@\cs{boost}}% & Special relativity boost by $\chi$, see \mfc{boost} in - \file{grafdoc.tex} \cr + \file{grafbase.dtx}.\\ \cs{xyswap}% \index{xyswap@\cs{xyswap}}% - & Exchanges the values of $x$ and $y$. \cr}% - -An arbitrary \MF{} transformation can be implemented with - -\begin{cd} -\cs{applyT}\marg{\meta{transformer}}% -\index{applyT@\cs{applyT}} + & Exchange the values of $x$ and $y$.\\ + \cs{applyT}\marg{\meta{transformer}}% + \index{applyT@\cs{applyT}}% + & Apply the \meta{transformer}. +\end{tabular} \end{cd} -This is mainly for \MF{} hackers. This applies the \MF{} -\meta{transformer} to the current coordinate system. For example, the -\mfp{} \TeX{} macro \cs{zslant\#1} is implemented as -\cs{applyT}\marg{zslanted \#1} where the argument \mfc{\#1} is a \MF{} -pair, such as $(x,y)$. Any code that satisfies \MF's syntax for a -\meta{transformer} (see D.~E.~Knuth, ``The \MF book'') is permitted, -although no effort is made to correctly write \TeX{} special characters -nor to preserve linebreaks in the code. +\cs{applyT} is for \MF{} hackers. Any code is permitted that satisfies +\MF{}'s syntax for a \meta{transformer} (see D.~E.~Knuth, ``The +\MF{}book'', page~73), although no effort is made to correctly write +\TeX{} special characters nor to preserve linebreaks in the code. When any of these commands is issued, the effect is to transform all subsequent figures (within the enclosing \env{coords} or \env{mfpic} @@ -3146,10 +4198,15 @@ applied in succession, then the most recent is applied first, so that figures are transformed as if the transformations were applied in the reverse order of their occurrence. This is similar to the application of prefix macros (as well as application of transformations in mathematics: -$T_1 T_2 z$ usually means to apply $T_1$ to the result of $T_2 z$). +$S T z$ usually means to apply $S$ to the result of $T z$). +Finally, some of these may not produce what the unwary user might expect +if the \env{mfpic} environment was started with unequal scaling. For +example, in such a case a rotated rectangle will not have right angles +unless the rotation is by a multiple of 90 degrees. -\subsubsection{Transformation of Paths.}\label{transformation} + +\subsection{Transforming paths}\label{transformation} In the previous section we discussed transformations of the \MF{} coordinate system. Those macros affect the \emph{drawing} of paths and @@ -3157,7 +4214,7 @@ other figures, but do not change the actual paths. We will explain the distinction after introducing two macros for storing and reusing figures. -\begin{cd} +\begin{cd}\pagelabel{store} \cs{store}\marg{\meta{path variable}}\marg{\meta{path}}\\ \cs{store}\marg{\meta{path variable}}\meta{path}% \index{store@\cs{store}} @@ -3165,99 +4222,108 @@ figures. This stores the following \meta{path} in the specified \MF{} \meta{path variable}. Any valid \MF{} symbolic token will do, in particular, any -sequence of letters or underscores. You should be careful to make the +sequence of letters and underscores. You should be careful to make the name distinctive to avoid overwriting the definition of some internal variable. The stored path may later be used as a figure macro using \cs{mfobj} (below). The \meta{path} may be any of the figure macros (such as \cs{curve}\marg{(0,0),(1,0),(1,1)}) or the result of -modifying it. For example. - -\begin{ex} -\cs{store}\marg{pth}\cs{lclosed}\cs{reverse}% - \cs{curve}\marg{(0,0),(1,0),(1,1)}) -\end{ex} +modifying it. For example: +\begin{verbatim} +\store{pth}\lclosed\reverse\curve{(0,0),(1,0),(1,1)} +\end{verbatim} In fact, \cs{store} is a prefix macro that does nothing to the following curve except store it. It acts as a rendering macro with a null rendering, so the curve is not made visible unless other rendering -macros appear before or after it. It is special in that it is the only -prefix macro that allows the following path to be an argument, that is, -enclosed in braces. This is solely to support past \mfp{} versions in -which \cs{store} was \emph{not} defined as a prefix macro. +macros appear before or after it. It allows the following path to be an +argument, that is, enclosed in braces. This is solely to support files +written for past \mfp{} versions in which \cs{store} was \emph{not} +defined as a prefix macro. + +One use of \cs{store} is to create a shorthand for a path that is +otherwise long and tedious to type. Another is to create `symbols' or +`arrowheads' for use in \cs{plotsymbol}, \cs{arrowhead} and related +commands. -\begin{cd} +\begin{cd}\pagelabel{mfobj} \cs{mfobj}\marg{\meta{path expression}}\\ \cs{mpobj}\marg{\meta{path expression}}% -\index{mfobj@\cs{mfobj}}\index{mpobj@\cs{mpobj}} +\index{mfobj@\cs{mfobj}}% +\index{mpobj@\cs{mpobj}} \end{cd} -The \meta{path expression} is a previously stored path variable, or a -valid \MF{} (or \MP) expression combining such variables and/or constant -paths. This allows the use of path variables or expressions as figure -macros, permitting all prefix operations, etc.. Here's some -oversimplified uses of \cs{store} and \cs{mfobj}: +This figure macro produces the path represented by \meta{path +expression}, which is either a path variable in which a path was +previously stored, or a valid \MF{} expression combining such variables +and constant paths. This allows the use of path variables or +expressions as figure macros, permitting all prefix operations, etc.. +Here are some examples of the use of \cs{store} and \cs{mfobj}. \nobreak \begin{verbatim} -\store{my_f}{\circle{...}} % Store a circle. -\dotted\mfobj{my_f} % Now draw it dotted, -\hatch\mfobj{my_f} % and hatch its interior -% Store two curves: -\store{my_f}{\curve{...}} -\store{my_g}{\curve{...}} -% Store two combinations of them: -\store{my_h}{\mfobj{my_f--my_g--cycle}} % a MF path expression -\store{my_k}{% - \lclosed\connect % a combination path created from - \mfobj{my_f}\mfobj{my_g} % mfpic commands. - \endconnect} -\dotted\mfobj{my_f} % Draw the first dotted, -\dotted\mfobj{my_g} % then the second. -\shade\mfobj{my_h} % Now shade one combination. -\hatch\mfobj{my_k} % and hatch the other +\store{my_f}{\cyclic{...}} % Store a closed curve. +\dotted\mfobj{my_f} % Now draw it dotted, +\hatch\mfobj{my_f} % and hatch its interior +% Create two symbols +% one outline: +\store{MyTriang}{\polyline{(-.5,-.5),(.5,-.5),(0,.5),(-.5,-.5)} +% one solid: +\store{MySolidTriang}{\polygon{(-.5,-.5),(.5,-.5),(0,.5)} +% Use them as symbols: +\plotsymbols{MyTriang}{(0,0),(2,2)} +\arrowmid{MySolidTriang}\polyline{(1,1),(0,2)} \end{verbatim} -The two forms \cs{mfobj} and \cs{mpobj} are absolutely equivalent. + +\emph{Note}: If a stored path has the same starting point as ending +point, but is \emph{not} closed then it will behave like \texttt{Circle} +(for example) when used in \cs{plotsymbol}: only its outline is drawn, +and its interior is erased when \opt{clearsymbols} is in effect. If a +closed path is stored, it behaves like \texttt{SolidCircle}: it is not +drawn, but rather filled. If a path is stored that satisfies neither, it +behaves like \texttt{Asterisk}, being simply drawn in all circumstances. + +The two forms \cs{mfobj} and \cs{mpobj} are absolutely equivalent; they +differ only in spelling. It should be noted that every \mfp{} figure is implicitly stored in the object \gbc{curpath}. So you can use \cs{mfobj}\marg{curpath} and get -the path defined by the most recent sequence of prefix macros and -figure. +the path defined by the most recently completed figure macro (possibly +modified by prefixes). Getting back to coordinate transforms, if one changes the coordinate system and then stores and draws a curve, say by \begin{verbatim} - \coords - \rotate{45 deg} - \store{xx}{\rect{(0,0),(1,1)}} - \dashed\mfobj{xx} - \endcoords +\coords + \rotate{45 deg} + \store{xx}{\rect{(0,0),(1,1)}} + \dashed\mfobj{xx} +\endcoords \end{verbatim} one will get a transformed picture, but the object \cs{mfobj}\marg{xx} will contain the simple, unrotated rectangular path and drawing it later (outside the \env{coords} environment) will prove that. This is because the \texttt{coords} environment works at the drawing level, not at the -definition level. In oversimplified terms, \cs{dashed} invokes the -transformation, but not \cs{store}. More precisely, \mfp{} prefix macros -have an input and an output and a side effect. The input is the output -of whatever follows it, the output can be the same as the input (the -case for rendering prefixes) or modified version of that (the closure -prefixes). The side effect is the drawing (dashing, filling) of the path, -appending of an arrowhead, etc.. These side effects have to know where -to place their marks, so a computation is invoked that converts the -user's graph coordinates into \MF's drawing coordinates. The previous -transformation macros work by modifying the parameters used in this -computation. +definition level. + +In oversimplified terms, \cs{dashed} invokes the transformation, but not +\cs{store}. More precisely, the rendering macros have the side effect of +adding ink to the page (or subtracting it). To know where to place this +ink, a calculation is performed that translates graph coordinates to +actual positions. The above transforms work by modify the parameters +used in that calculation. On the other hand, \cs{store} merely stores +the output of the immediately following prefix or figure macro. See the +beginning of section~\ref{modifier} for a discussion of input, output +and side effects of \mfp{} prefix and figure macros. The following transformation prefixes provide a means of actually creating and storing a transformed path. In the terms just discussed, their input is a path, their output is the transformed path, and they -have no side effects (other than invoking the default rendering if no -rendering prefix was previously provided). +have no side effects. -\begin{cd} -\cs{rotatepath}\marg{(\meta{x},\meta{y}),\meta{$\theta$}}$\ldots$\\ -\cs{shiftpath}\marg{(\meta{dx},\meta{dy})}$\ldots$\\ -\cs{scalepath}\marg{(\meta{x},\meta{y}),\meta{s}}$\ldots$\\ +\begin{cd}\pagelabel{shiftpath} +\cs{rotatepath}\marg{\meta{$p$},\meta{$\theta$}}$\ldots$\\ +\cs{shiftpath}\marg{\meta{v}}$\ldots$\\ +\cs{scalepath}\marg{\meta{$p$},\meta{s}}$\ldots$\\ \cs{xscalepath}\marg{\meta{x},\meta{s}}$\ldots$\\ \cs{yscalepath}\marg{\meta{y},\meta{s}}$\ldots$\\ \cs{slantpath}\marg{\meta{y},\meta{s}}$\ldots$\\ @@ -3265,40 +4331,44 @@ rendering prefix was previously provided). \cs{yslantpath}\marg{\meta{x},\meta{s}}$\ldots$\\ \cs{reflectpath}\marg{\meta{$p_1$},\meta{$p_2$}}$\ldots$\\ \cs{xyswappath}$\ldots$\\ -\cs{transformpath}\marg{\meta{transformer}}$\ldots$ -\index{rotatepath@\cs{rotatepath}}\index{shiftpath@\cs{shiftpath}}% -\index{scalepath@\cs{scalepath}}\index{xscalepath@\cs{xscalepath}}% -\index{yscalepath@\cs{yscalepath}}\index{slantpath@\cs{slantpath}}% -\index{xslantpath@\cs{xslantpath}}\index{yslantpath@\cs{yslantpath}}% -\index{reflectpath@\cs{reflectpath}}\index{xyswappath@\cs{xyswappath}}% +\cs{transformpath}\marg{\meta{transformer}}$\ldots$% +\index{rotatepath@\cs{rotatepath}}% +\index{shiftpath@\cs{shiftpath}}% +\index{scalepath@\cs{scalepath}}% +\index{xscalepath@\cs{xscalepath}}% +\index{yscalepath@\cs{yscalepath}}% +\index{slantpath@\cs{slantpath}}% +\index{xslantpath@\cs{xslantpath}}% +\index{yslantpath@\cs{yslantpath}}% +\index{reflectpath@\cs{reflectpath}}% +\index{xyswappath@\cs{xyswappath}}% \index{transformpath@\cs{transformpath}} \end{cd} +These are modifying macros that all return the result of applying an +affine transformation to the following path. They differ in the +transformation applied and the data needed in the mandatory argument. I +have found them extremely useful, and better than \env{coords} +environments when I need to draw a figure, together with several +slightly different versions of it. If \cs{store} is used just before one +of these prefixes, it stores the transformed path rather than the +original. + \cs{rotatepath} rotates the following path by \meta{$\theta$} degrees -about point \mfc{(\meta{x},\meta{y})}. After the commands: -\begin{ex} - \cs{store}\marg{xx}\marg{\cs{rotatepath}\marg{(0,0), 45}% - \cs{rect}\marg{(0,0),(1,1)}} -\end{ex} -the object \cs{mfobj}\marg{xx} contains an actual rotated rectangle, as -drawing it will prove. The above macro, and the five that follow are -extremely useful (and better than \env{coords} environments) if one -needs to draw a figure, together with many slightly different versions -of it. +about point \meta{$p$}. -\cs{shiftpath} shifts the following path by the horizontal amount -\meta{dx} and the vertical amount \meta{dy}. +\cs{shiftpath} shifts the following path by the vector \meta{v}. \cs{scalepath} scales (magnifies or shrinks) the following path by the -factor \meta{s}, in such a way that the point \parg{\meta{x},\meta{y}} -is kept fixed. That is -\begin{ex} - \cs{scalepath}\marg{(0,0),2}\cs{rect}\marg{(0,0),(1,1)} -\end{ex} +factor \meta{s}, in such a way that the point \meta{$p$} is kept fixed. +That is +\begin{verbatim} +\scalepath{(0,0),2}\rect{(0,0),(1,1)} +\end{verbatim} is essentially the same as \cs{rect}\marg{(0,0),(2,2)}, while -\begin{ex} - \cs{scalepath}\marg{(1,1),2}\cs{rect}\marg{(0,0),(1,1)} -\end{ex} +\begin{verbatim} +\scalepath{(1,1),2}\rect{(0,0),(1,1)} +\end{verbatim} is the same as \cs{rect}\marg{(-1,-1),(1,1)}. In both cases the rectangle is doubled in size. In the first case the lower left corner stays the same, while in the second case the the upper right corner @@ -3312,8 +4382,9 @@ fixed. \cs{yscalepath} is similar, except the $y$-direction is affected. keeping points with second coordinate equal to \meta{y} fixed. That is, a point $p$ on the path is moved right by an amount proportional to the height of $p$ above the line $y={}$\meta{y}, with $s$ being the -proportionality factor. Vertical lines in the path will acquire a slope -of $1/s$, while horizontal lines stay horizontal. +proportionality factor. Points below that line move left. Vertical lines +in the path will acquire a slope of $1/s$, while horizontal lines stay +horizontal. \cs{xslantpath} is an alias for \cs{slantpath} @@ -3329,27 +4400,52 @@ exchanged. This is similar in some respects to \cs{reflectpath}\marg{(0,0),(1,1)}, and produces the same result if the $x$ and $y$ scales of the picture are the same. However, \cs{reflectpath} compensates for such different scales (so the path -shape remains the same), while \cs{xyswappath} does not (so that after a -swap, verticals become horizontal and horizontals become vertical). One -cannot have both when the scales are different. +shape remains the same), while \cs{xyswappath} does not. However, after +a swap, verticals become horizontal and horizontals become vertical. +(It is impossible, when the scales are different, for an affine transform +to both preserve shape and exchange horizontal and vertical lines.) + +This compensation for different scales is also done for \cs{rotatepath}, +so the resulting path always has the same shape after the rotation as +before. None of the other path transformation prefixes compensate for +different scales, and none of the coordinate system transformations of +the previous subsection do it. For \MF{} or \MP{} power users, \cs{transformpath} can take any `transformer' and transform the following path with it. Here, a -\emph{transformer} is anything that can follow a path and create a new -path. Examples are \mfc{scaled}, \mfc{shifted (1,1)}, and \mfc{rotatedabout -(0,1)}. +\emph{transformer} is the same as in the previous section. Examples are +\mfc{scaled}, \mfc{shifted(1,1)}, and \mfc{rotatedabout(0,1)}. All these prefixes change only the path that follows, not any rendering of it that follows. For example: -\begin{ex} - \cs{gfill}\cs{rotatepath}\marg{(0,0),90}\cs{dashed}% - \cs{rect}\marg{(0,0),(1,1)} -\end{ex} +\begin{verbatim} +\gfill\rotatepath{(0,0),90}\dashed\rect{(0,0),(1,1)} +\end{verbatim} will not produce a rotated dashed rectangle. Rather the original rectangle will be dashed, and the rotated rectangle will be filled. +One complication is the handling of the default rendering. One expects +\verb$\rect{(0,0),(1,1)}$ to draw a rectangle, and +\verb$\rotatepath{(0,0),45}\rect{(0,0),(1,1)}$ to draw a rotated +rectangle (but not the original). That is, a transformation + figure is +treated as if it were a single figure. But what would one expect in the +following? +\begin{verbatim} +\rotatepath{(0,0),45}\dashed\rect{(0,0),(1,1)} +\end{verbatim} +What one will get is the original dashed and the rotated one with the +default rendering (typically drawn with solid lines). That is, these +prefixes cannot see the renderings that occur later in the sequence. +They add the default rendering as if those didn't exist. If something +other than this is desired, one can either rearrange the prefixes or add +a \phantomsection\label{norenderexample}\cs{norender} in appropriate +places. For example, to add a shifted arrowhead without drawing the +shifted path: +\begin{verbatim} +\arrow\norender\shiftpath{(0,1)}\arrow\draw\lines{(0,0),(8,8)} +\end{verbatim} -\subsection{Parameters.}\label{parameters} +\section{Parameters.}\label{parameters} There are many parameters in \mfp{} which the user can modify to obtain different effects, such as different arrowhead size or shape. @@ -3358,229 +4454,265 @@ macros they modify, but they are all described together here. Many of the parameters are stored by \TeX{} as dimensions, and so are available even if there is no \MF{} file open; changes to them are not -subject to the usual \TeX{} rules of scope however: they are local to -\TeX{} groups only if set inside an \env{mfpic} environment otherwise +subject to the usual \TeX{} rules of scope however: they are local +only to \env{mfpic} environments if set inside one, otherwise they are global. This is for consistency: other parameters are stored by \MF{} (so the macros to change them will have no effect unless a \MF{} -file is open) and the changes are subject to \MF's rules of scope---to +file is open) and the changes are subject to \MF{}'s rules of scope---to the \mfp{} user, this means that changes inside the \cs{mfpic} $\ldots$ \cs{endmfpic} environment are local to that environment, but other \TeX{} groupings have no effect on scope. Some commands (notably those that set the axismargins and \cs{tlabel} parameters) change both \TeX{} -parameters and \MF{} parameters, and it is important to keep then +parameters and \MF{} parameters, and it is important to keep them consistent. -\begin{cd} +There are a few parameters that do obey \TeX{} grouping, but only inside +\env{mfpic} environments. These are noted where the parameter is +described. + +All parameters are initialized when \prog{mfpic} is loaded. We give the +initial value or state in each of these descriptions. + +\begin{cd}\pagelabel{mfpicunit} \cs{mfpicunit}% \index{mfpicunit@\cs{mfpicunit}} \end{cd} -This \TeX{} dimension stores the basic unit length for \mfp{} -pictures---the $x$ and $y$ scales in the \cs{mfpic} macro are multiples -of this unit. The default value is \dim{1pt}. +This dimension stores the basic unit length for \mfp{} pictures. The $x$ +and $y$ scales in the \cs{mfpic} macro are multiples of this unit. The +initial value is \dim{1pt}. It is global outside an \env{mfpic} +environment. Changes made to it inside an \env{mfpic} environment have +no effect and are lost at the end of the environment. -\begin{cd} +\begin{cd}\pagelabel{pointsize} \cs{pointsize}% \index{pointsize@\cs{pointsize}} \end{cd} -This \TeX{} dimension stores the diameter of the circle drawn by the -\cs{point} macro and the diameter of the symbols drawn by -\cs{plotsymbol} and by \cs{plot}. The default value is \dim{2pt}. +This dimension stores the diameter of the circle drawn by the +\cs{point} macro and the diameter of the symbols drawn by \cs{plot}, +\cs{plotsymbol} and \cs{plotnodes}. The initial value is \dim{2pt}. -\begin{cd} -\cs{pointfilltrue} and \cs{pointfillfalse}% +\begin{cd}\pagelabel{pointfilltrue} +\cs{pointfilltrue}, \cs{pointfillfalse}% \index{pointfilltrue@\cs{pointfilltrue}}% \index{pointfillfalse@\cs{pointfillfalse}} \end{cd} This \TeX{} boolean switch determines whether the circle drawn by \cs{point} will be filled or open (outline drawn, inside erased). -The default is \texttt{true}: filled. This value is local to any \TeX{} +The initial state is \texttt{true}: filled. This value is local to any \TeX{} group inside an \env{mfpic} environment. Outside such it is global. -\begin{cd} -\cs{pen}\marg{\meta{drawpensize}}\\ -\cs{drawpen}\marg{\meta{drawpensize}}\\ -\cs{penwd}\marg{\meta{drawpensize}}% +\begin{cd}\pagelabel{drawpen} +\cs{pen}\marg{\meta{size}}\\ +\cs{drawpen}\marg{\meta{size}}\\ +\cs{penwd}\marg{\meta{size}}% \index{pen@\cs{pen}}% \index{drawpen@\cs{drawpen}}% \index{penwd@\cs{penwd}} \end{cd} -Establishes the width of the normal drawing pen. The default is -\dim{0.5pt}. This width is stored by \MF. The shading dots and hatching -pen are unaffected by this. There exist three aliases for this command, -the first two to maintain backward compatibility, the last one for -consistency with other dimension changing commands. Publishers generally -recommended authors to use at least a width of one-half point for -drawings submitted for publication. +These commands establishes the width of the normal drawing pen (that is, +the thickness of lines, whether solid or dashed). The initial value is +\dim{0.5bp}. This width is stored by \MF{}. This has no effect on the +size of dots for \cs{dotted}, \cs{shade}, \cs{grid}, etc. It also has no +effect on the lines drawn for hatching. There exist three aliases for +this command, the first two to maintain backward compatibility, the last +one for consistency with other dimension changing commands. Publishers +generally recommended authors to use at least a width of one-half point +for drawings submitted for publication. -\begin{cd} -\cs{shadewd}\marg{\meta{dotdiam}}% +\begin{cd}\pagelabel{shadewd} +\cs{shadewd}\marg{\meta{diam}}% \index{shadewd@\cs{shadewd}} \end{cd} -Sets the diameter of the dots used in the shading macro. The drawing and -hatching pens are unaffected by this. The default is \dim{0.5pt}, and -the value is stored by \MF. +This command sets the diameter of the dots used in the shading macro. +The drawing and hatching pens are unaffected by this. The initial value +is \dim{0.5bp}, and the value is stored by \MF{}. -\begin{cd} -\cs{hatchwd}\marg{\meta{hatchpensize}}% +\begin{cd}\pagelabel{hatchwd} +\cs{hatchwd}\marg{\meta{size}}% \index{hatchwd@\cs{hatchwd}} \end{cd} -Sets the line thickness used in the hatching macros. The drawing pen and -shading dots are unaffected by this. The default is \dim{0.5pt}, and the -value is stored by \MF. +This sets the line thickness used in the hatching macros. The drawing +pen and shading dots are unaffected by this. The initial value is +\dim{0.5bp}, and the value is stored by \MF{}. -\begin{cd} -\cs{polkadotwd}\marg{\meta{polkadotdiam}}% +\begin{cd}\pagelabel{polkadotwd} +\cs{polkadotwd}\marg{\meta{diam}}% \index{polkadotwd@\cs{polkadotwd}} \end{cd} -Sets the diameter of the dots used in the \cs{polkadot} macro. The -default is \dim{5pt}, and the value is stored by \MF. +This sets the diameter of the dots used in the \cs{polkadot} macro. The +initial value is \dim{5bp}, and the value is stored by \MF{}. -\begin{cd} +\begin{cd}\pagelabel{headlen} \cs{headlen}% \index{headlen@\cs{headlen}} \end{cd} -This \TeX{} dimension stores the length of the arrowhead drawn by -the \cs{arrow} macro. The default value is \dim{3pt}. +This dimension stores the length of the arrowhead drawn by the +\cs{arrow} macro. The initial value is \dim{3pt}. -\begin{cd} +\begin{cd}\pagelabel{axisheadlen} \cs{axisheadlen}% \index{axisheadlen@\cs{axisheadlen}} \end{cd} -This \TeX{} dimension stores the length of the arrowhead drawn by the +This dimension stores the length of the arrowhead drawn by the \cs{axes}, \cs{xaxis} and \cs{yaxis} macros, and by the macros \cs{axis} -and \cs{doaxes} when applied to the parameters \texttt{x} and \texttt{y}. +and \cs{doaxes} when applied to the parameters \texttt{x} and +\texttt{y}. The initial value is \dim{5pt}. -\begin{cd} +\begin{cd}\pagelabel{sideheadlen} \cs{sideheadlen}% \index{sideheadlen@\cs{sideheadlen}} \end{cd} -This \TeX{} dimension stores the length of the arrowhead drawn by the -\cs{axis} and \cs{doaxes} macros when applied to \texttt{l}, \texttt{b}, -\texttt{r} or \texttt{t}. The default value is \dim{0pt}. +This dimension stores the length of the arrowhead drawn by the \cs{axis} +and \cs{doaxes} macros when applied to \texttt{l}, \texttt{b}, +\texttt{r} or \texttt{t}. The initial value is \dim{0pt} (that is, the +default is not to put arrowheads on border axes). -\begin{cd} -\cs{headshape}\marg{\meta{hdwdr}}\marg{\meta{hdten}}\marg{\meta{hfilled}}% +\begin{cd}\pagelabel{headshape} +\cs{headshape}\marg{\meta{ratio}}\marg{\meta{tension}}\marg{\meta{filled}}% \index{headshape@\cs{headshape}} \end{cd} -Establishes the shape of the arrowhead drawn by the \cs{arrow} and -\cs{axes} macros. The value of \meta{hdwdr} is the ratio of the width of -the arrowhead to its length; \meta{hdten} is the tension of the B\'ezier -curves; and \meta{hfilled} is a \MF{} boolean value indicating whether -the arrowheads are to be filled (if \mfc{true}) or open. The default -values are $1$, $1$, \mfc{false}, respectively. The \meta{hdwdr}, -\meta{hdten} and \meta{hfilled} values are stored by \MF. Setting -\meta{hdten} to `\mfc{infinity}' will make the sides of the arrowheads -straight lines. These values are all stored by \MF. +This establishes the shape of the \gbc{Arrowhead} drawn by the +\cs{arrow...} and \cs{axes} macros. It also establishes the shape of +\gbc{Leftharpoon} and \gbc{Rightharpoon}. The value of \meta{ratio} is +the ratio of the width of the arrowhead to its length; \meta{tension} is +the tension of the B\'ezier curves; and \meta{filled} is a \MF{} boolean +value indicating whether the arrowheads are to be filled (if \mfc{true}) +or open. The initial values are $1$, $1$, and \mfc{false}, respectively. +Setting \meta{tension} to `\mfc{infinity}' will make the sides of the +arrowheads straight lines. The harpoon heads are arranged to be exactly +half of the full arrowhead. The \meta{ratio}, \meta{tension} and +\meta{filled} values are stored by \MF{}. -\begin{cd} +After \cs{headshape} is used, the symbols \gbc{Arrowhead}, +\gbc{Leftharpoon}, and \gbc{Rightharpoon} take on the new shape if used +in one of the \cs{plot...} commands. + +\begin{cd}\pagelabel{dashlen} \cs{dashlen}, \cs{dashspace}% \index{dashlen@\cs{dashlen}} \end{cd} -These \TeX{} dimensions store, respectively, the length of dashes and -the length of spaces between dashes, for lines drawn by the \cs{dashed} +These dimensions store, respectively, the length of dashes and the +length of spaces between dashes, for lines drawn by the \cs{dashed} macro. The \cs{dashed} macro may adjust the dashes and the spaces -between by as much as $1\over{n}$ of their value, where $n$ is the -number of spaces appearing in the curve, in order not to have partial -dashes at the ends. The default values are both \dim{4pt}. The dashes -will actually be longer (and the spaces shorter) by the thickness of the -pen used when they are drawn. - -\begin{cd} -\cs{dashlineset}, -\cs{dotlineset}% +between by as much as $1/n$ of their value, where $n$ is the number of +spaces appearing in the curve, in order not to have partial dashes at +the ends. The initial values are both \dim{4pt}. The dashes will +actually be longer (and the spaces shorter) by the thickness of the pen +used when they are drawn. + +\begin{cd}\pagelabel{dashlineset} +\cs{dashlineset}, \cs{dotlineset}% \index{dashlineset@\cs{dashlineset}}% \index{dotlineset@\cs{dotlineset}} \end{cd} -These macros provide convenient standard settings for the \cs{dashlen} +These macros provide shorthands for certain settings of the \cs{dashlen} and \cs{dashspace} dimensions. The macro \cs{dashlineset} sets both -values to \dim{4pt}; the macro \cs{dotlineset} sets \cs{dashlen} to -\dim{1pt} and \cs{dashspace} to \dim{2pt}. +values to \dim{4pt}, while \cs{dotlineset} sets \cs{dashlen} to +\dim{1pt} and \cs{dashspace} to \dim{2pt}. They are kept mainly for +backward compatibility. -\begin{cd} +\begin{cd}\pagelabel{hashlen} \cs{hashlen}% \index{hashlen@\cs{hashlen}} \end{cd} -This \TeX{} dimension stores the length of the axis hash marks drawn by -the \cs{xmarks} and \cs{ymarks} macros. The default value is \dim{4pt}. +This dimension stores the length of the axis hash marks drawn by the +\cs{xmarks} and \cs{ymarks} macros. The initial value is \dim{4pt}. -\begin{cd} +\begin{cd}\pagelabel{shadespace} \cs{shadespace}% \index{shadespace@\cs{shadespace}} \end{cd} -This \TeX{} dimension establishes the spacing between dots drawn by the -\cs{shade} macro. The default value is \dim{1pt}. +This dimension establishes the spacing between dots drawn by the +\cs{shade} macro. The initial value is \dim{1pt}. -\begin{cd} -\cs{darkershade}, -\cs{lightershade}% +\begin{cd}\pagelabel{darkershade} +\cs{darkershade}, \cs{lightershade}% \index{darkershade@\cs{darkershade}}% \index{lightershade@\cs{lightershade}} \end{cd} These macros both multiply the \cs{shadespace} dimension by constant factors, $5/6=.833333$ and $6/5=1.2$ respectively, to provide convenient -standard settings for several levels of shading. +standard settings for several levels of shading. Under \MF{} it is +possible that using one of these macros can have no visible effect. See +the discussion of the \cs{shade} macro in subsection~\ref{filling}. -\begin{cd} +\begin{cd}\pagelabel{polkadotspace} \cs{polkadotspace}% \index{polkadotspace@\cs{polkadotspace}} \end{cd} -This \TeX{} dimension establishes the spacing between the centers of the -dots used in the macro \cs{polkadot}. The default is \dim{10pt}. +This dimension establishes the spacing between the centers of the dots +used for the macro \cs{polkadot}. The initial value is \dim{10pt}. -\begin{cd} -\cs{dotsize}, \index{dotspace@\cs{dotspace}}\cs{dotspace}% -\index{dotsize@\cs{dotsize}} +\begin{cd}\pagelabel{dotsize} +\cs{dotsize}, \cs{dotspace}% +\index{dotsize@\cs{dotsize}}\index{dotspace@\cs{dotspace}}% \end{cd} These \TeX{} dimensions establishes the size and spacing between the -centers of the dots used in the \cs{dotted} macro. The defaults are -\dim{0.5pt} and \dim{3pt}. +centers of the dots used in the \cs{dotted} macro. The initial values +are \dim{0.5pt} and \dim{3pt}. -\begin{cd} +\begin{cd}\pagelabel{griddotsize} +\cs{griddotsize}% +\index{griddotsize@\cs{griddotsize}}% +\end{cd} + +This dimension is used as the default for the sizes of dots in the +\cs{grid} and \cs{plrgridpoints} commands. The initial value is +\dim{0.5pt} + +\begin{cd}\pagelabel{symbolspace} \cs{symbolspace}% \index{symbolspace@\cs{symbolspace}} \end{cd} Similar to \cs{dotspace}, this \TeX{} dimension establishes the space -between symbols placed by the macro -\cs{plot}\marg{\meta{symbol}}$\ldots\,$. Its default is \dim{5pt}. +between the centers of symbols placed by the macro +\cs{plot}\marg{\meta{symbol}}$\ldots\,$. Its initial value is \dim{5pt}. -\begin{cd} +\begin{cd}\pagelabel{hatchspace} \cs{hatchspace}% \index{hatchspace@\cs{hatchspace}} \end{cd} -This \TeX{} dimension establishes the spacing between lines drawn by the -\cs{hatch} macro. The default value is \dim{3pt}. +This dimension establishes the spacing between lines drawn by the +\cs{hatch} macro. The initial value is \dim{3pt}. \begin{cd} +\cs{tlpointsep}\marg{\meta{separation}}\\ +\cs{tlpathsep}\marg{\meta{separation}}\\ \cs{tlabelsep}\marg{\meta{separation}}% +\index{tlpointsep@\cs{tlpointsep}}% +\index{tlpathsep@\cs{tlpathsep}}% \index{tlabelsep@\cs{tlabelsep}} \end{cd} -This macro establishes the separation between a label and its nominal -position. It affects text written with any of the commands \cs{tlabel}, -\cs{tlabels}, \cs{axislabels} or \cs{plottext}. It also sets the -separation between the text and the curve defined by the commands -\cs{tlabelrect}, \cs{tlabeloval} or \cs{tlabelellipse}. The default is -\dim{0pt}. The value is stored by both \TeX{} and \MF. +The first macro establishes the separation between a label and its +nominal position. It affects text written with any of the commands +\cs{tlabel}, \cs{tlabels}, \cs{axislabels} or \cs{plottext}. The second +sets the separation between the text and the curve defined by the +commands \cs{tlabelrect}, \cs{tlabeloval} or \cs{tlabelellipse}. The +third sets both of these separations to the same value. It is for +backward compatibility: in the past there was only one dimension used +for both purposes. The initial value of each is \dim{0pt}. The values +are stored by both \TeX{} and \MF{}. \begin{cd} \cs{tlabeloffset}\marg{\meta{hlen}}\marg{\meta{vlen}}% @@ -3589,73 +4721,133 @@ separation between the text and the curve defined by the commands This macro establishes a uniform offset that applies to all labels. It affects text written with any of the commands \cs{tlabel}, \cs{tlabels}, -\cs{axislabels} or \cs{plottext}. The default is to have both horizontal -and vertical offsets of \dim{0pt}. The values are stored by both \TeX{} -and \MF. +\cs{axislabels} or \cs{plottext}. The initial state is to have both +horizontal and vertical offsets of \dim{0pt}. The values are stored by +both \TeX{} and \MF{}. -\begin{cd} +\begin{cd}\pagelabel{mfpdataperline} \cs{mfpdataperline}% \index{mfpdataperline@\cs{mfpdataperline}} \end{cd} -When \mfp{} is reading data from files and writing it to the -output file, this macro stores the maximum number of points that will be -written on a single line in the output file. Its default is defined by -\cs{def}\cs{mfpdataperline}\marg{5}. +When \mfp{} is reading from data files and writing to the output file, +this macro stores the maximum number of data points that will be written +on a single line in the output file. Its initial definition is +\cs{def}\cs{mfpdataperline}\marg{5}. Any such definition (or +redefinition) obeys \emph{all} \TeX{} groupings. -\begin{cd} -\cs{mfpicheight}, -\cs{mfpicwidth}% +\begin{cd}\pagelabel{mfpicheight} +\cs{mfpicheight}, \cs{mfpicwidth}% \index{mfpicheight@\cs{mfpicheight}}% \index{mfpicwidth@\cs{mfpicwidth}} \end{cd} -These \TeX{} dimensions store the height and width of the figure created -by the most recently completed \env{mfpic} environment. This might -perhaps be of interest to hackers or to aid in precise positioning of -the graphics. They are meant to be read-only: the \cs{endmfpic} command -globally sets them equal to the height and width of the picture. But -\mfp{} does not otherwise make any use of them. +These dimensions store the height and width of the figure created by the +most recently completed \env{mfpic} environment. This might perhaps be +of interest to hackers or to aid in precise positioning of the graphics. +They are meant to be read-only: the \cs{endmfpic} command globally sets +them equal to the height and width of the picture. But \mfp{} does not +otherwise make any use of them. As they are not to be changed, grouping +is irrelevent, but when \mfp{} sets them, it does so globally. These are +set even if the picture is saved with \cs{savepic}. If they are needed +for the corresponding \cs{usepic}, and that occurs after another +\env{mfpic} environment, they should be copied to other length commands +right after the \env{mfpic} environment that set them. +\begin{cd}\pagelabel{mfpiccaptionskip} +\cs{mfpiccaptionskip}% +\index{mfpiccaptionskip@\cs{mfpiccaptionskip}} +\end{cd} -\subsection{For Advanced Users.}\label{advanced} +This skip register (`rubber length' in \LaTeX) stores the space between +a picture and the caption produced with \cs{tcaption}. It is local to +all \TeX{} groups. If changed inside an \env{mfpic} environment it will +affect only the \cs{tcaption} command in that picture. It's initial +setting is \cs{medskipamount}, producing the same space as a +\cs{medskip}. -\subsubsection{Power Users.}\label{power} +\section{For Advanced Users.}\label{advanced} -\begin{cd} +\subsection{Splines}\label{splines} + +\begin{cd}\pagelabel{qspline} \cs{qspline}\marg{\meta{list}}\\ \cs{closedqspline}\marg{\meta{list}}\\ \cs{cspline}\marg{\meta{list}}\\ -\cs{closedcspline}\marg{\meta{list}}\\ +\cs{closedcspline}\marg{\meta{list}}% \index{qspline@\cs{qspline}}% \index{closedqspline@\cs{closedqspline}}% \index{cspline@\cs{cspline}}% \index{closedcspline@\cs{closedcspline}}% \end{cd} -These are alternate ways of defining curves. In each case, \meta{list} -is a comma separated list of points. These represent not the points the -curve passes through, but the \emph{control points}. The first two -produce quadratic B-splines and the last two produce cubic B-splines. If -you don't know what B-splines are, or don't know what control points -are, it is recommended you not use these commands. - -\begin{cd} +These figure macros use alternate ways of defining curves. In each case, +\meta{list} is a comma separated list of ordered pairs. These represent +not the points the curve passes through, but the \emph{control points}. +The first two produce quadratic B-splines and the last two produce cubic +B-splines. If you don't know what B-splines are, or don't know what +control points are, it is recommended you not use these commands. + +For \cs{qspline}, the curve will pass through the midpoints of the line +segments joining the points in the list, tangent to that line segment. + +For the \cs{cspline}, the list also defines line segments. Divide these +into equal thirds at two points on each segment. Connect these +\emph{division points only} to obtain line segments. Each \emph{odd +numbered} segment is the middle third of one of the original line +segments. The \cs{cspline} curve passes through the midpoint of each +\emph{even numbered} line segment, tangent to it. + +\begin{cd}\pagelabel{computedspline} +\cs{computedspline}\marg{\meta{list}}\\ +\cs{closedcomputedspline}\marg{\meta{list}}% +\index{computedspline@\cs{computedspline}}% +\index{closedcomputedspline@\cs{closedcomputedspline}}% +\end{cd} + +These figure macros both produce cubic splines. For these you \emph{do} +provide the list of points the curves are to pass through. They become +the nodes, and then the control points are computed from them. The nodes +do not uniquely determine the control points so extra equations are +required. For the first version, the extra equations give the path zero +curvature at the endpoints (a \emph{relaxed} spline). For the closed +version, the extra equations are those that close the curve smoothly. + +\begin{cd}\pagelabel{fcnspline} +\cs{fcnspline}\marg{\meta{list}}\\ +\cs{periodicfcnspline}\marg{\meta{list}}% +\index{fcnspline@\cs{fcnspline}}% +\index{periodicfcnspline@\cs{periodicfcnspline}}% +\end{cd} + +These figure macros use cubic spline equations to produce a smooth graph +of a function based on a list of points with increasing $x$-values. See +\cs{fcncurve} in section~\ref{curves} for another way to do this. As in +the computed splines, above, the spline equations at the nodes do not +provide sufficient information to compute all control points. In the +basic version, \cs{fcnspline}, extra equations produce a graph with zero +curvature at the endpoints (a relaxed spline), while the periodic +version uses equations that make the first and second derivatives at the +last point match those at the first point. + +\begin{cd}\pagelabel{cbclosed} \cs{cbclosed}$\ldots$\\ \cs{qbclosed}$\ldots$% \index{cbclosed@\cs{cbclosed}}% \index{qbclosed@\cs{qbclosed}} \end{cd} -These are prefix macros for closing curves. The first closes with a -cubic B-spline, the second with a quadratic B-spline. They will close -any given curve, but the command \cs{cbclosed} is meant to close a cubic -B-spline (see above). That is, \cs{cbclosed}\cs{cspline} should produce -the same result as \cs{closedcspline} with the same argument. The -corresponding statements are true of \cs{qbclosed}: it is meant to close -a quadratic B-spline and \cs{qbclosed}\cs{qspline} should produce the -same result as \cs{closedqspline} with the same argument. +These are modifying macros that close the following path. The first +closes with a cubic B-spline, the second with a quadratic B-spline. They +will close any given curve, but the command \cs{cbclosed} is meant to +close a cubic B-spline (see above). That is, \cs{cbclosed}\cs{cspline} +should produce the same result as \cs{closedcspline} with the same +argument. The corresponding statements are true of \cs{qbclosed}: it is +meant to close a quadratic B-spline and \cs{qbclosed}\cs{qspline} should +produce the same result as \cs{closedqspline} with the same argument. + +\subsection{B\'eziers} The power user, having noticed that \cs{curve} and \cs{cyclic} insert some direction modifiers into the path created, may have decided that @@ -3663,47 +4855,50 @@ there is no \mfp{} command to create a simple \MF{} default style path, for example \mfc{(1,1)..(0,1)..(0,0)..cycle}. If so, he or she has forgotten about \cs{mfobj}: the command \begin{verbatim} - \mfobj{(1,1)..(0,1)..(0,0)..cycle} +\mfobj{(1,1)..(0,1)..(0,0)..cycle} \end{verbatim} will produce, in the \file{.mf} file, exactly this path, but surround it -with the \TeX{} wrapping needed to make \mfp's prefix macro system work. +with the \TeX{} wrapping needed to make \mfp{}'s prefix macro system work. However, the syntax of more complicated paths can be extremely lengthy, so we offer this interface: -\begin{cd} +\begin{cd}\pagelabel{mfbezier} \cs{mfbezier}\oarg{\meta{tens}}\marg{\meta{list}}\\ \cs{closedmfbezier}\oarg{\meta{tens}}\marg{\meta{list}}% -\index{mfbezier@\cs{mfbezier}} +\index{mfbezier@\cs{mfbezier}}% \index{closedmfbezier@\cs{closedmfbezier}} \end{cd} -This connects the points in the list with the path join operator -\mfc{..tension \meta{tens}..}. If the tension option \oarg{\meta{tens}} -is omitted, the value set by \cs{settension} (initially 1) is used. One -can get a cyclic path by prepending \cs{bclosed} (with matching tension -option), but it will not produce the same result as \cs{closedmfbezier}. -These are cubic B\'ezier's (but you know that if you are a power user). -Quadratic B\'eziers (as in \LaTeX's picture environment) can be -obtained with the following: +These figure macros uses the \MF{} path join operator `\mfc{..tension +\meta{tens}..}' to connect the points in the list. If the tension option +\oarg{\meta{tens}} is omitted, the value set by \cs{settension} +(initially 1) is used. One can get a cyclic path by prepending +\cs{bclosed} (with matching tension option), but it will not produce the +same result as \cs{closedmfbezier}. These are cubic B\'ezier's (but you +know that if you are a power user). Quadratic B\'eziers (as in +\LaTeX{}'s picture environment) can be obtained with the following: -\begin{cd} +\begin{cd}\pagelabel{qbeziers} \cs{qbeziers}\oarg{\meta{tens}}\marg{\meta{list}}\\ \cs{closedqbeziers}\oarg{\meta{tens}}\marg{\meta{list}}% -\index{qbeziers@\cs{qbeziers}} +\index{qbeziers@\cs{qbeziers}}% \index{closedqbeziers@\cs{closedqbeziers}} \end{cd} -Note the plural, to indicate that they will draw a series of quadratic -B\'eziers. In the \meta{list}, the first, third, fifth, etc., are the -points to connect, while the second, fourth, etc., are the control -points. The open version requires an ending point, and so needs an odd -number of points in the list. The closed version assumes the first point -is the ending, and so requires an even number in the list. The curve -will not automatically be smooth. That depends on the choice of the -control points. +These figure macros produce quadratic B\'ezier curves, the equivalent of +a sequence of \LaTeX{} \cs{qbezier} commands. Note the plural forms, to +distinguish the first from the \LaTeX{} command, and to indicate that +they can draw a \emph{series} of quadratic B\'eziers. In the +\meta{list}, the first, third, fifth, etc., are the points to connect, +while the second, fourth, etc., are the control points. The open version +requires an ending point, and so needs an odd number of points in the +list. The closed version assumes the first point is the ending, and so +requires an even number in the list. The curve will not automatically be +smooth. That depends on the choice of the control points. +\subsection{Raw \MF{} code}\label{mfcode} -\begin{cd} +\begin{cd}\pagelabel{mfsrc} \cs{mfsrc}\marg{\meta{metafont code}}\\ \cs{mfcmd}\marg{\meta{metafont code}}\\ \cs{mflist}\marg{\meta{metafont code}}% @@ -3716,7 +4911,7 @@ These all write the \meta{metafont code} directly to the \MF{} file, using a \TeX{} \cs{write} command. Line breaks within \meta{metafont code} are preserved.% \footnote{Under most circumstances, but not if the command (plus its - argument) is part of another macro} % + argument) is part of the argument of another macro.} % Almost all the \mfp{} drawing macros invoke one of these. Because of the way \TeX{} reads and processes macro arguments, not all drawing macros preserve line breaks (nor do they all need to). However, the ones that @@ -3727,11 +4922,10 @@ in these is minor: \cs{mfsrc} writes its argument without change, \cs{mflist} surrounds its argument with parentheses and then appends a semicolon. -Using these can have some rather bizarre consequences, though, so -it is not recommended to the unwary. It is, however, currently the -only way to make use of \MF's equation solving ability. Here's an -oversimplified example: - +Using these can have some rather bizarre consequences, though, so it is +not recommended to the unwary. It is, however, currently the only way to +make use of \MF{}'s equation solving ability. Here's an oversimplified +example: \begin{verbatim} \mfpic[20]{-0.5}{1.5}{0}{1.5} \mfsrc{z1=(0,0); @@ -3741,66 +4935,115 @@ oversimplified example: \endmfpic \end{verbatim} -Check out the sample \file{forfun.tex} for a more realistic example. +Check out the sample \file{forfun.tex} for a more extensive example. It +should produce the word `\textsf{mfpic}' in blue, outlined in green in a +box with yellow background. -\begin{cd} +\subsection{Creating \MF{} variables}\label{variables} + +\begin{cd}\pagelabel{setmfvariable} \cs{setmfvariable}\marg{\meta{type}}\marg{\meta{name}}\marg{\meta{value}}\\ -\cs{setmpvariable}\marg{\meta{type}}\marg{\meta{name}}\marg{\meta{value}}% -\index{setmfvariable@\cs{setmfvariable}} -\index{setmpvariable@\cs{setmpvariable}} +\cs{setmpvariable}\marg{\meta{type}}\marg{\meta{name}}\marg{\meta{value}}\\ +\cs{globalsetmfvariable}\marg{\meta{type}}\marg{\meta{name}}\marg{\meta{value}}\\ +\cs{setmfnumeric}\marg{\meta{name}}\marg{\meta{value}}\\ +\cs{setmfpair} \marg{\meta{name}}\marg{\meta{value}}\\ +\cs{setmfboolean}\marg{\meta{name}}\marg{\meta{value}}\\ +\cs{setmfcolor} \marg{\meta{name}}\marg{\meta{value}}% +\index{setmfvariable@\cs{setmfvariable}}% +\index{setmpvariable@\cs{setmpvariable}}% +\index{globalsetmfvariable@\cs{globalsetmfvariable}}% +\index{setmfnumeric@\cs{setmfnumeric}}% +\index{setmfpair@\cs{setmfpair}}% +\index{setmfboolean@\cs{setmfboolean}}% +\index{setmfcolor@\cs{setmfcolor}}% \end{cd} These formerly internal \mfp{} macros can be use to define symbolic -names for any \MF{} or \MP{} variable type. They are interchangeable; -you can use either one with or without the \opt{metapost} option. +names for any \MF{} or \MP{} variable type. The first two are +interchangeable; you can use either one with or without the +\opt{metapost} option. The remaining four are abbreviations. For +example, \cs{setmfpair}\marg{X}\marg{(2,0)} is the same as +\cs{setmfvariable}\marg{pair}\marg{X}\marg{(2,0)}. Note that these +overwrite any variable with the specified \meta{name}. For certain +internal names, \MF{} will issue an error, but usually the variable is +silently redefined. For the four abbreviations, there is no ``mp'' +version, but they may be used with either the \opt{metapost} or +\opt{metafont} options. + +The \meta{value} must be a constant of the appropriate type or a \MF{} +expression returning the appropriate type. It can also be (or include) +other variables previously defined. + As an example of their use, since dimensions are numeric data types in -\MF, the command -\begin{ex} - \cs{setmfvariable}\marg{numeric}\verb${my_dim}$\marg{7pt} -\end{ex} +\MF{}, the command +\begin{verbatim} +\setmfnumeric{my_dim}{7pt} +\end{verbatim} would set the \MF{} variable \verb$my_dim$ to the value \texttt{7pt}. After that, \verb$my_dim$ can be used in any \emph{drawing} command where a dimension is required: -\begin{ex} - \cs{plotsymbol}\verb$[my_dim]$\marg{Triangle}\cs{rect}\marg{(0,0),(1,1)} -\end{ex} +\begin{verbatim} +\plotsymbol[my_dim]{Triangle}\rect{(0,0),(1,1)} +\end{verbatim} will plot the rectangle with small triangles spaced \dim{7pt} apart. -You can define paths this way -(\cs{setmfvariable}\marg{path}\marg{X}\marg{(0,0)..(1,1)..(0,1)}), but -the \meta{value} has to be valid \MF{} path construction syntax, -\emph{not} something like \cs{rect}\marg{$\ldots$}. You need \cs{store} -if you want to set a variable to an \mfp{} path. However, defined either -way, they can be used in \cs{mfobj}. - -A variable defined this way is local to the \env{mfpic} environment it -is contained in. It is in fact local to any \MF{} group. In \mfp, only -\cs{connect} {\dots} \cs{endconnect} and \cs{mfpic} {\dots} +The knowledgeable user may realize that \mfc{path} and \gbc{picture} are +\MF{} data types, and may want use them in \cs{setmfvariable}. It is +also true that at some level, \mfp{} figure macros produce a path and +\cs{mfpimage} produces a picture. However, \mfp{} commands cannot be +used in the value portion of \cs{setmfvariable}. The \TeX{} code that +most \mfp{} commands produce would be meaningless to \MF{}. You can +store the path produced by figure macros with \cs{store}, and store +pictures in variables with \cs{mfpimage} or even \cs{tile}. + +With the obvious exception of \cs{globalsetmfvariable} command, these +commands define the variable locally. That is, the variable will revert +to any previous definition (or become undefined) at the end of the +\env{mfpic} environment it is defined in. It is in fact local to any +\MF{} group. In \mfp{}, only \cs{connect} {\dots} \cs{endconnect}, +\cs{mfpimage} {\dots} \cs{endmfpimage}, and \cs{mfpic} {\dots} \cs{endmfpic} create \MF{} groups in the graph file. -\begin{cd} -\cs{noship}\\% -\cs{stopshipping}\\% -\cs{resumeshipping}\\% -\index{noship@\cs{noship}} -\index{stopshipping@\cs{stopshipping}} -\index{resumeshipping@\cs{resumeshipping}} -\end{cd} +A warning about variable names. \CMF{} and \MP{} allow multi-part +variable names like `\mfc{arrowhead length}' or `\mfc{X.r}' The part +after the first space or `.' is called a \mfc{suffix}. In \MF{}, +variable settings are global unless explicitly made local. The code of +the \cs{setmf...} commands does this. However, \MF{} syntax forbids this +localization when a variable name has a suffix. Moreover, if you +localize a variable, \MF{} will localize all variables with that name +plus any suffix. Even more, localizing a variable renders all variables +with the same name plus suffix locally undefined. The command +\cs{globalsetmfvariable} simply omits the localization part, so suffixes +are permitted, but it cannot `globalize' something that has previously +been localized within the same group. + +For example, suppose you use the example code in subsection~\ref{arrows} +and define a custom arrowhead path \gbc{myAH} and the corresponding +clearing path \gbc{myAH.clear}. Suppose now you try to make this head +the default for the \cs{arrow} command by doing the following. +\begin{verbatim} +\setmfvariable{path}{Arrowhead}{myAH} +\end{verbatim} +Then this assignments is local and makes \gbc{Arrowhead.clear} undefined +(locally). You cannot use \cs{setmfvariable} to define +\gbc{Arrowhead.clear}; that will produce an error from \MF{}. You need +to do +\begin{verbatim} +\setmfvariable{path}{Arrowhead}{myAH} +\globalsetmfvariable{path}{Arrowhead.clear}{myAH.clear} +\end{verbatim} +and \emph{both} assignments will be local. To make both assignments +global, use the global version in both. -\cs{stopshipping} turns off character shipping (by \MF{} to the TFM and -GF files, or by \MP{} to appropriate \EPS{} output file) until -\cs{resumeshipping} occurs. If you want just one character not shipped, -just use \cs{noship} inside the mfpic environment. This is useful if all -one wishes to do in the current \env{mfpic} environment is to make -\emph{tiles} (see below). -\begin{cd} -\cs{patharr}\marg{\meta{pv}}$\ldots$\cs{endpatharr}% -\index{patharr@\cs{patharr}}\index{endpatharr@\cs{endpatharr}} +\begin{cd}\pagelabel{patharr} +\cs{patharr}\marg{\meta{name}}$\ldots$\cs{endpatharr}% +\index{patharr@\cs{patharr}}% +\index{endpatharr@\cs{endpatharr}} \end{cd} This pair of macros, acting as an environment, accumulate all enclosing -paths, in order, into a path array named \meta{pv}. A path array is a +paths, in order, into a path array named \meta{name}. A path array is a collection of paths with a common base name indexed by integers from 1 to the number of paths. Any path in the array can be accessed by means of \cs{mfobj}. For example, after @@ -3815,158 +5058,601 @@ are used, \MF{} allows \gbc{pa1} as an abbreviation for \gbc{pa[1]}. However, if a numeric variable or some expression is used (e.g., \gbc{pa[n+1]}) the square brackets are required. -This command can only be used in an \env{mfpic} environment. The -definitions it makes are, however, global. +This command can only be used in an \env{mfpic} environment. For this +reason, the definitions it makes are global. -\emph{Note}: In \LaTeX, this pair of macros can be used in the form of a -\LaTeX-style environment called \env{patharr}---as in +\emph{Note}: In \LaTeX{}, this pair of macros can be used in the form of a +\LaTeX{}-style environment called \env{patharr}---as in \cs{begin}\marg{patharr}$\ldots$\cs{end}\marg{patharr}. -\begin{cd} -\cs{pairarray}\marg{\meta{var}}{\meta{list-of-points}}\\ -\cs{numericarray}\marg{\meta{var}}{\meta{list-of-numbers}}% +\begin{cd}\pagelabel{setmfarray} +\cs{setmfarray}\marg{\meta{type}}\marg{\meta{var}}\marg{\meta{list}}\\ +\cs{setmparray}\marg{\meta{type}}\marg{\meta{var}}\marg{\meta{list}}\\ +\cs{globalsetmfarray}\marg{\meta{type}}\marg{\meta{var}}\marg{\meta{list}}\\ +\cs{pairarray}\marg{\meta{var}}\marg{\meta{list-of-points}}\\ +\cs{numericarray}\marg{\meta{var}}\marg{\meta{list-of-numbers}}\\ +\cs{colorarray}\marg{\meta{var}}\marg{\meta{list-of-colors}}% +\index{setmfarray@\cs{setmfarray}}% +\index{setmparray@\cs{setmparray}}% +\index{globalsetmfarray@\cs{globalsetmfarray}}% \index{pairarray@\cs{pairarray}}% -\index{numericarray@\cs{numericarray}} +\index{numericarray@\cs{numericarray}}% +\index{colorarray@\cs{colorarray}} \end{cd} -These enable the simultaneous definition of pair and numeric variables. +These enable the simultaneous definition of variables. For example, after \begin{verbatim} - \pairarray{X}{(0,1),(1,1),(0,0),(1,0)} +\pairarray{X}{(0,1),(1,1),(0,0),(1,0)} \end{verbatim} the variables \mfc{X1}, \mfc{X2}, \mfc{X3}, and \mfc{X4} are equal to the given points in that order. And then \begin{verbatim} - \polyline{X1,X2,X3,X4} +\polyline{X1,X2,X3,X4} \end{verbatim} will draw the lines connecting these four points. The index may optionally be put in square brackets and may be separated from the name by any number of spaces. If a numeric expression is used instead of an explicit number, square brackets \emph{must} surround it: \gbc{X[1+1]}, -\gbc{X[2]}, \gbc{X2} and \gbc{X 2} are all the same. The arrays are -defined locally if these commands occur in an \env{mfpic} environment, -global otherwise. In all arrays, the variable \gbc{X} itself (not -followed by any digit or brackets) is a number equal to the number of -elements in the array. +\gbc{X[2]}, \gbc{X2} and \gbc{X 2} are all the same. For all these array +commands, the variable \gbc{X} by itself (not followed by any digit or +brackets) becomes a numeric variable equal to the number of elements in +the array. Except for \cs{globalsetmfarray}, the arrays are defined +locally if these commands occur in an \env{mfpic} environment, global +otherwise. Array variables may be used only where the values are processed only by -\MF{} or \MP, they are unknown to \TeX. In particular, they cannot be +\MF{} or \MP{}, they are unknown to \TeX{}. In particular, they cannot be used in commands that position text unless \opt{mplabels} is in effect. +Variables may be used in the \meta{list} parameters of commands, +but they must have been previously defined or otherwise known to \MF{}. Several commands in \mfp{} define arrays of objects that can be used in -other commands. The main ones are \cs{piechart} and \cs{barchart}. These -arrays are always global. Using \cs{piechart} causes the following -arrays to become defined: +other commands. The main ones are \cs{regpolygon}, \cs{piechart} and +\cs{barchart}. These arrays are always global (either because their +use is restricted to an \env{mfpic} environment or for backward +compatibility with the time when they were so restricted). + +Using \cs{regpolygon}{\meta{num}}\marg{X}\marg{...}\marg{...} causes a +pair array named \gbc{X} to be defined having \meta{num} elements (and +the additional pair \gbc{X0} for the center). This is in addition to +creating the actual figure. The variable \gbc{X} alone becomes a numeric +equated to \meta{num}. + +Using \cs{piechart} (or \cs{mfppiechart}) causes the following arrays to +become defined (or redefined): \begin{itemize} \item \gbc{piewedge}, a path array describing the wedges of the chart. - The command \cs{piewdge}\marg{\meta{num}} (without optional - argument) is almost exactly the same as - \cs{mfobj}\marg{piewedge[\meta{num}]}. - \item \gbc{pieangle}, a numeric array, the starting angle of each wedge. - \item \gbc{piedirection}, a pair array, the unit vectors pointing in - the directions of the centers of the wedges. If \cs{pieangle1} - is 0 and \gbc{pieangle2} is 90 degrees, then \gbc{piedirection1} - is $(\cos 45,\sin 45)$. + To access \gbc{piewedge[1]}, for example, one could use + \cs{mfobj}\marg{piewedge[1]}. This is almost exactly the + same as the \mfp{} command \cs{piewdge}\marg{1} without + optional arguments. + \item \gbc{pieangle}, a numeric array, gives the starting angles of + the wedges. + \item \gbc{piedirection}, a pair array, gives the unit vectors + pointing from the center of the piechart through middles of the + wedges. For example, if \cs{pieangle1} is 0 and \gbc{pieangle2} + is 90 degrees, then \gbc{piedirection1} is $(\cos 45,\sin 45)$, + the unit vector whose angle is $45$ degrees. \end{itemize} -Using \cs{barchart} causes the following arrays to become defined. The -exact meaning depends on whether bars are horizontal or vertical. The -following describes horizontal bars; interchange the roles of $x$ and -$y$ if they are vertical: +Using \cs{barchart} (or \cs{mfpbarchart} or any of its aliases) causes +the following arrays to become defined (or redefined). The exact meaning +depends on whether bars are horizontal or vertical. The following +describes horizontal bars; exchange the roles of $x$ and $y$ if they are +vertical (also change `right' to `top', etc.): \begin{itemize} - \item \gbc{barstart}, the position on the $y$-axis of the leading edge - of the bars. - \item \gbc{barbegin}, the $x$-coordinate of the leftmost end of the - bars. - \item \gbc{barend}, the $x$-coordinate of the rightmost end of the - bars. - \item \gbc{chartbar}, the rectangular path of the bar; \gbc{chartbar1} - is the rectangle with corners at \gbc{(barbegin1,barstart1)} and - \gbc{(barend1,barstart+barwd)}, where \gbc{barwd} is the - width (thickness) of the bar. + \item \gbc{barstart}, a numeric array, gives the position on the + $y$-axis of the leading edge of the bars. + \item \gbc{barbegin}, numeric, gives the $x$-coordinate of the + leftmost end of the bars. + \item \gbc{barend}, numeric, gives the $x$-coordinate of the rightmost + end of the bars. + \item \gbc{chartbar}, a path array, gives the actual bars. For + example, \gbc{chartbar2} is the rectangle with opposite corners + \gbc{(barbegin2,barstart2)} and \gbc{(barend2,barstart2+barwd)}, + where the numeric variable \gbc{barwd} is the thickness of the + bar (which is a height for horizontal bars). \item \gbc{barlength}, the same as \gbc{barend}. This is for backward - compatibility; the was name chosen at a time when all the bars - had one side on an axis (i.e., \gbc{barbegin[n] = 0}). + compatibility; the name was chosen at a time when all the bars + had one side on an axis. \end{itemize} -\begin{cd} +\subsection{Miscelaneous pair expressions}\label{pairexpressions} + +A useful \MF{} operator that produces points is the intermediation +operator, whose syntax is +\begin{cd} +\texttt{(\meta{num})[\meta{$p_1$},\meta{$p_2$}]} +\end{cd} +That is, a number or numeric expression in parentheses followed by +literal brackets (this is \emph{not} an optional argument) containing two points +or pair expressions separated by a comma. It returns an intermediate point on +the line through \meta{$p_1$} and \meta{$p_2$}. The formula for the +returned value is $p_1 + \mbox{\meta{num}}(p_2 - p_1)$. The midpoint is +obtained with $\mbox{\meta{num}} = .5$. If the \meta{num} is a pure +number, the parentheses can be omitted, but they are required if it is +any other numeric expression. Values of \meta{num} larger than 1 or +less than zero produce points on the line that lie outside the segment +from $p_1$ to $p_2$. This operator can also be applied to +numbers or (in \MP{}) to colors. So that \mfc{(2/3)[3,6] = 5} and +\mfc{.7[green,blue] = (0,.3,.7)}. See section~\ref{colors} for a +description of colors in \MP{} and \MF{}. + +\begin{cd} + \gbc{pathpoint(\meta{frac},\meta{name})} +\end{cd} +This is another useful \MF{} command. It requires a number, \meta{frac}, +and the \emph{name} of a previously defined \MF{} path variable. +(Defined, for example, using \cs{store}; see +subsection~\ref{transformation}). It returns the point on the path that +is approximately that fraction of the path's length from the start of +the path. For example to draw a line from $(0,0)$ to the midpoint of an +arc, do the following: +\begin{verbatim} +\store{myarc}\draw\arc{(1,0),(0,2),90} +\polyline{(0,0), pathpoint(.5,myarc)} +\end{verbatim} +\CMF{} has no general command for calculating the lengths of paths; +\CMP{} does, but it is quite slow. Thus neither program has an efficient +method for finding the described point, so \mfp{} uses \MF\slash\MP{} macros +that are faster, but less accurate than they could be. Still, the +results should (except in pathological cases) be accurate to within a +couple of percent of the length of the path. If they are not, adjust the +value of the fraction. These remarks about accuracy also hold for any +other command (such as \cs{partpath} in subsection~\ref{reversal}) that +take the fraction of a path length as a parameter. + +The \gbc{pathpoint} command is not a basic \MF{} command, but is defined +by the \prog{grafbase} macros that accompany \mfp{}. + + +\subsection{Manipulating \MF{} picture variables} + +\begin{cd}\pagelabel{tile} \cs{tile}\marg{\meta{tilename},\meta{unit},\meta{wd},\meta{ht},\meta{clip}}\\ - \ $\ldots$\\ + \ \meta{\mfp{} drawing commands}\\ \cs{endtile}% -\index{tile@\cs{tile}}\index{endtile@\cs{endtile}} +\index{tile@\cs{tile}}% +\index{endtile@\cs{endtile}} \end{cd} In this environment, all drawing commands contribute to a \emph{tile}. A \emph{tile} is a rectangular picture which may be used to fill the -interior of closed paths. The units of drawing are given by -\meta{unit}, which should be a dimension (like \dim{1pt} or \dim{2in}). -The tile's horizontal dimensions are $0$ to $\meta{wd}\cdot\meta{unit}$ -and its vertical dimensions $0$ to $\meta{ht}\cdot\meta{unit}$, so -\meta{wd} and \meta{ht} should be pure numbers. If \meta{clip} is -\mfc{true} then all drawing is clipped to be within the tile's boundary. +interior of closed paths. Actually, a tile is a composite object. After +\cs{tile}\marg{Nick, ... } $\ldots$ \cs{endtile} a picture variable +\gbc{Nick.pic} is created as well as numeric variable \gbc{Nick.wd} and +\gbc{Nick.ht}. These are needed by the \cs{tess} command, below. + +The units of drawing are given by \meta{unit}, which should be an +explicit dimension (like \dim{1pt} or \dim{2in}). The tile's horizontal +dimensions are $0$ to $\meta{wd}\cdot\meta{unit}$ and its vertical +dimensions $0$ to $\meta{ht}\cdot\meta{unit}$, so \meta{wd} and +\meta{ht} should be pure numbers. If \meta{clip} is \mfc{true} then the +drawing is clipped to be within the tile's boundary. By using this macro, you can design your own fill patterns (to use them, -see the \cs{tess} macro below), but please take some care with the -\ae sthetics! The \meta{tilename} is globally defined by this command. +see the \cs{tess} macro below), but see the warning about memory use by +the \cs{tess} command. The \meta{tilename} is globally defined by this +command. -\begin{cd} +\begin{cd}\pagelabel{tess} \cs{tess}\marg{\meta{tilename}}$\ldots$% \index{tess@\cs{tess}} \end{cd} -Tile the interior of a closed path with a tessellation comprised of -copies of the \emph{tile} specified by \meta{tilename}. There is no -default \meta{tilename}; you must make all your own tiles. Tiling an -open curve is technically an error, but the \MF{} code responds by -drawing the path and not doing any tiling. +This rendering macro tiles the interior of a closed path with a +tessellation comprised of copies of the \emph{tile} specified by +\meta{tilename}. The tile must have been previously created by +\cs{tile}\marg{\meta{tilename}, ... }. Tiling an open curve is +technically an error, but the \MF{} code responds by drawing the path +and not doing any tiling. The \MF{} code places shifted copies of the +tile picture in a rectangular grid sufficient to cover the region, then +clips it to the closed path before drawing it. Tiling large regions with complicated tiles can exceed the capacity of -some versions of \MP. There is less of a problem with \MF. This is not +some versions of \MP{}. There is less of a problem with \MF{}. This is not because \MF{} has greater capacity, but because of the natural difference between bitmaps and vector graphics. -In \MP, the tiles are copied with whatever color they are given when +In \MP{}, the tiles are copied with whatever color they are given when they are defined. They can be multicolored. -\begin{cd} +Before version 0.8, \cs{tile} was the only way to create a picture +variable, and the only way to draw this picture was with the \cs{tess} +command. Now we have the following command to place multiple copies of +a picture: + +\begin{cd}\pagelabel{putmfpimage} + \cs{putmfpimage}\marg{\meta{name}}{\meta{list}}% +\index{putmfpimage@\cs{putmfpimage}} +\end{cd} + +This take the name of a picture variable and copies the picture at each +location in the \meta{list}, which should be a comma-separated list of +coordinate pairs in graph coorcinates. The picture is copied so that its +\emph{reference point} is placed at each of the locations. The reference +point of a picture created with \cs{tile} is its lower left corner. + +\begin{cd}\pagelabel{mfpimage} + \cs{mfpimage}\oarg{\meta{refpt}}\marg{\meta{picname}}\\ + \ \meta{\mfp{} drawing commands}\\ + \cs{endmfpimage}% +\index{mfpimage@\cs{mfpimage}}% +\index{endmfpimage@\cs{endmfpimage}} +\end{cd} + +This is another way to create a picture variable. The drawing commands +within the \env{mfpimage} environment contribute not to the current +\mfp{} picture, but rather to the picture variable named in \meta{picname}. +Otherwise, they operate exactly as they would outside this environment, +using the same coordinate system and the same default values of all +parameters, etc. (unlike the \env{tile} environment, which defines its +own coordinate system). The picture is created with its reference point +at the point \meta{refpt} given in the optional argument. The default is +\texttt{(0,0)}. For example: +\begin{verbatim} +\mfpimage[(1,1)]{Jan} + \fill\rect{(0,0),(1,1)} + \fill\rect{(1,1),(2,2)} + \rect{(0,0),(2,2)} +\endmfpimage +\end{verbatim} +produces a simple 2-by-2 chessboard with its reference point at the +center point $(1,1)$. One can then write something like +\begin{verbatim} +\putmfpimage{Jan}{(1,1),(3,1),(1,3),(3,3)} +\end{verbatim} +to get a 4-by-4 chessboard: the picture \mfc{Jan} copied with its +center at each of the listed points. + +The behavior of \cs{tlabel}\,s in an \env{mfpimage} environment depends +on the setting. If \opt{mplabels} is turned off, then labels are added +by \TeX{} and are \emph{not} included as part of the named \MF{} or +\MP{} picture variable. If \opt{mplabels} is turned on and +\opt{overlaylabels} is also turned on, or if the \env{mfpimage} +environment is between \cs{startbacktext} and \cs{stopbacktext}, then +the labels will be saved and placed when the \env{mfpic} environment +ends and \emph{not} added to the named picture variable. Thus, to +include text labels in the named picture variable, you must have +\opt{mplabels} on, \opt{overlaylabels} off, and \env{mfpimage} outside +any \cs{startbacktext}\slash\cs{stopbacktext}. + +The picture created by \cs{mfpimage} is locally defined. That is, it +becomes undefined at the end of the current \env{mfpic} environment. If +one needs it to be global, one can use \cs{globalsetmfvariable} (see +subsection~\ref{variables}) to copy it to another variable. For example. +the command +\begin{verbatim} + \globalsetmfvariable{picture}{Dan}{Jan} +\end{verbatim} +would make \gbc{Dan} globally defined to be equal to the current value +of the picture \gbc{Jan}. + +You can use \cs{putmfpimage} inside a \env{mfpimage} environment, +provided the picture being placed has been previously defined. Nesting a +\env{mfpimage} inside another has not been completely tested and is not +recommended. One can use the \LaTeX{} environment construct +\cs{begin}\marg{mfpimage} $\ldots$ \cs{end}\marg{mfpimage} in a LaTeX +document instead of \cs{mfpimage} $\ldots$ \cs{endmfpimage}. + +\subsection{\CMF{} loops}\label{loops} + +All the \mfp{} loop commands create a loop (in the \MF{} language) in +the output file. The \MF{} commands in that loop are executed repeatedly. +From the point of view of \TeX{}, however each command occurs only once. +Starting with version 0.9, these loops can be created inside or outside +the \env{mfpic} drawing environment. If outside, they must not contain +any drawing commands, but can contain commands that set variables, +perform computations, etc. + +\begin{cd}\pagelabel{mfpfor} +\cs{mfpfor}\marg{\meta{for-loop header}}\\ + \ \meta{\mfp{} commands}\\ +\cs{endmfpfor}% +\index{mfpfor@\cs{mfpfor}}% +\index{endmfpfor@\cs{endmfpfor}} +\end{cd} + +This creates a for-loop in the \MF{} output file. The \cs{mfpfor} writes +the start of the loop and \cs{endmfpfor} writes the end. Any code +written in the output file between them is executed repeatedly by +\MF{}, according to the information in \meta{for-loop header}. There are +two types of header possible, illustrated by the following examples. +\begin{verbatim} +\mfpfor{center = (0,0), (1,0), (0,1)} + \gfill\circle{center,1} +\endmfpfor +\end{verbatim} +This example will fill three circles of radius 1 with centers at the +three given points. This type of header has the format +\begin{display} + \mfc{\meta{variable} = \meta{list}} +\end{display} +where \meta{variable} should be a simple variable name and \meta{list} is a +comma separated list of items of the appropriate data type. In the +above, \gbc{center} needs coordinate pairs, but in the following +\begin{verbatim} +\mfpfor{radius = 1,3,4} + \dotted\circle{(0,0),radius} +\endmfpfor +\end{verbatim} +\gbc{radius} needs numeric data. + +The other type of header uses a stepped variable: +\begin{verbatim} +\mfpfor{level = 3 step 2 until 9} + \circle{(0,0),sqrt(level)} +\endmfpfor +\end{verbatim} +This will cause the \MF{} variable \gbc{level} to step through the +values 3, 5, 7 and 9 and the circles with radius $\sqrt{3}$, $\sqrt{5}$, +etc. will be drawn. This type of header has the format +\begin{display} + \mfc{\meta{variable} = \meta{start} step \meta{delta} until \meta{stop}} +\end{display} +where \meta{variable} is as before, while \meta{start}, \meta{delta} and +\meta{stop} are numeric values. If \meta{delta} is positive the loop is +skipped entirely if \meta{stop} is less than \meta{start}. Otherwise the +loop is executed successively with the variable equal to \meta{start}, +then $\meta{start} + \meta{delta}$ then $\meta{start} + 2\meta{delta}$, +etc., as long as the variable is not greater than \meta{stop}. The +behavior is similar if \meta{delta} is negative, except the loop is +repeated only as long as the variable is not less than \meta{stop}. If +\meta{delta} is \mfc{0}, then the \MF{} run will generate an error. + +Note that the index variable (\gbc{center} and \gbc{radius} in the above +two examples) is a temporary \MF{} variable. If \opt{mplabels} is turned +on, this variable will work as expected in the \emph{location} parameter +of a \cs{tlabel} command, but if it is used in the \emph{label} part, it +will be interpreted as \TeX{} code and printed as is. + +The single word ``\mfc{upto}'' can be used as an abbreviation for +``\mfc{step 1 until}'' and ``\mfc{downto}'' for ``\mfc{step -1 until}'' +in for-loop headers. Spaces are not significant in for-loop headers. + +\begin{cd}\pagelabel{mfpwhile} + \cs{mfpwhile}\marg{\meta{condition}}\\ + \ \meta{\mfp{} commands}\\ + \cs{endmfpwhile}% +\index{mfpwhile@\cs{mfpwhile}}% +\index{endmfpwhile@\cs{endmfpwhile}} +\end{cd} + +The \meta{condition} should be an expression that can be either true or +false about a \MF{} variable that changes at some time during the loop +body. The loop body is executed (by \MF) as long as the condition is +true. Example: +\begin{verbatim} +\setmfvariable{numeric}{R}{20} +\mfpwhile{R > 1} + \rect{(0,0), (R,3R)} + \mfcmd{R:=R/2} +\endmfpwhile +\end{verbatim} +There are no \mfp{} command to \emph{systematically} change a variable, +so in this example we have resorted to directly writing a \MF{} assignment +command via \cs{mfcmd} (see subsection~\ref{mfcode} above) that reduces +\mfc{R} by half. The loop will be executed with \mfc{R} having the +successive values $20$, $10$, $5$, $2.5$, and $1.25$. The resulting +picture could have been achieved with \cs{mfpfor} using this list of +values. + +\begin{cd}\pagelabel{mfploop} +\cs{mfploop}\\ + \ \meta{\mfp{} commands}\\ +\cs{mfpuntil}\marg{\meta{condition}}\\ + \ \meta{\mfp{} commands}\\ +\cs{endmfploop}% +\index{mfploop@\cs{mfploop}}% +\index{mfpuntil@\cs{mfpuntil}}% +\index{endmfploop@\cs{endmfploop}}% +\end{cd} + +The body of this loop will be repeated until the \meta{condition} +becomes true. The condition should be some expression that can be either +true or false about a variable that changes during the loop execution. +It should eventually become true. If an \env{mfploop} environment does +not contain an \cs{mfpuntil} command, then the \cs{endmfploop} command +will generate a warning message. If the warning is ignored, and the user +has not otherwise arranged for loop termination,% + \footnote{Perhaps by means of \cs{mfsrc} commands. It is because of + this possibility that only a warning is produced and not an error.} +the \file{.mf} file will contain an infinite loop. The \cs{mfpuntil} +command will break the loop at whatever point it occurs. Example: +\begin{verbatim} +\setmfvariable{numeric}{R}{20} +\mfploop + \mfcmd{R:=R/2} + \mfpuntil{R <= 1} + \rect{(0,0), (R,3R)} +\endmfploop +\end{verbatim} +This will draw rectangles with $R$ equal to $10$, $5$, $2.5$, and +$1.25$. On the next execution of the loop the condition \mfc{R<=1} is +true, and the break occurs before the next rectangle is drawn. + +The command \cs{mfpuntil} can also be used in \env{mfpfor} and +\env{mfpwhile} environments to break the loop prematurely when the given +condition becomes true. + +All three of these loop structures bracket the inner code in a \TeX{} +group. In a \LaTeX{} document, the usual \cs{begin}\slash\cs{end} style can +be used. For example, +\begin{verbatim} +\begin{mfpfor}{radius = 1,3,4} + \circle{(0,0),radius} +\end{mfpfor} +\end{verbatim} + +\subsection{Miscellaneous}\label{misc} + +\begin{cd}\pagelabel{noship} +\cs{noship}\\% +\cs{stopshipping}\\% +\cs{resumeshipping}% +\index{noship@\cs{noship}}% +\index{stopshipping@\cs{stopshipping}}% +\index{resumeshipping@\cs{resumeshipping}} +\end{cd} + +\cs{stopshipping} turns off character shipping (by \MF{} to the TFM and +GF files, or by \MP{} to appropriate \EPS{} output file) until +\cs{resumeshipping} occurs. If you want just one character not shipped, +just use \cs{noship} inside that \env{mfpic} environment. This is useful +if all one wishes to do in the current \env{mfpic} environment is to +make tiles (see above) or define picture variables with \cs{mfpimage} or +path arrays with \cs{patharr}. While \cs{mfpimage} defines the picture +locally, one can globally copy it to another variable with +\cs{globalsetmfvariable} (see subsection~\ref{variables}). + +\begin{cd}\pagelabel{assignmfvalue} +\cs{assignmfvalue}\marg{\meta{\TeX{}-macro}}\marg{\meta{MF-expr}}\\ +\cs{assignmpvalue}\marg{\meta{\TeX{}-macro}}\marg{\meta{MP-expr}}\\ +\cs{globalassignmfvalue}\marg{\meta{\TeX{}-macro}}\marg{\meta{MF-expr}}\\ +\cs{globalassignmpvalue}\marg{\meta{\TeX{}-macro}}\marg{\meta{MP-expr}}% +\index{assignmfvalue@\cs{assignmfvalue}}% +\index{assignmpvalue@\cs{assignmpvalue}}% +\index{globalassignmfvalue@\cs{globalassignmfvalue}}% +\index{globalassignmpvalue@\cs{globalassignmpvalue}}% +\end{cd} + +The `\texttt{mf}' and `\texttt{mp}' versions of these commands differ +only in spelling; either may be substituted for the other in any +document. This command causes the \meta{MF-expr} to be written to the +output file for \MF{} to evaluate. The resulting value is then written +to the \file{.log} file of that \MF{} run. On the next \TeX{} run, if +\opt{mfpreadlog} (see section~\ref{readlog}) is in effect, the macro +\meta{\TeX{}-macro} will be defined to produce the resulting value. For +example: +\begin{verbatim} +\setmfvariable{numeric}{s}{2} +\assignmfvalue{\val}{exp s} +\tlabel(1,2){$e^s = \val$} +\end{verbatim} +After \MF{} is run and then \TeX{} run a second time, \cs{val} will +acquire the definition `7.38905', the value of \gbc{exp s} when +\gbc{s=2} (i.e., $e^2$, correct to at least the fourth decimal place). +If \opt{mplabels} is in effect, the correct label is written to the +figure file only during this second run, and a second \MP{} run will be +required. In many cases (when using \pdfTeX{}, for example, or when the +label changes the figure dimensions), a third \TeX{} run will be +required to make the figure correct when it is included in the document. + +Before \MF{} is run to evaluate the expression, the macro produces +`???'. Thus, it cannot be used in places where a number is needed (as in +the position arguments of a \cs{tlabel} command). Note also that if a +command defined by \cs{assignmfvalue} is used in a tlabel with +\opt{mplabels} in effect, then \opt{mplabels} must be in effect during +the \cs{assignmfvalue} command as well. + +The `\texttt{global}' versions make the definition of the +\meta{\TeX{}-macro} global, surviving the current group. In particular, +it can be used in other pictures. The plain versions create commands +that are only locally defined. Past versions of this manual stated that +you can say +\begin{display} + \cs{global}\cs{assignmfvalue} +\end{display} +to define the macro globally. This turned out not to be true in all +cases, and now it may not be true at all. If a global definition is +needed, use the global versions above. + +Because of the asynchronous nature of the definition process, using +\cs{assignmfvalue} with the same macro name more than once in the same +\env{mfpic} environment will not work. The macro acquires its definition +upon reading the logfile during the execution of \cs{opengraphsfile}, +and it will end up with the last definition encountered. (The same is +true for uses outside \env{mfpic} environments: the macro acquires the +last such definition.) Moreover, the definition is associated to a +picture by number. Which means that reordering the environments or +changing the numbering by any means will require the \TeX{}-\MF{}-\TeX{} +sequence (or more) to be repeated. + +If the \meta{\TeX{}-macro} is already defined, no warning will be issued +and the command will be redefined, so be careful in the name chosen. +If \opt{mplabels} is turned off when \cs{assignmfvalue} is used, but +turned on before the \meta{\TeX{}-macro} is used in a \cs{tlabel} +command, the macro definition will not be written to the \file{.mp} +file, and either an error message, or incorrect label will result +when \MP{} tries to make the tlabel. + +The concept and much of the code for \cs{assignmfvalue} came from Werner +Lemberg. However, I have rewritten it substantially to conform to \mfp{} +conventions and so any errors are my responsibility. + +\begin{cd}\pagelabel{cutoffafter} \cs{cutoffafter}\marg{\meta{obj}}\dots\\ \cs{cutoffbefore}\marg{\meta{obj}}\dots\\ \cs{trimpath}\marg{\meta{dim$_1$},\meta{dim$_2$}}\dots\\ -\cs{trimpath}\marg{\meta{dim$_1$}}\dots\\ +\cs{trimpath}\marg{\meta{dim}}\dots% \index{cutoffafter@\cs{cutoffafter}}% \index{cutoffbefore@\cs{cutoffbefore}}% \index{trimpath@\cs{trimpath}}% \end{cd} -These are prefix macros. The first two take an `object' (a variable in -which a path was previously stored using \cs{store}) and uses it to trim -one end off the following path. \cs{cutoffbefore} cuts off the part of -the path before its first intersection with the object, while -\cs{cutoffafter} cuts off the part after the last intersection. If the -path does not intersect the object, nothing is cut off. If the object -and the path intersect in more than one point, as little as possible -(usually% - \footnote{\MF's methods for finding the `first' point of +These prefix macros modify the following path by cutting part of it off. +The first two take an `object' (a variable in which a path was +previously stored using \cs{store}) and uses it to trim off one end of the +following path. \cs{cutoffbefore} cuts off the part of the path +\emph{before} its first intersection with the object, while +\cs{cutoffafter} cuts off the part \emph{after} the last intersection. +If the path does not intersect the object, nothing is cut off. If the +object and the path intersect in more than one point, as little as +possible (usually% + \footnote{\MF{}'s methods for finding the `first' point of intersection do not always find the actual first one.}) % is cut off. This is completely reliably only when there is only one point of intersection. The \cs{trimpath} macro takes two dimensions separated by commas and -trims those lengths off the initial and terminal ends of the path. If -only one dimension is given, that is used at both ends. This macro is -essentially equivalent to applying \cs{cutoffafter} and then -\cs{cutoffbefore} where the objects are circles which have radii equal -to the given dimensions and which are centered at the endpoints of the -path. Consequently, if the path is shorter than either dimension, it -will not intersect either circle and nothing will be trimmed. Similarly, -if the result of \cs{cutoffafter} is shorter than the first dimension, -then \cs{cutoffbefore} will not trim any more off. The first two macros -can be used to create a curve that starts or ends right at another -figure without having to find the point where the two curves intersect. -The third one can be used on the result to produce a curve that stops -just short of the point of intersection. - -\begin{cd} +trims those lengths off the initial and terminal ends of the path. +Alternatively, it takes one dimension and and trims that length off of +both ends. If any of \meta{dim$_1$}, \meta{dim$_2$} or \meta{dim} is +missing, it is taken to be \dim{0pt}. This macro is essentially +equivalent to applying a combination of the first two commands, using as +the objects circles which have radii equal to the given dimensions and +which are centered at the endpoints of the path. Consequently, if the +path is shorter than either dimension, it will not intersect either +circle and nothing will be trimmed. Similarly, if the result of the +first cut is too short the second cut may not cut anything off. If the +path intersects one of these circles more than once, it is not really +predictable at which point the cut will be made. + +The first two macros can be used to create a curve that starts or ends +right at another figure without having to know the point where the two +curves intersect. The third one can be used on the result to produce a +curve that stops a short distance before the point of intersection. + +\begin{cd}\pagelabel{random} +\cs{randomlines}\marg{\meta{maxshift}}\dots\\ +\cs{randomizepath}\marg{\meta{maxshift}, \meta{weirdness}}\dots +\index{randomizepath@\cs{randomizepath}}% +\index{randomlines@\cs{randomlines}} +\end{cd} + +These modify the following path by applying random shifts to the nodes +of a path. The first one, \cs{randomlines} then simply connects those +new points by straight lines, while the second one also applies +randomization to the control vectors. The \meta{maxshift} argument is +either a positive number (in graph units) that limits the distance a +node can be moved, or it is an ordered pair of positive numbers, in +which case the first limits the horizontal distance and the second +limits the vertical. If \meta{maxshift} is larger than the distance +between nodes, cusps or loops are likely in the result. + +For \cs{randomizepath} the \meta{weirdness} parameter controls how the +control vectors are modified. Roughly speaking the control vectors are +randomly rotated up to $30\langle\mathit{weirdness}\rangle$ degrees and +randomly scaled up or down by a factor of +$2^{\langle\mathit{weirdness}\rangle}$. (A `control vector' is a vector +pointing from a node to one of its control points.) However, this is +done in a way that preserves smoothness at each node where the path is +smooth. Values of \meta{weirdness} greater than 1 are probably too +weird. + + +\begin{cd}\pagelabel{mftitle} \cs{mftitle}\marg{\meta{title}}% \index{mftitle@\cs{mftitle}} \end{cd} @@ -3975,7 +5661,7 @@ Write the string \meta{title} to the \MF{} file, and use it as a \MF{} message. (See \textit{The \MF{}book}, chapter 22, page 187, for two uses of this.) -\begin{cd} +\begin{cd}\pagelabel{tmtitle} \cs{tmtitle}\marg{\meta{title}}% \index{tmtitle@\cs{tmtitle}} \end{cd} @@ -3992,7 +5678,7 @@ are so important to typesetting and drawing, it is common to use up all dimensions to store dimension values. The following is the command that handles the allocation of these dimensions. -\begin{cd} +\begin{cd}\pagelabel{newfdim} \cs{newfdim}\marg{\meta{fdim}}% \index{newfdim@\cs{newfdim}} \end{cd} @@ -4001,23 +5687,22 @@ This create a new global font dimension named \meta{fdim}, which is a \TeX{} control sequence (with backslash). It can be used almost like an ordinary \TeX{} dimension. One exception is that the \TeX{} commands \cs{advance}, \cs{multiply} and \cs{divide} cannot be applied directly -to font dimensions (nor \LaTeX's \cs{addtolength}); however, the font +to font dimensions (nor \LaTeX{}'s \cs{addtolength}); however, the font dimension can be copied to a temporary \TeX{} dimension register, which -can then be manipulated and copied back (using \cs{setlength} in \LaTeX, +can then be manipulated and copied back (using \cs{setlength} in \LaTeX{}, if desired). Another exception is that all changes to a font dimension are global in scope. Also beware that \cs{newfdim} uses font dimensions from a single font, the \file{dummy} font, which most \TeX{} systems ought to have. (You'll know if yours doesn't, because \mfp{} will fail upon loading!) Also, implementations of \TeX{} differ in the number of -font dimensions allowed per font. Hopefully, \mfp{} won't exceed your -local \TeX's limit. +font dimensions allowed per font. \Mfp{} currently uses font dimensions +23 through 52, which should be OK. -All of \mfp's basic dimension parameters are font dimensions. We have -lied slightly when we called them `\TeX{} dimensions'. We arrange for -them to be local to \env{mfpic} environments by saving their values at -the start and restoring them at the end. +Almost all of \mfp{}'s basic dimension parameters are font dimensions. +We arrange for them to be local to \env{mfpic} environments by saving +their values at the start and restoring them at the end. -\begin{cd} +\begin{cd}\pagelabel{setmfpicgraphic} \cs{setmfpicgraphic}\marg{\meta{filename}}% \index{setmfpicgraphic@\cs{setmfpicgraphic}} \end{cd} @@ -4027,7 +5712,7 @@ appendix~\ref{graphics} for a discussion of its use and its default definition. It is a user-level macro so that it can be redefined in unusual cases. It operates on the output of the following macro: -\begin{cd} +\begin{cd}\pagelabel{setfilename} \cs{setfilename}\marg{\meta{file}}\marg{\meta{num}}% \index{setfilename@\cs{setfilename}} \end{cd} @@ -4047,7 +5732,7 @@ creates the actual filename from the above two parts. It should also be completely expandable. See the appendices, subsection~\ref{graphics} for further dicussion. -\begin{cd} +\begin{cd}\pagelabel{preparemfpicgraphic} \cs{preparemfpicgraphic}\marg{\meta{filename}}% \index{preparemfpicgraphic@\cs{preparemfpicgraphic}} \end{cd} @@ -4061,7 +5746,7 @@ redefines an internal command of the graphics package to make the data available. If \cs{setmfpicgraphic} is redefined then this may also have to be redefined. -\begin{cd} +\begin{cd}\pagelabel{getmfpicoffset} \cs{getmfpicoffset}\marg{\meta{filename}}% \index{getmfpicoffset@\cs{getmfpicoffset}} \end{cd} @@ -4071,7 +5756,7 @@ store the offset of the lower left corner of the figure in the macros \cs{mfpicllx} and \cs{mfpiclly}. If \cs{setmfpicgraphic} is redefined then this may also have to be redefined. -\begin{cd} +\begin{cd}\pagelabel{ifmfpmpost} \cs{ifmfpmpost}% \index{ifmfpmpost@\cs{ifmfpmpost}} \end{cd} @@ -4084,72 +5769,50 @@ should not be changing the setting once it is set: a great deal of \mfp{} internal code depends on them, and on keeping them consistent with the \cs{opengraphsfile} commands reading of these booleans. -\begin{cd} -\cs{mfpicversion} +\begin{cd}\pagelabel{mfpicversion} +\cs{mfpicversion}% \index{mfpicversion@\cs{mfpicversion}} \end{cd} This expands to the current \mfp{} version multiplied by 100. At this -writing, it produces `\texttt{70}' because the version is 0.7. It -can be used to test for the current version: +writing, it produces `\texttt{90}' because the version is 0.9. It can +be used to test the version: \begin{verbatim} - \ifx\mfpicversion\undefined \def\mfpicversion{0}\fi - \ifnum\mfpicversion>70 ... \else ... \fi +\ifx\mfpicversion\undefined \def\mfpicversion{0}\fi +\ifnum\mfpicversion>70 ... \else ... \fi \end{verbatim} \cs{mfpicversion} was added in version 0.7. -\subsubsection{Hackers.}\label{hackers} -\Mfp{} employs a modified version of \LaTeX's \cs{@ifnextchar} -that not only skips over spaces when seeking the next character, but -also skips over \cs{relax} or tokens that have been \cs{let} equal to -it. This is because, in contexts where we try to preserve lines, we make -the end-of-line character active and set it equal to \cs{relax}. Since -it is hard to predict in what context a macro will be used, this gives -code like -\begin{ex} - \cs{function}\\ - \oarg{s1.2}\marg{0,2,.1}\marg{ x**2 } -\end{ex} -the same behavior in both.% - \footnote{Actually, because of a bug in previous versions, this was - not true, but it is now. I hope.} -One consequence is that putting \cs{relax} to stop a command from seeing -a `\texttt{[}' as the start of an optional argument will not work for -\mfp{} commands. The same holds for the `\texttt{*}' in those few -commands that have a star-form, and also for other commands that look -ahead (\cs{tlabel} looks for a `\texttt{(}' starting off the location, -and macros that operate on lists of data look ahead for -`\cs{datafile}'). This is not a serious problem, because there is only -one command (\cs{smoothdata}) that takes an optional arguments but -doesn't have mandatory arguments after that. If a `\cs{relax}' appeared -after any other \mfp{} command, it would be taken as an argument and an -error would result. In any case, \cs{empty} will stop the looking ahead -if it should ever be necessary. - -Most of \mfp's commands have arguments with parts delimited by commas +Most of \mfp{}'s commands have arguments with parts delimited by commas and parentheses. In most cases this is no problem because they are written unchanged to the \file{.mf} and there they are parsed just fine. Some commands' arguments, however, have to be parsed by both \TeX{} and -\MF. Examples are \cs{tlabel} (sometimes, under \opt{mplabels}), and +\MF{}. Examples are \cs{tlabel} (sometimes, under \opt{mplabels}), and \cs{pointdef}. One might be tempted to use \MP{} expressions there and that works fine as long as they do not contain commas or parentheses. In such cases, they can sometimes be enclosed in braces to prevent \TeX{} seeing these elements as delimiters, but sometimes these braces might get written to the \file{.mf} (or \file{.mp}) output and cause a \MF{} -(\MP) error. In such cases the following work-around might be possible: - +(\MP{}) error. In such cases the following work-around might be possible: \begin{verbatim} - \def\identity#1{#1} - \pointdef{A}(\identity{angle (1,2)},3) - \rect{(0,0),\A} +\def\identity#1{#1} +\pointdef{A}(\identity{angle (1,2)},3) +\rect{(0,0),\A} \end{verbatim} -The braces prevent \TeX's argument parsing from seeing the first comma +The braces prevent \TeX{}'s argument parsing from seeing the first comma as a delimiter, but upon writing to the \file{.mf}, the \cs{identity} commands are expanded and only the contents appear in the output. (\TeX{} parses the argument to assign meanings to \cs{Ax} and \cs{Ay}.) +If the \prog{babel} package is loaded with certain options, the comma +may become a special character. In that case, one may need to deactivate +babel shorthands before some \mfp{} code. One might use \cs{everymfpic} +to do this in every \env{mfpic} environment. In some cases, one may need +to reactivate babel shorthands insided \cs{tlabel}, and one might use +\cs{everytlabel} for this purpose. See your \prog{babel} documentation +for the commands to do these things. \clearpage @@ -4157,104 +5820,124 @@ parses the argument to assign meanings to \cs{Ax} and \cs{Ay}.) \def\subsectionmark#1{} \def\subsubsectionmark#1{} \thispagestyle{plain} -\section{Appendices}\label{appendices} +\chapter{Appendices}\label{appendices} -\subsection{Acknowledgements.}\label{acknowledgements} +\section{Acknowledgements.}\label{acknowledgements} Tom would like to thank all of the people at Dartmouth as well as out in the network world for testing \mfp{} and sending him back comments. He would particularly like to thank: -\medskip -Geoffrey Tobin %(G.Tobin@latrobe.edu.au) +Geoffrey Tobin for his many suggestions, especially about cleaning up the \MF{} code, enforcing dimensions, fixing the dotted line computations, and speeding up the shading routines (through this process, Geoffrey and Tom managed -to teach each other many of the subtleties of \MF), and for keeping +to teach each other many of the subtleties of \MF{}), and for keeping track of \mfp{} for nearly a year while Tom finished his thesis; -\medskip -Bryan Green %(bgreen@sanjuan.uvic.ca) +Bryan Green for his many suggestions, some of which (including his rewriting the \cs{tcaption} macro) ultimately led to the current version's ability to put graphs in-line or side-by-side; and -\medskip -Uwe Bonnes %(bon@lte.e-technik.uni-erlangen.de) -and Jarom\'\i r Kuben, % (vabo@muni.cz) -who worked out rewrites of \mfp{} during Tom's -working hiatus and who each contributed several valuable ideas. +Uwe Bonnes and +Jarom\'\i r Kuben, +who worked out rewrites of \mfp{} during Tom's working hiatus and who +each contributed several valuable ideas. -\medskip -Some credit also belongs to Anthony Stark, % (ajs@merck.com) +Some credit also belongs to +Anthony Stark, whose work on a FIG to \MF{} converter has had a serious impact on the -development of many of \mfp's capabilities. +development of many of \mfp{}'s capabilities. -\medskip -Finally, Tom would like to thank Alan Vlach, the other \TeX{}nician at -Berry College, for helping him decide on the format of many of the -macros, and for helping with testing. +Finally, Tom would like to thank +Alan Vlach, +the other \TeX{}nician at Berry College, for helping him decide on the +format of many of the macros, and for helping with testing. \medskip Dan Luecking would like to echo Tom's thanks to all of the above, especially Geoffrey Tobin and Jarom\'\i r Kuben. And to add the names -Taco Hoekwater, for comments, advice and suggestions, and Zaimi -Sami~Alex for suggestions. +Taco Hoekwater, for comments, advice and suggestions, Werner Lemberg, +for the \cs{assignmfvalue} command, and Zaimi Sami~Alex for suggestions. But mostly, he'd like to thank Tom Leathrum for starting it all. -\subsection{Changes History.}\label{changes} +\section{Changes History.}\label{changes} -See the file \file{changes.txt} for a somewhat sporadic and rambling -history of changes to \mfp. See the file \file{readme.txt} for a -list of any known problems. +See the file \file{changes.txt} for a somewhat sporadic history of +changes to \mfp{} (through the previous version). See the file +\file{new.txt} for changes since the previous version. See the file +\file{README} for any known problems. %\clearpage -\subsection{Summary of Options}\label{summary} +\section{Summary of Options.}\label{summary} Unless otherwise stated, any of the command forms will be local to the current \env{mfpic} environment if used inside. Otherwise it will affect all later environments. \medskip -\def\stack#1{\everycr{}\def\\{\cr}\halign{\strut##\hfil\cr#1\crcr}} -{\everycr{\noalign{\medskip}} -\halign to \hsize{\opt{#}\hfil\quad\tabskip0pt plus 1fil& - \vtop{\stack{#}}\hfil\quad& - \vtop{\parindent0pt \hsize.45\hsize \rightskip0pt plus1fil\relax - \strut\ignorespaces#\strut}\tabskip0pt\cr -{\rmfamily\scshape Option}:& \textsc{Command form(s)}:& \omit\textsc{Restrictions}: \hfil\cr +% \shortstack doesn't allow [t] aligment: +\def\stack#1{{\tabular[t]{@{}l@{}}#1\endtabular}} + +% Use halign so it will break over 2 pages +{\openup\jot +\halign to \textwidth + {#\hfil\quad\tabskip0ptplus 1fil& + #\hfil\quad& + \vtop{\parindent0pt\rightskip0pt plus 1fil\relax + \hsize.5\hsize\normalbaselines + \strut#\strut}\tabskip0pt \cr +\textsc{Option}:& \textsc{Command form(s)}:& \textsc{Restrictions}:\cr \noalign{\smallskip\hrule\smallskip} -metapost&\cs{usemetapost}& Command must come before - \cs{opengraphsfile}. Incompatible with \opt{metafont} option. \cr -metafont&\cs{usemetafont}& The default. Command must come before - \cs{opengraphsfile}. Incompatible with \opt{metapost} option. \cr -mplabels&\cs{usemplabels},\\ \cs{nomplabels}& Requires - \opt{metapost}. If command is used inside an \env{mfpic} - environment, it should come before \cs{tlabel} commands to be - affected. \cr -overlaylabels&\cs{overlaylabels},\\ \cs{nooverlaylabels}& Has no effect - without \opt{metapost}. \cr -truebbox& \cs{usetruebbox},\\ \cs{notruebbox}& Has no effect - without \opt{metapost}. \cr -clip& \cs{clipmfpic},\\ \cs{noclipmfpic}& No restrictions. \cr -clearsymbols& \cs{clearsymbols},\\ \cs{noclearsymbols}& No restrictions. \cr -centeredcaptions& \cs{usecenteredcaptions},\\ \cs{nocenteredcaptions}& - No restrictions. \cr -debug&\cs{mfpicdebugtrue},\\\cs{mfpicdebugfalse}& To turn on - debugging while \file{mfpic.tex} is loading, issue - \cs{def}\cs{mfpicdebug}\marg{true}. \cr -\vtop{\hbox{draft\strut} - \hbox{final\strut} - \hbox{nowrite\strut}}&\cs{mfpicdraft}\\ - \cs{mfpicfinal}\\ - \cs{mfpicnowrite}& Should not be used - together. Command forms should come before - \cs{opengraphsfile}\cr +\opt{metapost}& + \cs{usemetapost}& + Command must come before \cs{opengraphsfile}. + Incompatible with \opt{metafont} option.\cr +\opt{metafont}& + \cs{usemetafont}& + The default. Command must come before + \cs{opengraphsfile}. Incompatible with \opt{metapost} + option. \cr +\opt{mplabels}& + \stack{\cs{usemplabels},\\ \cs{nomplabels}}& + Requires \opt{metapost}. If command is used inside an + \env{mfpic} environment, it should come before + \cs{tlabel} commands to be affected. \cr +\opt{overlaylabels}& + \stack{\cs{overlaylabels},\\ \cs{nooverlaylabels}}& + Has no effect without \opt{metapost}. \cr +\opt{truebbox}& + \stack{\cs{usetruebbox},\\ \cs{notruebbox}}& + Has no effect without \opt{metapost}. \cr +\opt{clip}& + \stack{\cs{clipmfpic},\\ \cs{noclipmfpic}}& + No restrictions. \cr +\opt{clearsymbols}& + \stack{\cs{clearsymbols},\\ \cs{noclearsymbols}}& + No restrictions. \cr +\stack{\opt{centeredcaptions}\\ \opt{raggedcaptions}}& + \stack{\cs{usecenteredcaptions},\\ \cs{nocenteredcaptions}\\ + \cs{useraggedcaptions},\\ \cs{noraggedcaptions}}& + If command is used inside an \env{mfpic} environment, it + should come before the \cs{tcaption} command.\cr +\opt{debug}& + \stack{\cs{mfpicdebugtrue},\\\cs{mfpicdebugfalse}}& + To turn on debugging while \file{mfpic.tex} is loading, + issue \cs{def}\cs{mfpicdebug}\marg{true}.\cr +\stack{\opt{draft}\\ \opt{final}\\ \opt{nowrite}}& + \stack{\cs{mfpicdraft}\\ \cs{mfpicfinal}\\ \cs{mfpicnowrite}}& + Should not be used together. Command forms should come + before \cs{opengraphsfile} \cr +\opt{mfpreadlog}& + \cs{mfpreadlog}& + Needed for \cs{assignmfvalue}. Must occur before + \cs{opengraphsfile}. \cr }} %\clearpage -\subsection{Plotting styles for \cs{plotdata}}\label{styles} +\section{Plotting Styles for \cs{plotdata}.}\label{styles} When \cs{plotdata} passes from one curve to the next, it increments a counter and uses that counter to select a dash pattern, color, or symbol. @@ -4269,17 +5952,17 @@ These variables must not be used in the second argument of Under \cs{dashedlines}, we have the following dash patterns: \medskip -\indent\vbox{% -\halign{#\hfil\qquad&#\hfil\quad&#\hfil\strut\cr +\begin{tabular}{@{}lll} \textsc{Name}&\textsc{Pattern}&\textsc{Meaning}\cr -\noalign{\smallskip\hrule\smallskip} -\mfc{dashtype0}& \dim{0bp} & solid line \cr -\mfc{dashtype1}& \dim{3bp,4bp} & dashes \cr -\mfc{dashtype2}& \dim{0bp,4bp} & dots \cr -\mfc{dashtype3}& \dim{0bp,4bp,3bp,4bp} & dot-dash \cr -\mfc{dashtype4}& \dim{0bp,4bp,3bp,4bp,0bp,4bp} & dot-dash-dot \cr -\mfc{dashtype5}& \dim{0bp,4bp,3bp,4bp,3bp,4bp} & dot-dash-dash\cr -}} +\hline +\vbox to 10pt{}% +\mfc{dashtype0}& \dim{0bp} & solid line \\ +\mfc{dashtype1}& \dim{3bp,4bp} & dashes \\ +\mfc{dashtype2}& \dim{0bp,4bp} & dots \\ +\mfc{dashtype3}& \dim{0bp,4bp,3bp,4bp} & dot-dash \\ +\mfc{dashtype4}& \dim{0bp,4bp,3bp,4bp,0bp,4bp}& dot-dash-dot \\ +\mfc{dashtype5}& \dim{0bp,4bp,3bp,4bp,3bp,4bp}& dot-dash-dash +\end{tabular} \medskip Under \cs{coloredlines}, we have the following colors. Except for @@ -4289,19 +5972,19 @@ background. (The success of this attempt varies greatly with the output or display device.) \medskip -\indent\vbox{% -\halign{#\hfil\qquad&#\hfil\quad&#\hfil\strut\cr -\textsc{Name}&\textsc{Color}&\textsc{(r,g,b)}\cr -\noalign{\smallskip\hrule\smallskip} -\mfc{colortype0}& black & $( 0, 0, 0)$\cr -\mfc{colortype1}& red & $( 1, 0, 0)$\cr -\mfc{colortype2}& blue & $( .2, .2, 1)$\cr -\mfc{colortype3}& orange & $(.66,.34, 0)$\cr -\mfc{colortype4}& green & $( 0, .8, 0)$\cr -\mfc{colortype5}& magenta& $(.85, 0,.85)$\cr -\mfc{colortype6}& cyan & $( 0,.85,.85)$\cr -\mfc{colortype7}& yellow & $(.85,.85, 0)$\cr -}} +\begin{tabular}{@{}lll} +\textsc{Name}&\textsc{Color}&\textsc{(r,g,b)}\\ +\hline +\vbox to 10pt{}% +\mfc{colortype0}& black & $( 0, 0, 0)$\\ +\mfc{colortype1}& red & $( 1, 0, 0)$\\ +\mfc{colortype2}& blue & $( .2, .2, 1)$\\ +\mfc{colortype3}& orange & $(.66,.34, 0)$\\ +\mfc{colortype4}& green & $( 0, .8, 0)$\\ +\mfc{colortype5}& magenta& $(.85, 0,.85)$\\ +\mfc{colortype6}& cyan & $( 0,.85,.85)$\\ +\mfc{colortype7}& yellow & $(.85,.85, 0)$\\ +\end{tabular} \medskip @@ -4311,29 +5994,29 @@ are identical to the more descriptive name. Syntactically, all are \MF{} path variables. (The order changed between versions 0.6 and 0.7.) \medskip -\indent\vbox{% -\halign{#\hfil\qquad&#\hfil\strut\cr -\textsc{Name}&\textsc{Description}\cr -\noalign{\smallskip\hrule\smallskip} -\mfc{pointtype0}& \mfc{Circle} \cr -\mfc{pointtype1}& \mfc{Cross} \cr -\mfc{pointtype2}& \mfc{SolidDiamond} \cr -\mfc{pointtype3}& \mfc{Square} \cr -\mfc{pointtype4}& \mfc{Plus} \cr -\mfc{pointtype5}& \mfc{Triangle} \cr -\mfc{pointtype6}& \mfc{SolidCircle} \cr -\mfc{pointtype7}& \mfc{Star} \cr -\mfc{pointtype8}& \mfc{SolidTriangle}\cr -}} - -\subsection{Special considerations when using \MF}\label{mfconsiderations} +\begin{tabular}{@{}ll} +\textsc{Name}&\textsc{Description}\\ +\hline +\vbox to 10pt{}% +\mfc{pointtype0}& \mfc{Circle} \\ +\mfc{pointtype1}& \mfc{Cross} \\ +\mfc{pointtype2}& \mfc{SolidDiamond} \\ +\mfc{pointtype3}& \mfc{Square} \\ +\mfc{pointtype4}& \mfc{Plus} \\ +\mfc{pointtype5}& \mfc{Triangle} \\ +\mfc{pointtype6}& \mfc{SolidCircle} \\ +\mfc{pointtype7}& \mfc{Star} \\ +\mfc{pointtype8}& \mfc{SolidTriangle} +\end{tabular} + +\section{Special Considerations When Using \CMF{}.}\label{mfconsiderations} The most important restriction in \MF{} is on the size of a picture. Coordinates in \MF{} ultimately refer to pixel units in the font that is output. These are required to be less than 4096, so an absolute limit on -the size of a picture is whatever length a row of 4096 pixels is. In -fonts prepared for a LaserJet4 (600 DPI), this means about 6.8 inches. -For a 1200 DPI pronter, the limit is about 3.4 inches. +the size of a picture is whatever length a row of 4095 pixels is. In +fonts prepared for a LaserJet4 (600 DPI), this means 6.825 inches +(17.3355cm). For a 1200 DPI pronter, the limit is 3.4125 inches. A similar limit holds for numbers input, and the values of variables: \MF{} will return an error for \mfc{sin 4096}. Intermediate values can @@ -4341,45 +6024,51 @@ be greater (\mfc{sin (2*2048)} will cause no error), but final, stored results are subject to the limit. An \mfp{} example that generated an error recently was: \begin{verbatim} - \mfpicunit 1mm - \mfpic[10]{-3}{7}{-3.5}{5} - \function{-4.5,4,.1}{x*x} - \endmfpic +\mfpicunit 1mm +\mfpic[10]{-3}{7}{-3.5}{5} + \function{-4.5,4,.1}{x*x} +\endmfpic \end{verbatim} -The problem was the value of $(-4.5)^2=20.25$ in pixel units (after -multiplying by the \cs{mfpic} scaling factor the \cs{mfpicunit} in -inches and the DPI value): $20.25\times10\times0.03937\times600 > 4783$. -The error did not occur at the point of creating the font, but merely at -the point of storing the path in an internal variable for manipulation -and drawing. +The problem was the value of $4.5*4.5 = 20.25$: after multiplying by the +\cs{mfpic} scaling factor, the \cs{mfpicunit} in inches, and the DPI +value, this produces $20.25\times10\times0.03937\times600 > 4783$ pixel +units. The error did not occur at the point of creating the font, but +merely at the point of storing the path in an internal variable for +manipulation and drawing. Thus, the fact that this particular picture +was clipped to a much smaller size for printing did not help. +In \MP{}, the limit on numeric values is only 8 times as high: $32768$. +However, that is independent of printer resolution and is interpreted as +\PS{} points (\TeX{}'s `big points'). At $72$ points to the inch, this +allows figures to be about 12.64 yards (11.56m). -\subsection{Special considerations when using \MP}\label{mpconsiderations} -\subsubsection{Required support} +\section{Special Considerations When Using \CMP{}.}\label{mpconsiderations} -To use \mfp{} with \MP, the following support is needed (besides a +\subsection{Required support} + +To use \mfp{} with \MP{}, the following support is needed (besides a working \MP{} installation): -\medskip -\halign{#\hfil\quad&\vtop{\hsize 4.4 truein \raggedright \noindent - \strut#\strut}\hfil\cr -Under plain\TeX &The file \file{epsf.tex}\cr -Under \LaTeX209 &The file \file{epsf.tex} or \file{epsf.sty}\cr -Under \LaTeXe &The package \prog{graphics} or \prog{graphicx}\cr -Under \pdfLaTeX{} &The package \prog{graphics} or - \prog{graphicx} with option \opt{pdftex}\cr -Under plain \pdfTeX{} &The files \file{supp-pdf.tex} and - \file{supp-mis.tex}\cr -In all cases &The files \file{grafbase.mp} and +\medskip\noindent +\begin{tabular}{@{}lp{4.2in}} +plain \TeX{} &The file \file{epsf.tex}\\ +\LaTeX{}209 &(No longer supported, but plain \TeX{} methods +might work)\\ +\LaTeX{} &The package \prog{graphics} or \prog{graphicx}\\ +\pdfLaTeX{} &The package \prog{graphics} or + \prog{graphicx} with option \opt{pdftex}\\ +plain \pdfTeX{} &The files \file{supp-pdf.tex} and + \file{supp-mis.tex}\\ +In all cases &\raggedright The files \file{grafbase.mp} and \file{dvipsnam.mp} plus, of course, \file{mfpic.tex} (and \file{mfpic.sty} for - \LaTeX)\cr -} + \LaTeX{}) +\end{tabular} \medskip The files \file{grafbase.mp} and \file{dvipsnam.mp} should be in a -directory searched by \MP. The remaining files should be in directories +directory searched by \MP{}. The remaining files should be in directories searched by the appropriate \TeX{} variant. If \MP{} cannot find the file \file{grafbase.mp}, then by default it will try to input \file{grafbase.mf}, which is generally futile (or fatal). @@ -4387,35 +6076,36 @@ file \file{grafbase.mp}, then by default it will try to input In case \pdfLaTeX{} is used, the graphics package is given the \opt{pdftex} option. This option requires the file \file{pdftex.def} which currently inputs the files \file{supp-pdf.tex} and -\file{supp-mis.tex}. The file \file{pdftex.def} is supplied with the -\prog{graphics} package. The other two are usually supplied with a -\pdfTeX{} distribution, and are definitely part of the \ConTeXt{} -distribution. Older versions had some bugs in connection with the -\prog{babel} package. One workaround was to load the \prog{graphics} -package and \mfp{} before \prog{babel}. +\file{supp-mis.tex}. These three files should be supplied with +all \TeX{} installations.% + \footnote{At this writing, the file + \file{CTAN/macros/context/cont-mpd.zip} contains these two + \file{supp} files, plus a few others for working with \MP{}.} % +Older versions had some bugs in connection with the \prog{babel} +package. One workaround was to load the \prog{graphics} package and +\mfp{} before \prog{babel}. If the user loads one of the above required files or packages before the -\mfp{} macros are loaded then \mfp{} will not reload them. -If they have not been input, \mfp{} will load whichever one it -decides is required. In the \LaTeXe{} case, \mfp{} will load the -\prog{graphics} package. If the user wishes \prog{graphicx}, then that -package must be loaded before \mfp. +\mfp{} macros are loaded then \mfp{} will not reload them. \Mfp{} will +load whichever one it decides is required. In the \LaTeXe{} case, \mfp{} +will load the \prog{graphics} package. If the user wishes +\prog{graphicx}, then that package must be loaded before \mfp{}. -\subsubsection{\CMP{} is not \MF} +\subsection{\CMP{} is not \MF{}} -\PS{} is not a pixel oriented language and so neither is \MP. The model -for drawing objects is completely different between \MF{} and \MP, and +\PS{} is not a pixel oriented language and so neither is \MP{}. The model +for drawing objects is completely different between \MF{} and \MP{}, and so one cannot always expect the same results. \CMP{} support in \mfp{} was carefully written so that files successfully printed with \mfp{} using \MF{} would be just as successfully printed -using \MP. Nevertheless, it frequently choke on files that make use of +using \MP{}. Nevertheless, it frequently choke on files that make use of the \cs{mfsrc} command for writing code directly to the \file{.mf} file. -While \file{grafbase.mp} is closely based on \file{grafbase.mf}, much of +While \file{grafbase.mp} is closely based on \file{grafbase.mf}, some of the code had to be completely rewritten. Pictures in \MP{} are stored as (possibly nested) sequences of objects, -where objects are things like points, paths, contours, other pictures, -etc. In \MF, pictures are stored as a grid of pixels. Pictures that are +where objects are things like points, paths, contours, sub-pictures, +etc. In \MF{}, pictures are stored as a grid of pixels. Pictures that are relatively simple in one program might be very complex in the other and even exceed memory allocated for their storage. Two examples are the \cs{polkadot} and \cs{hatch} commands. When the polkadot space and size @@ -4423,17 +6113,16 @@ are both too small, a \cs{polkadot}-ed region has been known to exceed \MP{} capacity, while being well within \MF{} capacity. In \MP{} the memory consumed by \cs{hatch} goes up in direct proportion to the linear dimensions of the figure being hatched, while in \MF{} it goes up in -proportion to the area, and then the reverse can happen, with \MF's -capacity exeeded far sooner that \MP's. +proportion to the area (except in horizontal hatching), and then the +reverse can happen, with \MF{}'s capacity exeeded far sooner that \MP{}'s. In \MP{} it is important to note that each prefix modifies the result of the entire following sequence. In essence prefixes can be viewed as being applied in the opposite order to their occurrence. Example: - -\begin{ex} - \cs{dashed}\cs{gfill}\cs{rect}\marg{(0,0),(1,1)} -\end{ex} +\begin{verbatim} +\dashed\gfill\rect{(0,0),(1,1)} +\end{verbatim} This adds the dashed outline to the filled rectangle. That is, first the rectangle is defined, then it is filled, then the outline is drawn in dashed lines. This makes a difference when colors other than black are @@ -4441,9 +6130,9 @@ used. Drawing is done with the center of the virtual pen stroked down the middle of the boundary, so half of its width falls inside the rectangle. On the other hand, filling is done right up to the boundary. In this example, the dashed lines are drawn on top of part of the fill. -In the reverse order, the fill would cover part of the outline. +In the reverse order, the fill would cover part of the dashed outline. -\subsubsection{Graphic inclusion}\label{graphics} +\subsection{Graphic inclusion}\label{graphics} It may be impossible to completely cater to all possible methods of graphic inclusions with automatic tests. The macro that is invoked @@ -4451,39 +6140,44 @@ to include the \PS{} graphic is \cs{setmfpicgraphic} and the user may (carefully!) redefine this to suit special circumstances. Actually, \mfp{} runs the following sequence: -\begin{cd} -\cs{preparemfpicgraphic}\marg{\meta{filename}}\\ -\cs{setmfpicgraphic}\marg{\meta{filename}}\\ -\cs{getmfpicoffset}\marg{\meta{filename}}% +\begin{ex} + \cs{preparemfpicgraphic}\marg{\meta{filename}}\\ + \cs{setmfpicgraphic}\marg{\meta{filename}}\\ + \cs{getmfpicoffset}\marg{\meta{filename}}% \index{preparemfpicgraphic@\cs{preparemfpicgraphic}}% \index{setmfpicgraphic@\cs{setmfpicgraphic}}% \index{getmfpicoffset@\cs{getmfpicoffset}} -\end{cd} +\end{ex} The following are the default definitions for \cs{setmfpicgraphic}: -\medskip -\halign{#:\hfil&\quad#\hfil\cr -In plain \TeX& -\cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{epsfbox}\marg{\#1}}\cr -In \LaTeX209& -\cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{epsfbox}\marg{\#1}}\cr -In \LaTeXe& -\cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{includegraphics}\marg{\#1}}\cr -In \pdfLaTeX& -\cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{includegraphics}\marg{\#1}}\cr -In \pdfTeX& -\cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{convertMPtoPDF}\marg{\#1}% - \marg{1}\marg{1}}\cr -} +\medskip\noindent +\begin{tabular}{@{}ll} +plain \TeX{}& + \cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{epsfbox}% + \marg{\#1}}\\ +\LaTeX{}209& (No longer supported, but likely the plain \TeX{} +definition will be selected.)\\ +\LaTeX{}& + \cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{includegraphics}% + \marg{\#1}}\\ +\pdfLaTeX{}& + \cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{includegraphics}% + \marg{\#1}}\\ +\pdfTeX{}& + \cs{def}\cs{setmfpicgraphic}\texttt{\#1}\marg{\cs{convertMPtoPDF}% + \marg{\#1}\marg{1}\marg{1}} +\end{tabular} + \medskip Moreover, since \MP{} by default writes files with numeric extensions, we add code to each figure, so that these graphics are correctly recognized as \EPS{} or \prog{MPS}. For example, to the figure with extension \file{.1}, we add the equivalent of one of the following \begin{itemize} -\item[] \cs{DeclareGraphicsRule}\marg{.1}\marg{eps}\marg{.1}\marg{} in \LaTeXe. -\item[] \cs{DeclareGraphicsRule}\marg{.1}\marg{mps}\marg{.1}\marg{} in \pdfLaTeX. +\item[] \cs{DeclareGraphicsRule}\marg{.1}\marg{eps}\marg{.1}\marg{} in \LaTeXe{}. +\item[] \cs{DeclareGraphicsRule}\marg{.1}\marg{mps}\marg{.1}\marg{} in +\pdfLaTeX{}. \end{itemize} After running the command \cs{setmfpicgraphic}, \mfp{} runs @@ -4503,17 +6197,15 @@ file name as the only argument, although only \cs{setmfpicgraphic} currently does anything with it. One possible reason for wanting to redefine \cs{setmfpicgraphic} might -be to rescale all pictures. This is \emph{definitely not} a good idea -without the option \opt{mplabels} since the \mfp{} code for -placing labels and captions and reserving space for the picture relies -on the picture having the dimensions given by the arguments to the -\cs{mfpic} command. With \opt{mplabels} plus \opt{truebbox} it will -probably work, but (i)~it has \emph{not} been considered in writing the -\mfp{} code, (ii)~it will then scale all the text as well as the -figure, and (iii)~it will scale all line thickness, which should -normally be a design choice independent of the size of a picture. To -rescale all pictures, one need only change \cs{mfpicunit} and rerun -\TeX{} and \MP. +be to rescale all pictures. This is \emph{definitely not} a good idea. A +good deal of \mfp{}'s figure placemant code assumes that the size of the +figure is consistent with the coordinate system set up by the \cs{mfpic} +command. With \opt{mplabels} plus \opt{truebbox} it might work, but +(i)~it has \emph{not} been considered in writing the \mfp{} code, +(ii)~it will then scale all the text as well as the figure, and (iii)~it +will scale all line thickness, which should normally be a design choice +independent of the size of a picture. To rescale all pictures, one need +only change \cs{mfpicunit} and rerun \TeX{} and \MP{}. A better reason might be to allow the conversion of your \MP{} figures to some other format. Then redefining \cs{setmfpicgraphic} @@ -4538,36 +6230,43 @@ As \mfp{} is currently written, \cs{setfilename} must be definitions, no assignments such as \cs{setcounter}, and no calculations. To test whether a proposed definition is completely expandable, put -\begin{ex} -\cs{message}\marg{\texttt{***}% -\cs{setfilename}\marg{file}\marg{1}\texttt{***}} -\end{ex} +\begin{verbatim} +\message{***\setfilename{file}{1}***} +\end{verbatim} after the definition in a \file{.tex} file and view the result on the terminal or in the \file{.log} file. You should see only your expected filename between the asterisks. -\subsection{\prog{Mfpic} and the rest of the world} +\section{\prog{Mfpic} and the Rest of the World.} -\subsubsection{The literature} +\subsection{The literature} -There are at least two places where \mfp{} has garnered more than a -cursory mention. The most up-to-date is a section in \textit{The +This author has personal knowledge of only one mathematical article +which definitely uses \mfp{} to create diagrams, and that is this +author's joint paper with J.~Duncan and C.~M.~McGregor: \textit{On the +value of pi for norms in $\mathbf{R}^2$} in the College Mathematics +Journal, vol.~35, pages 84--92. + +There are at least two major publications where \mfp{} has garnered more +than a cursory mention. The most up-to-date is a section in \textit{The \LaTeX{} Graphics Companion} by Michel Goossens, Sebastian Rahtz and Frank Mittelbach. It describes a version prior to the introduction of \MP{} support, but it correctly describes a subset of its current -commands and abilities. +commands and abilities. \textit{The \LaTeX{} Companion} (Second Edition) +mentions \mfp{}, but only in its annotation of the bibliography entry +for \textit{\TeX{} Unbound} (see below). The other is \textit{\TeX{} Unbound} by Alan Hoenig, which contains a -chapter on \mfp. Unfortunately, it describes a version that was +chapter on \mfp{}. Unfortunately, it describes a version that was replaced in 1996 with version 0.2.10.9. The following summarizes the differences between the description% \footnote{While I'm at it: \textit{\TeX{} Unbound} occasionally refers to \mfp{} using a logo-like formatting in which the `MF' is in a special font and the `I' is lowered. This `logo' may suggest - a relationship between \mfp{} and \PiCTeX. There is no such + a relationship between \mfp{} and \PiCTeX{}. There is no such relationship, and there is no official logo-like designation for - \mfp.} % + \mfp{}.} % found in Chapter 15 and \mfp{} versions 0.2.10.9 through the current one: @@ -4575,14 +6274,15 @@ current one: command of the same name. The syntax is slightly different from that given for \cs{wedge}: \begin{ex} - \cs{sector}\marg{(\meta{x},\meta{y}), \meta{radius}, \meta{angle1}, \meta{angle2}} + \cs{sector}\marg{(\meta{x},\meta{y}), \meta{radius}, \meta{angle1}, + \meta{angle2}} \end{ex} The macro \cs{plr}\marg{(\meta{$r_0$},\meta{$\theta_0$}),% (\meta{$r_1$},\meta{$\theta_1$}),$\ldots$} is used to convert polar coordinate pairs to rectangular coordinates, so the commands \cs{plrcurve}, \cs{plrcyclic}, \cs{plrlines} and \cs{plrpoint} were -dropped from \mfp. Now use +dropped from \mfp{}. Now use \begin{ex} \cs{curve}\marg{\cs{plr}\marg{(\meta{$r_0$},\meta{$\theta_0$}),% (\meta{$r_1$},\meta{$\theta_1$}),$\ldots$}} @@ -4592,8 +6292,7 @@ instead of \cs{plrcurve}\marg{(\meta{$r_0$},\meta{$\theta_0$}),% (\meta{$r_1$},\meta{$\theta_1$}),$\ldots$} \end{ex} -and similarly for \cs{cyclic}, \cs{lines} and \cs{point} with respect to -\cs{plrcyclic}, \cs{plrlines} and \cs{plrpoint}. +and similarly for \cs{plrcyclic}, \cs{plrlines} and \cs{plrpoint}. \cs{fill} is now renamed \cs{gfill} to avoid conflict with the \LaTeX{} command of the same name. @@ -4610,28 +6309,25 @@ The following affine transform commands were changed from a third person indicative form (which could be confused with a plural noun) to an imperative form: -\medskip -\moveright\parindent -\vbox{% - \halign{#\qquad\hfil&#\hfil\cr - Old name: & New name:\cr - \cs{boosts} & \cs{boost}\cr - \cs{reflectsabout} & \cs{reflectabout}\cr - \cs{rotatesaround} & \cs{rotatearound}\cr - \cs{rotates} & \cs{rotate}\cr - \cs{scales} & \cs{scale}\cr - \cs{shifts} & \cs{shift}\cr - \cs{xscales} & \cs{xscale}\cr - \cs{xslants} & \cs{xslant}\cr - \cs{xyswaps} & \cs{xyswap}\cr - \cs{yscales} & \cs{yscale}\cr - \cs{yslants} & \cs{yslant}\cr - \cs{zscales} & \cs{zscale}\cr - \cs{zslants} & \cs{zslant}\cr - }% -} +\begin{ex} +\begin{tabular}{@{}ll} + Old name: & New name:\\ + \cs{boosts} & \cs{boost}\\ + \cs{reflectsabout} & \cs{reflectabout}\\ + \cs{rotatesaround} & \cs{rotatearound}\\ + \cs{rotates} & \cs{rotate}\\ + \cs{scales} & \cs{scale}\\ + \cs{shifts} & \cs{shift}\\ + \cs{xscales} & \cs{xscale}\\ + \cs{xslants} & \cs{xslant}\\ + \cs{xyswaps} & \cs{xyswap}\\ + \cs{yscales} & \cs{yscale}\\ + \cs{yslants} & \cs{yslant}\\ + \cs{zscales} & \cs{zscale}\\ + \cs{zslants} & \cs{zslant} +\end{tabular} +\end{ex} -\medskip \cs{caption} and \cs{label} are now renamed \cs{tcaption} and \cs{tlabel} to avoid conflict with the \LaTeX{} commands. @@ -4642,10 +6338,10 @@ a semicolon to its argument. \smallskip There is a misprint: \cs{axisheadlin} should be \cs{axisheadlen}. -Finally, in the \LaTeX{} template on page 496: \mfp{} now supports -the \cs{usepackage} method of loading. +Finally, in the \LaTeX{} template on page 496: recent \mfp{} may be +loaded with \cs{usepackage}. -\subsubsection{Other programs} +\subsection{Other programs} There exists a program, \prog{fig2mfpic} that produces \mfp{} code as output. The code produced (as of this writing) is somewhat old and @@ -4662,10 +6358,10 @@ There exist a package, \prog{circuit\_macros}, that can produce a variety of output formats, one of which is \mfp{} code. One writes a file (don't ask me what it consists of) and apparently processes it with \prog{m4} and then \prog{dpic} to produce the output. The \mfp{} code -produced appears to be compatible with the current \mfp. +produced appears to be compatible with the current \mfp{}. \renewcommand\mfpindexheading{% - \subsection{Index of commands, options and parameters by page}} + \section{Index of commands, options and parameters.}} \let\oldcs\cs \renewcommand{\cs}[1]{\leavevmode\mytt{\llap{\char`\\}#1}} @@ -4675,316 +6371,392 @@ produced appears to be compatible with the current \mfp. \columnseprule 0pt \columnsep 35pt -\twocolumn[\subsection{List of commands by type}] +\twocolumn[\section{List of commands by type.}] \parindent0pt \parskip0pt plus .3pt\relax \makeatletter +\renewcommand\@idxitem{\par\hangindent 10\p@} \let\item\@idxitem \makeatother -\subsubsection{Figures} - - \item \cs{arc} - \item \cs{axis} - \item \cs{btwnfcn} - \item \cs{chartbar} - \item \cs{circle} - \item \cs{closedcspline} - \item \cs{closedmfbezier} - \item \cs{closedqbeziers} - \item \cs{closedqspline} - \item \cs{cspline} - \item \cs{curve} - \item \cs{cyclic} - \item \cs{datafile} - \item \cs{ellipse} - \item \cs{fcncurve} - \item \cs{function} - \item \cs{graphbar} - \item \cs{histobar} - \item \cs{lines} - \item \cs{mfbezier} - \item \cs{mfobj} - \item \cs{parafcn} - \item \cs{piewedge} - \item \cs{plrfcn} - \item \cs{plrregion} - \item \cs{polygon} - \item \cs{polyline} - \item \cs{qbeziers} - \item \cs{qspline} - \item \cs{rect} - \item \cs{regpolygon} - \item \cs{sector} - \item \cs{tlabelcircle} - \item \cs{tlabelellipse} - \item \cs{tlabeloval} - \item \cs{tlabelrect} - \item \cs{turtle} - - -\subsubsection{Figure modifiers} - - \item \cs{arrow} - \item \cs{bclosed} - \item \cs{cbclosed} - \item \cs{connect}, \cs{endconnect} - \item \cs{cutoffafter} - \item \cs{cutoffbefore} - \item \cs{lclosed} - \item \cs{makesector} - \item \cs{partpath} - \item \cs{qbclosed} - \item \cs{reflectpath} - \item \cs{reverse} - \item \cs{rotatepath} - \item \cs{scalepath} - \item \cs{sclosed} - \item \cs{shiftpath} - \item \cs{slantpath} - \item \cs{subpath} - \item \cs{transformpath} - \item \cs{trimpath} - \item \cs{xscalepath} - \item \cs{xslantpath} - \item \cs{xyswappath} - \item \cs{yscalepath} - \item \cs{yslantpath} - - -\subsubsection{Figure renderers} - - \item \cs{dashed} - \item \cs{dotted} - \item \cs{draw} - \item \cs{gclear} - \item \cs{gclip} - \item \cs{gendashed} - \item \cs{gfill} - \item \cs{hatch} - \item \cs{lhatch} - \item \cs{plot} - \item \cs{plotdata} (sort of) - \item \cs{plotnodes} - \item \cs{polkadot} - \item \cs{rhatch} - \item \cs{shade} - \item \cs{tess} - \item \cs{thatch} - \item \cs{xhatch} - -\subsubsection{Lengths} - - - \item \cs{axisheadlen} - \item \cs{dashlen} - \item \cs{dotsize} - \item \cs{dotspace} - \item \cs{hashlen} - \item \cs{hatchspace} - \item \cs{headlen} - \item \cs{mfpiccaptionskip} - \item \cs{mfpicheight} - \item \cs{mfpicunit} - \item \cs{mfpicwidth} - \item \cs{pointsize} - \item \cs{polkadotspace} - \item \cs{shadespace} - \item \cs{sideheadlen} - \item \cs{symbolspace} - -\subsubsection{Coordinate transformation} - - \item \cs{applyT} - \item \cs{boost} - \item \cs{coords}, \cs{endcoords} - \item \cs{mirror} - \item \cs{reflectabout} - \item \cs{rotate} - \item \cs{rotatearound} - \item \cs{scale} - \item \cs{shift} - \item \cs{turn} - \item \cs{xscale} - \item \cs{xslant} - \item \cs{xyswap} - \item \cs{yscale} - \item \cs{yslant} - \item \cs{zscale} - \item \cs{zslant} - -\subsubsection{Axes, grids, and marks} - - \item \cs{axes} - \item \cs{axis} - \item \cs{axismarks} - \item \cs{bmarks} - \item \cs{doaxes} - \item \cs{grid} - \item \cs{gridarcs} - \item \cs{gridlines} - \item \cs{gridpoints} - \item \cs{gridrays} - \item \cs{hgridlines} - \item \cs{lattice} - \item \cs{lmarks} - \item \cs{plotsymbol} - \item \cs{plrgrid} - \item \cs{plrgridpoints} - \item \cs{plrpatch} - \item \cs{point} - \item \cs{rmarks} - \item \cs{tmarks} - \item \cs{vgridlines} - \item \cs{xaxis} - \item \cs{xmarks} - \item \cs{yaxis} - \item \cs{ymarks} - -\subsubsection{Setting options} - - \item \cs{clearsymbols} - \item \cs{clipmfpic} - \item \cs{mfpicdebugfalse} - \item \cs{mfpicdebugtrue} - \item \cs{mfpicdraft} - \item \cs{mfpicfinal} - \item \cs{mfpicnowrite} - \item \cs{nocenteredcaptions} - \item \cs{noclearsymbols} - \item \cs{noclipmfpic} - \item \cs{nomplabels} - \item \cs{nooverlaylabels} - \item \cs{noship} - \item \cs{notruebbox} - \item \cs{overlaylabels} - \item \cs{resumeshipping} - \item \cs{stopshipping} - \item \cs{usecenteredcaptions} - \item \cs{usemetafont} - \item \cs{usemetapost} - \item \cs{usemplabels} - \item \cs{usetruebbox} - -\subsubsection{Changing values} - - \item \cs{axismargin} - \item \cs{darkershade} - \item \cs{dashlineset} - \item \cs{dashpattern} - \item \cs{dotlineset} - \item \cs{drawpen} - \item \cs{hatchwd} - \item \cs{headshape} - \item \cs{lightershade} - \item \cs{mfpicnumber} - \item \cs{mfplinestyle} - \item \cs{mfplinetype} - \item \cs{pen} - \item \cs{penwd} - \item \cs{polkadotwd} - \item \cs{setallaxismargins} - \item \cs{setallbordermarks} - \item \cs{setaxismargins} - \item \cs{setaxismarks} - \item \cs{setbordermarks} - \item \cs{setmfvariable} - \item \cs{setmpvariable} - \item \cs{settension} - \item \cs{setxmarks} - \item \cs{setymarks} - \item \cs{shadewd} - -\subsubsection{Changing colors} - - \item \cs{backgroundcolor} - \item \cs{drawcolor} - \item \cs{fillcolor} - \item \cs{hatchcolor} - \item \cs{headcolor} - \item \cs{mfpdefinecolor} - \item \cs{pointcolor} - \item \cs{tlabelcolor} - -\subsubsection{Defining arrays} - - \item \cs{barchart} - \item \cs{bargraph} - \item \cs{histogram} - \item \cs{numericarray} - \item \cs{pairarray} - \item \cs{patharr}, \cs{endpatharr} - \item \cs{piechart} - -\subsubsection{Changing behavior} - - \item \cs{clearsymbols} - \item \cs{coloredlines} - \item \cs{dashedlines} - \item \cs{datapointsonly} - \item \cs{defaultplot} - \item \cs{everytlabel} - \item \cs{makepercentcomment} - \item \cs{makepercentother} - \item \cs{mfpdatacomment} - \item \cs{mfpdataperline} - \item \cs{mfpverbtex} - \item \cs{noclearsymbols} - \item \cs{pointedlines} - \item \cs{pointfillfalse} - \item \cs{pointfilltrue} - \item \cs{reconfigureplot} - \item \cs{setrender} - \item \cs{smoothdata} - \item \cs{tlabeljustify} - \item \cs{tlabeloffset} - \item \cs{tlabelsep} - \item \cs{tlpathjustify} - \item \cs{unsmoothdata} - \item \cs{using} - \item \cs{usingnumericdefault} - \item \cs{usingpairdefault} - -\subsubsection{Files and environments} - - \item \cs{closegraphsfile} - \item \cs{mfpframe}, \cs{endmfpframe} - \item \cs{mfpic}, \cs{endmfpic} - \item \cs{opengraphsfile} - -\subsubsection{Text} - - \item \cs{axislabels} - \item \cs{plottext} - \item \cs{tcaption} - \item \cs{tlabels} - \item \cs{tlabel} - -\subsubsection{Misc} \widowpenalty10000 - - \item \cs{fdef} - \item \cs{getmfpicoffset} - \item \cs{ifmfpmpost} - \item \cs{mfcmd} - \item \cs{mflist} - \item \cs{mfpframed} - \item \cs{mfpicversion} - \item \cs{mfpverbtex} - \item \cs{mfsrc} - \item \cs{mftitle} - \item \cs{newfdim} - \item \cs{newsavepic} - \item \cs{plr} - \item \cs{pointdef} - \item \cs{preparemfpicgraphic} - \item \cs{savepic} - \item \cs{setmfpicgraphic} - \item \cs{setfilename} - \item \cs{sequence} - \item \cs{store} - \item \cs{tile}, \cs{endtile} - \item \cs{tmtitle} - \item \cs{usepic} +\subsection{Figure macros} + + \item \cs{arc}, \pageref{arc} + \item \cs{axis}, \pageref{axis} + \item \cs{axisline}, \pageref{axisline} + \item \cs{belowfcn}, \pageref{belowfcn} + \item \cs{border}, \pageref{axisline} + \item \cs{btwnfcn}, \pageref{btwnfcn} + \item \cs{btwnplrfcn}, \pageref{btwnfcn} + \item \cs{chartbar}, \pageref{chartbar} + \item \cs{circle}, \pageref{circle} + \item \cs{computedspline},\\ + \cs{closedcomputedspline}, \pageref{computedspline} + \item \cs{convexcurve}, \cs{closedconvexcurve}, \pageref{convexcurve} + \item \cs{convexcyclic}, \pageref{convexcurve} + \item \cs{cspline}, \cs{closedcspline}, \pageref{qspline} + \item \cs{curve}, \cs{closedcurve}, \pageref{curve} + \item \cs{cyclic}, \pageref{curve} + \item \cs{datafile}, \pageref{datafile} + \item \cs{ellipse}, \pageref{ellipse} + \item \cs{fcncurve}, \pageref{fcncurve} + \item \cs{fcnspline}, \pageref{fcnspline} + \item \cs{function}, \pageref{function} + \item \cs{ganttbar}, \pageref{chartbar} + \item \cs{graphbar}, \pageref{chartbar} + \item \cs{histobar}, \pageref{chartbar} + \item \cs{levelcurve}, \pageref{levelcurve} + \item \cs{lines}, \pageref{polyline} + \item \cs{mfbezier}, \cs{closedmfbezier}, \pageref{mfbezier} + \item \cs{mfobj}, \cs{mpobj}, \pageref{mfobj} + \item \cs{parafcn}, \pageref{parafcn} + \item \cs{periodicfcnspline}, \pageref{fcnspline} + \item \cs{piewedge}, \pageref{piewedge} + \item \cs{plrfcn}, \pageref{plrfcn} + \item \cs{plrregion}, \pageref{belowfcn} + \item \cs{polygon}, \pageref{polygon} + \item \cs{polyline}, \pageref{polyline} + \item \cs{qbeziers}, \cs{closedqbeziers}, \pageref{qbeziers} + \item \cs{qspline}, \cs{closedqspline}, \pageref{qspline} + \item \cs{rect}, \pageref{rect} + \item \cs{regpolygon}, \pageref{regpolygon} + \item \cs{sector}, \pageref{sector} + \item \cs{tlabelcircle}, \pageref{tlabelellipse} + \item \cs{tlabelellipse}, \pageref{tlabelellipse} + \item \cs{tlabeloval}, \pageref{tlabeloval} + \item \cs{tlabelrect}, \pageref{tlabelrect} + \item \cs{turtle}, \pageref{turtle} + +\subsection{Macros that render} + + \item \cs{corkscrew}, \pageref{corkscrew} + \item \cs{dashed}, \pageref{dashed} + \item \cs{dotted}, \pageref{dotted} + \item \cs{doubledraw}, \pageref{doubledraw} + \item \cs{draw}, \pageref{draw} + \item \cs{gclear}, \pageref{gclear} + \item \cs{gclip}, \pageref{gclip} + \item \cs{gendashed}, \pageref{gendashed} + \item \cs{gfill}, \pageref{gfill} + \item \cs{hatch}, \pageref{hatch} + \item \cs{lhatch}, \pageref{hatch} + \item \cs{plot}, \pageref{plot} + \item \cs{plotdata}, \pageref{plotdata} + \item \cs{plotnodes}, \pageref{plotnodes} + \item \cs{polkadot}, \pageref{polkadot} + \item \cs{rhatch}, \pageref{hatch} + \item \cs{sinewave}, \pageref{zigzag} + \item \cs{shade}, \pageref{shade} + \item \cs{tess}, \pageref{tess} + \item \cs{thatch}, \pageref{thatch} + \item \cs{xhatch}, \pageref{hatch} + \item \cs{zigzag}, \pageref{zigzag} + +\subsection{Macros that append (arrows)} + + \item \cs{arrow}, \pageref{arrow} + \item \cs{arrowhead}, \pageref{arrowhead} + \item \cs{arrowmid}, \pageref{arrowhead} + \item \cs{arrowtail}, \pageref{arrowhead} + +\subsection{Macros that modify} + + \item \cs{bclosed}, \pageref{lclosed} + \item \cs{cbclosed}, \pageref{cbclosed} + \item \cs{connect}, \cs{endconnect}, \pageref{connect} + \item \cs{cutoffafter}, \pageref{cutoffafter} + \item \cs{cutoffbefore}, \pageref{cutoffafter} + \item \cs{lclosed}, \pageref{lclosed} + \item \cs{makesector}, \pageref{makesector} + \item \cs{parallelpath}, \pageref{parallelpath} + \item \cs{partpath}, \pageref{partpath} + \item \cs{qbclosed}, \pageref{cbclosed} + \item \cs{randomizepath}, \pageref{random} + \item \cs{randomlines}, \pageref{random} + \item \cs{reflectpath}, \pageref{shiftpath} + \item \cs{reverse}, \pageref{reverse} + \item \cs{rotatepath}, \pageref{shiftpath} + \item \cs{scalepath}, \pageref{shiftpath} + \item \cs{sclosed}, \pageref{lclosed} + \item \cs{shiftpath}, \pageref{shiftpath} + \item \cs{slantpath}, \pageref{shiftpath} + \item \cs{subpath}, \pageref{partpath} + \item \cs{transformpath}, \pageref{shiftpath} + \item \cs{trimpath}, \pageref{cutoffafter} + \item \cs{xscalepath}, \pageref{shiftpath} + \item \cs{xslantpath}, \pageref{shiftpath} + \item \cs{xyswappath}, \pageref{shiftpath} + \item \cs{yscalepath}, \pageref{shiftpath} + \item \cs{yslantpath}, \pageref{shiftpath} + +\subsection{Lengths} + + \item \cs{axisheadlen}, \pageref{axisheadlen} + \item \cs{dashlen}, \pageref{dashlen} + \item \cs{dotsize}, \pageref{dotsize} + \item \cs{dotspace}, \pageref{dotsize} + \item \cs{griddotsize}, \pageref{griddotsize} + \item \cs{hashlen}, \pageref{hashlen} + \item \cs{hatchspace}, \pageref{hatchspace} + \item \cs{headlen}, \pageref{headlen} + \item \cs{mfpiccaptionskip}, \pageref{mfpiccaptionskip} + \item \cs{mfpicheight}, \pageref{mfpicheight} + \item \cs{mfpicunit}, \pageref{mfpicunit} + \item \cs{mfpicwidth}, \pageref{mfpicheight} + \item \cs{pointsize}, \pageref{pointsize} + \item \cs{polkadotspace}, \pageref{polkadotspace} + \item \cs{shadespace}, \pageref{shadespace} + \item \cs{sideheadlen}, \pageref{sideheadlen} + \item \cs{symbolspace}, \pageref{symbolspace} + +\subsection{Coordinate transformation} + + \item \cs{applyT}, \pageref{applyT} + \item \cs{boost}, \pageref{applyT} + \item \cs{coords}, \cs{endcoords}, \pageref{coords} + \item \cs{mirror}, \pageref{applyT} + \item \cs{reflectabout}, \pageref{applyT} + \item \cs{rotate}, \pageref{applyT} + \item \cs{rotatearound}, \pageref{applyT} + \item \cs{scale}, \pageref{applyT} + \item \cs{shift}, \pageref{applyT} + \item \cs{turn}, \pageref{applyT} + \item \cs{xscale}, \pageref{applyT} + \item \cs{xslant}, \pageref{applyT} + \item \cs{xyswap}, \pageref{applyT} + \item \cs{yscale}, \pageref{applyT} + \item \cs{yslant}, \pageref{applyT} + \item \cs{zscale}, \pageref{applyT} + \item \cs{zslant}, \pageref{applyT} + +\subsection{Symbols, axes, grids, marks} + + \item \cs{axes}, \pageref{axes} + \item \cs{axis}, \pageref{axis} + \item \cs{axismarks}, \pageref{axismarks} + \item \cs{bmarks}, \pageref{axismarks} + \item \cs{doaxes}, \pageref{axis} + \item \cs{grid}, \pageref{grid} + \item \cs{gridarcs}, \pageref{plrgrid} + \item \cs{gridlines}, \pageref{grid} + \item \cs{gridpoints}, \pageref{grid} + \item \cs{gridrays}, \pageref{plrgrid} + \item \cs{hgridlines}, \pageref{grid} + \item \cs{lattice}, \pageref{grid} + \item \cs{lmarks}, \pageref{axismarks} + \item \cs{plotsymbol}, \pageref{plotsymbol} + \item \cs{plrgridpoints}, \pageref{plrgrid} + \item \cs{plrgrid}, \pageref{plrgrid} + \item \cs{plrpatch}, \pageref{plrgrid} + \item \cs{plrvectorfield}, \pageref{vectorfield} + \item \cs{point}, \pageref{point} + \item \cs{putmfpimage}, \pageref{putmfpimage} + \item \cs{rmarks}, \pageref{axismarks} + \item \cs{tmarks}, \pageref{axismarks} + \item \cs{vectorfield}, \pageref{vectorfield} + \item \cs{vgridlines}, \pageref{grid} + \item \cs{xaxis}, \pageref{axes} + \item \cs{xmarks}, \pageref{axismarks} + \item \cs{yaxis}, \pageref{axes} + \item \cs{ymarks}, \pageref{axismarks} + +\subsection{Symbol names} + + \item \gbc{Arrowhead}, \pageref{arrowhead} + \item \gbc{Asterisk}, \pageref{plotsymbol} + \item \gbc{Circle}, \pageref{plotsymbol} + \item \gbc{Crossbar}, \pageref{arrowhead} + \item \gbc{Cross}, \pageref{plotsymbol} + \item \gbc{Diamond}, \pageref{plotsymbol} + \item \gbc{Leftbar}, \pageref{arrowhead} + \item \gbc{Leftharpoon}, \pageref{arrowhead} + \item \gbc{Lefthook}, \pageref{arrowhead} + \item \gbc{Plus}, \pageref{plotsymbol} + \item \gbc{Rightbar}, \pageref{arrowhead} + \item \gbc{Rightharpoon}, \pageref{arrowhead} + \item \gbc{Righthook}, \pageref{arrowhead} + \item \gbc{SolidCircle}, \pageref{plotsymbol} + \item \gbc{SolidDiamond}, \pageref{plotsymbol} + \item \gbc{SolidSquare}, \pageref{plotsymbol} + \item \gbc{SolidStar}, \pageref{plotsymbol} + \item \gbc{SolidTriangle}, \pageref{plotsymbol} + \item \gbc{Square}, \pageref{plotsymbol} + \item \gbc{Star}, \pageref{plotsymbol} + \item \gbc{Triangle}, \pageref{plotsymbol} + +\subsection{Setting options} + + \item \cs{clearsymbols}, \pageref{clearsymbols} + \item \cs{clipmfpic}, \pageref{clip} + \item \cs{mfpicdebugfalse}, \pageref{debug} + \item \cs{mfpicdebugtrue}, \pageref{debug} + \item \cs{mfpicdraft}, \pageref{draft} + \item \cs{mfpicfinal}, \pageref{draft} + \item \cs{mfpicnowrite}, \pageref{draft} + \item \cs{mfpreadlog}, \pageref{readlog} + \item \cs{nocenteredcaptions}, \pageref{centeredcaptions} + \item \cs{noclearsymbols}, \pageref{clearsymbols} + \item \cs{noclipmfpic}, \pageref{clip} + \item \cs{nomplabels}, \pageref{mplabels} + \item \cs{nooverlaylabels}, \pageref{overlaylabels} + \item \cs{noraggedcaptions}, \pageref{raggedcaptions} + \item \cs{notruebbox}, \pageref{truebbox} + \item \cs{overlaylabels}, \pageref{overlaylabels} + \item \cs{usecenteredcaptions}, \pageref{centeredcaptions} + \item \cs{usemetafont}, \pageref{metapost} + \item \cs{usemetapost}, \pageref{metapost} + \item \cs{usemplabels}, \pageref{mplabels} + \item \cs{useraggedcaptions}, \pageref{raggedcaptions} + \item \cs{usetruebbox}, \pageref{truebbox} + +\subsection{Setting values} + + \item \cs{axismargin}, \pageref{axismargin} + \item \cs{darkershade}, \pageref{darkershade} + \item \cs{dashlineset}, \pageref{dashlineset} + \item \cs{dashpattern}, \pageref{dashpattern} + \item \cs{dotlineset}, \pageref{dashlineset} + \item \cs{drawpen}, \pageref{drawpen} + \item \cs{globalsetmfvariable}, \pageref{setmfvariable} + \item \cs{hatchwd}, \pageref{hatchwd} + \item \cs{headshape}, \pageref{headshape} + \item \cs{lightershade}, \pageref{darkershade} + \item \cs{mfpicnumber}, \pageref{mfpicnumber} + \item \cs{mfplinestyle}, \pageref{mfplinetype} + \item \cs{mfplinetype}, \pageref{mfplinetype} + \item \cs{pen}, \pageref{drawpen} + \item \cs{penwd}, \pageref{drawpen} + \item \cs{polkadotwd}, \pageref{polkadotwd} + \item \cs{setallaxismargins}, \pageref{axismargin} + \item \cs{setallbordermarks}, \pageref{setaxismarks} + \item \cs{setaxismargins}, \pageref{axismargin} + \item \cs{setaxismarks}, \pageref{setaxismarks} + \item \cs{setbordermarks}, \pageref{setaxismarks} + \item \cs{setmfboolean}, \pageref{setmfvariable} + \item \cs{setmfcolor}, \pageref{setmfvariable} + \item \cs{setmfnumeric}, \pageref{setmfvariable} + \item \cs{setmfpair}, \pageref{setmfvariable} + \item \cs{setmfvariable}, \pageref{setmfvariable} + \item \cs{setmpvariable}, \pageref{setmfvariable} + \item \cs{settension}, \pageref{settension} + \item \cs{setxmarks}, \pageref{setaxismarks} + \item \cs{setymarks}, \pageref{setaxismarks} + \item \cs{shadewd}, \pageref{shadewd} + +\subsection{Changing colors} + + \item \cs{backgroundcolor}, \pageref{drawcolor} + \item \cs{drawcolor}, \pageref{drawcolor} + \item \cs{fillcolor}, \pageref{drawcolor} + \item \cs{hatchcolor}, \pageref{drawcolor} + \item \cs{headcolor}, \pageref{drawcolor} + \item \cs{mfpdefinecolor}, \pageref{mfpdefinecolor} + \item \cs{pointcolor}, \pageref{drawcolor} + \item \cs{tlabelcolor}, \pageref{drawcolor} + +\subsection{Defining arrays} + + \item \cs{barchart}, \pageref{barchart} + \item \cs{bargraph}, \pageref{barchart} + \item \cs{colorarray}, \pageref{setmfarray} + \item \cs{gantt}, \pageref{barchart} + \item \cs{globalsetmfarray}, \pageref{setmfarray} + \item \cs{histogram}, \pageref{barchart} + \item \cs{mfpbarchart}, \pageref{barchart} + \item \cs{mfpbargraph}, \pageref{barchart} + \item \cs{mfpgantt}, \pageref{barchart} + \item \cs{mfphistogram}, \pageref{barchart} + \item \cs{mfppiechart}, \pageref{piechart} + \item \cs{numericarray}, \pageref{setmfarray} + \item \cs{pairarray}, \pageref{setmfarray} + \item \cs{patharr}, \cs{endpatharr}, \pageref{patharr} + \item \cs{piechart}, \pageref{piechart} + \item \cs{setmfarray}, \pageref{setmfarray} + \item \cs{setmparray}, \pageref{setmfarray} + +\subsection{Changing behavior} + + \item \cs{coloredlines}, \pageref{coloredlines} + \item \cs{dashedlines}, \pageref{coloredlines} + \item \cs{datapointsonly}, \pageref{coloredlines} + \item \cs{defaultplot}, \pageref{defaultplot} + \item \cs{everytlabel}, \pageref{everytlabel} + \item \cs{everymfpic}, \cs{everyendmfpic}, \pageref{everymfpic} + \item \cs{makepercentcomment}, \pageref{makepercentother} + \item \cs{makepercentother}, \pageref{makepercentother} + \item \cs{mfpdatacomment}, \pageref{mfpdatacomment} + \item \cs{mfpdataperline}, \pageref{mfpdataperline} + \item \cs{mfpverbtex}, \pageref{mfpverbtex} + \item \cs{noship}, \pageref{noship} + \item \cs{pointedlines}, \pageref{coloredlines} + \item \cs{pointfillfalse}, \pageref{pointfilltrue} + \item \cs{pointfilltrue}, \pageref{pointfilltrue} + \item \cs{reconfigureplot}, \pageref{reconfigureplot} + \item \cs{resumeshipping}, \pageref{noship} + \item \cs{setrender}, \pageref{setrender} + \item \cs{smoothdata}, \pageref{datafile} + \item \cs{stopshipping}, \pageref{noship} + \item \cs{tlabeljustify}, \pageref{tlabeljustify} + \item \cs{tlabeloffset}, \pageref{tlabeloffset} + \item \cs{tlabelsep}, \pageref{tlabeloffset} + \item \cs{tlpathjustify}, \pageref{tlpathjustify} + \item \cs{tlpathsep}, \pageref{tlabeloffset} + \item \cs{tlpointsep}, \pageref{tlabeloffset} + \item \cs{unsmoothdata}, \pageref{datafile} + \item \cs{using}, \pageref{using} + \item \cs{usingnumericdefault}, \pageref{usingpairdefault} + \item \cs{usingpairdefault}, \pageref{usingpairdefault} + +\subsection{Files and environments} + + \item \cs{closegraphsfile}, \pageref{opengraphsfile} + \item \cs{mfpframe}, \cs{endmfpframe}, \pageref{mfpframe} + \item \cs{mfpic}, \cs{endmfpic}, \pageref{mfpic} + \item \cs{opengraphsfile}, \pageref{opengraphsfile} + +\subsection{Text} + + \item \cs{axislabels}, \pageref{axislabels} + \item \cs{plottext}, \pageref{plottext} + \item \cs{startbacktext}, \pageref{backtext} + \item \cs{stopbacktext}, \pageref{backtext} + \item \cs{tcaption}, \pageref{tcaption} + \item \cs{tlabel}, \pageref{tlabel} + \item \cs{tlabels}, \pageref{tlabel} + +\subsection{Misc} + + \item \cs{assignmfvalue}, \pageref{assignmfvalue} + \item \cs{assignmpvalue}, \pageref{assignmfvalue} + \item \cs{fdef}, \pageref{fdef} + \item \cs{getmfpicoffset}, \pageref{getmfpicoffset} + \item \cs{globalassignmfvalue}, \pageref{assignmfvalue} + \item \cs{globalassignmpvalue}, \pageref{assignmfvalue} + \item \cs{ifmfpmpost}, \pageref{ifmfpmpost} + \item \cs{mfcmd}, \pageref{mfsrc} + \item \cs{mflist}, \pageref{mfsrc} + \item \cs{mfpfor}, \cs{endmfpfor}, \pageref{mfpfor} + \item \cs{mfpframed}, \pageref{mfpframe} + \item \cs{mfpicversion}, \pageref{mfpicversion} + \item \cs{mfpimage}, \cs{endmfpimage}, \pageref{mfpimage} + \item \cs{mfploop}, \cs{endmfploop}, \pageref{mfploop} + \item \cs{mfpuntil}, \pageref{mfploop} + \item \cs{mfpwhile}, \cs{endmfpwhile}, \pageref{mfpwhile} + \item \cs{mfsrc}, \pageref{mfsrc} + \item \cs{mftitle}, \pageref{mftitle} + \item \cs{newfdim}, \pageref{newfdim} + \item \cs{newsavepic}, \pageref{newsavepic} + \item \cs{plr}, \pageref{plr} + \item \cs{pointdef}, \pageref{pointdef} + \item \cs{preparemfpicgraphic}, \pageref{preparemfpicgraphic} + \item \cs{savepic}, \pageref{newsavepic} + \item \cs{sequence}, \pageref{sequence} + \item \cs{setfilename}, \pageref{setfilename} + \item \cs{setmfpicgraphic}, \pageref{setmfpicgraphic} + \item \cs{store}, \pageref{store} + \item \cs{tile}, \cs{endtile}, \pageref{tile} + \item \cs{tmtitle}, \pageref{tmtitle} + \item \cs{usepic}, \pageref{newsavepic} \end{document} |