%% help.WARMnotes (DRAFT only)
%% created September 3, 1999
%% corrected on July 4, 2001
%% --------------------------------------------------------------------
%% Do not typeset this file. This is a cheat-sheet guide to WARMreader 
%% containg samples of
%% LaTeX Code  and description summary for the most Basic Examples 
%======================================================================%
%______________________________________________________________________%
%.......10........20........30........40........50........60........70.%
%________|_________|_________|_________|_________|_________|_________|_%
%======================================================================%

\documentclass[letterpaper]{report}
  \usepackage{graphicx, color}
  \usepackage{verbatim}

% FOR LaTeX2HTML
% \usepackage{html}

% FOR XY
      %========================================================%
      %    For Unix or textures
      %    not driver specific, uses fonts, PDF compatible
      %========================================================%
  \usepackage[all,frame,import]{xy} %for unix or textures


% FOR WARMreader
	 \input WARMreader.sty

      %========================================================%
      %  Useable Figure Formats: EPS, PDF, JPG
      %--------------------------------------------------------
      %           |             PROCESS
      %           |--------------------------------------------
      %    FILE   |    PDFLaTeX        DVIPS         LaTeX2HTML
      %    TYPE   |              (distill to PDF)    
      %--------------------------------------------------------
      %    EPS    |    no               yes              yes
      %           |
      %    PDF    |    yes              no               no
      %           |
      %    JPG    |    yes              yes*             yes*
      %           |
      %--------------------------------------------------------
      %           |    * requires \DeclareGraphicsRule{}{}{}{}
      %========================================================%

      %========================================================%
      %  .bb FILE    
      %--------------------------------------------------------
      %  %%BoundingBox: ...
      %  %%HiRes Bounding Box: ...
      %  %%Coordinates: LL
      %  %%StartMarkedPoints
      %  %% MarkedPoint: (x1, y1) 1 %text of math
      %  %% MarkedPoint: (x2, y2) 1 %text of math
      %  %% MarkedPoint: (x3, y3) 1 %text of math
      %  %% MarkedPoint: (x4, y4) 1 %text of math
      %  %% MarkedPoint: (x5, y5) 1 %text of math
      %  %%EndMarkedPoints
      %--------------------------------------------------------
      %

      %========================================================%
      %  WARMreader COMMANDS      
      %        <num means  # or range m-n, m-, {}
      %  
      %--------------------------------------------------------
      %
      %  MODIFYING A SINGLE POINT
      %
      %   \xyMarkedTxt <mods>{<num>}
      %   \xyMarkedText <mods>{<num>}
      %--------------------------------------------------------
      %   \xyMarkedMath <mods>{<num>}
      %========================================================
      %
      %  MODIFYING A LIST OF POINTS
      %
      %   \xyMarkedTxtPoints <mods>{<list>}
      %   \xyMarkedTextPoints <mods>{<list>}
      %--------------------------------------------------------
      %   \xyMarkedMathPoints <mods>{<list>}
      %========================================================
      %
      %  MODIFYING A LIST OF POINTS EXCEPT
      %
      %   \xyMarkedTxtExcept <mods>{<list>}
      %   \xyMarkedTextExcept <mods>{<list>}
      %--------------------------------------------------------
      %   \xyMarkedMathExcept <mods>{<list>}
      %========================================================
      %........................................................
      %
      %
      %  STYLED LABELS TO MODIFY A SINGLE POINT
      %
      %   \xyMarkedStyledText <mods>{<num>}
      %   \xyMarkedStyledTxt <mods>{<num>}
      %--------------------------------------------------------
      %   \xyMarkedStyledMath <mods>{<num>}
      %========================================================
      %
      %  STYLED LABELS TO  A LIST OF POINTS
      %
      %   \xyMarkedStyledPoints <mods>{<list>}
      %   \xyMarkedStyledPoints <mods>{<list>}
      %--------------------------------------------------------
      %   \xyMarkedStyledPoints <mods>{<list>}
      %========================================================
      %
      %  STYLED LABELS TO A LIST OF POINTS EXCEPT
      %
      %   \xyMarkedStyledExcept <mods>{<list>}
      %   \xyMarkedStyledExcept <mods>{<list>}
      %--------------------------------------------------------
      %   \xyMarkedStyledExcept <mods>{<list>}
      %========================================================



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
%    In the examples below "figure" refers to a an eps or pdf file,
%    figure.eps or figure.pdf.
%======================================================================%
%  EXAMPLE 01 : LABELS ALL IN TEXT MODE; math within $ delimiters
%----------------------------------------------------------------------

      %========================================================%
      %  \xyMarkedImport{figure}    % brings in graphic     
      %        may be used without WARMprocess
      %   when .bb and .eps information is self-contained
      %   and no modifications are needed.
      %========================================================%

\begin{xy}
\xyMarkedImport{figure}          % brings in graphic {figure}
\xyMarkedTxtPoints{}             % processes all labels in text mode
\end{xy}


%======================================================================%
%  EXAMPLE 01 : LABELS ALL IN MATH MODE; text within \text{} or \mbox{}
%----------------------------------------------------------------------


%      WARMreader READS MARKED POINTS AND COORDINATES INFO

\WARMprocessEPS{figure}{eps}{bb}%

\begin{xy}
\xyMarkedImport{}          % brings in graphic of "figure"
\xyMarkedMathPoints{}      % processes all labels in math mode
\end{xy}


%======================================================================%
%  EXAMPLE 03 : LABELS ALL IN MATH MODE and TEXT MODE
%----------------------------------------------------------------------


%      WARMreader READS MARKED POINTS AND COORDINATES INFO

\WARMprocessEPS{figure}{eps}{bb}%

\begin{xy}
\xyMarkedImport{}                % brings in graphic of "figure"
\xyMarkedMathPoints{1-3, 5-7}    % processes 6 labels in math mode
\xyMarkedTxtPoints{4}            % processes label 4 in text mode
\end{xy}


%======================================================================%
%  EXAMPLE 04 : Changing the styles of labels individually
%----------------------------------------------------------------------

%      WARMreader READS MARKED POINTS AND COORDINATES INFO
%
% EXPLICIT

\WARMprocessEPS{figure}{eps}{bb}%

\begin{xy}
\xyMarkedImport{}                     % brings in graphic of "figure"
\xyMarkedTxtPoints{1-3,5-}            % process 1-2, and 6- last label
\xyMarkedStyledText{\large\textbf}{4} % change style of text label 4
\xyMarkedStyledMath{\scriptstyle\mathrm}{6} % change style of math label 6
\end{xy}

%======================================================================%
%  EXAMPLE 05 : Changing the styles of labels globally (for all figures)
%----------------------------------------------------------------------
%  
\renewcommand{\labeltextmodifiers}{++!D}
\renewcommand{\labelmathmodifiers}{+!D}
\renewcommand{\labeltmathstyle}{\scriptstyle}
\renewcommand{\labeltextstyle}{\mathstyle}


\WARMprocessEPS{figure}{eps}{bb}%

\begin{xy}
\xyMarkedImport{}                     % brings in graphic of "figure"
\xyMarkedTxtPoints{1-3,5-}            % process 1-2, and 6- last label
\xyMarkedStyledTxt{4}                 % change style of text label 4
\xyMarkedStyledMath{6}                % change style of math label 6
\end{xy}

%======================================================================%
%  EXAMPLE 06 : Changing the styles of labels with MODIFIERS
%----------------------------------------------------------------------

%======================================================================%
%  EXAMPLE 05 : Changing the styles of labels globally with MODIFIERS
%----------------------------------------------------------------------
%  

\renewcommand{\labeltextmodifiers}{++!D}
\renewcommand{\labelmathmodifiers}{+!D}
\renewcommand{\labeltmathstyle}{\scriptstyle}
\renewcommand{\labeltextstyle}{\mathstyle}


\WARMprocessEPS{figure}{eps}{bb}%
\begin{xy}
\xyMarkedImport{}                      % brings in graphic of "figure"
\xyMarkedMathPoints ++!D!L(.1){2}      % process 2 with modifier ++!D!L(.1)
\xyMarkedMathPoints ++!D!L(.3){5}      % process 5 with modifier ++!D!L(.3)
\xyMarkedMathPoints ++!D{6}            % process 6 with modifier ++!D
\xyMarkedMathExcept{2,4-6}             % process all points in math mode except 2, 4-6
\xyMarkedTxtPoints++!D!L{4}            % process 4 with modifier ++!D!L
\end{xy}




%======================================================================%
%  XyPic Legend 
%----------------------------------------------------------------------

% MARKEDPOINT

      %---------------------------------------------------------  
      %  EXAMPLE: NO MODIFIER :   \xyMarkedMathPoints{5}
      %========================================================%


        (La)TeX sets an \hbox{} containing the typeset label, 
        the reference point is centered and anchored at the marked coords

      %---------------------------------------------------------   
      %  EXAMPLE: WITH MODIFIER    \xyMarkedMathPoints ++!D!L(.3){5} 
      %========================================================%

%  +    adds a small margin increasing the size of the box both horiz, &vert.
%  !D   shifts the reference point Down within the box to the bottom edge
%  !U   shifts the reference point Up within the box to the top edge
%  !L   shifts the reference point within the box to the Left edge
%  !R   shifts the reference point within the box to the Right edge


%   NUDGING 
%  !D(x.x) nudges the reference point Down towards/past the bottom edge by x.x
%  !U(x.x) nudges the reference point Down towards/past the top edge
%  !L(x.x) nudges the reference point Down towards/past the left edge
%  !R(x.x) nudges the reference point Down towards/past  the right edge

      %---------------------------------------------------------  
      % SHOW ALL MARKED POINTS
      %
      %  Default for <object> is a symbol with crossed lines
      %      and subscript <num> of marked point 
      %      defined by 
      %     \def\markobjectlabel#!{\POS
      %                                *\dir{x},       %drop the crossed lines; note the ,
      %                                *+<3pt>!U{\scriptsciptstyle#1} %drop the subscript
      %                           } 
      %
      %  \showAllMarkedPoints{<object>}{<figurename>}{<ext>} 
      %
      %  EXAMPLE:  
      %
      %  \showAllMarkedPoints{}{figure}{eps}
      %  \xyShowMarkPoints{}{-}   after \WARMprocess has been used
      %
      %========================================================%
 
 
      %========================================================%
      %  SHOW MARKED POINTS WITH CUSTOMIZED <object> 
      %---------------------------------------------------------  
      %  \xyShowMark       {<pos>*<object>}{<num>} 
      %  \xyShowMarkPoints {<pos>*<object>}{<list>} 
      %  \xyShowMarksExcept{<pos>*<object>}{<list>} 
      %
      %  If {<pos>*<object>} is empty {}
      %  the \markobjectlabel (the crossed lines)
      %     is used as the object to mark each point in the list
      %  for \xyShowMark{}{}
      %
      %---------------------------------------------------------  
      %  EXAMPLE:  DROPPING A FILLED DISK AND RECTANCLE 
      %            AROUND ALL MARKED POINTS
      %---------------------------------------------------------  
      %
      %  \showMarkPoints{*++[red][F-:red]@{*}}{-} 
      %
      %========================================================%

 
      %========================================================%
      %  MARKING AN OBJECT WITH MAXIMUM FLEXIBILITY
      %
      %  \xyMarkedPos{<num>} <pos>*<object>
      %
      %   moves the ``current point'' to the location 
      %   of the marked point and placing anything using Xy-pic
      %---------------------------------------------------------  
      %  EXAMPLE:  MARKED POINTS WITH EACH LABEL IN BLUE IN 
      %            FONT \large \bfseries\sffamily 
      %  See page 1007 TUGboat 20/3 Labelling Graphics....
      %---------------------------------------------------------
      
\WARMprocessEPS{figure}{eps}{bb}
\renewcommand{\labeltextstyle}{\large\bfseries\sffamily}
\begin{xy}
\xyMarkedImport{}
\xyMarkedPos{1}*+!DR[blue]\txt\labeltextstyle{...}
\xyMarkedPos{2}*+++![blue]\txt\labeltextstyle{...}
\xyMarkedPos{3}*+!U[blue]\txt\labeltextstyle{...}
\xyMarkedPos{4}+/u1ex/*+!DL[F-:red][blue]\txt\labeltextstyle{...}
\xyMarkedPos{5}*+!L[blue]\txt\labeltextstyle{...}
\xyMarkedPos{6}*+!UR[blue]\txt\labeltextstyle{...}
\xyMarkedPos{7}*+!DL[blue]\txt\labeltextstyle{...}
\end{xy}


      %========================================================%
      %  DEFAULTS
      %	  @ means  \dir
      %---------------------------------------------------------  

%     @{x}  --> \times
%     @{+}  --> +
%     @{*}  --> filled disc (similar to \bullet in size}
%     @{o}  --> open disc (similar to \bullet in size}

      %========================================================%
      %  DEFAULTS
      %	 \objectmargin = 3pt  
      %---------------------------------------------------------  
      %  OBJECT BEING DROPPED AND ITS MODIFIERS ARE ENCLOSED IN {} 
      %                                before the {<point/range>} 
      %
      %  {<modifier{<modifier>...
      %       [<modifier>] ...[<modifier>] <specifier><object>}%
                                                {<point/range>}  
      %========================================================%

% MODIFIERS OF OBJECTS (no brackets neeeded)

%     *      means   drop an object

%     +      means   put \objectmargin-size space around  
%     ++     means   put \objectmargin-size space around  twice

%     +<xpt, ypt>      means   increase the box symmetrically  
                               by a total of xpt in the horiz. dir. 
                               increase the box symmetrically  
                               by a total of ypt in the vert. dir. 

%     +<dpt>           means   increase the box symmetrically  
                                by a total of dpt in both horiz.  
                                                  and vert. dir. 
%     +=               means   increase the box size on the smaller sides
                               to turn the box into a square
                               
%     +=               means   decrease  the box size on the larger sides
                               to turn the box into a square
                               


% MODIFIERS OF OBJECTS (brackets neeeded)
%     [red]  means   color object read
%     [F-]   means   put solid outline of rectangle
%     [F.]   means   put dotted outline of rectangle
%     [F--]  means   put dashed outline of rectangle
%     [F=]   means   put double outline of rectangle
%     [Fo]   means   put solid outline of circle
%     [Fe]   means   put solid outline of ellipse
%     [Fee]  means   put double outline of ellipse
%     [Foo]  means   put double outline of circle

%======================================================================%
%  MISCELLANEOUS COMMANDS
%----------------------------------------------------------------------

      %========================================================%
      % ORIGIN OF COORDINATES OF MARKED POINTS LL or UL
      %
      %    Default is usually in  LL coordinates
      %    Use \MacintoshOrigin if figure has points in UL coordinates
      %---------------------------------------------------------  

\MacintoshOrigin  (Use if figure has points in UL coordinates)
                  
      %========================================================%
      % ENDLINE Problems
      %    If file is from another platform and has not
      %    been converted Mac {\r} Unix{\n} DOS{\n\r}
      %    Use \EndLineAdjust  before \WARMprocessEPS
      %---------------------------------------------------------  
    
\EndLineAdjust 
\WARMprocessEPS{}{}{}


      %========================================================%
      % \xyWARMinclude
      %    
      %    
      %    
      %---------------------------------------------------------  

      %========================================================%
      % adjusting figures up to get rid of white space
      %---------------------------------------------------------
      
\vskip -3.5\bigskipammount
\WARMprocessMMA{}{}{}

      %========================================================%
      % drop thinner red lines
      %---------------------------------------------------------
      
\newcommand{\Xhair}{\drop[thinner][red]+o[F-]@{x}}%
 

%======================================================================%
%  MATHEMATICA 
%----------------------------------------------------------------------

      %========================================================%
      % .mbb file format
      %---------------------------------------------------------

LDRU:{xLD, yLD, xRU , yRU}
StartData
,{x1,y1, para}
,{x2,y2, cub1}
,{x3,y3, cub2}
,{x4,y4, neg1}
,{x5,y5, neg2}
EndData



      %========================================================%
      % need to use the aspect ratio to get the LDRU coordinates
      % LDRU:{xLD, yLD, xRU , yRU}
      %---------------------------------------------------------

%%AspectRatio: .61803       %height/width of the rectangle
%LDRU:{-2.42465,-3.80861, 6.6868, 3.25092}
     


      %========================================================%
      % POSITIONING LABELS RELATIVE TO A SINGLE MARKED POINT
      %---------------------------------------------------------


\WARMprocessMMA{Q1}{eps}{mbb}
\renewcommand{\xyWARMinclude}[1]{\scaledfig{.7}{#1}}%
\begin{xy}
\xyMarkedImport{}
\xyMarkedpos{para}*+{},\ar@{<-}+(7.25)
                  *+!D\txt{base of parabola}
%
%-----stores the location  as "cub"                  
%
\xyMarkedpos{cub1}*+++{}!D(.6),\ar@{<-}-(3.5,15)
                  *+!U(.8)\txt{turning points\\of a cubic}="cub"  %stores the location  as "cub"
%                  
\xyMarkedpos{cub2}*+++{},\ar@{<-}"cub"
%                  
%
%-----stores the location  as "min"                  
%
\xyMarkedpos{neg1}*++{},\ar@{<-}+(.5,25),
                  *+!L(.6)\txt{local minima}="min"
%                  
\xyMarkedpos{neg2}*++{},\ar@{<-}"min",
\end{xy}

\end{document}