Changeset 151 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xnotice.html

Timestamp:

08/09/06 12:21:11 (18 years ago)

Author:

navarro

Message:

english and nicer header (3b)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xnotice.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xnotice.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Create a widget with some text at the middle of the window
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_xnotice">
 
-          <h2><a class="top" href="#container">top</a>xnotice </h2>
+          <h2><a class="top" href="#container">top</a>xnotice <span class="categories">
+ Information
+ </span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME:xnotice
-
- PURPOSE:cree un widget avec du texte au milieu de la fenetre.
-
- CATEGORY:information
-
- CALLING SEQUENCE:widgetid=xnotice(text)
- 
- INPUTS:text: un string ou un vecteur de string. Si c''est un
- scalaire on cherche le separateur de ligne !C pour creer un texte a
- plusieurs lignes.
-
- KEYWORD PARAMETERS:chkwidget: oblige a verifier qu''il y a des
- widgets actif pour creer un widget, sinon imprime au prompt
-
- OUTPUTS:lidentite du widget cree
-
- COMMON BLOCKS
-
- SIDE EFFECTS:ne fait pas appelle a xmanager -> ne cree aucun event!
- il faut detruire ce widget a la main:
- widget_control, widgetid, /destroy
-
- RESTRICTIONS:
-
- EXAMPLE:
-    IDL> id=xnotice('ca marche !C ou pas?')
-    IDL> widget_control, id, /destroy
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ The identity of the created widget
+</div>
 
           
@@ -754 +732 @@
             
             <h4 id="_xnotice_param_text">text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
               
               
@@ -764 +742 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ it is a string or a vector of string. If it is a scalar, we 
+ look for the line separator !C to create a text with several lines.
+</div>
             
 
@@ -784 +765 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ Force to verify that they are some active widget to create a widget, 
+ otherwise print at the prompt
+</div>
             
           
 
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+    IDL> id=xnotice('ca marche !C ou pas?')
+    IDL> widget_control, id, /destroy
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id: xnotice.pro 150 2006-08-09 10:12:54Z navarro $
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat"> 
+ It do not call xmanager -> It do not create any event! 
+ We have to delete this widget manuelly:
+ widget_control, widgetid, /destroy
+</div>