Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: