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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

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