[89] | 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 (IDLdoc API 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 (IDLdoc API documentation)"; |
---|
| 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
| 26 | <h1>IDLdoc API 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="textable.html"><<prev file</a> | <a href="translate_sub_super.html">next file >></a> <a href="textoidl.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine 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">textoidl.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 | |
---|
| 99 | <div id="routine_details"> |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | <div class="routine_details" id="_Textoidl"> |
---|
| 103 | |
---|
| 104 | <h2><a class="top" href="#container">top</a>Textoidl </h2> |
---|
| 105 | |
---|
| 106 | <p class="header"> |
---|
| 107 | <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> |
---|
| 108 | |
---|
| 109 | <div class="comments"> |
---|
| 110 | NAME: |
---|
| 111 | TEXTOIDL |
---|
| 112 | PURPOSE: |
---|
| 113 | Convert a valid TeX string to a valid IDL string for plot labels. |
---|
| 114 | CATEGORY: |
---|
| 115 | text/strings |
---|
| 116 | CALLING SEQUENCE: |
---|
| 117 | new = textoidl(old) |
---|
| 118 | INPUTS: |
---|
| 119 | old -- TeX string to be converted. Will not be in |
---|
| 120 | modified. old may be a string array. |
---|
| 121 | KEYWORD PARAMETERS: |
---|
| 122 | FONT -- Set to 0 to use hardware font, -1 to use |
---|
| 123 | vector. Note that the only hardware font |
---|
| 124 | supported is PostScript. |
---|
| 125 | /TEX_SEQUENCES -- return the available TeX sequences |
---|
| 126 | /HELP -- print out info on use of the function |
---|
| 127 | and exit. |
---|
| 128 | OUTPUTS: |
---|
| 129 | new -- IDL string corresponding to old. out |
---|
| 130 | COMMON BLOCKS: |
---|
| 131 | SIDE EFFECTS: |
---|
| 132 | NOTES: |
---|
| 133 | - Use the procedure SHOWTEX to get a list of the available TeX |
---|
| 134 | control sequences. |
---|
| 135 | - The only hardware font for which translation is available is |
---|
| 136 | PostScript. |
---|
| 137 | - The only device for which hardware font' |
---|
| 138 | translation is available is PostScript.' |
---|
| 139 | - The FONT keyword overrides the font selected' |
---|
| 140 | by !p.font' |
---|
| 141 | EXAMPLE: |
---|
| 142 | out = TeXtoIDL('\Gamma^2 + 5N_{ed}') |
---|
| 143 | The string out may be used in XYOUTS or other IDL text |
---|
| 144 | display routines. It will be an uppercase Gamma, with an |
---|
| 145 | exponent of 2, then a plus sign, then an N with the subscript |
---|
| 146 | ed. |
---|
| 147 | MODIFICATION HISTORY: |
---|
| 148 | $Id: textoidl.pro 47 2006-05-09 09:13:01Z pinsard $ |
---|
| 149 | $Log: textoidl.pro,v $ |
---|
| 150 | Revision 1.7 2004/06/15 17:25:54 mcraig |
---|
| 151 | Fixed bug in regular expression, changed array notation to square brackets |
---|
| 152 | |
---|
| 153 | Revision 1.6 2004/01/11 01:49:00 mcraig |
---|
| 154 | Changed format of one array to newer [] style to avoidf conflict with function name in astro library. |
---|
| 155 | |
---|
| 156 | Revision 1.5 2001/11/23 21:10:55 mcraig |
---|
| 157 | Added backslash '\' to tex sequences in translation table to protect them during regexp search in strsplit. |
---|
| 158 | |
---|
| 159 | Revision 1.4 1996/06/14 20:00:27 mcraig |
---|
| 160 | Updated Copyright info. |
---|
| 161 | |
---|
| 162 | Revision 1.3 1996/05/09 00:22:17 mcraig |
---|
| 163 | Added error handling, cleaned up documentation. |
---|
| 164 | |
---|
| 165 | Revision 1.2 1996/02/08 18:52:50 mcraig |
---|
| 166 | Added ability to use hardware fonts for PostScript device. |
---|
| 167 | |
---|
| 168 | Revision 1.1 1996/01/31 18:47:37 mcraig |
---|
| 169 | Initial revision |
---|
| 170 | |
---|
| 171 | RELEASE: |
---|
| 172 | $Name: Rel_2_1_2 $ |
---|
| 173 | |
---|
| 174 | COPYRIGHT: |
---|
| 175 | Copyright (C) 1996 The Regents of the University of California, All |
---|
| 176 | Rights Reserved. Written by Matthew W. Craig. |
---|
| 177 | See the file COPYRIGHT for restrictions on distrubting this code. |
---|
| 178 | This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | <h3>Parameters</h3> |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | <h4 id="_Textoidl_param_InputString">InputString |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | </h4> |
---|
| 196 | |
---|
| 197 | <div class="comments"></div> |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | <h3>Keywords</h3> |
---|
| 205 | |
---|
| 206 | <h4 id="_Textoidl_keyword_FONT">FONT |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | |
---|
| 210 | |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | </h4> |
---|
| 216 | |
---|
| 217 | <div class="comments"></div> |
---|
| 218 | |
---|
| 219 | <h4 id="_Textoidl_keyword_HELP">HELP |
---|
| 220 | |
---|
| 221 | |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | </h4> |
---|
| 229 | |
---|
| 230 | <div class="comments"></div> |
---|
| 231 | |
---|
| 232 | <h4 id="_Textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | </h4> |
---|
| 242 | |
---|
| 243 | <div class="comments"></div> |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | |
---|
| 251 | |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | |
---|
| 256 | |
---|
| 257 | |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | |
---|
| 267 | |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | </div> |
---|
| 271 | |
---|
| 272 | </div> |
---|
| 273 | |
---|
| 274 | |
---|
| 275 | |
---|
| 276 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 277 | |
---|
| 278 | </div> |
---|
| 279 | |
---|
| 280 | </body> |
---|
| 281 | </html> |
---|