Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/str_size.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/str_size.html (modified) (7 diffs)

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

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ The purpose of this function is to return the proper
+ character size to make a specified string a specifed
+ width in a window. The width is specified in normalized
+ coordinates. The function is extremely useful for sizing
+ strings and labels in resizeable graphics windows.
+</div>
 
       
@@ -711 +717 @@
         <div class="routine_details" id="_STR_SIZE">
 
-          <h2><a class="top" href="#container">top</a>STR_SIZE </h2>
+          <h2><a class="top" href="#container">top</a>STR_SIZE <span class="categories">
+ Graphics Programs, Widgets.
+</span></h2>
         
           <p class="header">
-            <span class="result">result = </span>STR_SIZE(<span class="result"><a href="#_STR_SIZE_param_string">string</a>, <a href="#_STR_SIZE_param_targetWidth">targetWidth</a></span>, <a href="#_STR_SIZE_keyword_INITSIZE">INITSIZE</a>=<span class="result">INITSIZE</span>, <a href="#_STR_SIZE_keyword_STEP">STEP</a>=<span class="result">STEP</span>)</p>
+            <span class="result">result = </span>STR_SIZE(<span class="result"><a href="#_STR_SIZE_param_string">string</a>[, <a href="#_STR_SIZE_param_targetWidth">targetWidth</a>]</span>, <a href="#_STR_SIZE_keyword_INITSIZE">INITSIZE</a>=<span class="result">INITSIZE</span>, <a href="#_STR_SIZE_keyword_STEP">STEP</a>=<span class="result">STEP</span>)</p>
         
           <div class="comments">
- NAME:
-  STR_SIZE
-
- PURPOSE:
-
-  The purpose of this function is to return the proper
-  character size to make a specified string a specifed
-  width in a window. The width is specified in normalized
-  coordinates. The function is extremely useful for sizing
-  strings and labels in resizeable graphics windows.
-
- CATEGORY:
-
-  Graphics Programs, Widgets.
-
- CALLING SEQUENCE:
-
-  thisCharSize = STR_SIZE(thisSting, targetWidth)
-
- INPUTS:
-
-  thisString:  This is the string that you want to make a specifed
-     target size or width.
-
- OPTIONAL INPUTS:
-
-  targetWidth:  This is the target width of the string in normalized
-     coordinates in the current graphics window. The character
-     size of the string (returned as thisCharSize) will be
-     calculated to get the string width as close as possible to
-     the target width. The default is 0.25.
-
- KEYWORD PARAMETERS:
-
-  INITSIZE:  This is the initial size of the string. Default is 1.0.
-
-  STEP:   This is the amount the string size will change in each step
-     of the interative process of calculating the string size.
-     The default value is 0.05.
-
- OUTPUTS:
-
-  thisCharSize:  This is the size the specified string should be set
-     to if you want to produce output of the specified target
-     width. The value is in standard character size units where
-     1.0 is the standard character size.
-
- EXAMPLE:
-
-  To make the string "Happy Holidays" take up 30% of the width of
-  the current graphics window, type this:
-
-               XYOUTS, 0.5, 0.5, ALIGN=0.5, "Happy Holidays", $
-        CHARSIZE=STR_SIZE("Happy Holidays", 0.3)
-
- MODIFICATION HISTORY:
-
-  Written by: David Fanning, 17 DEC 96.
-  Added a scaling factor to take into account the aspect ratio
-     of the window in determing the character size. 28 Oct 97. DWF</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat"> 
+ thisCharSize. This is the size the specified string should be set
+ to if you want to produce output of the specified target
+ width. The value is in standard character size units where
+ 1.0 is the standard character size.
+</div>
 
           
@@ -785 +739 @@
             
             <h4 id="_STR_SIZE_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
               
               
@@ -795 +749 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ This is the string that you want to make a specifed
+ target size or width.
+</div>
             
             <h4 id="_STR_SIZE_param_targetWidth">targetWidth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
+              <span class="attr">in</span>
+              
+              <span class="attr">optional</span>
               
               
@@ -808 +765 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ This is the target width of the string in normalized
+ coordinates in the current graphics window. The character
+ size of the string (returned as thisCharSize) will be
+ calculated to get the string width as close as possible to
+ the target width. The default is 0.25.
+</div>
             
 
@@ -828 +791 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">  
+ This is the initial size of the string. Default is 1.0.
+</div>
             
             <h4 id="_STR_SIZE_keyword_STEP">STEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -841 +806 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ This is the amount the string size will change in each step
+ of the interative process of calculating the string size.
+ The default value is 0.05.
+</div>
             
           
 
-          
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+ To make the string "Happy Holidays" take up 30% of the width of
+ the current graphics window, type this:
+
+   XYOUTS, 0.5, 0.5, ALIGN=0.5, "Happy Holidays", $
+   CHARSIZE=STR_SIZE("Happy Holidays", 0.3)
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id: str_size.pro 134 2006-07-07 10:19:08Z navarro $
+</div>
+          <h4>History</h4><div class="preformat">
+ Written by: David Fanning, 17 DEC 96.
+ Added a scaling factor to take into account the aspect ratio
+ of the window in determing the character size. 28 Oct 97. DWF
+</div>