Context Navigation

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

Last change on this file since 107 was 107, checked in by smasson, 18 years ago
bugfix in ead/write_oasis
File size: 8.1 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?format=raw" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td >Source</td>
58
59
60
61	<td><a href="./../idldoc-help.html?format=raw" 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?format=raw" target="_TOP">view single page</a> \| <a href="./../index.html?format=raw" 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?format=raw">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"></div>
90
91
92
93
94
95
96
97
98	<div id="routine_summary">
99	<h2>Routine summary</h2>
100
101	<dl>
102
103	<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>
104	<dd> SPECIAL NOTE: The file translate_sub_super.</dd>
105
106	<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>
107	<dd> NAME: TRANSLATE_SUB_SUPER PURPOSE: Translate TeX sub/superscripts to IDL sub/superscripts.</dd>
108
109	</dl>
110	</div>
111
112
113	<div id="routine_details">
114
115
116	<div class="routine_details" id="_Sub_sup_idl">
117
118	<h2><a class="top" href="#container">top</a>Sub_sup_idl </h2>
119
120	<p class="header">
121	<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>
122
123	<div class="comments">
124	SPECIAL NOTE:
125	The file translate_sub_super.pro contains two functions,
126	translate_sub_super, and sub_sup_idl. The former is the
127	generic routine for processing TeX sub/superscripts, the
128	latter is used only by translate_sub_super and has no general
129	utility. Hence it lives here. You will see documentation for
130	translate_sub_super second if you use DOC_LIBRARY.</div>
131
132
133
134
135	<h3>Parameters</h3>
136
137
138	<h4 id="_Sub_sup_idl_param_token">token
139
140
141
142
143
144
145
146
147	</h4>
148
149	<div class="comments"></div>
150
151
152
153
154
155
156	<h3>Keywords</h3>
157
158	<h4 id="_Sub_sup_idl_keyword_FORCE_UD">FORCE_UD
159
160
161
162
163
164
165
166
167	</h4>
168
169	<div class="comments"></div>
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196	</div>
197
198
199	<div class="routine_details" id="_Translate_sub_super">
200
201	<h2><a class="top" href="#container">top</a>Translate_sub_super </h2>
202
203	<p class="header">
204	<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>
205
206	<div class="comments">
207	NAME:
208	TRANSLATE_SUB_SUPER
209	PURPOSE:
210	Translate TeX sub/superscripts to IDL sub/superscripts.
211	CATEGORY:
212	text/strings
213	CALLING SEQUENCE:
214	new = translate_sub_super( old )
215	INPUTS:
216	old -- string to be translated from TeX to IDL. in
217	KEYWORD PARAMETERS:
218	/RECURSED -- set if this function is being called
219	recursively.
220	/HELP -- Set to print useful message and exit.
221	OUTPUTS:
222	new -- string old converted from TeX to IDL out
223	COMMON BLOCKS:
224	SIDE EFFECTS:
225	NOTES:
226	- For best results, when both a sub and superscript are used,
227	place the shorter of the two first (e.g. 'N^{a}_{bbbb}' is
228	better than 'N_{bbbb}^{a}').
229	- Single character sub/super scripts do not need to be
230	protected by braces.
231	- Sub/superscripts may be nested (e.g. 'N^{N_1^N}').
232	EXAMPLE:
233	out = translate_sub_super( 'N^2_{big}' )
234	Then out='N!U2!N!Dbig!N' which looks like it should on the
235	display.
236	LIBRARY FUNCTIONS CALLED:
237	str_token -- Text/string (mcraig)
238	sub_sup_idl -- contained in this file
239	MODIFICATION HISTORY:
240	$Id: translate_sub_super.pro 47 2006-05-09 09:13:01Z pinsard $
241	$Log: translate_sub_super.pro,v $
242	Revision 1.5 2000/06/14 19:09:22 mcraig
243	Changed name of strtok str_token to avoid conflict in IDL 5.3.
244
245	Revision 1.4 1996/06/14 20:00:27 mcraig
246	Updated Copyright info.
247
248	Revision 1.3 1996/05/09 00:22:17 mcraig
249	Changed some function calls to reflect changes in those functions, moved
250	some code out of the main loop that didn't need to be there, added
251	documentation.
252
253	Revision 1.2 1996/02/08 18:54:20 mcraig
254	Changed default sub/superscript size to be !D/!U rather than !I/!E to
255	improve readability of plat annotations.
256
257	Revision 1.1 1996/01/31 18:47:37 mcraig
258	Initial revision
259
260	RELEASE:
261	$Name: Rel_2_1_2 $
262
263	COPYRIGHT:
264	Copyright (C) 1996 The Regents of the University of California, All
265	Rights Reserved. Written by Matthew W. Craig.
266	See the file COPYRIGHT for restrictions on distrubting this code.
267	This code comes with absolutely NO warranty; see DISCLAIMER for details.</div>
268
269
270
271
272	<h3>Parameters</h3>
273
274
275	<h4 id="_Translate_sub_super_param_InputString">InputString
276
277
278
279
280
281
282
283
284	</h4>
285
286	<div class="comments"></div>
287
288
289
290
291
292
293	<h3>Keywords</h3>
294
295	<h4 id="_Translate_sub_super_keyword_RECURSED">RECURSED
296
297
298
299
300
301
302
303
304	</h4>
305
306	<div class="comments"></div>
307
308	<h4 id="_Translate_sub_super_keyword_HELP">HELP
309
310
311
312
313
314
315
316
317	</h4>
318
319	<div class="comments"></div>
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346	</div>
347
348	</div>
349
350
351
352	<div id="tagline">Produced by IDLdoc 2.0.</div>
353
354	</div>
355
356	</body>
357	</html>

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

Download in other formats: