source: trunk/SRC/Documentation/idldoc_html_output/Textoidl/translate_sub_super.html @ 338

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

update documentation
File size: 10.3 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>translate_sub_super.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="translate_sub_super.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//translate_sub_super.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="textoidl.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="translate_sub_super.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">translate_sub_super.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Return the proper IDL font positioning command for TeX
91 sub/superscripts.
92</div>
93
94     
95
96     
97
98     
99
100     
101      <div id="routine_summary">               
102        <h2>Routine summary</h2>
103       
104        <dl>
105         
106          <dt><p><a href="#_sub_sup_idl"><span class="result">result = </span>sub_sup_idl(<span class="result">token</span>, FORCE_UD=<span class="result">FORCE_UD</span>)</a></p><dt>
107          <dd> </dd>   
108         
109          <dt><p><a href="#_translate_sub_super"><span class="result">result = </span>translate_sub_super(<span class="result">InputString</span>, RECURSED=<span class="result">RECURSED</span>, HELP=<span class="result">HELP</span>)</a></p><dt>
110          <dd>  NAME:        TRANSLATE_SUB_SUPER  PURPOSE:        Translate TeX sub/superscripts to IDL sub/superscripts.</dd> 
111               
112        </dl>
113      </div>
114     
115
116      <div id="routine_details">
117       
118
119        <div class="routine_details" id="_sub_sup_idl">
120
121          <h2><a class="top" href="#container">top</a>sub_sup_idl <span class="categories">
122 Text, String
123</span></h2>
124       
125          <p class="header">
126            <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>
127       
128          <div class="comments">
129</div>
130
131          <h3>Return value</h3><div class="preformat">
132 Either '!U' or !E' for superscripts, or '!D' or '!I' for subscripts.
133</div>
134
135         
136            <h3>Parameters</h3>
137       
138           
139            <h4 id="_sub_sup_idl_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140             
141             
142             
143             
144             
145             
146             
147             
148            </h4>
149       
150          <div class="comments">
151 Either '^' or '_', the TeX super/subscript characters
152</div>
153           
154
155         
156
157         
158
159            <h3>Keywords</h3>
160           
161            <h4 id="_sub_sup_idl_keyword_FORCE_UD">FORCE_UD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167             
168             
169             
170            </h4>
171       
172            <div class="comments">
173 Set this to use !U/!D instead of !E/!I for sub/superscripts.
174</div>
175           
176         
177
178          <h3>Examples</h3><div class="preformat">
179
180</div>
181          <h3>Version history</h3>
182         
183          <h4>Version</h4><div class="preformat">
184 $Id: translate_sub_super.pro 327 2007-12-13 16:22:35Z pinsard $
185</div>
186          <h4>History</h4><div class="preformat">
187       $Log: translate_sub_super.pro,v $
188       Revision 1.5  2000/06/14 19:09:22  mcraig
189       Changed name of strtok str_token to avoid conflict in IDL 5.3.
190
191       Revision 1.4  1996/06/14 20:00:27  mcraig
192       Updated Copyright info.
193
194       Revision 1.3  1996/05/09 00:22:17  mcraig
195       Changed some function calls to reflect changes in those functions, moved
196       some code out of the main loop that didn't need to be there, added
197       documentation.
198
199       Revision 1.1  1996/01/31 18:47:37  mcraig
200       Initial revision
201
202  Copyright (C) 1996 The Regents of the University of California, All
203  Rights Reserved.  Written by Matthew W. Craig.
204  See the file COPYRIGHT for restrictions on distrubting this code.
205  This code comes with absolutely NO warranty; see DISCLAIMER for details.
206</div>
207         
208         
209          <h3>Known issues</h3>
210         
211         
212         
213          <h4>Restrictions</h4><div class="preformat">
214 Make sure sub_sup_idl stays before translate_sub_super.  At least
215 for now, when IDL encounters a function and automatically compiles
216 it, it only compiles the functions in the file up to the named
217 function.  So even if sub_sup_idl was declared with
218 FORWARD_FUNCTION in translate_sub_super, it would not properly
219 compile.
220
221 The file translate_sub_super.pro contains two functions,
222 translate_sub_super, and sub_sup_idl.  The former is the
223 generic routine for processing TeX sub/superscripts, the
224 latter is used only by translate_sub_super and has no general
225 utility.  Hence it lives here.  You will see documentation for
226 translate_sub_super second if you use DOC_LIBRARY.
227
228 Used only by translate_sub_super.  Should be kept in same
229 file.
230</div>
231       
232          <h3>Other attributes</h3>
233         
234         
235          <h4>Uses routines</h4><div class="preformat">
236
237</div>
238         
239         
240         
241       
242          <h3>Statistics</h3>
243          <table class="statistics">
244            <tr><td>McCabe cyclic</td><td>           7</td></tr>
245            <tr><td>McCabe essential</td><td>           1</td></tr>
246            <tr><td>McCabe modular design</td><td>           1</td></tr>
247          </table>
248         
249       
250        </div>
251       
252
253        <div class="routine_details" id="_translate_sub_super">
254
255          <h2><a class="top" href="#container">top</a>translate_sub_super </h2>
256       
257          <p class="header">
258            <span class="result">result = </span>translate_sub_super(<span class="result"><a href="#_translate_sub_super_param_InputString">InputString</a></span>, <a href="#_translate_sub_super_keyword_RECURSED">RECURSED</a>=<span class="result">RECURSED</span>, <a href="#_translate_sub_super_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
259       
260          <div class="comments">
261 NAME:
262       TRANSLATE_SUB_SUPER
263 PURPOSE:
264       Translate TeX sub/superscripts to IDL sub/superscripts.
265 CATEGORY:
266       text/strings
267 CALLING SEQUENCE:
268       new = translate_sub_super( old )
269 INPUTS:
270       old       -- string to be translated from TeX to IDL.   in
271 KEYWORD PARAMETERS:
272       /RECURSED -- set if this function is being called
273                    recursively.
274       /HELP     -- Set to print useful message and exit.
275 OUTPUTS:
276       new       -- string old converted from TeX to IDL       out
277 COMMON BLOCKS:
278 SIDE EFFECTS:
279 NOTES:
280       - For best results, when both a sub and superscript are used,
281         place the shorter of the two first (e.g. 'N^{a}_{bbbb}' is
282         better than 'N_{bbbb}^{a}').
283       - Single character sub/super scripts do not need to be
284         protected by braces.
285       - Sub/superscripts may be nested (e.g. 'N^{N_1^N}').
286 EXAMPLE:
287       out = translate_sub_super( 'N^2_{big}' )
288       Then out='N!U2!N!Dbig!N' which looks like it should on the
289       display.
290 LIBRARY FUNCTIONS CALLED:
291       str_token      -- Text/string (mcraig)
292       sub_sup_idl -- contained in this file
293 MODIFICATION HISTORY:
294       $Id: translate_sub_super.pro 327 2007-12-13 16:22:35Z pinsard $
295       $Log: translate_sub_super.pro,v $
296       Revision 1.5  2000/06/14 19:09:22  mcraig
297       Changed name of strtok str_token to avoid conflict in IDL 5.3.
298
299       Revision 1.4  1996/06/14 20:00:27  mcraig
300       Updated Copyright info.
301
302       Revision 1.3  1996/05/09 00:22:17  mcraig
303       Changed some function calls to reflect changes in those functions, moved
304       some code out of the main loop that didn't need to be there, added
305       documentation.
306
307       Revision 1.2  1996/02/08 18:54:20  mcraig
308       Changed default sub/superscript size to be !D/!U rather than !I/!E to
309       improve readability of plat annotations.
310
311       Revision 1.1  1996/01/31 18:47:37  mcraig
312       Initial revision
313
314 RELEASE:
315       $Name: Rel_2_1_2 $
316
317 COPYRIGHT:
318  Copyright (C) 1996 The Regents of the University of California, All
319  Rights Reserved.  Written by Matthew W. Craig.
320  See the file COPYRIGHT for restrictions on distrubting this code.
321  This code comes with absolutely NO warranty; see DISCLAIMER for details.</div>
322
323         
324
325         
326            <h3>Parameters</h3>
327       
328           
329            <h4 id="_translate_sub_super_param_InputString">InputString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
330             
331             
332             
333             
334             
335             
336             
337             
338            </h4>
339       
340          <div class="comments"></div>
341           
342
343         
344
345         
346
347            <h3>Keywords</h3>
348           
349            <h4 id="_translate_sub_super_keyword_RECURSED">RECURSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
350             
351             
352             
353             
354             
355             
356             
357             
358            </h4>
359       
360            <div class="comments"></div>
361           
362            <h4 id="_translate_sub_super_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
363             
364             
365             
366             
367             
368             
369             
370             
371            </h4>
372       
373            <div class="comments"></div>
374           
375         
376
377         
378         
379         
380         
381         
382         
383         
384         
385         
386         
387         
388         
389       
390         
391         
392         
393         
394         
395         
396         
397       
398          <h3>Statistics</h3>
399          <table class="statistics">
400            <tr><td>McCabe cyclic</td><td>          11</td></tr>
401            <tr><td>McCabe essential</td><td>           1</td></tr>
402            <tr><td>McCabe modular design</td><td>           1</td></tr>
403          </table>
404         
405       
406        </div>
407       
408      </div>
409
410     
411
412      <div id="tagline">Produced by IDLdoc 2.0.</div>
413
414    </div>
415
416  </body>
417</html>
Note: See TracBrowser for help on using the repository browser.