summaryrefslogtreecommitdiff
path: root/support/xtexshell/help/help_tools
blob: dd421c572d4ee58ceffb190e4dcc13c2b9f758ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
:entry                      
psfig                       
pssilent               
psnoisy                
psdraft                   
psnoisy                
psscalefirst
psrotatefirst
:header
PSFIG: Including Postscript Documents  
:synopsis         
\psfig{figure=:em input_file[,option1[,option2,...]]}                  
\pssilent         
\psnoisy          
\psdraft               
\psfull           
\psscalefirst             
\psrotatefirst            
:description              
Psfig is a macro package for TeX that facilitates the inclusion of Postscript
figures into TeX documents. With the help of a compatible postprocessor (dvips
for example), figures are automatically scaled and positioned on the page,
and the proper amount of space is reserved.          
                                                     
To include a Postscript figure with psfig, include the psfig style at the top
of your document:                                                
                                                     
   \documentstyle[...,psfig]{article}                
                                                     
and then, when you wish to include a figure, invoke the macro
                                                     
   \psfig{figure=input}                              
                                                     
where input is the name of a Postscript file. Psfig will automatically position the
figure at the current point on the page, and reserve the proper amount of space
in TeX so that it doesn't block any other objects on the page.
                                                     
:bold \psfig

Psfig includes a postscript document. Optional parameters are:                                 
:el                                                           
:li height=len                                                
:li width=len                                                 
:li rheight=len                                               
:li rwidth=len                                                
:li angle=angle                                                    
:li prolog=filename                                           
:li clip=                                                     
:li bbllx=pos,bblly=pos,bburx=pos,bbury=pos Specify your own bounding box. This
is useful if your Postscript document does not have a bounding box. See below
:eel                                                          
                                                              
:bold \pssilent :bold and :bold \psnoisy                      
                                       
Normally, psfig will print advisory messages to remind you that it is including
figures as TeX processes a document. This behavior can be disabled with \pssilent,
and re-enabled with \psnoisy.          
                                       
:bold \psdraft :bold and :bold \psfull             
                                       
Some Postscript figures can take quite a long time to transmit and print; for
these figures a draft mode is available to speed printing of draft versions of
the document.  A figure printed in draft mode will appear as a box with the name
of the figure file (Figure 2). The macro \psdraft will switch into draft mode, 
and all subsequent psfig macros will produce draft figures until reaching the
macro \psfull, which switches out of draft mode.
                     
:bold Bounding :bold Boxes
                     
To properly translate and scale a figure psfig must know its `natural' position 
on the page; this information is present in what is called the :em bounding :em box
of a Postscript program. The bounding box is an outer limit to the marks created
by a program, and is specified as four coordinates of a rectangle: the lower-left 
x-coordinate (bbllx), the lower-left y-coordinate (bblly), the upper-right
x-coordinate (bburx), and the upper-right y-coordinate (bbury).
Adobe has defined a convention whereby the bounding box of a program
is contained in a `bounding box comment'.
                     
This comment, which :bold must be present in any file to be used as a psfig figure,
is a line of the form
                     
   %%BoundingBox: :em bbllx :em bblly :em bburx :em bbury
                                         
                     
:bold Rotation       
                     
With autoscaling, some rotated figures come out smaller because the diagonal of
their bounding box is of course longer than their height or width alone. This
behavior can be disabled with \psscalefirst, and re-enabled with \psrotatefirst.
:example

\documentstyle[11pt,psfig]{article}

\begin{document}        
                        
  % A simple Postscript figure
                              
  \psfig{figure=xmas.ps}      
                         
  % This one specifies the width and uses a special prolog
                                                               
  \psfig{figure=figs/lab2.ps,width=3.25in,prolog=figs/oldmac.pro}
                        
  % Now rotated rosettes
                        
  \psscalefirst         
  \centerline{\hbox{    
    \psfig{figure=rosette.ps,height=1.0in}
    \psfig{figure=rosette.ps,height=1.0in,angle=20}
    \psfig{figure=rosette.ps,height=1.0in,angle=40}
    \psfig{figure=rosette.ps,height=1.0in,angle=60}
  }}              
                  
\end{document}