source: trunk/SRC/Documentation/idldoc_assistant_output/Textoidl/sub_sup_idl.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 3.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>sub_sup_idl.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="strtrans.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="textable.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Textoidl/</font></h1>
58    <h2>sub_sup_idl.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65   
66
67     
68      <a name="#_sub_sup_idl"></a>
69
70      <h2>sub_sup_idl  </h2>
71
72      <p><font face="Courier"><i>result = </i>sub_sup_idl(<i><a href="#_sub_sup_idl_keyword_token">token</a></i>, <a href="#_sub_sup_idl_keyword_FORCE_UD">FORCE_UD</a>=<i>FORCE_UD</i>)</font></p>
73
74   
75 NAME:
76       SUB_SUP_IDL
77 PURPOSE:
78       Return the proper IDL font positioning command for TeX
79       sub/superscripts.
80 CATEGORY:
81 CALLING SEQUENCE:
82       fnt = sub_sup_idl( strn )
83 INPUTS:
84       strn -- Either '^' or '_', the TeX super/subscript       in
85               characters
86 KEYWORD PARAMETERS:
87       /FORCE_UD -- Set this to use !U/!D instead of !E/!I for
88                    sub/superscripts .
89 OUTPUTS:
90       fnt -- Either '!U' or !E' for superscripts,              out
91              or '!D' or '!I' for subscripts.
92 COMMON BLOCKS:
93 SIDE EFFECTS:
94 NOTES:
95 EXAMPLE:
96 LIBRARY FUNCTIONS CALLED:
97       
98 MODIFICATION HISTORY:
99       $Id: sub_sup_idl.pro 327 2007-12-13 16:22:35Z pinsard $
100       $Log: sub_sup_idl.pro,v $
101       Revision 1.1  1996/01/31 18:47:37  mcraig
102       Initial revision
103
104 RELEASE:
105       $Name: Rel_2_1_2 $
106
107
108   
109
110   
111    <h3>Parameters</h3>
112   
113
114    <a name="#_sub_sup_idl_keyword_token"></a>
115    <h4>token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122     
123     
124    </h4>
125
126   
127   
128   
129
130   
131    <h3>Keywords</h3>
132
133   
134    <a name="#_sub_sup_idl_keyword_FORCE_UD"></a>
135    <h4>FORCE_UD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141     
142     
143     
144    </h4>
145
146   
147   
148   
149
150   
151   
152   
153   
154   
155   
156
157   
158   
159   
160   
161   
162
163   
164   
165   
166   
167   
168   
169   
170
171    <font size="-3"><p>&nbsp;</p></font>
172    <hr size="1" color="#CCCCCC"/>
173     
174
175   
176
177    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
178
179  </body>
180</html>
Note: See TracBrowser for help on using the repository browser.