| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
|---|
| 2 | <HTML> |
|---|
| 3 | <HEAD> |
|---|
| 4 | <!-- Generated by IDLdoc 1.6, build date Fri Jan 14 15:57:17 2005 on Wed Feb 09 12:40:19 2005 --> |
|---|
| 5 | <TITLE>idldoc.pro</TITLE> |
|---|
| 6 | <STYLE><!-- |
|---|
| 7 | a:link { color: #660000 } |
|---|
| 8 | a:active { color: #660000 } |
|---|
| 9 | a:visited {color: #660000 } |
|---|
| 10 | |
|---|
| 11 | /* Default font for body text */ |
|---|
| 12 | BODY { |
|---|
| 13 | FONT-SIZE: 10pt; |
|---|
| 14 | FONT-FAMILY: Arial; |
|---|
| 15 | BACKGROUND-COLOR: #FFFFF9 |
|---|
| 16 | } |
|---|
| 17 | |
|---|
| 18 | /* Default font for text in tables */ |
|---|
| 19 | TD { |
|---|
| 20 | FONT-SIZE: 10pt; |
|---|
| 21 | FONT-FAMILY: Arial |
|---|
| 22 | } |
|---|
| 23 | |
|---|
| 24 | /* Format for body of all files */ |
|---|
| 25 | BODY.standard { |
|---|
| 26 | FONT-SIZE: 10pt; |
|---|
| 27 | FONT-FAMILY: Arial; |
|---|
| 28 | BACKGROUND-COLOR: #FFFFF9 |
|---|
| 29 | } |
|---|
| 30 | |
|---|
| 31 | TABLE.parameters { |
|---|
| 32 | BORDER-TOP: 1px solid #FFFFCC; |
|---|
| 33 | BORDER-BOTTOM: 1px solid #88AA66; |
|---|
| 34 | BORDER-LEFT: 1px solid #FFFFCC; |
|---|
| 35 | BORDER-RIGHT: 1px solid #88AA66; |
|---|
| 36 | WIDTH: 95%; |
|---|
| 37 | MARGIN-LEFT: 5% |
|---|
| 38 | } |
|---|
| 39 | |
|---|
| 40 | TR.parameters { |
|---|
| 41 | BORDER-RIGHT-WIDTH: 0px; |
|---|
| 42 | BORDER-TOP-WIDTH: 1px; |
|---|
| 43 | BORDER-LEFT-WIDTH: 0px; |
|---|
| 44 | WIDTH: 100%; |
|---|
| 45 | BORDER-BOTTOM-WIDTH: 1px; |
|---|
| 46 | BORDER-STYLE: solid |
|---|
| 47 | } |
|---|
| 48 | |
|---|
| 49 | TD.index_selection_header { |
|---|
| 50 | FONT-WEIGHT: bold; |
|---|
| 51 | FONT-SIZE: 14pt; |
|---|
| 52 | FONT-FAMILY: Arial, Helvetica, sans-serif |
|---|
| 53 | } |
|---|
| 54 | |
|---|
| 55 | TABLE.minor_listing { |
|---|
| 56 | BORDER-TOP: 1px solid #EEEEFF; |
|---|
| 57 | BORDER-BOTTOM: 1px solid #6666AA; |
|---|
| 58 | BORDER-LEFT: 1px solid #EEEEFF; |
|---|
| 59 | BORDER-RIGHT: 1px solid #6666AA; |
|---|
| 60 | WIDTH: 100% |
|---|
| 61 | } |
|---|
| 62 | |
|---|
| 63 | TABLE.listing { |
|---|
| 64 | BORDER-TOP: 1px solid #BBBBFF; |
|---|
| 65 | BORDER-BOTTOM: 1px solid #6666AA; |
|---|
| 66 | BORDER-LEFT: 1px solid #BBBBFF; |
|---|
| 67 | BORDER-RIGHT: 1px solid #6666AA; |
|---|
| 68 | WIDTH: 100% |
|---|
| 69 | } |
|---|
| 70 | |
|---|
| 71 | TABLE.routine_listing { |
|---|
| 72 | BACKGROUND: #FFFFAA; |
|---|
| 73 | BORDER-TOP: 1px solid #FFEEAA; |
|---|
| 74 | BORDER-BOTTOM: 1px solid #AAAA66; |
|---|
| 75 | BORDER-LEFT: 1px solid #FFEEAA; |
|---|
| 76 | BORDER-RIGHT: 1px solid #AAAA66; |
|---|
| 77 | WIDTH: 100% |
|---|
| 78 | } |
|---|
| 79 | |
|---|
| 80 | TD.title { |
|---|
| 81 | FONT-SIZE: 14pt; |
|---|
| 82 | BACKGROUND: #ccccff; |
|---|
| 83 | FONT-FAMILY: Arial, Helvetica, sans-serif |
|---|
| 84 | } |
|---|
| 85 | |
|---|
| 86 | TR.small_title { |
|---|
| 87 | FONT-WEIGHT: bold; |
|---|
| 88 | BACKGROUND: #eeeeff; |
|---|
| 89 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 90 | } |
|---|
| 91 | |
|---|
| 92 | /* #F0FFBA */ |
|---|
| 93 | TR.parameter_title { |
|---|
| 94 | FONT-WEIGHT: bold; |
|---|
| 95 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 96 | BACKGROUND: #F0FFE0 |
|---|
| 97 | } |
|---|
| 98 | |
|---|
| 99 | /***** Navbar stuff *****/ |
|---|
| 100 | |
|---|
| 101 | TD.navbar_unselected A:hover { |
|---|
| 102 | BACKGROUND: #AAAAFF; |
|---|
| 103 | BORDER-TOP: 3px solid #AAAAFF; |
|---|
| 104 | BORDER-BOTTOM: 3px solid #AAAAFF |
|---|
| 105 | } |
|---|
| 106 | |
|---|
| 107 | /* Formatting for the row with the labels */ |
|---|
| 108 | TR.navbar { |
|---|
| 109 | FONT-WEIGHT: bold; |
|---|
| 110 | BACKGROUND: #ddddff; |
|---|
| 111 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 112 | } |
|---|
| 113 | |
|---|
| 114 | /* Formatting for the table cell that is currently selected */ |
|---|
| 115 | TD.navbar_selected { |
|---|
| 116 | BORDER-TOP: 3px solid #0000AA; |
|---|
| 117 | BORDER-BOTTOM: 3px solid #DDDDFF |
|---|
| 118 | } |
|---|
| 119 | |
|---|
| 120 | TD.navbar_unselected { |
|---|
| 121 | BORDER-TOP: 3px solid #DDDDFF; |
|---|
| 122 | BORDER-BOTTOM: 3px solid #DDDDFF |
|---|
| 123 | } |
|---|
| 124 | |
|---|
| 125 | /* Formatting for the text that allows cycling through files and finding details vs. summary */ |
|---|
| 126 | TD.navbar_small { |
|---|
| 127 | FONT-WEIGHT: lighter; |
|---|
| 128 | FONT-SIZE: 8pt; |
|---|
| 129 | TEXT-TRANSFORM: lowercase; |
|---|
| 130 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 131 | } |
|---|
| 132 | |
|---|
| 133 | /* Formatting for Research System's logo */ |
|---|
| 134 | FONT.logo { |
|---|
| 135 | FONT-SIZE: 16pt; |
|---|
| 136 | TEXT-TRANSFORM: uppercase; |
|---|
| 137 | FONT-FAMILY: 'Times New Roman', serif |
|---|
| 138 | } |
|---|
| 139 | |
|---|
| 140 | /* Formatting for IDL version and User/Developer Documentation tag */ |
|---|
| 141 | FONT.version { |
|---|
| 142 | FONT-SIZE: 8pt; |
|---|
| 143 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 144 | } |
|---|
| 145 | |
|---|
| 146 | /* Formatting for directory name on a file page */ |
|---|
| 147 | FONT.directory { |
|---|
| 148 | FONT-SIZE: 8pt; |
|---|
| 149 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 150 | COLOR: darkolivegreen |
|---|
| 151 | } |
|---|
| 152 | |
|---|
| 153 | /* Formatting for a file name on a file page */ |
|---|
| 154 | FONT.file { |
|---|
| 155 | FONT-WEIGHT: bold; |
|---|
| 156 | FONT-SIZE: 16pt; |
|---|
| 157 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 158 | } |
|---|
| 159 | |
|---|
| 160 | /* Formatting for line at bottom of page indicating version of IDLdoc */ |
|---|
| 161 | FONT.tagline { |
|---|
| 162 | FONT-SIZE: 8pt; |
|---|
| 163 | FONT-STYLE: italic; |
|---|
| 164 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 165 | } |
|---|
| 166 | |
|---|
| 167 | FONT.code { |
|---|
| 168 | FONT-SIZE: 10pt; |
|---|
| 169 | FONT-FAMILY: 'Courier New', monospace |
|---|
| 170 | } |
|---|
| 171 | |
|---|
| 172 | /* Format for the attributes to a parameter or keyword in the table of parameters and keywords in the routine details */ |
|---|
| 173 | .param_attrib { |
|---|
| 174 | FONT-WEIGHT: 200; |
|---|
| 175 | FONT-SIZE: 8pt; |
|---|
| 176 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 177 | COLOR: darkolivegreen |
|---|
| 178 | } |
|---|
| 179 | |
|---|
| 180 | /* Format for a parameter or keyword name in the table of parameters and keywords in the routine details */ |
|---|
| 181 | FONT.param_name { |
|---|
| 182 | FONT-WEIGHT: bold; |
|---|
| 183 | FONT-SIZE: 10pt; |
|---|
| 184 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 185 | } |
|---|
| 186 | |
|---|
| 187 | TD.listing { |
|---|
| 188 | BORDER-RIGHT: 0px solid; |
|---|
| 189 | BORDER-TOP: 0px solid; |
|---|
| 190 | BORDER-LEFT: 0px solid; |
|---|
| 191 | BORDER-BOTTOM: 1px solid |
|---|
| 192 | } |
|---|
| 193 | |
|---|
| 194 | .list { |
|---|
| 195 | FONT-SIZE: 9pt; |
|---|
| 196 | FONT-FAMILY: Arial, Helvetica, sans-serif |
|---|
| 197 | } |
|---|
| 198 | |
|---|
| 199 | .list_title { |
|---|
| 200 | FONT-SIZE: 9pt; |
|---|
| 201 | FONT-WEIGHT: bold; |
|---|
| 202 | FONT-FAMILY: Arial, Helvetica, sans-serif |
|---|
| 203 | } |
|---|
| 204 | |
|---|
| 205 | /* Font for the number of files or directories in the side frames */ |
|---|
| 206 | .list_tagline { |
|---|
| 207 | FONT-WEIGHT: lighter; |
|---|
| 208 | FONT-SIZE: 8pt; |
|---|
| 209 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 210 | COLOR: darkolivegreen |
|---|
| 211 | } |
|---|
| 212 | |
|---|
| 213 | .list_tagline_caution { |
|---|
| 214 | FONT-SIZE: 8pt; |
|---|
| 215 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 216 | } |
|---|
| 217 | |
|---|
| 218 | .list_tagline_error { |
|---|
| 219 | FONT-SIZE: 8pt; |
|---|
| 220 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 221 | COLOR: #FF1111 |
|---|
| 222 | } |
|---|
| 223 | |
|---|
| 224 | P.code_header { |
|---|
| 225 | FONT-SIZE: 10pt; |
|---|
| 226 | MARGIN-TOP: 0pt; |
|---|
| 227 | MARGIN-BOTTOM: 0pt; |
|---|
| 228 | MARGIN-LEFT: 30pt; |
|---|
| 229 | TEXT-INDENT: -30pt; |
|---|
| 230 | FONT-FAMILY: 'Courier New', monospace |
|---|
| 231 | } |
|---|
| 232 | |
|---|
| 233 | P.first_line { |
|---|
| 234 | MARGIN-TOP: 3pt; |
|---|
| 235 | MARGIN-BOTTOM: 0pt; |
|---|
| 236 | MARGIN-LEFT: 15pt; |
|---|
| 237 | FONT-WEIGHT: lighter; |
|---|
| 238 | FONT-SIZE: 8pt; |
|---|
| 239 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 240 | } |
|---|
| 241 | |
|---|
| 242 | .routine { |
|---|
| 243 | FONT-WEIGHT: bold; |
|---|
| 244 | FONT-SIZE: 12pt; |
|---|
| 245 | FONT-FAMILY: Arial, Helvetica, sans-serif |
|---|
| 246 | } |
|---|
| 247 | |
|---|
| 248 | /* Formatting for the attributes of a routine */ |
|---|
| 249 | DT.attribute { |
|---|
| 250 | FONT-WEIGHT: bold; |
|---|
| 251 | FONT-SIZE: 9pt; |
|---|
| 252 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 253 | } |
|---|
| 254 | |
|---|
| 255 | /* Formatting for the attributes of a routine */ |
|---|
| 256 | .attribute_item { |
|---|
| 257 | FONT-SIZE: 9pt; |
|---|
| 258 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 259 | MARGIN-BOTTOM: 4px; |
|---|
| 260 | FONT-WEIGHT: lighter; |
|---|
| 261 | COLOR: darkolivegreen |
|---|
| 262 | } |
|---|
| 263 | |
|---|
| 264 | /* Formatting for the attributes of a routine */ |
|---|
| 265 | DT.index_item { |
|---|
| 266 | FONT-SIZE: 9pt; |
|---|
| 267 | FONT-WEIGHT: lighter; |
|---|
| 268 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 269 | |
|---|
| 270 | } |
|---|
| 271 | |
|---|
| 272 | /* Formatting for the attributes of a routine */ |
|---|
| 273 | DD.index_description { |
|---|
| 274 | FONT-SIZE: 8pt; |
|---|
| 275 | FONT-FAMILY: Helvetica, sans-serif; |
|---|
| 276 | FONT-WEIGHT: lighter; |
|---|
| 277 | COLOR: darkolivegreen |
|---|
| 278 | } |
|---|
| 279 | |
|---|
| 280 | HR.divider { |
|---|
| 281 | COLOR: lightslateblue; |
|---|
| 282 | BORDER-TOP-WIDTH: 1px; |
|---|
| 283 | BORDER-BOTTOM-WIDTH: 0px; |
|---|
| 284 | BORDER-LEFT-WIDTH: 0px; |
|---|
| 285 | BORDER-RIGHT-WIDTH: 0px; |
|---|
| 286 | HEIGHT: 1px |
|---|
| 287 | } |
|---|
| 288 | |
|---|
| 289 | HR.table_divider { |
|---|
| 290 | COLOR: rgb(200, 200, 255); |
|---|
| 291 | BORDER-TOP-WIDTH: 1px; |
|---|
| 292 | BORDER-BOTTOM-WIDTH: 0px; |
|---|
| 293 | BORDER-LEFT-WIDTH: 0px; |
|---|
| 294 | BORDER-RIGHT-WIDTH: 0px; |
|---|
| 295 | BORDER-STYLE: dotted; |
|---|
| 296 | HEIGHT: 1px |
|---|
| 297 | } |
|---|
| 298 | |
|---|
| 299 | TR.table_divider { |
|---|
| 300 | HEIGHT: 1px; |
|---|
| 301 | MARGIN: 0px; |
|---|
| 302 | PADDING: 0px |
|---|
| 303 | } |
|---|
| 304 | |
|---|
| 305 | SPAN.index_selection { |
|---|
| 306 | FONT-WEIGHT: bold; |
|---|
| 307 | FONT-SIZE: 12pt; |
|---|
| 308 | FONT-FAMILY: Helvetica, sans-serif |
|---|
| 309 | } |
|---|
| 310 | --></STYLE> |
|---|
| 311 | </HEAD> |
|---|
| 312 | |
|---|
| 313 | <SCRIPT> |
|---|
| 314 | function setTitle() |
|---|
| 315 | { |
|---|
| 316 | parent.document.title="idldoc.pro (IDL Library)"; |
|---|
| 317 | } |
|---|
| 318 | </SCRIPT> |
|---|
| 319 | |
|---|
| 320 | <BODY CLASS="standard" onload="setTitle();"> |
|---|
| 321 | |
|---|
| 322 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="100%"> |
|---|
| 323 | <TR><TD VALIGN="TOP" BGCOLOR="#DDDDFF" style="BORDER-TOP: 1px solid #BBBBFF; BORDER-BOTTOM: 1px solid #6666AA; BORDER-LEFT: 1px solid #BBBBFF; BORDER-RIGHT: 1px solid #6666AA;"> |
|---|
| 324 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0"> |
|---|
| 325 | <TR CLASS="navbar"> |
|---|
| 326 | <TD class="navbar_unselected"> <A HREF="../../overview.html">Overview</A> </TD> |
|---|
| 327 | <TD class="navbar_unselected"> <A HREF="directory-overview.html">Directory</A> </TD> |
|---|
| 328 | <TD class="navbar_unselected"> <A HREF="../../full-index.html">Index</A> </TD> |
|---|
| 329 | <TD class="navbar_unselected"> <A HREF="../../search-page.html">Search</A> </TD> |
|---|
| 330 | <TD class="navbar_selected"> File </TD> |
|---|
| 331 | <TD class="navbar_unselected"> <A HREF="idldoc.pro">Source</A> </TD> |
|---|
| 332 | <TD class="navbar_unselected"> <A HREF="../../idldoc-help.html">Help</A> </TD> |
|---|
| 333 | <TD class="navbar_unselected"> Etc </TD> |
|---|
| 334 | </TR> |
|---|
| 335 | </TABLE> |
|---|
| 336 | </TD> |
|---|
| 337 | <TD> </TD> |
|---|
| 338 | <TD ROWSPAN="3" ALIGN="right"><FONT CLASS="logo"><NOBR>IDL Library</NOBR></FONT><BR><FONT CLASS="version"><NOBR>Michael Galloy, RSI</NOBR></FONT><BR><FONT CLASS="version" STYLE="font-weight: bold">Developer Documentation</FONT></TD> |
|---|
| 339 | </TR> |
|---|
| 340 | <TR><TD CLASS="navbar_small"> <A HREF="idldcroutine_parse_attr.html">prev file</A> | <A HREF="idldoc_class_fields.html">next file</A> <NOBR><A HREF="idldoc.html" TARGET="_top">view single page</A> | <A HREF="../../index.html" TARGET="_top">view frames</A> | <A HREF="idldoc-routines.html" TARGET="routine_frame">update routines</A></NOBR></TD></TR> |
|---|
| 341 | <TR><TD CLASS="navbar_small">SUMMARY: fields | <A HREF="#_routine_summary">routine</A> DETAILS: <A HREF="#_routine_details">routine</A></TD></TR> |
|---|
| 342 | <TR><TD></TD></TR> |
|---|
| 343 | </TABLE> |
|---|
| 344 | |
|---|
| 345 | <HR CLASS="divider"> |
|---|
| 346 | |
|---|
| 347 | <P> |
|---|
| 348 | <FONT CLASS="directory">.\tools\idldoc</FONT></BR> |
|---|
| 349 | <FONT CLASS="file">idldoc.pro</FONT> |
|---|
| 350 | <P> |
|---|
| 351 | <DL> |
|---|
| 352 | <DT CLASS="attribute">Last modification date: |
|---|
| 353 | <DD CLASS="attribute_item">Fri Jan 14 15:57:11 2005</DD></DT> |
|---|
| 354 | </DL> |
|---|
| 355 | <P> |
|---|
| 356 | IDLdoc is a hypertext documentation system for IDL code. It |
|---|
| 357 | is intended to show the API of a library of code in an easy to browse |
|---|
| 358 | manner. It produces HTML pages -- one page per '.pro' file, as |
|---|
| 359 | well as directory listing, overview pages, and an index of files, routines, |
|---|
| 360 | keywords, and parameter names. |
|---|
| 361 | |
|---|
| 362 | <p> Unmarked code may be processed by IDLdoc to produce a browseable |
|---|
| 363 | listing of routines and their arguments. But to obtain more useful |
|---|
| 364 | results, the source can be marked to produce formatted comments in |
|---|
| 365 | the output. Each routine has special tags to indicate particular |
|---|
| 366 | information for IDLdoc formatting use. HTML markup tags may be used |
|---|
| 367 | anywhere comments are expected. See the |
|---|
| 368 | <A HREF="idldoc_files.html">help</A> for individual files for specifics about |
|---|
| 369 | the tags available. |
|---|
| 370 | |
|---|
| 371 | <p> For a more an example of code that has been documented using IDLdoc, |
|---|
| 372 | check IDLdoc's source for its comments and compare to its output. |
|---|
| 373 | |
|---|
| 374 | <p> Class listings and fields summary will be generated for files which |
|---|
| 375 | end with __DEFINE.PRO. Use the "field" tag to make comments on each |
|---|
| 376 | field of the class/structure defined. |
|---|
| 377 | |
|---|
| 378 | <p> An overview file can be specified with the OVERVIEW keyword to IDLdoc. |
|---|
| 379 | This file is a plain text file with comments (which can contain HTML codes) |
|---|
| 380 | that will be displayed on a summary page. The below tags are processed by |
|---|
| 381 | IDLdoc. |
|---|
| 382 | |
|---|
| 383 | <p> |
|---|
| 384 | |
|---|
| 385 | <table width="100%" border="1" cellspacing="0" cellpadding="3"> |
|---|
| 386 | <tr bgcolor="#DDDDDD"><td colspan="2"><b>Overview Tags</b></td></tr> |
|---|
| 387 | <tr><td width="100" align="right" valign="top">dir</td> |
|---|
| 388 | <td>Comment for a directory. The first parameter to dir is the directory |
|---|
| 389 | name relative to the root dir. The rest of the tag content is the comment. |
|---|
| 390 | </td></tr> |
|---|
| 391 | </table> |
|---|
| 392 | |
|---|
| 393 | <p> The style of the output of IDLdoc can be changed by editing the |
|---|
| 394 | cascading style sheet used: idldoc.css found in the same directory |
|---|
| 395 | as IDLdoc. |
|---|
| 396 | |
|---|
| 397 | <p> This help was produced by IDLdoc. |
|---|
| 398 | |
|---|
| 399 | <P> |
|---|
| 400 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="listing"> |
|---|
| 401 | <TR><TD CLASS="title"> |
|---|
| 402 | <A NAME="_routine_summary">Routine Summary</A> |
|---|
| 403 | <FONT CLASS="list_tagline">21 routines</FONT> |
|---|
| 404 | </TD></TR> |
|---|
| 405 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_idldoc_version">idldoc_version</A>([/build])</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> IDLdoc version is returned.</P></TD></TR></TABLE> |
|---|
| 406 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_filecopy">idldoc_filecopy</A>, src, dst, warnings=<EM>variable</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Copies the src file to dst file, overwriting the previous dst file if necessary.</P></TD></TR></TABLE> |
|---|
| 407 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_find_at_symbol">idldoc_find_at_symbol</A>, lines[, line_num][, pos]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Find the first \@ symbol in a line or lines of comments.</P></TD></TR></TABLE> |
|---|
| 408 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_idldoc_elim_slash">idldoc_elim_slash</A>(dir)</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Changes any file specification notation to the web notation ("/").</P></TD></TR></TABLE> |
|---|
| 409 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_process_tags">idldoc_process_tags</A>, tag_lines, pro_dirs, comments, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Process the tags in the overview file.</P></TD></TR></TABLE> |
|---|
| 410 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_header">idldoc_write_header</A>, title, [lun=<EM>integral</EM>], [html=<EM>integral</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Write am IDLdoc-style header.</P></TD></TR></TABLE> |
|---|
| 411 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_warning">idldoc_write_warning</A>, pro_files, file_hash, title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>], statistics=<EM>statistics</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Create the warnings page for the library.</P></TD></TR></TABLE> |
|---|
| 412 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_search">idldoc_write_search</A>, pro_dirs, pro_files, title=<EM>title</EM>, index_hash=<EM>index_hash</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, nonavbar=<EM>nonavbar</EM>, file_hash=<EM>file_hash</EM>, user=<EM>user</EM>, root=<EM>root</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Writes the search file.</P></TD></TR></TABLE> |
|---|
| 413 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_etc">idldoc_write_etc</A>, etc_files, title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, nonavbar=<EM>nonavbar</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"></P></TD></TR></TABLE> |
|---|
| 414 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_dir_overview">idldoc_write_dir_overview</A>, pro_dir, pro_files, title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, nonavbar=<EM>nonavbar</EM>, file_hash=<EM>file_hash</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"></P></TD></TR></TABLE> |
|---|
| 415 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_directory_overviews">idldoc_write_directory_overviews</A>, pro_dirs, pro_files, title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, nonavbar=<EM>nonavbar</EM>, file_hash=<EM>file_hash</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"></P></TD></TR></TABLE> |
|---|
| 416 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_full_index">idldoc_write_full_index</A>, index_hash, title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM>, embed=<EM>embed</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Create the index for the library.</P></TD></TR></TABLE> |
|---|
| 417 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_overview">idldoc_write_overview</A>, overview, pro_dirs, [warnings=<EM>variable</EM>], [/user], [/embed], [/nonavbar], title=<EM>title</EM>, subtitle=<EM>subtitle</EM>, footer=<EM>footer</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Processes the file specified by the OVERVIEW keyword to IDLdoc (if present) and creates the 'overview.html' file that shows in the main browser frame when loading the 'index.html' file.</P></TD></TR></TABLE> |
|---|
| 418 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_blank">idldoc_write_blank</A>, [warnings=<EM>variable</EM>], embed=<EM>embed</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Create a blank file for the initial routines frame.</P></TD></TR></TABLE> |
|---|
| 419 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_help">idldoc_write_help</A>, [warnings=<EM>variable</EM>], [/user], [/embed], [/nonavbar], title=<EM>title</EM>, subtitle=<EM>subtitle</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Create help.html in the root directory.</P></TD></TR></TABLE> |
|---|
| 420 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_index">idldoc_write_index</A>, pro_dirs, title=<EM>title</EM>, [warnings=<EM>variable</EM>], browse_routines=<EM>browse_routines</EM></P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Create index.html in the root directory.</P></TD></TR></TABLE> |
|---|
| 421 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_dir_files">idldoc_write_dir_files</A>, pro_files, pro_dir, [/embed], user=<EM>user</EM>, file_hash=<EM>file_hash</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Writes the 'dir-files.html' file in each directory that contains the links to each of the .</P></TD></TR></TABLE> |
|---|
| 422 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_all_files">idldoc_write_all_files</A>, pro_files, [/embed], file_hash=<EM>file_hash</EM>, user=<EM>user</EM>, [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Writes the all-files.html file in the root directory.</P></TD></TR></TABLE> |
|---|
| 423 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc_write_all_dirs">idldoc_write_all_dirs</A>, pro_dirs, count, [/embed], [warnings=<EM>variable</EM>]</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Writes the all-dirs.html file in the root directory.</P></TD></TR></TABLE> |
|---|
| 424 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" STYLE="BORDER-BOTTOM: 1px groove" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function <A HREF="#_idldoc_find_dirs">idldoc_find_dirs</A>(pro_files, ndirs)</P></TD><TD ALIGN="right" VALIGN="top"><FONT CLASS="param_attrib">private </FONT></TD><TR><TD><P class="first_line"> Find the directories with .pro files in them.</P></TD></TR></TABLE> |
|---|
| 425 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure <A HREF="#_idldoc">idldoc</A>, root=<EM>string</EM>, [footer=<EM>string</EM>], [output=<EM>string</EM>], [overview=<EM>string</EM>], [/user], [/quiet], [/silent], [/embed], [/nonavbar], [title=<EM>string</EM>], [subtitle=<EM>string</EM>], [n_warnings=<EM>variable</EM>], [/browse_routines], preformat=<EM>preformat</EM></P></TD><TD ALIGN="right" VALIGN="top"></TD><TR><TD><P class="first_line"> Calling routine for IDLdoc.</P></TD></TR></TABLE> |
|---|
| 426 | </TABLE> |
|---|
| 427 | <P> |
|---|
| 428 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="listing"> |
|---|
| 429 | <TR><TD CLASS="title"><A NAME="_routine_details">Routine Details</A></TD></TR> |
|---|
| 430 | </TABLE> |
|---|
| 431 | <P> |
|---|
| 432 | <A NAME="_idldoc_version"/> |
|---|
| 433 | <TABLE CLASS="routine_listing"> |
|---|
| 434 | <TR><TD> |
|---|
| 435 | <SPAN CLASS="routine"> |
|---|
| 436 | idldoc_version |
|---|
| 437 | </SPAN> |
|---|
| 438 | </TD><TD ALIGN="right"> |
|---|
| 439 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 440 | </TD></TR></TABLE> |
|---|
| 441 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function idldoc_version([/<A HREF=#_idldoc_version_keyword_build>build</A>])</P></TD></TR></TABLE> |
|---|
| 442 | <P> |
|---|
| 443 | |
|---|
| 444 | IDLdoc version is returned. |
|---|
| 445 | |
|---|
| 446 | <P> |
|---|
| 447 | <DL> |
|---|
| 448 | <DT CLASS="attribute">Returns |
|---|
| 449 | <DD CLASS="attribute_item"> |
|---|
| 450 | string representing IDLdoc's current version |
|---|
| 451 | </DD></DT> |
|---|
| 452 | </DL> |
|---|
| 453 | <P> |
|---|
| 454 | <P> |
|---|
| 455 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 456 | <TR CLASS="parameter_title"> |
|---|
| 457 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 458 | </TR> |
|---|
| 459 | <TR CLASS="parameters"> |
|---|
| 460 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 461 | <A NAME="_idldoc_version_keyword_build"/> |
|---|
| 462 | <FONT CLASS="param_name">build</FONT><BR> |
|---|
| 463 | <FONT CLASS="param_attrib"> |
|---|
| 464 | <NOBR>in, optional</NOBR><BR> |
|---|
| 465 | <NOBR>boolean</NOBR> |
|---|
| 466 | </FONT> |
|---|
| 467 | </TD> |
|---|
| 468 | <TD VALIGN="top"> |
|---|
| 469 | set to return a string with the |
|---|
| 470 | build date in it also |
|---|
| 471 | </TD> |
|---|
| 472 | </TR> |
|---|
| 473 | </TABLE> |
|---|
| 474 | <P> |
|---|
| 475 | <A NAME="_idldoc_filecopy"/> |
|---|
| 476 | <TABLE CLASS="routine_listing"> |
|---|
| 477 | <TR><TD> |
|---|
| 478 | <SPAN CLASS="routine"> |
|---|
| 479 | idldoc_filecopy |
|---|
| 480 | </SPAN> |
|---|
| 481 | </TD><TD ALIGN="right"> |
|---|
| 482 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 483 | </TD></TR></TABLE> |
|---|
| 484 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_filecopy, <A HREF=#_idldoc_filecopy_param_src>src</A>, <A HREF=#_idldoc_filecopy_param_dst>dst</A>, <A HREF=#_idldoc_filecopy_keyword_warnings>warnings</A>=<EM>variable</EM></P></TD></TR></TABLE> |
|---|
| 485 | <P> |
|---|
| 486 | |
|---|
| 487 | Copies the src file to dst file, overwriting the previous dst file if |
|---|
| 488 | necessary. |
|---|
| 489 | |
|---|
| 490 | <P> |
|---|
| 491 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 492 | <TR CLASS="parameter_title"> |
|---|
| 493 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 494 | </TR> |
|---|
| 495 | <TR CLASS="parameters"> |
|---|
| 496 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 497 | <A NAME="_idldoc_filecopy_param_src"/> |
|---|
| 498 | <FONT CLASS="param_name">src</FONT><BR> |
|---|
| 499 | <FONT CLASS="param_attrib"> |
|---|
| 500 | <NOBR>in, required</NOBR><BR> |
|---|
| 501 | <NOBR>string</NOBR> |
|---|
| 502 | </FONT> |
|---|
| 503 | </TD> |
|---|
| 504 | <TD VALIGN="top"> |
|---|
| 505 | source filename |
|---|
| 506 | </TD> |
|---|
| 507 | </TR> |
|---|
| 508 | <TR CLASS="parameters"> |
|---|
| 509 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 510 | <A NAME="_idldoc_filecopy_param_dst"/> |
|---|
| 511 | <FONT CLASS="param_name">dst</FONT><BR> |
|---|
| 512 | <FONT CLASS="param_attrib"> |
|---|
| 513 | <NOBR>in, required</NOBR><BR> |
|---|
| 514 | <NOBR>string</NOBR> |
|---|
| 515 | </FONT> |
|---|
| 516 | </TD> |
|---|
| 517 | <TD VALIGN="top"> |
|---|
| 518 | destination filename; if this file |
|---|
| 519 | exists already, it will be overwritten |
|---|
| 520 | </TD> |
|---|
| 521 | </TR> |
|---|
| 522 | </TABLE> |
|---|
| 523 | <P> |
|---|
| 524 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 525 | <TR CLASS="parameter_title"> |
|---|
| 526 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 527 | </TR> |
|---|
| 528 | <TR CLASS="parameters"> |
|---|
| 529 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 530 | <A NAME="_idldoc_filecopy_keyword_warnings"/> |
|---|
| 531 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 532 | <FONT CLASS="param_attrib"> |
|---|
| 533 | <NOBR>out, required</NOBR><BR> |
|---|
| 534 | <NOBR>variable</NOBR> |
|---|
| 535 | </FONT> |
|---|
| 536 | </TD> |
|---|
| 537 | <TD VALIGN="top"> |
|---|
| 538 | a named variable to return the |
|---|
| 539 | number of warnings |
|---|
| 540 | </TD> |
|---|
| 541 | </TR> |
|---|
| 542 | </TABLE> |
|---|
| 543 | <P> |
|---|
| 544 | <A NAME="_idldoc_find_at_symbol"/> |
|---|
| 545 | <TABLE CLASS="routine_listing"> |
|---|
| 546 | <TR><TD> |
|---|
| 547 | <SPAN CLASS="routine"> |
|---|
| 548 | idldoc_find_at_symbol |
|---|
| 549 | </SPAN> |
|---|
| 550 | </TD><TD ALIGN="right"> |
|---|
| 551 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 552 | </TD></TR></TABLE> |
|---|
| 553 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_find_at_symbol, <A HREF=#_idldoc_find_at_symbol_param_lines>lines</A>[, <A HREF=#_idldoc_find_at_symbol_param_line_num>line_num</A>][, <A HREF=#_idldoc_find_at_symbol_param_pos>pos</A>]</P></TD></TR></TABLE> |
|---|
| 554 | <P> |
|---|
| 555 | |
|---|
| 556 | Find the first \@ symbol in a line or lines of comments. |
|---|
| 557 | |
|---|
| 558 | <P> |
|---|
| 559 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 560 | <TR CLASS="parameter_title"> |
|---|
| 561 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 562 | </TR> |
|---|
| 563 | <TR CLASS="parameters"> |
|---|
| 564 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 565 | <A NAME="_idldoc_find_at_symbol_param_lines"/> |
|---|
| 566 | <FONT CLASS="param_name">lines</FONT><BR> |
|---|
| 567 | <FONT CLASS="param_attrib"> |
|---|
| 568 | <NOBR>in, required</NOBR><BR> |
|---|
| 569 | <NOBR>string array</NOBR> |
|---|
| 570 | </FONT> |
|---|
| 571 | </TD> |
|---|
| 572 | <TD VALIGN="top"> |
|---|
| 573 | lines of IDL comments |
|---|
| 574 | </TD> |
|---|
| 575 | </TR> |
|---|
| 576 | <TR CLASS="parameters"> |
|---|
| 577 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 578 | <A NAME="_idldoc_find_at_symbol_param_line_num"/> |
|---|
| 579 | <FONT CLASS="param_name">line_num</FONT><BR> |
|---|
| 580 | <FONT CLASS="param_attrib"> |
|---|
| 581 | <NOBR>out, optional</NOBR><BR> |
|---|
| 582 | <NOBR>variable</NOBR> |
|---|
| 583 | </FONT> |
|---|
| 584 | </TD> |
|---|
| 585 | <TD VALIGN="top"> |
|---|
| 586 | line number of the @ symbol |
|---|
| 587 | </TD> |
|---|
| 588 | </TR> |
|---|
| 589 | <TR CLASS="parameters"> |
|---|
| 590 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 591 | <A NAME="_idldoc_find_at_symbol_param_pos"/> |
|---|
| 592 | <FONT CLASS="param_name">pos</FONT><BR> |
|---|
| 593 | <FONT CLASS="param_attrib"> |
|---|
| 594 | <NOBR>out, optional</NOBR><BR> |
|---|
| 595 | <NOBR>variable</NOBR> |
|---|
| 596 | </FONT> |
|---|
| 597 | </TD> |
|---|
| 598 | <TD VALIGN="top"> |
|---|
| 599 | position of the @ symbol |
|---|
| 600 | </TD> |
|---|
| 601 | </TR> |
|---|
| 602 | </TABLE> |
|---|
| 603 | <P> |
|---|
| 604 | <P> |
|---|
| 605 | <A NAME="_idldoc_elim_slash"/> |
|---|
| 606 | <TABLE CLASS="routine_listing"> |
|---|
| 607 | <TR><TD> |
|---|
| 608 | <SPAN CLASS="routine"> |
|---|
| 609 | idldoc_elim_slash |
|---|
| 610 | </SPAN> |
|---|
| 611 | </TD><TD ALIGN="right"> |
|---|
| 612 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 613 | </TD></TR></TABLE> |
|---|
| 614 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function idldoc_elim_slash(<A HREF=#_idldoc_elim_slash_param_dir>dir</A>)</P></TD></TR></TABLE> |
|---|
| 615 | <P> |
|---|
| 616 | |
|---|
| 617 | Changes any file specification notation to the web notation ("/"). |
|---|
| 618 | |
|---|
| 619 | <P> |
|---|
| 620 | <DL> |
|---|
| 621 | <DT CLASS="attribute">Returns |
|---|
| 622 | <DD CLASS="attribute_item"> |
|---|
| 623 | string or string array with path separators changed to "/" since |
|---|
| 624 | the web always uses "/" |
|---|
| 625 | </DD></DT> |
|---|
| 626 | </DL> |
|---|
| 627 | <P> |
|---|
| 628 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 629 | <TR CLASS="parameter_title"> |
|---|
| 630 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 631 | </TR> |
|---|
| 632 | <TR CLASS="parameters"> |
|---|
| 633 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 634 | <A NAME="_idldoc_elim_slash_param_dir"/> |
|---|
| 635 | <FONT CLASS="param_name">dir</FONT><BR> |
|---|
| 636 | <FONT CLASS="param_attrib"> |
|---|
| 637 | <NOBR>in</NOBR><BR> |
|---|
| 638 | <NOBR>string or string array</NOBR> |
|---|
| 639 | </FONT> |
|---|
| 640 | </TD> |
|---|
| 641 | <TD VALIGN="top"> |
|---|
| 642 | represents directory path(s) |
|---|
| 643 | </TD> |
|---|
| 644 | </TR> |
|---|
| 645 | </TABLE> |
|---|
| 646 | <P> |
|---|
| 647 | <P> |
|---|
| 648 | <A NAME="_idldoc_process_tags"/> |
|---|
| 649 | <TABLE CLASS="routine_listing"> |
|---|
| 650 | <TR><TD> |
|---|
| 651 | <SPAN CLASS="routine"> |
|---|
| 652 | idldoc_process_tags |
|---|
| 653 | </SPAN> |
|---|
| 654 | </TD><TD ALIGN="right"> |
|---|
| 655 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 656 | </TD></TR></TABLE> |
|---|
| 657 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_process_tags, <A HREF=#_idldoc_process_tags_param_tag_lines>tag_lines</A>, <A HREF=#_idldoc_process_tags_param_pro_dirs>pro_dirs</A>, <A HREF=#_idldoc_process_tags_param_comments>comments</A>, [<A HREF=#_idldoc_process_tags_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 658 | <P> |
|---|
| 659 | |
|---|
| 660 | Process the tags in the overview file. |
|---|
| 661 | |
|---|
| 662 | <P> |
|---|
| 663 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 664 | <TR CLASS="parameter_title"> |
|---|
| 665 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 666 | </TR> |
|---|
| 667 | <TR CLASS="parameters"> |
|---|
| 668 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 669 | <A NAME="_idldoc_process_tags_param_tag_lines"/> |
|---|
| 670 | <FONT CLASS="param_name">tag_lines</FONT><BR> |
|---|
| 671 | <FONT CLASS="param_attrib"> |
|---|
| 672 | <NOBR>in</NOBR><BR> |
|---|
| 673 | <NOBR>string array</NOBR> |
|---|
| 674 | </FONT> |
|---|
| 675 | </TD> |
|---|
| 676 | <TD VALIGN="top"> |
|---|
| 677 | the portion of the file specified |
|---|
| 678 | by overview that has at signs in it |
|---|
| 679 | </TD> |
|---|
| 680 | </TR> |
|---|
| 681 | <TR CLASS="parameters"> |
|---|
| 682 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 683 | <A NAME="_idldoc_process_tags_param_pro_dirs"/> |
|---|
| 684 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 685 | <FONT CLASS="param_attrib"> |
|---|
| 686 | <NOBR>in</NOBR><BR> |
|---|
| 687 | <NOBR>string array</NOBR> |
|---|
| 688 | </FONT> |
|---|
| 689 | </TD> |
|---|
| 690 | <TD VALIGN="top"> |
|---|
| 691 | directories under root that hold |
|---|
| 692 | .pro files |
|---|
| 693 | </TD> |
|---|
| 694 | </TR> |
|---|
| 695 | <TR CLASS="parameters"> |
|---|
| 696 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 697 | <A NAME="_idldoc_process_tags_param_comments"/> |
|---|
| 698 | <FONT CLASS="param_name">comments</FONT><BR> |
|---|
| 699 | <FONT CLASS="param_attrib"> |
|---|
| 700 | <NOBR>in/out</NOBR><BR> |
|---|
| 701 | <NOBR>variable</NOBR> |
|---|
| 702 | </FONT> |
|---|
| 703 | </TD> |
|---|
| 704 | <TD VALIGN="top"> |
|---|
| 705 | comments for the pro_dirs |
|---|
| 706 | directories; matches elementwise |
|---|
| 707 | </TD> |
|---|
| 708 | </TR> |
|---|
| 709 | </TABLE> |
|---|
| 710 | <P> |
|---|
| 711 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 712 | <TR CLASS="parameter_title"> |
|---|
| 713 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 714 | </TR> |
|---|
| 715 | <TR CLASS="parameters"> |
|---|
| 716 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 717 | <A NAME="_idldoc_process_tags_keyword_warnings"/> |
|---|
| 718 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 719 | <FONT CLASS="param_attrib"> |
|---|
| 720 | <NOBR>out, optional</NOBR><BR> |
|---|
| 721 | <NOBR>variable</NOBR> |
|---|
| 722 | </FONT> |
|---|
| 723 | </TD> |
|---|
| 724 | <TD VALIGN="top"> |
|---|
| 725 | a named variable to return the |
|---|
| 726 | number of warnings |
|---|
| 727 | </TD> |
|---|
| 728 | </TR> |
|---|
| 729 | </TABLE> |
|---|
| 730 | <P> |
|---|
| 731 | <A NAME="_idldoc_write_header"/> |
|---|
| 732 | <TABLE CLASS="routine_listing"> |
|---|
| 733 | <TR><TD> |
|---|
| 734 | <SPAN CLASS="routine"> |
|---|
| 735 | idldoc_write_header |
|---|
| 736 | </SPAN> |
|---|
| 737 | </TD><TD ALIGN="right"> |
|---|
| 738 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 739 | </TD></TR></TABLE> |
|---|
| 740 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_header, <A HREF=#_idldoc_write_header_param_title>title</A>, [<A HREF=#_idldoc_write_header_keyword_lun>lun</A>=<EM>integral</EM>], [<A HREF=#_idldoc_write_header_keyword_html>html</A>=<EM>integral</EM>]</P></TD></TR></TABLE> |
|---|
| 741 | <P> |
|---|
| 742 | |
|---|
| 743 | Write am IDLdoc-style header. |
|---|
| 744 | |
|---|
| 745 | <P> |
|---|
| 746 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 747 | <TR CLASS="parameter_title"> |
|---|
| 748 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 749 | </TR> |
|---|
| 750 | <TR CLASS="parameters"> |
|---|
| 751 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 752 | <A NAME="_idldoc_write_header_param_title"/> |
|---|
| 753 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 754 | <FONT CLASS="param_attrib"> |
|---|
| 755 | <NOBR>in, required</NOBR><BR> |
|---|
| 756 | <NOBR>str</NOBR> |
|---|
| 757 | </FONT> |
|---|
| 758 | </TD> |
|---|
| 759 | <TD VALIGN="top"> |
|---|
| 760 | title of the header |
|---|
| 761 | </TD> |
|---|
| 762 | </TR> |
|---|
| 763 | </TABLE> |
|---|
| 764 | <P> |
|---|
| 765 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 766 | <TR CLASS="parameter_title"> |
|---|
| 767 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 768 | </TR> |
|---|
| 769 | <TR CLASS="parameters"> |
|---|
| 770 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 771 | <A NAME="_idldoc_write_header_keyword_lun"/> |
|---|
| 772 | <FONT CLASS="param_name">lun</FONT><BR> |
|---|
| 773 | <FONT CLASS="param_attrib"> |
|---|
| 774 | <NOBR>in, optional</NOBR><BR> |
|---|
| 775 | <NOBR>integral</NOBR> |
|---|
| 776 | </FONT> |
|---|
| 777 | </TD> |
|---|
| 778 | <TD VALIGN="top"> |
|---|
| 779 | LUN of the file to appear in |
|---|
| 780 | </TD> |
|---|
| 781 | </TR> |
|---|
| 782 | <TR CLASS="parameters"> |
|---|
| 783 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 784 | <A NAME="_idldoc_write_header_keyword_html"/> |
|---|
| 785 | <FONT CLASS="param_name">html</FONT><BR> |
|---|
| 786 | <FONT CLASS="param_attrib"> |
|---|
| 787 | <NOBR>in, optional</NOBR><BR> |
|---|
| 788 | <NOBR>integral</NOBR> |
|---|
| 789 | </FONT> |
|---|
| 790 | </TD> |
|---|
| 791 | <TD VALIGN="top"> |
|---|
| 792 | HTML_OUTPUT object reference of |
|---|
| 793 | the file to appear in |
|---|
| 794 | </TD> |
|---|
| 795 | </TR> |
|---|
| 796 | </TABLE> |
|---|
| 797 | <P> |
|---|
| 798 | <A NAME="_idldoc_write_warning"/> |
|---|
| 799 | <TABLE CLASS="routine_listing"> |
|---|
| 800 | <TR><TD> |
|---|
| 801 | <SPAN CLASS="routine"> |
|---|
| 802 | idldoc_write_warning |
|---|
| 803 | </SPAN> |
|---|
| 804 | </TD><TD ALIGN="right"> |
|---|
| 805 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 806 | </TD></TR></TABLE> |
|---|
| 807 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_warning, <A HREF=#_idldoc_write_warning_param_pro_files>pro_files</A>, <A HREF=#_idldoc_write_warning_param_file_hash>file_hash</A>, <A HREF=#_idldoc_write_warning_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_warning_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_warning_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_warning_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_warning_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_warning_keyword_warnings>warnings</A>=<EM>variable</EM>], <A HREF=#_idldoc_write_warning_keyword_statistics>statistics</A>=<EM>statistics</EM></P></TD></TR></TABLE> |
|---|
| 808 | <P> |
|---|
| 809 | |
|---|
| 810 | Create the warnings page for the library. |
|---|
| 811 | |
|---|
| 812 | <P> |
|---|
| 813 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 814 | <TR CLASS="parameter_title"> |
|---|
| 815 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 816 | </TR> |
|---|
| 817 | <TR CLASS="parameters"> |
|---|
| 818 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 819 | <A NAME="_idldoc_write_warning_param_pro_files"/> |
|---|
| 820 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 821 | <FONT CLASS="param_attrib"> |
|---|
| 822 | </FONT> |
|---|
| 823 | </TD> |
|---|
| 824 | <TD VALIGN="top"> |
|---|
| 825 | . |
|---|
| 826 | </TD> |
|---|
| 827 | </TR> |
|---|
| 828 | <TR CLASS="parameters"> |
|---|
| 829 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 830 | <A NAME="_idldoc_write_warning_param_file_hash"/> |
|---|
| 831 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 832 | <FONT CLASS="param_attrib"> |
|---|
| 833 | <NOBR>in</NOBR><BR> |
|---|
| 834 | <NOBR>obj ref</NOBR> |
|---|
| 835 | </FONT> |
|---|
| 836 | </TD> |
|---|
| 837 | <TD VALIGN="top"> |
|---|
| 838 | hash table of file references |
|---|
| 839 | </TD> |
|---|
| 840 | </TR> |
|---|
| 841 | </TABLE> |
|---|
| 842 | <P> |
|---|
| 843 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 844 | <TR CLASS="parameter_title"> |
|---|
| 845 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 846 | </TR> |
|---|
| 847 | <TR CLASS="parameters"> |
|---|
| 848 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 849 | <A NAME="_idldoc_write_warning_keyword_title"/> |
|---|
| 850 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 851 | <FONT CLASS="param_attrib"> |
|---|
| 852 | </FONT> |
|---|
| 853 | </TD> |
|---|
| 854 | <TD VALIGN="top"> |
|---|
| 855 | . |
|---|
| 856 | </TD> |
|---|
| 857 | </TR> |
|---|
| 858 | <TR CLASS="parameters"> |
|---|
| 859 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 860 | <A NAME="_idldoc_write_warning_keyword_subtitle"/> |
|---|
| 861 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 862 | <FONT CLASS="param_attrib"> |
|---|
| 863 | </FONT> |
|---|
| 864 | </TD> |
|---|
| 865 | <TD VALIGN="top"> |
|---|
| 866 | . |
|---|
| 867 | </TD> |
|---|
| 868 | </TR> |
|---|
| 869 | <TR CLASS="parameters"> |
|---|
| 870 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 871 | <A NAME="_idldoc_write_warning_keyword_footer"/> |
|---|
| 872 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 873 | <FONT CLASS="param_attrib"> |
|---|
| 874 | </FONT> |
|---|
| 875 | </TD> |
|---|
| 876 | <TD VALIGN="top"> |
|---|
| 877 | . |
|---|
| 878 | </TD> |
|---|
| 879 | </TR> |
|---|
| 880 | <TR CLASS="parameters"> |
|---|
| 881 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 882 | <A NAME="_idldoc_write_warning_keyword_embed"/> |
|---|
| 883 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 884 | <FONT CLASS="param_attrib"> |
|---|
| 885 | </FONT> |
|---|
| 886 | </TD> |
|---|
| 887 | <TD VALIGN="top"> |
|---|
| 888 | . |
|---|
| 889 | </TD> |
|---|
| 890 | </TR> |
|---|
| 891 | <TR CLASS="parameters"> |
|---|
| 892 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 893 | <A NAME="_idldoc_write_warning_keyword_user"/> |
|---|
| 894 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 895 | <FONT CLASS="param_attrib"> |
|---|
| 896 | </FONT> |
|---|
| 897 | </TD> |
|---|
| 898 | <TD VALIGN="top"> |
|---|
| 899 | . |
|---|
| 900 | </TD> |
|---|
| 901 | </TR> |
|---|
| 902 | <TR CLASS="parameters"> |
|---|
| 903 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 904 | <A NAME="_idldoc_write_warning_keyword_warnings"/> |
|---|
| 905 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 906 | <FONT CLASS="param_attrib"> |
|---|
| 907 | <NOBR>out, optional</NOBR><BR> |
|---|
| 908 | <NOBR>variable</NOBR> |
|---|
| 909 | </FONT> |
|---|
| 910 | </TD> |
|---|
| 911 | <TD VALIGN="top"> |
|---|
| 912 | a named variable to return the |
|---|
| 913 | number of warnings |
|---|
| 914 | </TD> |
|---|
| 915 | </TR> |
|---|
| 916 | <TR CLASS="parameters"> |
|---|
| 917 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 918 | <A NAME="_idldoc_write_warning_keyword_statistics"/> |
|---|
| 919 | <FONT CLASS="param_name">statistics</FONT><BR> |
|---|
| 920 | <FONT CLASS="param_attrib"> |
|---|
| 921 | </FONT> |
|---|
| 922 | </TD> |
|---|
| 923 | <TD VALIGN="top"> |
|---|
| 924 | . |
|---|
| 925 | </TD> |
|---|
| 926 | </TR> |
|---|
| 927 | </TABLE> |
|---|
| 928 | <P> |
|---|
| 929 | <A NAME="_idldoc_write_search"/> |
|---|
| 930 | <TABLE CLASS="routine_listing"> |
|---|
| 931 | <TR><TD> |
|---|
| 932 | <SPAN CLASS="routine"> |
|---|
| 933 | idldoc_write_search |
|---|
| 934 | </SPAN> |
|---|
| 935 | </TD><TD ALIGN="right"> |
|---|
| 936 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 937 | </TD></TR></TABLE> |
|---|
| 938 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_search, <A HREF=#_idldoc_write_search_param_pro_dirs>pro_dirs</A>, <A HREF=#_idldoc_write_search_param_pro_files>pro_files</A>, <A HREF=#_idldoc_write_search_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_search_keyword_index_hash>index_hash</A>=<EM>index_hash</EM>, <A HREF=#_idldoc_write_search_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_search_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_search_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_search_keyword_nonavbar>nonavbar</A>=<EM>nonavbar</EM>, <A HREF=#_idldoc_write_search_keyword_file_hash>file_hash</A>=<EM>file_hash</EM>, <A HREF=#_idldoc_write_search_keyword_user>user</A>=<EM>user</EM>, <A HREF=#_idldoc_write_search_keyword_root>root</A>=<EM>root</EM>, [<A HREF=#_idldoc_write_search_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 939 | <P> |
|---|
| 940 | |
|---|
| 941 | Writes the search file. |
|---|
| 942 | |
|---|
| 943 | <P> |
|---|
| 944 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 945 | <TR CLASS="parameter_title"> |
|---|
| 946 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 947 | </TR> |
|---|
| 948 | <TR CLASS="parameters"> |
|---|
| 949 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 950 | <A NAME="_idldoc_write_search_param_pro_dirs"/> |
|---|
| 951 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 952 | <FONT CLASS="param_attrib"> |
|---|
| 953 | </FONT> |
|---|
| 954 | </TD> |
|---|
| 955 | <TD VALIGN="top"> |
|---|
| 956 | . |
|---|
| 957 | </TD> |
|---|
| 958 | </TR> |
|---|
| 959 | <TR CLASS="parameters"> |
|---|
| 960 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 961 | <A NAME="_idldoc_write_search_param_pro_files"/> |
|---|
| 962 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 963 | <FONT CLASS="param_attrib"> |
|---|
| 964 | </FONT> |
|---|
| 965 | </TD> |
|---|
| 966 | <TD VALIGN="top"> |
|---|
| 967 | . |
|---|
| 968 | </TD> |
|---|
| 969 | </TR> |
|---|
| 970 | </TABLE> |
|---|
| 971 | <P> |
|---|
| 972 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 973 | <TR CLASS="parameter_title"> |
|---|
| 974 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 975 | </TR> |
|---|
| 976 | <TR CLASS="parameters"> |
|---|
| 977 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 978 | <A NAME="_idldoc_write_search_keyword_title"/> |
|---|
| 979 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 980 | <FONT CLASS="param_attrib"> |
|---|
| 981 | </FONT> |
|---|
| 982 | </TD> |
|---|
| 983 | <TD VALIGN="top"> |
|---|
| 984 | . |
|---|
| 985 | </TD> |
|---|
| 986 | </TR> |
|---|
| 987 | <TR CLASS="parameters"> |
|---|
| 988 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 989 | <A NAME="_idldoc_write_search_keyword_index_hash"/> |
|---|
| 990 | <FONT CLASS="param_name">index_hash</FONT><BR> |
|---|
| 991 | <FONT CLASS="param_attrib"> |
|---|
| 992 | </FONT> |
|---|
| 993 | </TD> |
|---|
| 994 | <TD VALIGN="top"> |
|---|
| 995 | . |
|---|
| 996 | </TD> |
|---|
| 997 | </TR> |
|---|
| 998 | <TR CLASS="parameters"> |
|---|
| 999 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1000 | <A NAME="_idldoc_write_search_keyword_subtitle"/> |
|---|
| 1001 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1002 | <FONT CLASS="param_attrib"> |
|---|
| 1003 | </FONT> |
|---|
| 1004 | </TD> |
|---|
| 1005 | <TD VALIGN="top"> |
|---|
| 1006 | . |
|---|
| 1007 | </TD> |
|---|
| 1008 | </TR> |
|---|
| 1009 | <TR CLASS="parameters"> |
|---|
| 1010 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1011 | <A NAME="_idldoc_write_search_keyword_footer"/> |
|---|
| 1012 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1013 | <FONT CLASS="param_attrib"> |
|---|
| 1014 | </FONT> |
|---|
| 1015 | </TD> |
|---|
| 1016 | <TD VALIGN="top"> |
|---|
| 1017 | . |
|---|
| 1018 | </TD> |
|---|
| 1019 | </TR> |
|---|
| 1020 | <TR CLASS="parameters"> |
|---|
| 1021 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1022 | <A NAME="_idldoc_write_search_keyword_embed"/> |
|---|
| 1023 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1024 | <FONT CLASS="param_attrib"> |
|---|
| 1025 | </FONT> |
|---|
| 1026 | </TD> |
|---|
| 1027 | <TD VALIGN="top"> |
|---|
| 1028 | . |
|---|
| 1029 | </TD> |
|---|
| 1030 | </TR> |
|---|
| 1031 | <TR CLASS="parameters"> |
|---|
| 1032 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1033 | <A NAME="_idldoc_write_search_keyword_nonavbar"/> |
|---|
| 1034 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1035 | <FONT CLASS="param_attrib"> |
|---|
| 1036 | </FONT> |
|---|
| 1037 | </TD> |
|---|
| 1038 | <TD VALIGN="top"> |
|---|
| 1039 | . |
|---|
| 1040 | </TD> |
|---|
| 1041 | </TR> |
|---|
| 1042 | <TR CLASS="parameters"> |
|---|
| 1043 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1044 | <A NAME="_idldoc_write_search_keyword_file_hash"/> |
|---|
| 1045 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 1046 | <FONT CLASS="param_attrib"> |
|---|
| 1047 | </FONT> |
|---|
| 1048 | </TD> |
|---|
| 1049 | <TD VALIGN="top"> |
|---|
| 1050 | . |
|---|
| 1051 | </TD> |
|---|
| 1052 | </TR> |
|---|
| 1053 | <TR CLASS="parameters"> |
|---|
| 1054 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1055 | <A NAME="_idldoc_write_search_keyword_user"/> |
|---|
| 1056 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1057 | <FONT CLASS="param_attrib"> |
|---|
| 1058 | </FONT> |
|---|
| 1059 | </TD> |
|---|
| 1060 | <TD VALIGN="top"> |
|---|
| 1061 | . |
|---|
| 1062 | </TD> |
|---|
| 1063 | </TR> |
|---|
| 1064 | <TR CLASS="parameters"> |
|---|
| 1065 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1066 | <A NAME="_idldoc_write_search_keyword_root"/> |
|---|
| 1067 | <FONT CLASS="param_name">root</FONT><BR> |
|---|
| 1068 | <FONT CLASS="param_attrib"> |
|---|
| 1069 | </FONT> |
|---|
| 1070 | </TD> |
|---|
| 1071 | <TD VALIGN="top"> |
|---|
| 1072 | . |
|---|
| 1073 | </TD> |
|---|
| 1074 | </TR> |
|---|
| 1075 | <TR CLASS="parameters"> |
|---|
| 1076 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1077 | <A NAME="_idldoc_write_search_keyword_warnings"/> |
|---|
| 1078 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1079 | <FONT CLASS="param_attrib"> |
|---|
| 1080 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1081 | <NOBR>variable</NOBR> |
|---|
| 1082 | </FONT> |
|---|
| 1083 | </TD> |
|---|
| 1084 | <TD VALIGN="top"> |
|---|
| 1085 | a named variable to return the |
|---|
| 1086 | number of warnings |
|---|
| 1087 | </TD> |
|---|
| 1088 | </TR> |
|---|
| 1089 | </TABLE> |
|---|
| 1090 | <P> |
|---|
| 1091 | <A NAME="_idldoc_write_etc"/> |
|---|
| 1092 | <TABLE CLASS="routine_listing"> |
|---|
| 1093 | <TR><TD> |
|---|
| 1094 | <SPAN CLASS="routine"> |
|---|
| 1095 | idldoc_write_etc |
|---|
| 1096 | </SPAN> |
|---|
| 1097 | </TD><TD ALIGN="right"> |
|---|
| 1098 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1099 | </TD></TR></TABLE> |
|---|
| 1100 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_etc, <A HREF=#_idldoc_write_etc_param_etc_files>etc_files</A>, <A HREF=#_idldoc_write_etc_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_etc_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_etc_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_etc_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_etc_keyword_nonavbar>nonavbar</A>=<EM>nonavbar</EM>, <A HREF=#_idldoc_write_etc_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_etc_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 1101 | <P> |
|---|
| 1102 | |
|---|
| 1103 | <P> |
|---|
| 1104 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1105 | <TR CLASS="parameter_title"> |
|---|
| 1106 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1107 | </TR> |
|---|
| 1108 | <TR CLASS="parameters"> |
|---|
| 1109 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1110 | <A NAME="_idldoc_write_etc_param_etc_files"/> |
|---|
| 1111 | <FONT CLASS="param_name">etc_files</FONT><BR> |
|---|
| 1112 | <FONT CLASS="param_attrib"> |
|---|
| 1113 | </FONT> |
|---|
| 1114 | </TD> |
|---|
| 1115 | <TD VALIGN="top"> |
|---|
| 1116 | . |
|---|
| 1117 | </TD> |
|---|
| 1118 | </TR> |
|---|
| 1119 | </TABLE> |
|---|
| 1120 | <P> |
|---|
| 1121 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1122 | <TR CLASS="parameter_title"> |
|---|
| 1123 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1124 | </TR> |
|---|
| 1125 | <TR CLASS="parameters"> |
|---|
| 1126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1127 | <A NAME="_idldoc_write_etc_keyword_title"/> |
|---|
| 1128 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1129 | <FONT CLASS="param_attrib"> |
|---|
| 1130 | </FONT> |
|---|
| 1131 | </TD> |
|---|
| 1132 | <TD VALIGN="top"> |
|---|
| 1133 | . |
|---|
| 1134 | </TD> |
|---|
| 1135 | </TR> |
|---|
| 1136 | <TR CLASS="parameters"> |
|---|
| 1137 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1138 | <A NAME="_idldoc_write_etc_keyword_subtitle"/> |
|---|
| 1139 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1140 | <FONT CLASS="param_attrib"> |
|---|
| 1141 | </FONT> |
|---|
| 1142 | </TD> |
|---|
| 1143 | <TD VALIGN="top"> |
|---|
| 1144 | . |
|---|
| 1145 | </TD> |
|---|
| 1146 | </TR> |
|---|
| 1147 | <TR CLASS="parameters"> |
|---|
| 1148 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1149 | <A NAME="_idldoc_write_etc_keyword_footer"/> |
|---|
| 1150 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1151 | <FONT CLASS="param_attrib"> |
|---|
| 1152 | </FONT> |
|---|
| 1153 | </TD> |
|---|
| 1154 | <TD VALIGN="top"> |
|---|
| 1155 | . |
|---|
| 1156 | </TD> |
|---|
| 1157 | </TR> |
|---|
| 1158 | <TR CLASS="parameters"> |
|---|
| 1159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1160 | <A NAME="_idldoc_write_etc_keyword_embed"/> |
|---|
| 1161 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1162 | <FONT CLASS="param_attrib"> |
|---|
| 1163 | </FONT> |
|---|
| 1164 | </TD> |
|---|
| 1165 | <TD VALIGN="top"> |
|---|
| 1166 | . |
|---|
| 1167 | </TD> |
|---|
| 1168 | </TR> |
|---|
| 1169 | <TR CLASS="parameters"> |
|---|
| 1170 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1171 | <A NAME="_idldoc_write_etc_keyword_nonavbar"/> |
|---|
| 1172 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1173 | <FONT CLASS="param_attrib"> |
|---|
| 1174 | </FONT> |
|---|
| 1175 | </TD> |
|---|
| 1176 | <TD VALIGN="top"> |
|---|
| 1177 | . |
|---|
| 1178 | </TD> |
|---|
| 1179 | </TR> |
|---|
| 1180 | <TR CLASS="parameters"> |
|---|
| 1181 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1182 | <A NAME="_idldoc_write_etc_keyword_user"/> |
|---|
| 1183 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1184 | <FONT CLASS="param_attrib"> |
|---|
| 1185 | </FONT> |
|---|
| 1186 | </TD> |
|---|
| 1187 | <TD VALIGN="top"> |
|---|
| 1188 | . |
|---|
| 1189 | </TD> |
|---|
| 1190 | </TR> |
|---|
| 1191 | <TR CLASS="parameters"> |
|---|
| 1192 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1193 | <A NAME="_idldoc_write_etc_keyword_warnings"/> |
|---|
| 1194 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1195 | <FONT CLASS="param_attrib"> |
|---|
| 1196 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1197 | <NOBR>variable</NOBR> |
|---|
| 1198 | </FONT> |
|---|
| 1199 | </TD> |
|---|
| 1200 | <TD VALIGN="top"> |
|---|
| 1201 | a named variable to return the |
|---|
| 1202 | number of warnings |
|---|
| 1203 | </TD> |
|---|
| 1204 | </TR> |
|---|
| 1205 | </TABLE> |
|---|
| 1206 | <P> |
|---|
| 1207 | <A NAME="_idldoc_write_dir_overview"/> |
|---|
| 1208 | <TABLE CLASS="routine_listing"> |
|---|
| 1209 | <TR><TD> |
|---|
| 1210 | <SPAN CLASS="routine"> |
|---|
| 1211 | idldoc_write_dir_overview |
|---|
| 1212 | </SPAN> |
|---|
| 1213 | </TD><TD ALIGN="right"> |
|---|
| 1214 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1215 | </TD></TR></TABLE> |
|---|
| 1216 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_dir_overview, <A HREF=#_idldoc_write_dir_overview_param_pro_dir>pro_dir</A>, <A HREF=#_idldoc_write_dir_overview_param_pro_files>pro_files</A>, <A HREF=#_idldoc_write_dir_overview_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_nonavbar>nonavbar</A>=<EM>nonavbar</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_file_hash>file_hash</A>=<EM>file_hash</EM>, <A HREF=#_idldoc_write_dir_overview_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_dir_overview_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 1217 | <P> |
|---|
| 1218 | |
|---|
| 1219 | <P> |
|---|
| 1220 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1221 | <TR CLASS="parameter_title"> |
|---|
| 1222 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1223 | </TR> |
|---|
| 1224 | <TR CLASS="parameters"> |
|---|
| 1225 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1226 | <A NAME="_idldoc_write_dir_overview_param_pro_dir"/> |
|---|
| 1227 | <FONT CLASS="param_name">pro_dir</FONT><BR> |
|---|
| 1228 | <FONT CLASS="param_attrib"> |
|---|
| 1229 | </FONT> |
|---|
| 1230 | </TD> |
|---|
| 1231 | <TD VALIGN="top"> |
|---|
| 1232 | . |
|---|
| 1233 | </TD> |
|---|
| 1234 | </TR> |
|---|
| 1235 | <TR CLASS="parameters"> |
|---|
| 1236 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1237 | <A NAME="_idldoc_write_dir_overview_param_pro_files"/> |
|---|
| 1238 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 1239 | <FONT CLASS="param_attrib"> |
|---|
| 1240 | </FONT> |
|---|
| 1241 | </TD> |
|---|
| 1242 | <TD VALIGN="top"> |
|---|
| 1243 | . |
|---|
| 1244 | </TD> |
|---|
| 1245 | </TR> |
|---|
| 1246 | </TABLE> |
|---|
| 1247 | <P> |
|---|
| 1248 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1249 | <TR CLASS="parameter_title"> |
|---|
| 1250 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1251 | </TR> |
|---|
| 1252 | <TR CLASS="parameters"> |
|---|
| 1253 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1254 | <A NAME="_idldoc_write_dir_overview_keyword_title"/> |
|---|
| 1255 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1256 | <FONT CLASS="param_attrib"> |
|---|
| 1257 | </FONT> |
|---|
| 1258 | </TD> |
|---|
| 1259 | <TD VALIGN="top"> |
|---|
| 1260 | . |
|---|
| 1261 | </TD> |
|---|
| 1262 | </TR> |
|---|
| 1263 | <TR CLASS="parameters"> |
|---|
| 1264 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1265 | <A NAME="_idldoc_write_dir_overview_keyword_subtitle"/> |
|---|
| 1266 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1267 | <FONT CLASS="param_attrib"> |
|---|
| 1268 | </FONT> |
|---|
| 1269 | </TD> |
|---|
| 1270 | <TD VALIGN="top"> |
|---|
| 1271 | . |
|---|
| 1272 | </TD> |
|---|
| 1273 | </TR> |
|---|
| 1274 | <TR CLASS="parameters"> |
|---|
| 1275 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1276 | <A NAME="_idldoc_write_dir_overview_keyword_footer"/> |
|---|
| 1277 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1278 | <FONT CLASS="param_attrib"> |
|---|
| 1279 | </FONT> |
|---|
| 1280 | </TD> |
|---|
| 1281 | <TD VALIGN="top"> |
|---|
| 1282 | . |
|---|
| 1283 | </TD> |
|---|
| 1284 | </TR> |
|---|
| 1285 | <TR CLASS="parameters"> |
|---|
| 1286 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1287 | <A NAME="_idldoc_write_dir_overview_keyword_embed"/> |
|---|
| 1288 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1289 | <FONT CLASS="param_attrib"> |
|---|
| 1290 | </FONT> |
|---|
| 1291 | </TD> |
|---|
| 1292 | <TD VALIGN="top"> |
|---|
| 1293 | . |
|---|
| 1294 | </TD> |
|---|
| 1295 | </TR> |
|---|
| 1296 | <TR CLASS="parameters"> |
|---|
| 1297 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1298 | <A NAME="_idldoc_write_dir_overview_keyword_nonavbar"/> |
|---|
| 1299 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1300 | <FONT CLASS="param_attrib"> |
|---|
| 1301 | </FONT> |
|---|
| 1302 | </TD> |
|---|
| 1303 | <TD VALIGN="top"> |
|---|
| 1304 | . |
|---|
| 1305 | </TD> |
|---|
| 1306 | </TR> |
|---|
| 1307 | <TR CLASS="parameters"> |
|---|
| 1308 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1309 | <A NAME="_idldoc_write_dir_overview_keyword_file_hash"/> |
|---|
| 1310 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 1311 | <FONT CLASS="param_attrib"> |
|---|
| 1312 | </FONT> |
|---|
| 1313 | </TD> |
|---|
| 1314 | <TD VALIGN="top"> |
|---|
| 1315 | . |
|---|
| 1316 | </TD> |
|---|
| 1317 | </TR> |
|---|
| 1318 | <TR CLASS="parameters"> |
|---|
| 1319 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1320 | <A NAME="_idldoc_write_dir_overview_keyword_user"/> |
|---|
| 1321 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1322 | <FONT CLASS="param_attrib"> |
|---|
| 1323 | </FONT> |
|---|
| 1324 | </TD> |
|---|
| 1325 | <TD VALIGN="top"> |
|---|
| 1326 | . |
|---|
| 1327 | </TD> |
|---|
| 1328 | </TR> |
|---|
| 1329 | <TR CLASS="parameters"> |
|---|
| 1330 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1331 | <A NAME="_idldoc_write_dir_overview_keyword_warnings"/> |
|---|
| 1332 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1333 | <FONT CLASS="param_attrib"> |
|---|
| 1334 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1335 | <NOBR>variable</NOBR> |
|---|
| 1336 | </FONT> |
|---|
| 1337 | </TD> |
|---|
| 1338 | <TD VALIGN="top"> |
|---|
| 1339 | a named variable to return the |
|---|
| 1340 | number of warnings |
|---|
| 1341 | </TD> |
|---|
| 1342 | </TR> |
|---|
| 1343 | </TABLE> |
|---|
| 1344 | <P> |
|---|
| 1345 | <A NAME="_idldoc_write_directory_overviews"/> |
|---|
| 1346 | <TABLE CLASS="routine_listing"> |
|---|
| 1347 | <TR><TD> |
|---|
| 1348 | <SPAN CLASS="routine"> |
|---|
| 1349 | idldoc_write_directory_overviews |
|---|
| 1350 | </SPAN> |
|---|
| 1351 | </TD><TD ALIGN="right"> |
|---|
| 1352 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1353 | </TD></TR></TABLE> |
|---|
| 1354 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_directory_overviews, <A HREF=#_idldoc_write_directory_overviews_param_pro_dirs>pro_dirs</A>, <A HREF=#_idldoc_write_directory_overviews_param_pro_files>pro_files</A>, <A HREF=#_idldoc_write_directory_overviews_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_nonavbar>nonavbar</A>=<EM>nonavbar</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_file_hash>file_hash</A>=<EM>file_hash</EM>, <A HREF=#_idldoc_write_directory_overviews_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_directory_overviews_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 1355 | <P> |
|---|
| 1356 | |
|---|
| 1357 | <P> |
|---|
| 1358 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1359 | <TR CLASS="parameter_title"> |
|---|
| 1360 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1361 | </TR> |
|---|
| 1362 | <TR CLASS="parameters"> |
|---|
| 1363 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1364 | <A NAME="_idldoc_write_directory_overviews_param_pro_dirs"/> |
|---|
| 1365 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 1366 | <FONT CLASS="param_attrib"> |
|---|
| 1367 | </FONT> |
|---|
| 1368 | </TD> |
|---|
| 1369 | <TD VALIGN="top"> |
|---|
| 1370 | . |
|---|
| 1371 | </TD> |
|---|
| 1372 | </TR> |
|---|
| 1373 | <TR CLASS="parameters"> |
|---|
| 1374 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1375 | <A NAME="_idldoc_write_directory_overviews_param_pro_files"/> |
|---|
| 1376 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 1377 | <FONT CLASS="param_attrib"> |
|---|
| 1378 | </FONT> |
|---|
| 1379 | </TD> |
|---|
| 1380 | <TD VALIGN="top"> |
|---|
| 1381 | . |
|---|
| 1382 | </TD> |
|---|
| 1383 | </TR> |
|---|
| 1384 | </TABLE> |
|---|
| 1385 | <P> |
|---|
| 1386 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1387 | <TR CLASS="parameter_title"> |
|---|
| 1388 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1389 | </TR> |
|---|
| 1390 | <TR CLASS="parameters"> |
|---|
| 1391 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1392 | <A NAME="_idldoc_write_directory_overviews_keyword_title"/> |
|---|
| 1393 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1394 | <FONT CLASS="param_attrib"> |
|---|
| 1395 | </FONT> |
|---|
| 1396 | </TD> |
|---|
| 1397 | <TD VALIGN="top"> |
|---|
| 1398 | . |
|---|
| 1399 | </TD> |
|---|
| 1400 | </TR> |
|---|
| 1401 | <TR CLASS="parameters"> |
|---|
| 1402 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1403 | <A NAME="_idldoc_write_directory_overviews_keyword_subtitle"/> |
|---|
| 1404 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1405 | <FONT CLASS="param_attrib"> |
|---|
| 1406 | </FONT> |
|---|
| 1407 | </TD> |
|---|
| 1408 | <TD VALIGN="top"> |
|---|
| 1409 | . |
|---|
| 1410 | </TD> |
|---|
| 1411 | </TR> |
|---|
| 1412 | <TR CLASS="parameters"> |
|---|
| 1413 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1414 | <A NAME="_idldoc_write_directory_overviews_keyword_footer"/> |
|---|
| 1415 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1416 | <FONT CLASS="param_attrib"> |
|---|
| 1417 | </FONT> |
|---|
| 1418 | </TD> |
|---|
| 1419 | <TD VALIGN="top"> |
|---|
| 1420 | . |
|---|
| 1421 | </TD> |
|---|
| 1422 | </TR> |
|---|
| 1423 | <TR CLASS="parameters"> |
|---|
| 1424 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1425 | <A NAME="_idldoc_write_directory_overviews_keyword_embed"/> |
|---|
| 1426 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1427 | <FONT CLASS="param_attrib"> |
|---|
| 1428 | </FONT> |
|---|
| 1429 | </TD> |
|---|
| 1430 | <TD VALIGN="top"> |
|---|
| 1431 | . |
|---|
| 1432 | </TD> |
|---|
| 1433 | </TR> |
|---|
| 1434 | <TR CLASS="parameters"> |
|---|
| 1435 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1436 | <A NAME="_idldoc_write_directory_overviews_keyword_nonavbar"/> |
|---|
| 1437 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1438 | <FONT CLASS="param_attrib"> |
|---|
| 1439 | </FONT> |
|---|
| 1440 | </TD> |
|---|
| 1441 | <TD VALIGN="top"> |
|---|
| 1442 | . |
|---|
| 1443 | </TD> |
|---|
| 1444 | </TR> |
|---|
| 1445 | <TR CLASS="parameters"> |
|---|
| 1446 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1447 | <A NAME="_idldoc_write_directory_overviews_keyword_file_hash"/> |
|---|
| 1448 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 1449 | <FONT CLASS="param_attrib"> |
|---|
| 1450 | </FONT> |
|---|
| 1451 | </TD> |
|---|
| 1452 | <TD VALIGN="top"> |
|---|
| 1453 | . |
|---|
| 1454 | </TD> |
|---|
| 1455 | </TR> |
|---|
| 1456 | <TR CLASS="parameters"> |
|---|
| 1457 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1458 | <A NAME="_idldoc_write_directory_overviews_keyword_user"/> |
|---|
| 1459 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1460 | <FONT CLASS="param_attrib"> |
|---|
| 1461 | </FONT> |
|---|
| 1462 | </TD> |
|---|
| 1463 | <TD VALIGN="top"> |
|---|
| 1464 | . |
|---|
| 1465 | </TD> |
|---|
| 1466 | </TR> |
|---|
| 1467 | <TR CLASS="parameters"> |
|---|
| 1468 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1469 | <A NAME="_idldoc_write_directory_overviews_keyword_warnings"/> |
|---|
| 1470 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1471 | <FONT CLASS="param_attrib"> |
|---|
| 1472 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1473 | <NOBR>variable</NOBR> |
|---|
| 1474 | </FONT> |
|---|
| 1475 | </TD> |
|---|
| 1476 | <TD VALIGN="top"> |
|---|
| 1477 | a named variable to return the |
|---|
| 1478 | number of warnings |
|---|
| 1479 | </TD> |
|---|
| 1480 | </TR> |
|---|
| 1481 | </TABLE> |
|---|
| 1482 | <P> |
|---|
| 1483 | <A NAME="_idldoc_write_full_index"/> |
|---|
| 1484 | <TABLE CLASS="routine_listing"> |
|---|
| 1485 | <TR><TD> |
|---|
| 1486 | <SPAN CLASS="routine"> |
|---|
| 1487 | idldoc_write_full_index |
|---|
| 1488 | </SPAN> |
|---|
| 1489 | </TD><TD ALIGN="right"> |
|---|
| 1490 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1491 | </TD></TR></TABLE> |
|---|
| 1492 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_full_index, <A HREF=#_idldoc_write_full_index_param_index_hash>index_hash</A>, <A HREF=#_idldoc_write_full_index_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_full_index_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_full_index_keyword_footer>footer</A>=<EM>footer</EM>, <A HREF=#_idldoc_write_full_index_keyword_embed>embed</A>=<EM>embed</EM>, <A HREF=#_idldoc_write_full_index_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_full_index_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 1493 | <P> |
|---|
| 1494 | |
|---|
| 1495 | Create the index for the library. |
|---|
| 1496 | |
|---|
| 1497 | <P> |
|---|
| 1498 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1499 | <TR CLASS="parameter_title"> |
|---|
| 1500 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1501 | </TR> |
|---|
| 1502 | <TR CLASS="parameters"> |
|---|
| 1503 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1504 | <A NAME="_idldoc_write_full_index_param_index_hash"/> |
|---|
| 1505 | <FONT CLASS="param_name">index_hash</FONT><BR> |
|---|
| 1506 | <FONT CLASS="param_attrib"> |
|---|
| 1507 | <NOBR>in</NOBR><BR> |
|---|
| 1508 | <NOBR>obj ref</NOBR> |
|---|
| 1509 | </FONT> |
|---|
| 1510 | </TD> |
|---|
| 1511 | <TD VALIGN="top"> |
|---|
| 1512 | hash table of index references |
|---|
| 1513 | </TD> |
|---|
| 1514 | </TR> |
|---|
| 1515 | </TABLE> |
|---|
| 1516 | <P> |
|---|
| 1517 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1518 | <TR CLASS="parameter_title"> |
|---|
| 1519 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1520 | </TR> |
|---|
| 1521 | <TR CLASS="parameters"> |
|---|
| 1522 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1523 | <A NAME="_idldoc_write_full_index_keyword_title"/> |
|---|
| 1524 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1525 | <FONT CLASS="param_attrib"> |
|---|
| 1526 | </FONT> |
|---|
| 1527 | </TD> |
|---|
| 1528 | <TD VALIGN="top"> |
|---|
| 1529 | . |
|---|
| 1530 | </TD> |
|---|
| 1531 | </TR> |
|---|
| 1532 | <TR CLASS="parameters"> |
|---|
| 1533 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1534 | <A NAME="_idldoc_write_full_index_keyword_subtitle"/> |
|---|
| 1535 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1536 | <FONT CLASS="param_attrib"> |
|---|
| 1537 | </FONT> |
|---|
| 1538 | </TD> |
|---|
| 1539 | <TD VALIGN="top"> |
|---|
| 1540 | . |
|---|
| 1541 | </TD> |
|---|
| 1542 | </TR> |
|---|
| 1543 | <TR CLASS="parameters"> |
|---|
| 1544 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1545 | <A NAME="_idldoc_write_full_index_keyword_footer"/> |
|---|
| 1546 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1547 | <FONT CLASS="param_attrib"> |
|---|
| 1548 | </FONT> |
|---|
| 1549 | </TD> |
|---|
| 1550 | <TD VALIGN="top"> |
|---|
| 1551 | . |
|---|
| 1552 | </TD> |
|---|
| 1553 | </TR> |
|---|
| 1554 | <TR CLASS="parameters"> |
|---|
| 1555 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1556 | <A NAME="_idldoc_write_full_index_keyword_embed"/> |
|---|
| 1557 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1558 | <FONT CLASS="param_attrib"> |
|---|
| 1559 | </FONT> |
|---|
| 1560 | </TD> |
|---|
| 1561 | <TD VALIGN="top"> |
|---|
| 1562 | . |
|---|
| 1563 | </TD> |
|---|
| 1564 | </TR> |
|---|
| 1565 | <TR CLASS="parameters"> |
|---|
| 1566 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1567 | <A NAME="_idldoc_write_full_index_keyword_user"/> |
|---|
| 1568 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1569 | <FONT CLASS="param_attrib"> |
|---|
| 1570 | </FONT> |
|---|
| 1571 | </TD> |
|---|
| 1572 | <TD VALIGN="top"> |
|---|
| 1573 | . |
|---|
| 1574 | </TD> |
|---|
| 1575 | </TR> |
|---|
| 1576 | <TR CLASS="parameters"> |
|---|
| 1577 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1578 | <A NAME="_idldoc_write_full_index_keyword_warnings"/> |
|---|
| 1579 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1580 | <FONT CLASS="param_attrib"> |
|---|
| 1581 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1582 | <NOBR>variable</NOBR> |
|---|
| 1583 | </FONT> |
|---|
| 1584 | </TD> |
|---|
| 1585 | <TD VALIGN="top"> |
|---|
| 1586 | a named variable to return the |
|---|
| 1587 | number of warnings |
|---|
| 1588 | </TD> |
|---|
| 1589 | </TR> |
|---|
| 1590 | </TABLE> |
|---|
| 1591 | <P> |
|---|
| 1592 | <A NAME="_idldoc_write_overview"/> |
|---|
| 1593 | <TABLE CLASS="routine_listing"> |
|---|
| 1594 | <TR><TD> |
|---|
| 1595 | <SPAN CLASS="routine"> |
|---|
| 1596 | idldoc_write_overview |
|---|
| 1597 | </SPAN> |
|---|
| 1598 | </TD><TD ALIGN="right"> |
|---|
| 1599 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1600 | </TD></TR></TABLE> |
|---|
| 1601 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_overview, <A HREF=#_idldoc_write_overview_param_overview>overview</A>, <A HREF=#_idldoc_write_overview_param_pro_dirs>pro_dirs</A>, [<A HREF=#_idldoc_write_overview_keyword_warnings>warnings</A>=<EM>variable</EM>], [/<A HREF=#_idldoc_write_overview_keyword_user>user</A>], [/<A HREF=#_idldoc_write_overview_keyword_embed>embed</A>], [/<A HREF=#_idldoc_write_overview_keyword_nonavbar>nonavbar</A>], <A HREF=#_idldoc_write_overview_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_overview_keyword_subtitle>subtitle</A>=<EM>subtitle</EM>, <A HREF=#_idldoc_write_overview_keyword_footer>footer</A>=<EM>footer</EM></P></TD></TR></TABLE> |
|---|
| 1602 | <P> |
|---|
| 1603 | |
|---|
| 1604 | Processes the file specified by the OVERVIEW keyword to IDLdoc (if present) |
|---|
| 1605 | and creates the 'overview.html' file that shows in the main browser |
|---|
| 1606 | frame when loading the 'index.html' file. Always shows at least all |
|---|
| 1607 | subdirectories with IDL .pro files in them. |
|---|
| 1608 | |
|---|
| 1609 | <P> |
|---|
| 1610 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1611 | <TR CLASS="parameter_title"> |
|---|
| 1612 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1613 | </TR> |
|---|
| 1614 | <TR CLASS="parameters"> |
|---|
| 1615 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1616 | <A NAME="_idldoc_write_overview_param_overview"/> |
|---|
| 1617 | <FONT CLASS="param_name">overview</FONT><BR> |
|---|
| 1618 | <FONT CLASS="param_attrib"> |
|---|
| 1619 | <NOBR>in</NOBR><BR> |
|---|
| 1620 | <NOBR>string</NOBR> |
|---|
| 1621 | </FONT> |
|---|
| 1622 | </TD> |
|---|
| 1623 | <TD VALIGN="top"> |
|---|
| 1624 | filename of the content to be placed in |
|---|
| 1625 | the overview.html file |
|---|
| 1626 | </TD> |
|---|
| 1627 | </TR> |
|---|
| 1628 | <TR CLASS="parameters"> |
|---|
| 1629 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1630 | <A NAME="_idldoc_write_overview_param_pro_dirs"/> |
|---|
| 1631 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 1632 | <FONT CLASS="param_attrib"> |
|---|
| 1633 | <NOBR>in</NOBR><BR> |
|---|
| 1634 | <NOBR>string array</NOBR> |
|---|
| 1635 | </FONT> |
|---|
| 1636 | </TD> |
|---|
| 1637 | <TD VALIGN="top"> |
|---|
| 1638 | a list of the directories containing |
|---|
| 1639 | .pro code below the root directory |
|---|
| 1640 | </TD> |
|---|
| 1641 | </TR> |
|---|
| 1642 | </TABLE> |
|---|
| 1643 | <P> |
|---|
| 1644 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1645 | <TR CLASS="parameter_title"> |
|---|
| 1646 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1647 | </TR> |
|---|
| 1648 | <TR CLASS="parameters"> |
|---|
| 1649 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1650 | <A NAME="_idldoc_write_overview_keyword_warnings"/> |
|---|
| 1651 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1652 | <FONT CLASS="param_attrib"> |
|---|
| 1653 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1654 | <NOBR>variable</NOBR> |
|---|
| 1655 | </FONT> |
|---|
| 1656 | </TD> |
|---|
| 1657 | <TD VALIGN="top"> |
|---|
| 1658 | a named variable to return the |
|---|
| 1659 | number of warnings |
|---|
| 1660 | </TD> |
|---|
| 1661 | </TR> |
|---|
| 1662 | <TR CLASS="parameters"> |
|---|
| 1663 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1664 | <A NAME="_idldoc_write_overview_keyword_user"/> |
|---|
| 1665 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1666 | <FONT CLASS="param_attrib"> |
|---|
| 1667 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1668 | <NOBR>boolean</NOBR> |
|---|
| 1669 | </FONT> |
|---|
| 1670 | </TD> |
|---|
| 1671 | <TD VALIGN="top"> |
|---|
| 1672 | set to give user documentation; |
|---|
| 1673 | otherwise developer documentation is produced |
|---|
| 1674 | </TD> |
|---|
| 1675 | </TR> |
|---|
| 1676 | <TR CLASS="parameters"> |
|---|
| 1677 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1678 | <A NAME="_idldoc_write_overview_keyword_embed"/> |
|---|
| 1679 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1680 | <FONT CLASS="param_attrib"> |
|---|
| 1681 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1682 | <NOBR>boolean</NOBR> |
|---|
| 1683 | </FONT> |
|---|
| 1684 | </TD> |
|---|
| 1685 | <TD VALIGN="top"> |
|---|
| 1686 | if set, embeds style sheet in |
|---|
| 1687 | each HTML document |
|---|
| 1688 | </TD> |
|---|
| 1689 | </TR> |
|---|
| 1690 | <TR CLASS="parameters"> |
|---|
| 1691 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1692 | <A NAME="_idldoc_write_overview_keyword_nonavbar"/> |
|---|
| 1693 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1694 | <FONT CLASS="param_attrib"> |
|---|
| 1695 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1696 | <NOBR>boolean (def. false)</NOBR> |
|---|
| 1697 | </FONT> |
|---|
| 1698 | </TD> |
|---|
| 1699 | <TD VALIGN="top"> |
|---|
| 1700 | set to exclude |
|---|
| 1701 | navbar on overview page |
|---|
| 1702 | </TD> |
|---|
| 1703 | </TR> |
|---|
| 1704 | <TR CLASS="parameters"> |
|---|
| 1705 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1706 | <A NAME="_idldoc_write_overview_keyword_title"/> |
|---|
| 1707 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1708 | <FONT CLASS="param_attrib"> |
|---|
| 1709 | </FONT> |
|---|
| 1710 | </TD> |
|---|
| 1711 | <TD VALIGN="top"> |
|---|
| 1712 | . |
|---|
| 1713 | </TD> |
|---|
| 1714 | </TR> |
|---|
| 1715 | <TR CLASS="parameters"> |
|---|
| 1716 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1717 | <A NAME="_idldoc_write_overview_keyword_subtitle"/> |
|---|
| 1718 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1719 | <FONT CLASS="param_attrib"> |
|---|
| 1720 | </FONT> |
|---|
| 1721 | </TD> |
|---|
| 1722 | <TD VALIGN="top"> |
|---|
| 1723 | . |
|---|
| 1724 | </TD> |
|---|
| 1725 | </TR> |
|---|
| 1726 | <TR CLASS="parameters"> |
|---|
| 1727 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1728 | <A NAME="_idldoc_write_overview_keyword_footer"/> |
|---|
| 1729 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 1730 | <FONT CLASS="param_attrib"> |
|---|
| 1731 | </FONT> |
|---|
| 1732 | </TD> |
|---|
| 1733 | <TD VALIGN="top"> |
|---|
| 1734 | . |
|---|
| 1735 | </TD> |
|---|
| 1736 | </TR> |
|---|
| 1737 | </TABLE> |
|---|
| 1738 | <P> |
|---|
| 1739 | <A NAME="_idldoc_write_blank"/> |
|---|
| 1740 | <TABLE CLASS="routine_listing"> |
|---|
| 1741 | <TR><TD> |
|---|
| 1742 | <SPAN CLASS="routine"> |
|---|
| 1743 | idldoc_write_blank |
|---|
| 1744 | </SPAN> |
|---|
| 1745 | </TD><TD ALIGN="right"> |
|---|
| 1746 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1747 | </TD></TR></TABLE> |
|---|
| 1748 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_blank, [<A HREF=#_idldoc_write_blank_keyword_warnings>warnings</A>=<EM>variable</EM>], <A HREF=#_idldoc_write_blank_keyword_embed>embed</A>=<EM>embed</EM></P></TD></TR></TABLE> |
|---|
| 1749 | <P> |
|---|
| 1750 | |
|---|
| 1751 | Create a blank file for the initial routines frame. |
|---|
| 1752 | |
|---|
| 1753 | <P> |
|---|
| 1754 | <P> |
|---|
| 1755 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1756 | <TR CLASS="parameter_title"> |
|---|
| 1757 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1758 | </TR> |
|---|
| 1759 | <TR CLASS="parameters"> |
|---|
| 1760 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1761 | <A NAME="_idldoc_write_blank_keyword_warnings"/> |
|---|
| 1762 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1763 | <FONT CLASS="param_attrib"> |
|---|
| 1764 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1765 | <NOBR>variable</NOBR> |
|---|
| 1766 | </FONT> |
|---|
| 1767 | </TD> |
|---|
| 1768 | <TD VALIGN="top"> |
|---|
| 1769 | a named variable to return the |
|---|
| 1770 | number of warnings |
|---|
| 1771 | </TD> |
|---|
| 1772 | </TR> |
|---|
| 1773 | <TR CLASS="parameters"> |
|---|
| 1774 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1775 | <A NAME="_idldoc_write_blank_keyword_embed"/> |
|---|
| 1776 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1777 | <FONT CLASS="param_attrib"> |
|---|
| 1778 | </FONT> |
|---|
| 1779 | </TD> |
|---|
| 1780 | <TD VALIGN="top"> |
|---|
| 1781 | . |
|---|
| 1782 | </TD> |
|---|
| 1783 | </TR> |
|---|
| 1784 | </TABLE> |
|---|
| 1785 | <P> |
|---|
| 1786 | <A NAME="_idldoc_write_help"/> |
|---|
| 1787 | <TABLE CLASS="routine_listing"> |
|---|
| 1788 | <TR><TD> |
|---|
| 1789 | <SPAN CLASS="routine"> |
|---|
| 1790 | idldoc_write_help |
|---|
| 1791 | </SPAN> |
|---|
| 1792 | </TD><TD ALIGN="right"> |
|---|
| 1793 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1794 | </TD></TR></TABLE> |
|---|
| 1795 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_help, [<A HREF=#_idldoc_write_help_keyword_warnings>warnings</A>=<EM>variable</EM>], [/<A HREF=#_idldoc_write_help_keyword_user>user</A>], [/<A HREF=#_idldoc_write_help_keyword_embed>embed</A>], [/<A HREF=#_idldoc_write_help_keyword_nonavbar>nonavbar</A>], <A HREF=#_idldoc_write_help_keyword_title>title</A>=<EM>title</EM>, <A HREF=#_idldoc_write_help_keyword_subtitle>subtitle</A>=<EM>subtitle</EM></P></TD></TR></TABLE> |
|---|
| 1796 | <P> |
|---|
| 1797 | |
|---|
| 1798 | Create help.html in the root directory. Assumes the current working |
|---|
| 1799 | directory is the root directory. |
|---|
| 1800 | |
|---|
| 1801 | <P> |
|---|
| 1802 | <P> |
|---|
| 1803 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1804 | <TR CLASS="parameter_title"> |
|---|
| 1805 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1806 | </TR> |
|---|
| 1807 | <TR CLASS="parameters"> |
|---|
| 1808 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1809 | <A NAME="_idldoc_write_help_keyword_warnings"/> |
|---|
| 1810 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1811 | <FONT CLASS="param_attrib"> |
|---|
| 1812 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1813 | <NOBR>variable</NOBR> |
|---|
| 1814 | </FONT> |
|---|
| 1815 | </TD> |
|---|
| 1816 | <TD VALIGN="top"> |
|---|
| 1817 | a named variable to return the |
|---|
| 1818 | number of warnings |
|---|
| 1819 | </TD> |
|---|
| 1820 | </TR> |
|---|
| 1821 | <TR CLASS="parameters"> |
|---|
| 1822 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1823 | <A NAME="_idldoc_write_help_keyword_user"/> |
|---|
| 1824 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 1825 | <FONT CLASS="param_attrib"> |
|---|
| 1826 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1827 | <NOBR>boolean</NOBR> |
|---|
| 1828 | </FONT> |
|---|
| 1829 | </TD> |
|---|
| 1830 | <TD VALIGN="top"> |
|---|
| 1831 | set to give user documentation; |
|---|
| 1832 | otherwise developer documentation is produced |
|---|
| 1833 | </TD> |
|---|
| 1834 | </TR> |
|---|
| 1835 | <TR CLASS="parameters"> |
|---|
| 1836 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1837 | <A NAME="_idldoc_write_help_keyword_embed"/> |
|---|
| 1838 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 1839 | <FONT CLASS="param_attrib"> |
|---|
| 1840 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1841 | <NOBR>boolean</NOBR> |
|---|
| 1842 | </FONT> |
|---|
| 1843 | </TD> |
|---|
| 1844 | <TD VALIGN="top"> |
|---|
| 1845 | if set, embeds style sheet in |
|---|
| 1846 | each HTML document |
|---|
| 1847 | </TD> |
|---|
| 1848 | </TR> |
|---|
| 1849 | <TR CLASS="parameters"> |
|---|
| 1850 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1851 | <A NAME="_idldoc_write_help_keyword_nonavbar"/> |
|---|
| 1852 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 1853 | <FONT CLASS="param_attrib"> |
|---|
| 1854 | <NOBR>in, optional</NOBR><BR> |
|---|
| 1855 | <NOBR>boolean (def. false)</NOBR> |
|---|
| 1856 | </FONT> |
|---|
| 1857 | </TD> |
|---|
| 1858 | <TD VALIGN="top"> |
|---|
| 1859 | set to exclude |
|---|
| 1860 | navbar on help page |
|---|
| 1861 | </TD> |
|---|
| 1862 | </TR> |
|---|
| 1863 | <TR CLASS="parameters"> |
|---|
| 1864 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1865 | <A NAME="_idldoc_write_help_keyword_title"/> |
|---|
| 1866 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1867 | <FONT CLASS="param_attrib"> |
|---|
| 1868 | </FONT> |
|---|
| 1869 | </TD> |
|---|
| 1870 | <TD VALIGN="top"> |
|---|
| 1871 | . |
|---|
| 1872 | </TD> |
|---|
| 1873 | </TR> |
|---|
| 1874 | <TR CLASS="parameters"> |
|---|
| 1875 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1876 | <A NAME="_idldoc_write_help_keyword_subtitle"/> |
|---|
| 1877 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 1878 | <FONT CLASS="param_attrib"> |
|---|
| 1879 | </FONT> |
|---|
| 1880 | </TD> |
|---|
| 1881 | <TD VALIGN="top"> |
|---|
| 1882 | . |
|---|
| 1883 | </TD> |
|---|
| 1884 | </TR> |
|---|
| 1885 | </TABLE> |
|---|
| 1886 | <P> |
|---|
| 1887 | <A NAME="_idldoc_write_index"/> |
|---|
| 1888 | <TABLE CLASS="routine_listing"> |
|---|
| 1889 | <TR><TD> |
|---|
| 1890 | <SPAN CLASS="routine"> |
|---|
| 1891 | idldoc_write_index |
|---|
| 1892 | </SPAN> |
|---|
| 1893 | </TD><TD ALIGN="right"> |
|---|
| 1894 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1895 | </TD></TR></TABLE> |
|---|
| 1896 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_index, <A HREF=#_idldoc_write_index_param_pro_dirs>pro_dirs</A>, <A HREF=#_idldoc_write_index_keyword_title>title</A>=<EM>title</EM>, [<A HREF=#_idldoc_write_index_keyword_warnings>warnings</A>=<EM>variable</EM>], <A HREF=#_idldoc_write_index_keyword_browse_routines>browse_routines</A>=<EM>browse_routines</EM></P></TD></TR></TABLE> |
|---|
| 1897 | <P> |
|---|
| 1898 | |
|---|
| 1899 | Create index.html in the root directory. Assumes the current working |
|---|
| 1900 | directory is the root directory. |
|---|
| 1901 | |
|---|
| 1902 | <P> |
|---|
| 1903 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1904 | <TR CLASS="parameter_title"> |
|---|
| 1905 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1906 | </TR> |
|---|
| 1907 | <TR CLASS="parameters"> |
|---|
| 1908 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1909 | <A NAME="_idldoc_write_index_param_pro_dirs"/> |
|---|
| 1910 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 1911 | <FONT CLASS="param_attrib"> |
|---|
| 1912 | <NOBR>in, required</NOBR><BR> |
|---|
| 1913 | <NOBR>strarr</NOBR> |
|---|
| 1914 | </FONT> |
|---|
| 1915 | </TD> |
|---|
| 1916 | <TD VALIGN="top"> |
|---|
| 1917 | directories with .PRO code in them |
|---|
| 1918 | </TD> |
|---|
| 1919 | </TR> |
|---|
| 1920 | </TABLE> |
|---|
| 1921 | <P> |
|---|
| 1922 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1923 | <TR CLASS="parameter_title"> |
|---|
| 1924 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 1925 | </TR> |
|---|
| 1926 | <TR CLASS="parameters"> |
|---|
| 1927 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1928 | <A NAME="_idldoc_write_index_keyword_title"/> |
|---|
| 1929 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 1930 | <FONT CLASS="param_attrib"> |
|---|
| 1931 | </FONT> |
|---|
| 1932 | </TD> |
|---|
| 1933 | <TD VALIGN="top"> |
|---|
| 1934 | . |
|---|
| 1935 | </TD> |
|---|
| 1936 | </TR> |
|---|
| 1937 | <TR CLASS="parameters"> |
|---|
| 1938 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1939 | <A NAME="_idldoc_write_index_keyword_warnings"/> |
|---|
| 1940 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 1941 | <FONT CLASS="param_attrib"> |
|---|
| 1942 | <NOBR>out, optional</NOBR><BR> |
|---|
| 1943 | <NOBR>variable</NOBR> |
|---|
| 1944 | </FONT> |
|---|
| 1945 | </TD> |
|---|
| 1946 | <TD VALIGN="top"> |
|---|
| 1947 | a named variable to return the |
|---|
| 1948 | number of warnings |
|---|
| 1949 | </TD> |
|---|
| 1950 | </TR> |
|---|
| 1951 | <TR CLASS="parameters"> |
|---|
| 1952 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1953 | <A NAME="_idldoc_write_index_keyword_browse_routines"/> |
|---|
| 1954 | <FONT CLASS="param_name">browse_routines</FONT><BR> |
|---|
| 1955 | <FONT CLASS="param_attrib"> |
|---|
| 1956 | </FONT> |
|---|
| 1957 | </TD> |
|---|
| 1958 | <TD VALIGN="top"> |
|---|
| 1959 | . |
|---|
| 1960 | </TD> |
|---|
| 1961 | </TR> |
|---|
| 1962 | </TABLE> |
|---|
| 1963 | <P> |
|---|
| 1964 | <A NAME="_idldoc_write_dir_files"/> |
|---|
| 1965 | <TABLE CLASS="routine_listing"> |
|---|
| 1966 | <TR><TD> |
|---|
| 1967 | <SPAN CLASS="routine"> |
|---|
| 1968 | idldoc_write_dir_files |
|---|
| 1969 | </SPAN> |
|---|
| 1970 | </TD><TD ALIGN="right"> |
|---|
| 1971 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 1972 | </TD></TR></TABLE> |
|---|
| 1973 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_dir_files, <A HREF=#_idldoc_write_dir_files_param_pro_files>pro_files</A>, <A HREF=#_idldoc_write_dir_files_param_pro_dir>pro_dir</A>, [/<A HREF=#_idldoc_write_dir_files_keyword_embed>embed</A>], <A HREF=#_idldoc_write_dir_files_keyword_user>user</A>=<EM>user</EM>, <A HREF=#_idldoc_write_dir_files_keyword_file_hash>file_hash</A>=<EM>file_hash</EM>, [<A HREF=#_idldoc_write_dir_files_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 1974 | <P> |
|---|
| 1975 | |
|---|
| 1976 | Writes the 'dir-files.html' file in each directory that contains the |
|---|
| 1977 | links to each of the .pro files in that directory. |
|---|
| 1978 | |
|---|
| 1979 | <P> |
|---|
| 1980 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 1981 | <TR CLASS="parameter_title"> |
|---|
| 1982 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 1983 | </TR> |
|---|
| 1984 | <TR CLASS="parameters"> |
|---|
| 1985 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 1986 | <A NAME="_idldoc_write_dir_files_param_pro_files"/> |
|---|
| 1987 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 1988 | <FONT CLASS="param_attrib"> |
|---|
| 1989 | <NOBR>in</NOBR><BR> |
|---|
| 1990 | <NOBR>string array</NOBR> |
|---|
| 1991 | </FONT> |
|---|
| 1992 | </TD> |
|---|
| 1993 | <TD VALIGN="top"> |
|---|
| 1994 | a string array of all the pro |
|---|
| 1995 | files under the 'root' directory |
|---|
| 1996 | </TD> |
|---|
| 1997 | </TR> |
|---|
| 1998 | <TR CLASS="parameters"> |
|---|
| 1999 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2000 | <A NAME="_idldoc_write_dir_files_param_pro_dir"/> |
|---|
| 2001 | <FONT CLASS="param_name">pro_dir</FONT><BR> |
|---|
| 2002 | <FONT CLASS="param_attrib"> |
|---|
| 2003 | <NOBR>in</NOBR><BR> |
|---|
| 2004 | <NOBR>string</NOBR> |
|---|
| 2005 | </FONT> |
|---|
| 2006 | </TD> |
|---|
| 2007 | <TD VALIGN="top"> |
|---|
| 2008 | string representing the current directory |
|---|
| 2009 | </TD> |
|---|
| 2010 | </TR> |
|---|
| 2011 | </TABLE> |
|---|
| 2012 | <P> |
|---|
| 2013 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2014 | <TR CLASS="parameter_title"> |
|---|
| 2015 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 2016 | </TR> |
|---|
| 2017 | <TR CLASS="parameters"> |
|---|
| 2018 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2019 | <A NAME="_idldoc_write_dir_files_keyword_embed"/> |
|---|
| 2020 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 2021 | <FONT CLASS="param_attrib"> |
|---|
| 2022 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2023 | <NOBR>boolean</NOBR> |
|---|
| 2024 | </FONT> |
|---|
| 2025 | </TD> |
|---|
| 2026 | <TD VALIGN="top"> |
|---|
| 2027 | if set, embeds style sheet in |
|---|
| 2028 | each HTML document |
|---|
| 2029 | </TD> |
|---|
| 2030 | </TR> |
|---|
| 2031 | <TR CLASS="parameters"> |
|---|
| 2032 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2033 | <A NAME="_idldoc_write_dir_files_keyword_user"/> |
|---|
| 2034 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 2035 | <FONT CLASS="param_attrib"> |
|---|
| 2036 | </FONT> |
|---|
| 2037 | </TD> |
|---|
| 2038 | <TD VALIGN="top"> |
|---|
| 2039 | . |
|---|
| 2040 | </TD> |
|---|
| 2041 | </TR> |
|---|
| 2042 | <TR CLASS="parameters"> |
|---|
| 2043 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2044 | <A NAME="_idldoc_write_dir_files_keyword_file_hash"/> |
|---|
| 2045 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 2046 | <FONT CLASS="param_attrib"> |
|---|
| 2047 | </FONT> |
|---|
| 2048 | </TD> |
|---|
| 2049 | <TD VALIGN="top"> |
|---|
| 2050 | . |
|---|
| 2051 | </TD> |
|---|
| 2052 | </TR> |
|---|
| 2053 | <TR CLASS="parameters"> |
|---|
| 2054 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2055 | <A NAME="_idldoc_write_dir_files_keyword_warnings"/> |
|---|
| 2056 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 2057 | <FONT CLASS="param_attrib"> |
|---|
| 2058 | <NOBR>out, optional</NOBR><BR> |
|---|
| 2059 | <NOBR>variable</NOBR> |
|---|
| 2060 | </FONT> |
|---|
| 2061 | </TD> |
|---|
| 2062 | <TD VALIGN="top"> |
|---|
| 2063 | a named variable to return the |
|---|
| 2064 | number of warnings |
|---|
| 2065 | </TD> |
|---|
| 2066 | </TR> |
|---|
| 2067 | </TABLE> |
|---|
| 2068 | <P> |
|---|
| 2069 | <A NAME="_idldoc_write_all_files"/> |
|---|
| 2070 | <TABLE CLASS="routine_listing"> |
|---|
| 2071 | <TR><TD> |
|---|
| 2072 | <SPAN CLASS="routine"> |
|---|
| 2073 | idldoc_write_all_files |
|---|
| 2074 | </SPAN> |
|---|
| 2075 | </TD><TD ALIGN="right"> |
|---|
| 2076 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 2077 | </TD></TR></TABLE> |
|---|
| 2078 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_all_files, <A HREF=#_idldoc_write_all_files_param_pro_files>pro_files</A>, [/<A HREF=#_idldoc_write_all_files_keyword_embed>embed</A>], <A HREF=#_idldoc_write_all_files_keyword_file_hash>file_hash</A>=<EM>file_hash</EM>, <A HREF=#_idldoc_write_all_files_keyword_user>user</A>=<EM>user</EM>, [<A HREF=#_idldoc_write_all_files_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 2079 | <P> |
|---|
| 2080 | |
|---|
| 2081 | Writes the all-files.html file in the root directory. |
|---|
| 2082 | |
|---|
| 2083 | <P> |
|---|
| 2084 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2085 | <TR CLASS="parameter_title"> |
|---|
| 2086 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 2087 | </TR> |
|---|
| 2088 | <TR CLASS="parameters"> |
|---|
| 2089 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2090 | <A NAME="_idldoc_write_all_files_param_pro_files"/> |
|---|
| 2091 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 2092 | <FONT CLASS="param_attrib"> |
|---|
| 2093 | <NOBR>in</NOBR><BR> |
|---|
| 2094 | <NOBR>string array</NOBR> |
|---|
| 2095 | </FONT> |
|---|
| 2096 | </TD> |
|---|
| 2097 | <TD VALIGN="top"> |
|---|
| 2098 | a string array of all the pro |
|---|
| 2099 | files under the 'root' directory |
|---|
| 2100 | </TD> |
|---|
| 2101 | </TR> |
|---|
| 2102 | </TABLE> |
|---|
| 2103 | <P> |
|---|
| 2104 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2105 | <TR CLASS="parameter_title"> |
|---|
| 2106 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 2107 | </TR> |
|---|
| 2108 | <TR CLASS="parameters"> |
|---|
| 2109 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2110 | <A NAME="_idldoc_write_all_files_keyword_embed"/> |
|---|
| 2111 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 2112 | <FONT CLASS="param_attrib"> |
|---|
| 2113 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2114 | <NOBR>boolean</NOBR> |
|---|
| 2115 | </FONT> |
|---|
| 2116 | </TD> |
|---|
| 2117 | <TD VALIGN="top"> |
|---|
| 2118 | if set, embeds style sheet in |
|---|
| 2119 | each HTML document |
|---|
| 2120 | </TD> |
|---|
| 2121 | </TR> |
|---|
| 2122 | <TR CLASS="parameters"> |
|---|
| 2123 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2124 | <A NAME="_idldoc_write_all_files_keyword_file_hash"/> |
|---|
| 2125 | <FONT CLASS="param_name">file_hash</FONT><BR> |
|---|
| 2126 | <FONT CLASS="param_attrib"> |
|---|
| 2127 | </FONT> |
|---|
| 2128 | </TD> |
|---|
| 2129 | <TD VALIGN="top"> |
|---|
| 2130 | . |
|---|
| 2131 | </TD> |
|---|
| 2132 | </TR> |
|---|
| 2133 | <TR CLASS="parameters"> |
|---|
| 2134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2135 | <A NAME="_idldoc_write_all_files_keyword_user"/> |
|---|
| 2136 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 2137 | <FONT CLASS="param_attrib"> |
|---|
| 2138 | </FONT> |
|---|
| 2139 | </TD> |
|---|
| 2140 | <TD VALIGN="top"> |
|---|
| 2141 | . |
|---|
| 2142 | </TD> |
|---|
| 2143 | </TR> |
|---|
| 2144 | <TR CLASS="parameters"> |
|---|
| 2145 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2146 | <A NAME="_idldoc_write_all_files_keyword_warnings"/> |
|---|
| 2147 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 2148 | <FONT CLASS="param_attrib"> |
|---|
| 2149 | <NOBR>out, optional</NOBR><BR> |
|---|
| 2150 | <NOBR>variable</NOBR> |
|---|
| 2151 | </FONT> |
|---|
| 2152 | </TD> |
|---|
| 2153 | <TD VALIGN="top"> |
|---|
| 2154 | a named variable to return the |
|---|
| 2155 | number of warnings |
|---|
| 2156 | </TD> |
|---|
| 2157 | </TR> |
|---|
| 2158 | </TABLE> |
|---|
| 2159 | <P> |
|---|
| 2160 | <A NAME="_idldoc_write_all_dirs"/> |
|---|
| 2161 | <TABLE CLASS="routine_listing"> |
|---|
| 2162 | <TR><TD> |
|---|
| 2163 | <SPAN CLASS="routine"> |
|---|
| 2164 | idldoc_write_all_dirs |
|---|
| 2165 | </SPAN> |
|---|
| 2166 | </TD><TD ALIGN="right"> |
|---|
| 2167 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 2168 | </TD></TR></TABLE> |
|---|
| 2169 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc_write_all_dirs, <A HREF=#_idldoc_write_all_dirs_param_pro_dirs>pro_dirs</A>, <A HREF=#_idldoc_write_all_dirs_param_count>count</A>, [/<A HREF=#_idldoc_write_all_dirs_keyword_embed>embed</A>], [<A HREF=#_idldoc_write_all_dirs_keyword_warnings>warnings</A>=<EM>variable</EM>]</P></TD></TR></TABLE> |
|---|
| 2170 | <P> |
|---|
| 2171 | |
|---|
| 2172 | Writes the all-dirs.html file in the root directory. |
|---|
| 2173 | |
|---|
| 2174 | <P> |
|---|
| 2175 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2176 | <TR CLASS="parameter_title"> |
|---|
| 2177 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 2178 | </TR> |
|---|
| 2179 | <TR CLASS="parameters"> |
|---|
| 2180 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2181 | <A NAME="_idldoc_write_all_dirs_param_pro_dirs"/> |
|---|
| 2182 | <FONT CLASS="param_name">pro_dirs</FONT><BR> |
|---|
| 2183 | <FONT CLASS="param_attrib"> |
|---|
| 2184 | <NOBR>in</NOBR><BR> |
|---|
| 2185 | <NOBR>string array</NOBR> |
|---|
| 2186 | </FONT> |
|---|
| 2187 | </TD> |
|---|
| 2188 | <TD VALIGN="top"> |
|---|
| 2189 | a string array of all the |
|---|
| 2190 | directories under the 'root' directory that contain .pro files; |
|---|
| 2191 | may not be valid, must check count gt 0 first |
|---|
| 2192 | </TD> |
|---|
| 2193 | </TR> |
|---|
| 2194 | <TR CLASS="parameters"> |
|---|
| 2195 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2196 | <A NAME="_idldoc_write_all_dirs_param_count"/> |
|---|
| 2197 | <FONT CLASS="param_name">count</FONT><BR> |
|---|
| 2198 | <FONT CLASS="param_attrib"> |
|---|
| 2199 | <NOBR>in</NOBR><BR> |
|---|
| 2200 | <NOBR>int</NOBR> |
|---|
| 2201 | </FONT> |
|---|
| 2202 | </TD> |
|---|
| 2203 | <TD VALIGN="top"> |
|---|
| 2204 | the number of directories in pro_dirs |
|---|
| 2205 | </TD> |
|---|
| 2206 | </TR> |
|---|
| 2207 | </TABLE> |
|---|
| 2208 | <P> |
|---|
| 2209 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2210 | <TR CLASS="parameter_title"> |
|---|
| 2211 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 2212 | </TR> |
|---|
| 2213 | <TR CLASS="parameters"> |
|---|
| 2214 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2215 | <A NAME="_idldoc_write_all_dirs_keyword_embed"/> |
|---|
| 2216 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 2217 | <FONT CLASS="param_attrib"> |
|---|
| 2218 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2219 | <NOBR>boolean</NOBR> |
|---|
| 2220 | </FONT> |
|---|
| 2221 | </TD> |
|---|
| 2222 | <TD VALIGN="top"> |
|---|
| 2223 | if set, embeds style sheet in |
|---|
| 2224 | each HTML document |
|---|
| 2225 | </TD> |
|---|
| 2226 | </TR> |
|---|
| 2227 | <TR CLASS="parameters"> |
|---|
| 2228 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2229 | <A NAME="_idldoc_write_all_dirs_keyword_warnings"/> |
|---|
| 2230 | <FONT CLASS="param_name">warnings</FONT><BR> |
|---|
| 2231 | <FONT CLASS="param_attrib"> |
|---|
| 2232 | <NOBR>out, optional</NOBR><BR> |
|---|
| 2233 | <NOBR>variable</NOBR> |
|---|
| 2234 | </FONT> |
|---|
| 2235 | </TD> |
|---|
| 2236 | <TD VALIGN="top"> |
|---|
| 2237 | a named variable to return the |
|---|
| 2238 | number of warnings |
|---|
| 2239 | </TD> |
|---|
| 2240 | </TR> |
|---|
| 2241 | </TABLE> |
|---|
| 2242 | <P> |
|---|
| 2243 | <A NAME="_idldoc_find_dirs"/> |
|---|
| 2244 | <TABLE CLASS="routine_listing"> |
|---|
| 2245 | <TR><TD> |
|---|
| 2246 | <SPAN CLASS="routine"> |
|---|
| 2247 | idldoc_find_dirs |
|---|
| 2248 | </SPAN> |
|---|
| 2249 | </TD><TD ALIGN="right"> |
|---|
| 2250 | <FONT CLASS="param_attrib">private </FONT> |
|---|
| 2251 | </TD></TR></TABLE> |
|---|
| 2252 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">function idldoc_find_dirs(<A HREF=#_idldoc_find_dirs_param_pro_files>pro_files</A>, <A HREF=#_idldoc_find_dirs_param_ndirs>ndirs</A>)</P></TD></TR></TABLE> |
|---|
| 2253 | <P> |
|---|
| 2254 | |
|---|
| 2255 | Find the directories with .pro files in them. |
|---|
| 2256 | |
|---|
| 2257 | <P> |
|---|
| 2258 | <DL> |
|---|
| 2259 | <DT CLASS="attribute">Returns |
|---|
| 2260 | <DD CLASS="attribute_item"> |
|---|
| 2261 | string array of the directories with .pro files in them, or -1 if |
|---|
| 2262 | there are none |
|---|
| 2263 | </DD></DT> |
|---|
| 2264 | </DL> |
|---|
| 2265 | <P> |
|---|
| 2266 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2267 | <TR CLASS="parameter_title"> |
|---|
| 2268 | <TD COLSPAN=2>Parameters</TD> |
|---|
| 2269 | </TR> |
|---|
| 2270 | <TR CLASS="parameters"> |
|---|
| 2271 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2272 | <A NAME="_idldoc_find_dirs_param_pro_files"/> |
|---|
| 2273 | <FONT CLASS="param_name">pro_files</FONT><BR> |
|---|
| 2274 | <FONT CLASS="param_attrib"> |
|---|
| 2275 | <NOBR>in</NOBR><BR> |
|---|
| 2276 | <NOBR>string array</NOBR> |
|---|
| 2277 | </FONT> |
|---|
| 2278 | </TD> |
|---|
| 2279 | <TD VALIGN="top"> |
|---|
| 2280 | a string array of all the pro |
|---|
| 2281 | files under the 'root' directory |
|---|
| 2282 | </TD> |
|---|
| 2283 | </TR> |
|---|
| 2284 | <TR CLASS="parameters"> |
|---|
| 2285 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2286 | <A NAME="_idldoc_find_dirs_param_ndirs"/> |
|---|
| 2287 | <FONT CLASS="param_name">ndirs</FONT><BR> |
|---|
| 2288 | <FONT CLASS="param_attrib"> |
|---|
| 2289 | <NOBR>out</NOBR><BR> |
|---|
| 2290 | <NOBR>variable</NOBR> |
|---|
| 2291 | </FONT> |
|---|
| 2292 | </TD> |
|---|
| 2293 | <TD VALIGN="top"> |
|---|
| 2294 | the number of directories under the root |
|---|
| 2295 | directory that contain .pro files |
|---|
| 2296 | </TD> |
|---|
| 2297 | </TR> |
|---|
| 2298 | </TABLE> |
|---|
| 2299 | <P> |
|---|
| 2300 | <P> |
|---|
| 2301 | <A NAME="_idldoc"/> |
|---|
| 2302 | <TABLE CLASS="routine_listing"> |
|---|
| 2303 | <TR><TD> |
|---|
| 2304 | <SPAN CLASS="routine"> |
|---|
| 2305 | idldoc |
|---|
| 2306 | </SPAN> |
|---|
| 2307 | </TD><TD ALIGN="right"> |
|---|
| 2308 | |
|---|
| 2309 | </TD></TR></TABLE> |
|---|
| 2310 | <TABLE CELLSPACING="2" CELLPADDING="0" BORDER="0" WIDTH="100%"><TR><TD ALIGN="left" VALIGN="top"><P CLASS="code_header">procedure idldoc, <A HREF=#_idldoc_keyword_root>root</A>=<EM>string</EM>, [<A HREF=#_idldoc_keyword_footer>footer</A>=<EM>string</EM>], [<A HREF=#_idldoc_keyword_output>output</A>=<EM>string</EM>], [<A HREF=#_idldoc_keyword_overview>overview</A>=<EM>string</EM>], [/<A HREF=#_idldoc_keyword_user>user</A>], [/<A HREF=#_idldoc_keyword_quiet>quiet</A>], [/<A HREF=#_idldoc_keyword_silent>silent</A>], [/<A HREF=#_idldoc_keyword_embed>embed</A>], [/<A HREF=#_idldoc_keyword_nonavbar>nonavbar</A>], [<A HREF=#_idldoc_keyword_title>title</A>=<EM>string</EM>], [<A HREF=#_idldoc_keyword_subtitle>subtitle</A>=<EM>string</EM>], [<A HREF=#_idldoc_keyword_n_warnings>n_warnings</A>=<EM>variable</EM>], [/<A HREF=#_idldoc_keyword_browse_routines>browse_routines</A>], <A HREF=#_idldoc_keyword_preformat>preformat</A>=<EM>preformat</EM></P></TD></TR></TABLE> |
|---|
| 2311 | <P> |
|---|
| 2312 | |
|---|
| 2313 | Calling routine for IDLdoc. |
|---|
| 2314 | |
|---|
| 2315 | <P> |
|---|
| 2316 | <DL> |
|---|
| 2317 | <DT CLASS="attribute">Examples |
|---|
| 2318 | <DD CLASS="attribute_item"> |
|---|
| 2319 | To run IDLdoc, try: |
|---|
| 2320 | <center><code>idldoc, root='C:\mycode'</code></center> |
|---|
| 2321 | where C:\mycode is the root of a directory tree containing IDL |
|---|
| 2322 | .pro files. |
|---|
| 2323 | |
|---|
| 2324 | </DD></DT> |
|---|
| 2325 | <DT CLASS="attribute">Requires |
|---|
| 2326 | <DD CLASS="attribute_item"> |
|---|
| 2327 | IDL 6.0 |
|---|
| 2328 | </DD></DT> |
|---|
| 2329 | <DT CLASS="attribute">Author |
|---|
| 2330 | <DD CLASS="attribute_item"> |
|---|
| 2331 | Michael D. Galloy |
|---|
| 2332 | </DD></DT> |
|---|
| 2333 | <DT CLASS="attribute">Copyright |
|---|
| 2334 | <DD CLASS="attribute_item"> |
|---|
| 2335 | RSI, 2002 |
|---|
| 2336 | </DD></DT> |
|---|
| 2337 | </DL> |
|---|
| 2338 | <P> |
|---|
| 2339 | <P> |
|---|
| 2340 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="parameters"> |
|---|
| 2341 | <TR CLASS="parameter_title"> |
|---|
| 2342 | <TD COLSPAN=2>Keywords</TD> |
|---|
| 2343 | </TR> |
|---|
| 2344 | <TR CLASS="parameters"> |
|---|
| 2345 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2346 | <A NAME="_idldoc_keyword_root"/> |
|---|
| 2347 | <FONT CLASS="param_name">root</FONT><BR> |
|---|
| 2348 | <FONT CLASS="param_attrib"> |
|---|
| 2349 | <NOBR>in, required</NOBR><BR> |
|---|
| 2350 | <NOBR>string</NOBR> |
|---|
| 2351 | </FONT> |
|---|
| 2352 | </TD> |
|---|
| 2353 | <TD VALIGN="top"> |
|---|
| 2354 | root directory for IDLdoc's |
|---|
| 2355 | recursive search for .pro files. IDLdoc will find any |
|---|
| 2356 | files with the '.pro' suffix and include them in its file |
|---|
| 2357 | listings. Only directories with '.pro' files in them are |
|---|
| 2358 | included in the directory listings. |
|---|
| 2359 | </TD> |
|---|
| 2360 | </TR> |
|---|
| 2361 | <TR CLASS="parameters"> |
|---|
| 2362 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2363 | <A NAME="_idldoc_keyword_footer"/> |
|---|
| 2364 | <FONT CLASS="param_name">footer</FONT><BR> |
|---|
| 2365 | <FONT CLASS="param_attrib"> |
|---|
| 2366 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2367 | <NOBR>string</NOBR> |
|---|
| 2368 | </FONT> |
|---|
| 2369 | </TD> |
|---|
| 2370 | <TD VALIGN="top"> |
|---|
| 2371 | filename for a footer |
|---|
| 2372 | to be placed at the bottom of files; this file can contain any valid |
|---|
| 2373 | HTML |
|---|
| 2374 | </TD> |
|---|
| 2375 | </TR> |
|---|
| 2376 | <TR CLASS="parameters"> |
|---|
| 2377 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2378 | <A NAME="_idldoc_keyword_output"/> |
|---|
| 2379 | <FONT CLASS="param_name">output</FONT><BR> |
|---|
| 2380 | <FONT CLASS="param_attrib"> |
|---|
| 2381 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2382 | <NOBR>string (def. same as root)</NOBR> |
|---|
| 2383 | </FONT> |
|---|
| 2384 | </TD> |
|---|
| 2385 | <TD VALIGN="top"> |
|---|
| 2386 | |
|---|
| 2387 | directory in which to create the HTML output and possible |
|---|
| 2388 | subdirectories |
|---|
| 2389 | </TD> |
|---|
| 2390 | </TR> |
|---|
| 2391 | <TR CLASS="parameters"> |
|---|
| 2392 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2393 | <A NAME="_idldoc_keyword_overview"/> |
|---|
| 2394 | <FONT CLASS="param_name">overview</FONT><BR> |
|---|
| 2395 | <FONT CLASS="param_attrib"> |
|---|
| 2396 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2397 | <NOBR>string</NOBR> |
|---|
| 2398 | </FONT> |
|---|
| 2399 | </TD> |
|---|
| 2400 | <TD VALIGN="top"> |
|---|
| 2401 | filepath to a file containing |
|---|
| 2402 | the summary of the package information about each directory in the |
|---|
| 2403 | package. |
|---|
| 2404 | </TD> |
|---|
| 2405 | </TR> |
|---|
| 2406 | <TR CLASS="parameters"> |
|---|
| 2407 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2408 | <A NAME="_idldoc_keyword_user"/> |
|---|
| 2409 | <FONT CLASS="param_name">user</FONT><BR> |
|---|
| 2410 | <FONT CLASS="param_attrib"> |
|---|
| 2411 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2412 | <NOBR>boolean</NOBR> |
|---|
| 2413 | </FONT> |
|---|
| 2414 | </TD> |
|---|
| 2415 | <TD VALIGN="top"> |
|---|
| 2416 | set to create a |
|---|
| 2417 | listing appropriate for <em>users</em> of the given |
|---|
| 2418 | library hierarchy; the default is to create documentation |
|---|
| 2419 | suited to developers. If set private routines are not |
|---|
| 2420 | shown in the documentation. |
|---|
| 2421 | </TD> |
|---|
| 2422 | </TR> |
|---|
| 2423 | <TR CLASS="parameters"> |
|---|
| 2424 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2425 | <A NAME="_idldoc_keyword_quiet"/> |
|---|
| 2426 | <FONT CLASS="param_name">quiet</FONT><BR> |
|---|
| 2427 | <FONT CLASS="param_attrib"> |
|---|
| 2428 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2429 | <NOBR>boolean</NOBR> |
|---|
| 2430 | </FONT> |
|---|
| 2431 | </TD> |
|---|
| 2432 | <TD VALIGN="top"> |
|---|
| 2433 | if set, print only |
|---|
| 2434 | warnings |
|---|
| 2435 | </TD> |
|---|
| 2436 | </TR> |
|---|
| 2437 | <TR CLASS="parameters"> |
|---|
| 2438 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2439 | <A NAME="_idldoc_keyword_silent"/> |
|---|
| 2440 | <FONT CLASS="param_name">silent</FONT><BR> |
|---|
| 2441 | <FONT CLASS="param_attrib"> |
|---|
| 2442 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2443 | <NOBR>boolean</NOBR> |
|---|
| 2444 | </FONT> |
|---|
| 2445 | </TD> |
|---|
| 2446 | <TD VALIGN="top"> |
|---|
| 2447 | if set, print no |
|---|
| 2448 | messages |
|---|
| 2449 | </TD> |
|---|
| 2450 | </TR> |
|---|
| 2451 | <TR CLASS="parameters"> |
|---|
| 2452 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2453 | <A NAME="_idldoc_keyword_embed"/> |
|---|
| 2454 | <FONT CLASS="param_name">embed</FONT><BR> |
|---|
| 2455 | <FONT CLASS="param_attrib"> |
|---|
| 2456 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2457 | <NOBR>boolean</NOBR> |
|---|
| 2458 | </FONT> |
|---|
| 2459 | </TD> |
|---|
| 2460 | <TD VALIGN="top"> |
|---|
| 2461 | if set, embeds style |
|---|
| 2462 | sheet in each HTML document; if this is not set, each HTML |
|---|
| 2463 | file will be looking for the cascading style sheet idldoc.css |
|---|
| 2464 | in the directory specified for the ROOT keyword |
|---|
| 2465 | </TD> |
|---|
| 2466 | </TR> |
|---|
| 2467 | <TR CLASS="parameters"> |
|---|
| 2468 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2469 | <A NAME="_idldoc_keyword_nonavbar"/> |
|---|
| 2470 | <FONT CLASS="param_name">nonavbar</FONT><BR> |
|---|
| 2471 | <FONT CLASS="param_attrib"> |
|---|
| 2472 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2473 | <NOBR>boolean</NOBR> |
|---|
| 2474 | </FONT> |
|---|
| 2475 | </TD> |
|---|
| 2476 | <TD VALIGN="top"> |
|---|
| 2477 | set to exclude the |
|---|
| 2478 | navigation bar at the top of each page |
|---|
| 2479 | </TD> |
|---|
| 2480 | </TR> |
|---|
| 2481 | <TR CLASS="parameters"> |
|---|
| 2482 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2483 | <A NAME="_idldoc_keyword_title"/> |
|---|
| 2484 | <FONT CLASS="param_name">title</FONT><BR> |
|---|
| 2485 | <FONT CLASS="param_attrib"> |
|---|
| 2486 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2487 | <NOBR>string (def. Research Systems)</NOBR> |
|---|
| 2488 | </FONT> |
|---|
| 2489 | </TD> |
|---|
| 2490 | <TD VALIGN="top"> |
|---|
| 2491 | title to |
|---|
| 2492 | place in the upper right of all generated pages |
|---|
| 2493 | </TD> |
|---|
| 2494 | </TR> |
|---|
| 2495 | <TR CLASS="parameters"> |
|---|
| 2496 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2497 | <A NAME="_idldoc_keyword_subtitle"/> |
|---|
| 2498 | <FONT CLASS="param_name">subtitle</FONT><BR> |
|---|
| 2499 | <FONT CLASS="param_attrib"> |
|---|
| 2500 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2501 | <NOBR>string (def. IDL version)</NOBR> |
|---|
| 2502 | </FONT> |
|---|
| 2503 | </TD> |
|---|
| 2504 | <TD VALIGN="top"> |
|---|
| 2505 | subtitle to |
|---|
| 2506 | place in the upper right of all generated pages |
|---|
| 2507 | </TD> |
|---|
| 2508 | </TR> |
|---|
| 2509 | <TR CLASS="parameters"> |
|---|
| 2510 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2511 | <A NAME="_idldoc_keyword_n_warnings"/> |
|---|
| 2512 | <FONT CLASS="param_name">n_warnings</FONT><BR> |
|---|
| 2513 | <FONT CLASS="param_attrib"> |
|---|
| 2514 | <NOBR>out, optional</NOBR><BR> |
|---|
| 2515 | <NOBR>variable</NOBR> |
|---|
| 2516 | </FONT> |
|---|
| 2517 | </TD> |
|---|
| 2518 | <TD VALIGN="top"> |
|---|
| 2519 | set to a named variable to |
|---|
| 2520 | contain the total number of warnings issued during the run |
|---|
| 2521 | </TD> |
|---|
| 2522 | </TR> |
|---|
| 2523 | <TR CLASS="parameters"> |
|---|
| 2524 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2525 | <A NAME="_idldoc_keyword_browse_routines"/> |
|---|
| 2526 | <FONT CLASS="param_name">browse_routines</FONT><BR> |
|---|
| 2527 | <FONT CLASS="param_attrib"> |
|---|
| 2528 | <NOBR>in, optional</NOBR><BR> |
|---|
| 2529 | <NOBR>boolean</NOBR> |
|---|
| 2530 | </FONT> |
|---|
| 2531 | </TD> |
|---|
| 2532 | <TD VALIGN="top"> |
|---|
| 2533 | set to include a frame |
|---|
| 2534 | to browse through the routines of the current file |
|---|
| 2535 | </TD> |
|---|
| 2536 | </TR> |
|---|
| 2537 | <TR CLASS="parameters"> |
|---|
| 2538 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"> |
|---|
| 2539 | <A NAME="_idldoc_keyword_preformat"/> |
|---|
| 2540 | <FONT CLASS="param_name">preformat</FONT><BR> |
|---|
| 2541 | <FONT CLASS="param_attrib"> |
|---|
| 2542 | </FONT> |
|---|
| 2543 | </TD> |
|---|
| 2544 | <TD VALIGN="top"> |
|---|
| 2545 | . |
|---|
| 2546 | </TD> |
|---|
| 2547 | </TR> |
|---|
| 2548 | </TABLE> |
|---|
| 2549 | <P> |
|---|
| 2550 | <HR CLASS="divider"> |
|---|
| 2551 | <CENTER> |
|---|
| 2552 | <FONT STYLE="font-family: Arial; font-size: 8pt"> |
|---|
| 2553 | Personal IDL library of Michael Galloy, Professional Services Engineer - Trainer/Consultant, |
|---|
| 2554 | <A HREF="http://www.rsinc.com">Research Systems</A> <BR> |
|---|
| 2555 | For more information about these routines contact <A HREF="mailto:mgalloy@rsinc.com">Michael Galloy</A> <BR> |
|---|
| 2556 | Feel free to <A HREF="mailto:mgalloy@rsinc.com">submit a bug or feature request</A> for any of these routines <BR> |
|---|
| 2557 | </FONT> |
|---|
| 2558 | </CENTER> |
|---|
| 2559 | <HR CLASS="divider"> |
|---|
| 2560 | <FONT CLASS="tagline">Produced by IDLdoc 1.6 on Wed Feb 09 12:40:19 2005</FONT> |
|---|
| 2561 | </BODY></HTML> |
|---|
