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

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

update documentation
File size: 6.6 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>textoidl.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="textoidl.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//textoidl.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="textable.html">&lt;&lt;prev file</a> | <a href="translate_sub_super.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="textoidl.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">textoidl.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Convert a valid TeX string to a valid IDL string for plot labels.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_textoidl">
105
106          <h2><a class="top" href="#container">top</a>textoidl <span class="categories">
107 Text, String
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>textoidl(<span class="result"><a href="#_textoidl_param_InputString">InputString</a></span>, <a href="#_textoidl_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_textoidl_keyword_HELP">HELP</a>=<span class="result">HELP</span>, <a href="#_textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES</a>=<span class="result">TEX_SEQUENCES</span>)</p>
112       
113          <div class="comments"></div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_textoidl_param_InputString">InputString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments">
133 TeX string to be converted.  Will not be modified.  old may be a string array.
134</div>
135           
136
137         
138
139         
140
141            <h3>Keywords</h3>
142           
143            <h4 id="_textoidl_keyword_FONT">FONT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144             
145             
146             
147             
148             
149             
150             
151             
152            </h4>
153       
154            <div class="comments">
155 Set to 0 to use hardware font, -1 to use
156 vector.  Note that the only hardware font
157 supported is PostScript.
158</div>
159           
160            <h4 id="_textoidl_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161             
162             
163             
164             
165             
166             
167             
168             
169            </h4>
170       
171            <div class="comments">
172 print out info on use of the function and exit.
173</div>
174           
175            <h4 id="_textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177             
178             
179             
180             
181             
182             
183             
184            </h4>
185       
186            <div class="comments">
187 return the available TeX sequences
188</div>
189           
190         
191
192          <h3>Examples</h3><div class="preformat">
193       out = TeXtoIDL('Gamma^2 + 5N_{ed}')
194       The string out may be used in XYOUTS or other IDL text
195       display routines.  It will be an uppercase Gamma, with an
196       exponent of 2, then a plus sign, then an N with the subscript
197       ed.
198</div>
199          <h3>Version history</h3>
200         
201          <h4>Version</h4><div class="preformat">
202 $Id: textoidl.pro 325 2007-12-06 10:04:53Z pinsard $</div>
203          <h4>History</h4><div class="preformat">
204       $Log: textoidl.pro,v $
205       Revision 1.7  2004/06/15 17:25:54  mcraig
206       Fixed bug in regular expression, changed array notation to square brackets
207
208       Revision 1.6  2004/01/11 01:49:00  mcraig
209       Changed format of one array to newer [] style to avoidf conflict with function name in astro library.
210
211       Revision 1.5  2001/11/23 21:10:55  mcraig
212       Added backslash '' to tex sequences in translation table to protect them during regexp search in strsplit.
213
214       Revision 1.4  1996/06/14 20:00:27  mcraig
215       Updated Copyright info.
216
217       Revision 1.3  1996/05/09 00:22:17  mcraig
218       Added error handling, cleaned up documentation.
219
220       Revision 1.2  1996/02/08 18:52:50  mcraig
221       Added ability to use hardware fonts for PostScript device.
222
223       Revision 1.1  1996/01/31 18:47:37  mcraig
224       Initial revision
225
226  Copyright (C) 1996 The Regents of the University of California, All
227  Rights Reserved.  Written by Matthew W. Craig.
228  See the file COPYRIGHT for restrictions on distrubting this code.
229  This code comes with absolutely NO warranty; see DISCLAIMER for details.
230</div>
231         
232         
233          <h3>Known issues</h3>
234         
235         
236         
237          <h4>Restrictions</h4><div class="preformat">
238       - Use the procedure SHOWTEX to get a list of the available TeX
239         control sequences. 
240       - The only hardware font for which translation is available is
241         PostScript.
242       - The only device for which hardware font'
243         translation is available is PostScript.'
244       - The FONT keyword overrides the font selected'
245         by !p.font'
246</div>
247       
248         
249         
250         
251         
252         
253         
254         
255       
256          <h3>Statistics</h3>
257          <table class="statistics">
258            <tr><td>McCabe cyclic</td><td>           8</td></tr>
259            <tr><td>McCabe essential</td><td>           1</td></tr>
260            <tr><td>McCabe modular design</td><td>           1</td></tr>
261          </table>
262         
263       
264        </div>
265       
266      </div>
267
268     
269
270      <div id="tagline">Produced by IDLdoc 2.0.</div>
271
272    </div>
273
274  </body>
275</html>
Note: See TracBrowser for help on using the repository browser.