Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strkeywd.html

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strkeywd.html (modified) (5 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strkeywd.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Translate a sturcture in a string able to be used to specify keywords 
+ in the calling of a function when we use EXECUTE (see example)
+</div>
 
       
@@ -711 +714 @@
         <div class="routine_details" id="_strkeywd">
 
-          <h2><a class="top" href="#container">top</a>strkeywd </h2>
+          <h2><a class="top" href="#container">top</a>strkeywd <span class="categories"> 
+ </span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME: strkeywd (string keywords)
-
- PURPOSE: traduit une sturcture en un string pouvant etre utilise
- pour specifier des keywords ds l''appelle d''une fonction qd on
- utilise execute (cf l''exemple)
-
- CATEGORY: pour passer des mots cles avec execute !
-
- CALLING SEQUENCE:res=strkeywd(struct)
- 
- INPUTS:struct: une structure
-
- KEYWORD PARAMETERS:
-
- OUTPUTS:un string compose de la facon suivante:
-         pour chaque element de la structure, on ecrit une partie du
-         string sous la forme: 
-         'nom_de_l''element=contennu de l''element'
-
- COMMON BLOCKS:
-
- SIDE EFFECTS:
-
-   Si un element de la structure contient un tableau, il sera
-   convertit en vecteur.
-
- RESTRICTIONS:
-
-   attention cette fonction comporte des boucles, des if et des cases
-   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
-   structure de grosse taille (avec bcp d''elements et avec des
-   elements etant de gros tableaux).
-   la structure en entree ne doit pas contenir de Complex floating, de
-   structure, de Double-precision complex, de Pointer, de Object
-   reference, de Unsigned Integer, de Unsigned Longword Integer, de
-   64-bit Integer, de Unsigned 64-bit Integer   
-
-
-
- EXAMPLE:
-
- on cree une structure
-       IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
-       IDL> help, b,/struct
-       ** Structure <817f4bc>, 3 tags, length=10, refs=1:
-          AGE_CAPITAINE   INT             35
-          OK              INT            111
-          YEAR            INT       Array[3]
- on met cette structure sous forme de string
-       IDL> a=strkeywd(b)
-       IDL> print, a
-       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
- maintenant on peut utiliser le string a pour passer des mots cles ds
- une fonction a l''aide de execute!!
-       IDL> test=execute('c=get_extra('+a+')')
-       IDL> help, c,/struct
-       ** Structure <817f2dc>, 3 tags, length=10, refs=1:
-          AGE_CAPITAINE   INT             35
-          OK              INT            111
-          YEAR            INT       Array[3]
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ a string composed like following:
+ For each element of the structure, we write a part of the string as: 
+         'name_of_the_element=content_of_the_element'
+</div>
 
           
@@ -796 +744 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ a structure
+</div>
             
 
@@ -803 +753 @@
           
 
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+ We create a structure
+       IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
+       IDL> help, b,/struct
+       ** Structure <817f4bc>, 3 tags, length=10, refs=1:
+          AGE_CAPITAINE   INT             35
+          OK              INT            111
+          YEAR            INT       Array[3]
+ We put this structure as a string
+       IDL> a=strkeywd(b)
+       IDL> print, a
+       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
+ Now we can use the string a to pass keywords in a function thanks to execute!!
+       IDL> test=execute('c=get_extra('+a+')')
+       IDL> help, c,/struct
+       ** Structure <817f2dc>, 3 tags, length=10, refs=1:
+          AGE_CAPITAINE   INT             35
+          OK              INT            111
+          YEAR            INT       Array[3]
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat">
+ If an element of the structure contain an array, it will be convert in a vector.
+
+
+ Beware, this function has loops, ifs ad cases everywhere. So it can 
+ not be used by big keywords (with a lot of elements which are big 
+ arrays). The input keyword must not contain Complex floatings, structure, 
+ Double-precision complex, Pointer, Object reference, Unsigned Integer, 
+ Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer.
+</div>