source: trunk/SRC/Documentation/idldoc_html_output/idldoc-help.html @ 147

Last change on this file since 147 was 138, checked in by smasson, 18 years ago

update documentation and .idlwave_catalog
File size: 18.1 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Template needs structure with the following fields:
6       version : IDLdoc version
7       date : string containing date of file creation
8       embed : 0 for link to CSS, 1 for embed CSS
9       css_location : if embed then string filename of CSS file location, o/w href to CSS file
10       navbar_filename : filename of navbar template
11       footer : filename of footer file to include
12       tagline_filename : filename of tagline template
13     Plus fields needed by the templates: navbar, tagline
14-->
15
16<!-- Generated by IDLdoc 2.0 -->
17
18<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
19  <head>
20    <title>IDLdoc Help (SAXO Documentation)</title>
21
22   
23    <style type="text/css" media="all">
24         
25/* CSS for all files which appear in the "main" viewing area: overview,
26   directory overviews, warnings, index, search, pro files, source
27   code, help, and etc files. */
28
29/* Link styles --------------------------------------------------------------- */
30
31a { text-decoration: none; }
32
33a:link, a:visited { 
34  color: #660000; 
35  border-bottom: 1px dotted #C0C0F0;   
36}
37
38a:hover, a:focus { 
39  color: #993333; 
40  background: #FFFFCC; 
41  border-bottom: 1px dotted #303099; 
42}
43
44
45/* Main styles --------------------------------------------------------------- */
46
47body {
48  margin: 0;
49  padding: 0;
50  font-size: 10pt;
51  font-family: Verdana, Helvetica, Arial, sans-serif;
52  background-color: #FFFFFF;
53}
54
55p {
56  margin-top: 0.5em;
57  margin-bottom: 0;
58}
59
60#container { margin: 1em; }
61
62code.section { white-space: pre; }
63
64pre.snippet {
65  margin-left: 5%;
66  background: #F0F0F0;
67  border: 1px dashed #999999;
68  width: 43em;
69  padding: 0.5em 0.5em 0.5em 0.5em;
70  white-space: pre;
71}
72
73/* Navbar styles ------------------------------------------------------------- */
74
75#navbar_title {
76  color: #000033;
77  background-color: #F0F0FF;
78  font-family: Arial, Helvetica, sans-serif;
79  padding: 20px 30px;
80  border-bottom: 1px solid #000033;
81}
82
83#navbar_title * {
84  margin: 0;
85  padding: 0;
86}
87
88#navbar_title h1 {
89  letter-spacing: 0.1em;
90  font-variant: small-caps;
91  font-size: 250%;
92  text-indent: -1em;
93  padding-left: 1em; 
94}
95
96#navbar_title h2 {
97  font-size: 110%;
98  font-weight: normal;
99  color: #333399;
100}
101
102#main_navbar table {
103  width: 100%;
104  border-bottom: 1px solid #666699;
105}
106
107#main_navbar td {
108  background: #CCCCFF;
109  font-size: 80%;
110  font-weight: bold;
111  font-family: Arial, Helvetica, sans-serif;
112  border-top: 3px solid #CCCCFF;
113  border-bottom: 3px solid #CCCCFF;
114  padding-left: 6px;
115  padding-right: 6px;
116  margin: 0;
117}
118
119#main_navbar td#selected {
120  background: #CCCCFF;
121  font-size: 80%;
122  font-weight: bold;
123  font-family: Arial, Helvetica, sans-serif;
124  border-top: 3px solid #333399;
125  border-bottom: 3px solid #CCCCFF;
126  padding-left: 6px;
127  padding-right: 6px;
128  margin: 0;
129}
130
131#main_navbar td#flexible {
132  width: 100%;
133  text-align: right;
134  padding-right: 1em;
135  background: #CCCCFF;
136  font-size: 70%;
137  font-weight: normal;
138  font-family: Arial, Helvetica, sans-serif;
139  text-transform: uppercase;
140  border-top: 3px solid #CCCCFF;
141  border-bottom: 3px solid #CCCCFF;
142}
143
144#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
145
146#main_navbar a:hover, #main_navbar a:focus {
147  color: #FFFF66;
148  background: #CCCCFF;
149  border-bottom: 1px none #606099; 
150  border: 0;
151}
152
153#secondary_navbar {
154  font-size: 80%;
155  font-weight: normal;
156  font-family: Arial, Helvetica, sans-serif;
157  margin-top: 4px;
158  margin-left: 20px;
159  white-space: nowrap;
160}
161
162
163/* Tagline and footer styles ------------------------------------------------- */
164
165div#tagline {
166  margin-top: 6px;
167  border-top: 1px dotted lightsteelblue;
168  padding-top: 6px;
169  font-size: 66%;
170  font-style: italic;
171}
172
173div#footer {
174  margin-top: 6px;
175  border-top: 1px dotted lightsteelblue;
176  padding-top: 6px;
177  font-size: 66%;
178  font-style: italic;
179}
180
181/* Basic data presenation styles -------------------------------------------- */
182
183.index_letter { 
184  font-size: 300%;
185  font-weight: bold;
186  color: #000066; 
187  margin: 0.5em 0 0 -0.1em;
188}
189
190h1, h2, h3, h4 {
191  font-weight: normal;
192  color: #3333CC;
193}
194
195h1 {
196  padding-top: 0.75em;
197  font-size: 160%;
198}
199
200h2 {
201  padding-top: 1em;
202  font-size: 120%;
203  }
204
205h3 {
206  padding-top: 0.75em;
207  margin-bottom: 0.25em;
208  font-size: 100%;
209}
210
211h4 {
212  padding: 0;
213  margin: 0.5em 0 0 0;
214  font-size: 80%;
215}
216
217table.basic {
218  empty-cells: show;
219  margin: 1.5em 1em 0 1em;
220  border: 1px dotted #CFCFFF;
221  font-size: 80%;
222}
223
224table.basic th {
225  background-color: #F0F0FF;
226  font-weight: bold;
227  text-align: left;
228  padding: 4px 1em 4px 4px;
229  border-bottom: 1px dotted #666699;
230}
231
232table.basic td {
233  vertical-align: top;
234  padding: 4px 1em 4px 4px;
235}
236
237dd {
238  margin-bottom: 0.25em;
239  font-size: 80%;
240}
241
242
243/* Warnings styles ----------------------------------------------------------- */
244
245
246#todo dl, #bugs dl { 
247  margin: 0 0 0 1.5em;
248  font-size: 80%;
249}
250
251#todo dd, #bugs dd { 
252  margin-left: 3em; 
253  font-size: 100%;
254}
255
256#undoc table, #obsolete table, #statistics table {
257  width: 80%;
258  margin-left: 2em;
259}
260
261#undoc td, #obsolete td, #statistics td { 
262  padding: 0 0 0 0;
263  font-size: 80%;
264  white-space: nowrap;
265}
266
267#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
268
269#undoc td.docstat, #statistics td.stat { 
270  width: 50%;
271  text-align: right;
272}
273
274#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
275
276#undoc td.notdoc, #statistics td.warning { color: #993333; }
277
278/* File + routine styles ----------------------------------------------------- */
279
280h1.directory { 
281  padding: 1em 0 0 0;
282  margin: 0;
283  font-size: 66%;
284}
285
286h1.directory a { border-bottom: 0; }
287
288h2.pro_file { 
289  padding: 0;
290  margin: 0;
291  font-size: 140%;
292}
293
294div#file_attr {
295  padding: 0 1em 0 1em;
296  margin: 1em;
297  background: #F6F6F6;
298  border: 1px dotted #999999;
299}
300
301div#file_attr dt {
302  font-size: 80%;
303  font-weight: bold;
304}
305
306div#file_attr dd {
307  font-size: 80%;
308}
309
310div#class_diagram { 
311  padding: 1em 0 1em 0; 
312  white-space: pre;
313  font-family: 'Courier New';
314}
315
316table#sav_attr { 
317  font-size: 90%; 
318  margin: 1em; 
319  padding: 1em 1em 1em 1em;
320  background: #F6F6F6;
321  border: 1px dotted #999999;
322}
323
324table#sav_attr th { text-align: left; }
325
326table#sav_attr td { vertical-align: top; padding-right: 2em; }
327
328table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
329
330p.sav_warning { margin-left: 4em; font-family: 80%; }
331
332table.variables { 
333  font-family: 'Courier New', monospace; 
334  font-size: 80%; 
335  text-indent: -2em; 
336  padding-left: 2em; 
337}
338
339table.variables td.image { width: 64px; }
340
341div#file_comments { white-space: pre; 
342  margin: 2em;
343  font-size: 80%;
344}
345
346
347div.field_summary {
348  padding: 0 1em 0 1em;
349  margin: 1em;
350  background: #FFFFF0;
351  border: 1px dotted #C0C000;
352}
353
354div#routine_summary { 
355  padding: 0 1em 0 1em;
356  margin: 1em;
357  background: #F0F0FF;
358  border: 1px dotted #9999FF;
359}
360
361div.field_summary h2, div#routine_summary h2 { 
362  padding: 0.5em 0 0 0;
363  margin: 0;
364}
365
366div.field_summary table, div.field_summary p { 
367  margin: 1em 1em;
368}
369
370div.field_summary td.name { 
371  vertical-align: top;
372  padding-bottom: 0.25em;
373  color: #3333CC;
374}
375
376div.field_summary span.field_type { 
377  font-weight: normal;
378  font-size: 80%;
379  color: black;
380}
381
382div.field_summary td.comments { 
383  vertical-align: top;
384  padding-left: 2em;
385  font-size: 80%;
386}
387
388p.commaList { 
389  margin: 1em 1em 1em 1em;
390}
391
392span.warning { 
393  color: #CC6633;
394  font-weight: bold;
395  font-size: 66%;
396  text-transform: uppercase;
397}
398
399span.categories { 
400  color: #006633;
401  font-weight: bold;
402  font-size: 66%;
403  text-transform: uppercase;
404}
405
406span.undoc { 
407  color: #FF6633;
408  font-weight: bold;
409  font-size: 80%;
410  text-transform: uppercase;
411}
412
413span.attr { 
414  color: #006633;
415  font-weight: bold;
416  font-size: 80%;
417  text-transform: uppercase;
418}
419
420span.value { 
421  color: #006633;
422  font-weight: normal;
423  text-transform: none;
424}
425
426a.top { 
427  font-weight: bold;
428  font-size: 66%;
429  text-transform: uppercase;
430  float: right;
431}
432
433span.result { 
434  font-family: Verdana, Arial, Helvetica, sans-serif;
435  font-style: italic;
436  font-size: 80%;
437}
438
439div#routine_summary p, div.routine_details p.header { 
440  padding-top: 0.5em;
441  margin-left: 1.5em;
442  text-indent: -1.5em;
443  font-family: 'Courier New', monospace;
444}
445
446div.routine_details { 
447  padding: 0.5em 1em 0.5em 1em;
448  margin: 1em;
449  border: 1px dotted #CCCCCC;
450}
451
452div.routine_details h2 { 
453  padding-top: 0;
454  margin-top: 0;
455}
456
457div.routine_details div.value { 
458  margin: 0 1em 0 1em;
459  font-size: 80%;
460}
461
462div.routine_details div.comments { 
463  font-size: 80%;
464  margin: 0.75em 1em 1em 1em;
465}
466
467div.routine_details div.preformat { 
468  white-space: pre;
469}
470
471table.statistics { 
472  font-size: 80%;
473  margin-left: 1em;
474}
475
476table.statistics td { 
477  padding: 0 2em 0 0;
478}
479
480/* Overview styles ----------------------------------------------------------- */
481
482div.overview { 
483  width: 100%;
484  margin-top: 1em;
485  clear: both;
486}
487
488div.overview table {
489  empty-cells: show;
490  font-size: 90%;
491  margin: 1em 1em 1em 1em;
492  padding: 1em 0.5em 1em 0.5em;
493  background: #F6F6F6;
494  border: 1px dotted #999999;
495}
496
497div.overview td {
498  padding: 3px 1em 3px 1em;
499}
500
501div.overview td.dir {
502  width: 1%;
503  vertical-align: top;
504  text-align: right;
505  padding-right: 1em;
506}
507
508
509/* Navigation list styles for tree structures -------------------------------- */
510
511#tree {
512  text-align: left;
513  font-size: 90%;
514  margin: 0.75em 0 0.75em 0;
515  padding: 0;
516}
517
518#tree ul {
519  text-align: left;
520  margin: 0;
521  padding: 0;
522}
523
524#tree li {
525  margin: 0 0 0 15px;
526  padding: 0;
527  list-style-type: none;
528}
529
530#tree .symbols {
531  float: left;
532  width: 12px;
533  height: 1em;
534  padding-left: 4px;
535  background-position: 0 100%;
536  background-repeat: no-repeat;
537}
538
539/* Search styles ------------------------------------------------------------- */
540
541input.writein { 
542  padding-left: 0.5em;
543  border: 1px solid #CCCCCC;
544  font-family: 'Courier New';
545  background: #FFFFF3;
546}
547
548#search form { 
549  margin-left: 2em;
550}
551
552#search table { 
553  margin: 1em 1em 0 2em;
554  padding: 1em 2em 1em 2em;
555  background: #F6F6F6;
556  border: 1px dotted #999999;
557}
558
559#search tr { 
560  text-align: center;
561}
562
563#search td { 
564  font-size: 80%; 
565  text-align: left;
566}
567
568#search td * { 
569  vertical-align: middle;
570}
571
572#search p { 
573  font-size: 66%;
574  margin: 0 3em 2em 3em;
575}
576
577/* Help styles --------------------------------------------------------------- */
578
579div.toc { 
580  padding: 0 1em 0 1em;
581  margin: 1em;
582  background: #F0F0FF;
583  border: 1px dotted #9999FF; 
584  width: 19em;
585}
586
587div.right { 
588  float: right;
589  width: 22em;
590}
591
592ol.toc { 
593  list-style-type: upper-roman;
594}
595
596ol.toc ol { 
597  padding-left: 3em;
598  margin-left: 0;
599  list-style-type: lower-alpha;
600}
601
602dl.variables dt { font-size: 80%; }
603dl.variables dd { margin-bottom: 0.5em; }
604
605    </style>   
606    <style type="text/css" media="print">
607         #navbar_title { 
608  background-color: #FFFFFF; 
609}
610
611#main_navbar td {
612  background: #FFFFFF;
613  border-top: 0.25em solid #FFFFFF;
614  border-bottom: 0.25em solid #FFFFFF;
615}
616
617#main_navbar td#selected {
618  background: #FFFFFF;
619  border-top: 0.25em solid #333399;
620  border-bottom: 0.25em solid #FFFFFF;
621}
622
623#main_navbar td#flexible {
624  background: #FFFFFF;
625  border-top: 0.25em solid #FFFFFF;
626  border-bottom: 0.25em solid #FFFFFF;
627}
628
629#secondary_navbar {
630  display: none;
631}
632
633    </style>
634   
635
636    <script type="text/javascript">
637      function setTitle() {
638        parent.document.title="Help (SAXO Documentation)";
639      }
640    </script>
641  </head>
642
643  <body onload="setTitle();">
644
645    <div id="navbar_title">
646  <h1>SAXO Documentation</h1>
647</div>
648
649
650<div id="main_navbar">
651
652  <table cellspacing="0">
653    <tr>
654     
655      <td><a href="overview.html?format=raw" title="Overview of library">Overview</a></td>
656     
657
658     
659      <td >Directory</td>
660     
661
662     
663      <td><a href="idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
664     
665
666     
667      <td><a href="idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
668     
669
670     
671      <td><a href="search-page.html?format=raw" title="Search library">Search</a></td>
672     
673
674      <td >File</td>
675
676     
677      <td >Source</td>
678     
679
680     
681      <td id="selected">Help</td>
682     
683
684      <td >Etc</td>
685
686      <td id="flexible">Developer&nbsp;documentation</td>
687    </tr>
688  </table>
689
690</div>
691
692<div id="secondary_navbar">
693
694&lt;&lt; prev file | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="idldoc-help.html?format=raw" target="_TOP">view single page</a> | <a href="index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: routine
695
696</div>
697
698
699    <div id="container">
700
701      <div class="toc small">
702        <ol class="toc">
703          <li><a href="idldoc-help.html?format=raw">Help for users of an IDLdoc'ed library</a></li>
704          <li><a href="idldoc-dev-help.html?format=raw">Basic markup of code</a></li>
705          <li><a href="idldoc-dev-help2.html?format=raw">Modifying IDLdoc output</a></li>
706        </ol>
707      </div>
708
709      <h1>Help on IDLdoc output</h1>
710
711      <p>The following information is provides documentation in
712      interpreting the results of the output of IDLdoc. For
713      documentation on marking up IDL code to better use IDLdoc's
714      capabilities, see the <a href="idldoc-dev-help.html?format=raw">developer's
715      help</a> or the <a href="idldoc-dev-help2.html?format=raw">advanced developer's help</a>.</p>
716
717      <h2>File summary</h2>
718
719      <p>The file summary includes a the class hierarchy diagram for
720      files with names ending in __define, a list of various
721      attributes of the file, and a description.</p>
722
723      <h2>Field summary</h2>
724
725      <p>If the filename of PRO file ends in __define, then the fields
726      defined in the routine of the same name are listed with their
727      type and any comments provided by the developer. Following this
728      listing are separate listings for each parent class of the
729      class/structure with a list of their fields with types.</p>
730
731      <h2>Routine summary</h2>
732
733      <p>The routine summary simply provides the calling sequence for
734      each routine in the file (in the same syntax is the online help
735      for IDL) and the first sentence of the detailed description for
736      each routine in the file.</p>
737
738      <h2>Routine details</h2>
739
740      <p>The routine details sections gives a possibly longer
741      description of the routine as well as a tables of the parameters
742      and keywords accepted by the routine. Also listed are various
743      attributes of the routine.</p>
744
745      <p>All the parameters and keywords of the routine will be in
746      these tables regardless if they have been commented using IDLdoc
747      (though the developer can hide parameters and keywords if they
748      chose).</p>
749
750      <h3>Routine attributes</h3>
751
752      <p>A routine can be marked with various attributes described in
753      the below table.</p>
754
755      <table class="basic" cellspacing="0">
756        <tr>
757          <th>Attribute</th>
758          <th>Description</th>
759        </tr>
760        <tr>
761          <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">abstract</span></h2></td>
762          <td>
763            The routine name will be italicized if the routine is
764            marked "abstract" (meaning it is not implemented, it is
765            provided for its interface only).  This is generally used
766            in only object-oriented programming.
767          </td>
768        </tr>
769        <tr>
770          <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">private</span></h2></td>
771          <td>
772            This routine is not intended to be called except by other
773            routines in the same file. In other words it is a "helper
774            routine". Private routines are only seen if the library is
775            IDLdoc'ed in "developer" mode.
776          </td>
777        </tr>
778        <tr>
779          <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">obsolete</span></h2></td>
780          <td>
781            This routine is no longer supported by the library
782            maintainer.
783          </td>
784        </tr>
785        <tr>
786          <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="categories">categories</span></h2></td>
787          <td>
788            The names of any categories for the routine are listed.
789          </td>
790        </tr>
791      </table>
792
793      <h3>Parameter and keyword attributes</h3>
794
795      <p>A parameter or keyword can be marked with various attributes
796      described in the below table.</p>
797
798      <table class="basic" cellspacing="0">
799        <tr>
800          <th>Attribute</th>
801          <th>Description</th>
802        </tr>
803        <tr>
804          <td><span class="attr">in</span></td>
805          <td>
806            Indicates that the argument is intended to be passed into
807            the routine.
808          </td>
809        </tr>
810        <tr>
811          <td><span class="attr">out</span></td>
812          <td>
813            Indicates that the argument is intended to be used to pass
814            a value out of the routine. A named variable must be
815            passed to the routine to pass a value back to the calling
816            level.
817          </td>
818        </tr>
819        <tr>
820          <td><span class="attr">optional</span></td>
821          <td>
822            This attribute indicates the argument is optional;
823            optional parameters and keywords are also placed inside
824            brackets ([]) in the routine summary.
825          </td>
826        </tr>
827        <tr>
828          <td><span class="attr">required</span></td>
829          <td>Indicates the argument is required</td>
830        </tr>
831        <tr>
832          <td><span class="attr">type</span></td>
833          <td>
834            Type indicates the IDL type of the variable.  Can be used
835            indicate a group of types, a specific type, an array of a
836            certain type, etc.  Boolean keywords are indicated by a
837            /KEYWORD_NAME in the routine summary.
838          </td>
839        </tr>
840        <tr>
841          <td><span class="attr">default</span></td>
842          <td>
843            Default indicates the default value for an optional
844            parameter or keyword.
845          </td>
846        </tr>
847        <tr>
848          <td><span class="attr">private</span></td>
849          <td>
850            This parameter is not intended to be used in calls except
851            by other routines in the same file. Private parameters are
852            only seen if the library is IDLdoc'ed in "developer" mode.
853          </td>
854        </tr>
855      </table>
856
857     
858
859      <div id="tagline">Produced by IDLdoc 2.0.</div>
860
861      </div>
862    </body>
863</html>
Note: See TracBrowser for help on using the repository browser.