| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>textoidl.pro (SAXO Documentation Assistant)</title> |
|---|
| 6 | </head> |
|---|
| 7 | |
|---|
| 8 | <body text="#000000" bgcolor="#FFFFFF"> |
|---|
| 9 | |
|---|
| 10 | |
|---|
| 11 | <!-- Navbar template takes a structure with the following fields: |
|---|
| 12 | overview_href : |
|---|
| 13 | overview_selected : |
|---|
| 14 | dir_overview_href : |
|---|
| 15 | dir_overview_selected : |
|---|
| 16 | categories_href : |
|---|
| 17 | categories_selected : |
|---|
| 18 | index_href : |
|---|
| 19 | index_selected : |
|---|
| 20 | search_href : |
|---|
| 21 | search_selected : |
|---|
| 22 | file_selected : |
|---|
| 23 | source_href : |
|---|
| 24 | source_selected : |
|---|
| 25 | help_href : |
|---|
| 26 | help_selected : |
|---|
| 27 | etc_selected : |
|---|
| 28 | |
|---|
| 29 | prev_file_href : |
|---|
| 30 | next_file_href : |
|---|
| 31 | |
|---|
| 32 | view_single_page_href : |
|---|
| 33 | view_frames_href : |
|---|
| 34 | |
|---|
| 35 | summary_fields_href : |
|---|
| 36 | summary_routine_href : |
|---|
| 37 | details_routine_href : |
|---|
| 38 | |
|---|
| 39 | title : |
|---|
| 40 | subtitle : |
|---|
| 41 | user : |
|---|
| 42 | --> |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | <table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom"> |
|---|
| 46 | <tr> |
|---|
| 47 | <td width="10%"> |
|---|
| 48 | <a href="textable.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> |
|---|
| 49 | <td width="80%" align="center" valign="center"> |
|---|
| 50 | <font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> |
|---|
| 51 | <td width="10%" align="right"> |
|---|
| 52 | <a href="translate_sub_super.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">Textoidl/</font></h1> |
|---|
| 58 | <h2>textoidl.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | Convert a valid TeX string to a valid IDL string for plot labels. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | <a name="#_textoidl"></a> |
|---|
| 71 | |
|---|
| 72 | <h2>textoidl <font size="-1" color="#006633"> |
|---|
| 73 | Text, String |
|---|
| 74 | </font></h2> |
|---|
| 75 | |
|---|
| 76 | <p><font face="Courier"><i>result = </i>textoidl(<i><a href="#_textoidl_keyword_InputString">InputString</a></i>, <a href="#_textoidl_keyword_FONT">FONT</a>=<i>FONT</i>, <a href="#_textoidl_keyword_HELP">HELP</a>=<i>HELP</i>, <a href="#_textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES</a>=<i>TEX_SEQUENCES</i>)</font></p> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | <h3>Parameters</h3> |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | <a name="#_textoidl_keyword_InputString"></a> |
|---|
| 87 | <h4>InputString |
|---|
| 88 | <font size="-1" color="#006633">in</font> |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | <font size="-1" color="#006633">required</font> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | </h4> |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | TeX string to be converted. Will not be modified. old may be a string array. |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | <h3>Keywords</h3> |
|---|
| 106 | |
|---|
| 107 | |
|---|
| 108 | <a name="#_textoidl_keyword_FONT"></a> |
|---|
| 109 | <h4>FONT |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | </h4> |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | Set to 0 to use hardware font, -1 to use |
|---|
| 122 | vector. Note that the only hardware font |
|---|
| 123 | supported is PostScript. |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | <a name="#_textoidl_keyword_HELP"></a> |
|---|
| 127 | <h4>HELP |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | </h4> |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | print out info on use of the function and exit. |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | <a name="#_textoidl_keyword_TEX_SEQUENCES"></a> |
|---|
| 143 | <h4>TEX_SEQUENCES |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | </h4> |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | return the available TeX sequences |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | <h3>Examples</h3><pre> |
|---|
| 161 | |
|---|
| 162 | IDL> out = TeXtoIDL('Gamma^2 + 5N_{ed}') |
|---|
| 163 | |
|---|
| 164 | The string out may be used in XYOUTS or other IDL text |
|---|
| 165 | display routines. It will be an uppercase Gamma, with an |
|---|
| 166 | exponent of 2, then a plus sign, then an N with the subscript |
|---|
| 167 | "ed". |
|---|
| 168 | |
|---|
| 169 | </pre><h3>Version history</h3> |
|---|
| 170 | |
|---|
| 171 | <h4>Version</h4> |
|---|
| 172 | $Id: textoidl.pro 372 2008-08-08 12:31:53Z pinsard $ |
|---|
| 173 | <h4>History</h4> |
|---|
| 174 | $Log: textoidl.pro,v $ |
|---|
| 175 | Revision 1.7 2004/06/15 17:25:54 mcraig |
|---|
| 176 | Fixed bug in regular expression, changed array notation to square brackets |
|---|
| 177 | |
|---|
| 178 | Revision 1.6 2004/01/11 01:49:00 mcraig |
|---|
| 179 | Changed format of one array to newer [] style to avoidf conflict with function name in astro library. |
|---|
| 180 | |
|---|
| 181 | Revision 1.5 2001/11/23 21:10:55 mcraig |
|---|
| 182 | Added backslash '' to tex sequences in translation table to protect them during regexp search in strsplit. |
|---|
| 183 | |
|---|
| 184 | Revision 1.4 1996/06/14 20:00:27 mcraig |
|---|
| 185 | Updated Copyright info. |
|---|
| 186 | |
|---|
| 187 | Revision 1.3 1996/05/09 00:22:17 mcraig |
|---|
| 188 | Added error handling, cleaned up documentation. |
|---|
| 189 | |
|---|
| 190 | Revision 1.2 1996/02/08 18:52:50 mcraig |
|---|
| 191 | Added ability to use hardware fonts for PostScript device. |
|---|
| 192 | |
|---|
| 193 | Revision 1.1 1996/01/31 18:47:37 mcraig |
|---|
| 194 | Initial revision |
|---|
| 195 | |
|---|
| 196 | Copyright (C) 1996 The Regents of the University of California, All |
|---|
| 197 | Rights Reserved. Written by Matthew W. Craig. |
|---|
| 198 | See the file COPYRIGHT for restrictions on distrubting this code. |
|---|
| 199 | This code comes with absolutely NO warranty; see DISCLAIMER for details. |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | <h3>Known issues</h3> |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | <h4>Restrictions</h4> |
|---|
| 208 | - Use the procedure SHOWTEX to get a list of the available TeX |
|---|
| 209 | control sequences. |
|---|
| 210 | - The only hardware font for which translation is available is |
|---|
| 211 | PostScript. |
|---|
| 212 | - The only device for which hardware font' |
|---|
| 213 | translation is available is PostScript.' |
|---|
| 214 | - The FONT keyword overrides the font selected' |
|---|
| 215 | by !p.font' |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | <font size="-3"><p> </p></font> |
|---|
| 227 | <hr size="1" color="#CCCCCC"/> |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 233 | |
|---|
| 234 | </body> |
|---|
| 235 | </html> |
|---|
