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

Last change on this file since 187 was 168, checked in by pinsard, 18 years ago

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