source: trunk/SRC/Documentation/idldoc_html_output/Textoidl/sub_sup_idl.html @ 200

Last change on this file since 200 was 200, checked in by smasson, 18 years ago

update idldoc documentation
File size: 4.4 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>sub_sup_idl.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="sub_sup_idl.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Textoidl//sub_sup_idl.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="strtrans.html">&lt;&lt;prev file</a> | <a href="textable.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="sub_sup_idl.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Textoidl/</a></h1>
82      <h2 class="pro_file">sub_sup_idl.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_Sub_sup_idl">
103
104          <h2><a class="top" href="#container">top</a>Sub_sup_idl </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>Sub_sup_idl(<span class="result"><a href="#_Sub_sup_idl_param_token">token</a></span>, <a href="#_Sub_sup_idl_keyword_FORCE_UD">FORCE_UD</a>=<span class="result">FORCE_UD</span>)</p>
108       
109          <div class="comments">
110 NAME:
111       SUB_SUP_IDL
112 PURPOSE:
113       Return the proper IDL font positioning command for TeX
114       sub/superscripts.
115 CATEGORY:
116 CALLING SEQUENCE:
117       fnt = sub_sup_idl( strn )
118 INPUTS:
119       strn -- Either '^' or '_', the TeX super/subscript       in
120               characters
121 KEYWORD PARAMETERS:
122       /FORCE_UD -- Set this to use !U/!D instead of !E/!I for
123                    sub/superscripts .
124 OUTPUTS:
125       fnt -- Either '!U' or !E' for superscripts,              out
126              or '!D' or '!I' for subscripts.
127 COMMON BLOCKS:
128 SIDE EFFECTS:
129 NOTES:
130 EXAMPLE:
131 LIBRARY FUNCTIONS CALLED:
132       
133 MODIFICATION HISTORY:
134       $Id: sub_sup_idl.pro 134 2006-07-07 10:19:08Z navarro $
135       $Log: sub_sup_idl.pro,v $
136       Revision 1.1  1996/01/31 18:47:37  mcraig
137       Initial revision
138
139 RELEASE:
140       $Name: Rel_2_1_2 $</div>
141
142         
143
144         
145            <h3>Parameters</h3>
146       
147           
148            <h4 id="_Sub_sup_idl_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159          <div class="comments"></div>
160           
161
162         
163
164         
165
166            <h3>Keywords</h3>
167           
168            <h4 id="_Sub_sup_idl_keyword_FORCE_UD">FORCE_UD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179            <div class="comments"></div>
180           
181         
182
183         
184         
185         
186         
187         
188         
189         
190         
191         
192         
193         
194         
195       
196         
197         
198         
199         
200         
201         
202         
203       
204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>           6</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
223</html>
Note: See TracBrowser for help on using the repository browser.