Changeset 163 for trunk/SRC/Textoidl/textoidl.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Textoidl/textoidl.pro (modified) (4 diffs)

trunk/SRC/Textoidl/textoidl.pro

@@ +1 @@
+;+
+; @file_comments
+; Convert a valid TeX string to a valid IDL string for plot labels.
 ;
-;+
-; NAME:
-;       TEXTOIDL
-; PURPOSE:
-;       Convert a valid TeX string to a valid IDL string for plot labels.
-; CATEGORY:
-;       text/strings
-; CALLING SEQUENCE:
-;       new = textoidl(old)
-; INPUTS:
-;       old            -- TeX string to be converted.  Will not be     in
-;                         modified.  old may be a string array.
-; KEYWORD PARAMETERS:
-;       FONT           -- Set to 0 to use hardware font, -1 to use 
-;                         vector.  Note that the only hardware font 
-;                         supported is PostScript.
-;       /TEX_SEQUENCES -- return the available TeX sequences
-;       /HELP          -- print out info on use of the function
-;                         and exit.
-; OUTPUTS:
-;       new            -- IDL string corresponding to old.             out
-; COMMON BLOCKS:
-; SIDE EFFECTS:
-; NOTES:
+; @categories
+; Text, String
+;
+; @param INPUTSTRING {in}{required}
+; TeX string to be converted.  Will not be modified.  old may be a string array.
+;
+; @keyword FONT
+; Set to 0 to use hardware font, -1 to use 
+; vector.  Note that the only hardware font 
+; supported is PostScript.
+;
+; @keyword TEX_SEQUENCES
+; return the available TeX sequences
+;
+; @keyword HELP
+; print out info on use of the function and exit.
+;
+; @restrictions
 ;       - Use the procedure SHOWTEX to get a list of the available TeX
 ;         control sequences.  
@@ -32 +29 @@
 ;       - The FONT keyword overrides the font selected'
 ;         by !p.font'
-; EXAMPLE:
+;
+; @examples
 ;       out = TeXtoIDL('\Gamma^2 + 5N_{ed}')
 ;       The string out may be used in XYOUTS or other IDL text
@@ -38 +36 @@
 ;       exponent of 2, then a plus sign, then an N with the subscript
 ;       ed.
-; MODIFICATION HISTORY:
-;       $Id$
+;
+; @history
 ;       $Log: textoidl.pro,v $
 ;       Revision 1.7  2004/06/15 17:25:54  mcraig
@@ -62 +60 @@
 ;       Initial revision
 ;
-; RELEASE:
-;       $Name: Rel_2_1_2 $
-;
-; COPYRIGHT:
 ;  Copyright (C) 1996 The Regents of the University of California, All
 ;  Rights Reserved.  Written by Matthew W. Craig.
 ;  See the file COPYRIGHT for restrictions on distrubting this code.
 ;  This code comes with absolutely NO warranty; see DISCLAIMER for details.
+;
+; @version
+; $Id$
 ;-
 ;
-FUNCTION Textoidl, InputString, $
+FUNCTION textoidl, InputString, $
                    FONT=fnt, $
                    HELP=hlp, $