Changeset 163 for trunk/SRC/Documentation/idldoc_html_output/Textoidl
- Timestamp:
- 08/29/06 14:59:46 (18 years ago)
- Location:
- trunk/SRC/Documentation/idldoc_html_output/Textoidl
- Files:
-
- 11 edited
-
directory-overview.html (modified) (3 diffs)
-
matchdelim.html (modified) (4 diffs)
-
nexttok.html (modified) (1 diff)
-
showtex.html (modified) (4 diffs)
-
str_token.html (modified) (6 diffs)
-
strcnt.html (modified) (3 diffs)
-
strtrans.html (modified) (1 diff)
-
sub_sup_idl.html (modified) (1 diff)
-
textable.html (modified) (5 diffs)
-
textoidl.html (modified) (3 diffs)
-
translate_sub_super.html (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Textoidl/directory-overview.html
r157 r163 702 702 703 703 <dt><a href="matchdelim.html?format=raw">matchdelim.pro</a></dt> 704 <dd> </dd>704 <dd> Match open/close delimiters in a string.</dd> 705 705 706 706 <dt><a href="nexttok.html?format=raw">nexttok.pro</a></dt> … … 714 714 715 715 <dt><a href="strcnt.html?format=raw">strcnt.pro</a></dt> 716 <dd> </dd>716 <dd> Count number of occurrences of a substring in a string.</dd> 717 717 718 718 <dt><a href="strtrans.html?format=raw">strtrans.pro</a></dt> … … 723 723 724 724 <dt><a href="textable.html?format=raw">textable.pro</a></dt> 725 <dd> </dd>725 <dd> Returns a translation table from TeX to IDL.</dd> 726 726 727 727 <dt><a href="textoidl.html?format=raw">textoidl.pro</a></dt> 728 <dd> </dd>728 <dd> Convert a valid TeX string to a valid IDL string for plot labels.</dd> 729 729 730 730 <dt><a href="translate_sub_super.html?format=raw">translate_sub_super.pro</a></dt> 731 <dd> </dd>731 <dd> Return the proper IDL font positioning command for TeX sub/superscripts.</dd> 732 732 733 733 </dl> -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/matchdelim.html
r157 r163 699 699 </div> 700 700 701 <div id="file_comments"></div> 701 <div id="file_comments"> 702 Match open/close delimiters in a string. 703 </div> 702 704 703 705 … … 712 714 713 715 714 <div class="routine_details" id="_Matchdelim"> 715 716 <h2><a class="top" href="#container">top</a>Matchdelim </h2> 716 <div class="routine_details" id="_matchdelim"> 717 718 <h2><a class="top" href="#container">top</a>matchdelim <span class="categories"> 719 Text, String 720 </span></h2> 717 721 718 722 <p class="header"> 719 <span class="result">result = </span>Matchdelim(<span class="result"><a href="#_Matchdelim_param_InString">InString</a>, <a href="#_Matchdelim_param_OpenPos">OpenPos</a></span>, <a href="#_Matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<span class="result">OPEN_DELIM</span>, <a href="#_Matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<span class="result">CLOSE_DELIM</span>, <a href="#_Matchdelim_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 723 <span class="result">result = </span>matchdelim(<span class="result"><a href="#_matchdelim_param_InString">InString</a>[, <a href="#_matchdelim_param_OpenPos">OpenPos</a>]</span>, <a href="#_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<span class="result">OPEN_DELIM</span>, <a href="#_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<span class="result">CLOSE_DELIM</span>, <a href="#_matchdelim_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 724 725 <div class="comments"></div> 726 727 <h3>Return value</h3><div class="preformat"> 728 729 </div> 730 731 732 <h3>Parameters</h3> 733 734 735 <h4 id="_matchdelim_param_InString">InString 736 <span class="attr">in</span> 737 738 739 <span class="attr">required</span> 740 741 <span class="attr">type:</span> <span class="value">string</span> 742 743 744 </h4> 745 746 <div class="comments">') 747 </div> 748 749 <h4 id="_matchdelim_param_OpenPos">OpenPos 750 <span class="attr">in</span> 751 752 <span class="attr">optional</span> 753 754 755 756 757 758 </h4> 720 759 721 760 <div class="comments"> 722 NAME: 723 MATCHDELIM 724 PURPOSE: 725 Match open/close delimiters in a string. 726 CATEGORY: 727 text/strings 728 CALLING SEQUENCE: 729 position = matchdelim( strn, [openpos]) 730 INPUTS: 731 strn -- a string containing an open in 732 delimiter (e.g. '{') in which you 733 want to find the matching closing 734 delimiter (e.g. '}') 735 KEYWORD PARAMETERS: 736 OPEN_DELIM -- A single character containing the opening in 737 delimiter (e.g. '('). Default is '{' 738 CLOSE_DELIM -- A single character containing the closing in 739 delimiter (e.g. ')'). Default is '}' 740 OUTPUTS: 741 position -- returns the position in strn of the out 742 closing delimiter, -1 if no closing found. 743 openpos -- Set to a named variable to receive the out 744 position of the first opening delimiter. 745 Optional. 746 COMMON BLOCKS: 747 SIDE EFFECTS: 748 NOTES: 749 - Any pair of (nonidentical) characters can be used as 750 delimiters. 751 EXAMPLE: 752 matchdelim('{one{two}}three') returns 9, the character just 753 before 'three'. 754 MODIFICATION HISTORY: 755 $Id: matchdelim.pro 134 2006-07-07 10:19:08Z navarro $ 756 $Log: matchdelim.pro,v $ 757 Revision 1.3 1996/06/14 20:00:27 mcraig 758 Updated Copyright info. 759 760 Revision 1.2 1996/05/09 00:22:17 mcraig 761 Removed restriction that open delim must be first char. Added argument 762 to allow for return of position of open delim. 763 764 Revision 1.1 1996/01/31 18:41:06 mcraig 765 Initial revision 766 767 RELEASE: 768 $Name: Rel_2_1_2 $ 769 770 COPYRIGHT: 771 Copyright (C) 1996 The Regents of the University of California, All 772 Rights Reserved. Written by Matthew W. Craig. 773 See the file COPYRIGHT for restrictions on distrubting this code. 774 This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 775 776 777 778 779 <h3>Parameters</h3> 780 781 782 <h4 id="_Matchdelim_param_InString">InString 783 784 785 786 787 788 789 790 791 </h4> 792 793 <div class="comments"></div> 794 795 <h4 id="_Matchdelim_param_OpenPos">OpenPos 796 797 798 799 800 801 802 803 804 </h4> 805 806 <div class="comments"></div> 761 Set to a named variable to receive the 762 position of the first opening delimiter. 763 </div> 807 764 808 765 … … 813 770 <h3>Keywords</h3> 814 771 815 <h4 id="_Matchdelim_keyword_OPEN_DELIM">OPEN_DELIM 772 <h4 id="_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM 773 774 775 776 777 778 779 <span class="attr">default:</span> <span class="value">'{'</span> 780 781 </h4> 782 783 <div class="comments"> 784 A single character containing the opening 785 delimiter (e.g. '('). 786 </div> 787 788 <h4 id="_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM 789 790 791 792 793 794 795 <span class="attr">default:</span> <span class="value">'</span> 796 797 </h4> 798 799 <div class="comments">'} 800 A single character containing the closing 801 delimiter (e.g. ')'). 802 </div> 803 804 <h4 id="_matchdelim_keyword_HELP">HELP 816 805 817 806 … … 826 815 <div class="comments"></div> 827 816 828 <h4 id="_Matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM 829 830 831 832 833 834 835 836 837 </h4> 838 839 <div class="comments"></div> 840 841 <h4 id="_Matchdelim_keyword_HELP">HELP 842 843 844 845 846 847 848 849 850 </h4> 851 852 <div class="comments"></div> 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 817 818 819 <h3>Examples</h3><div class="preformat"> 820 matchdelim('{one{two}}three') returns 9, the character just before 'three'. 821 </div> 822 <h3>Version history</h3> 823 824 <h4>Version</h4><div class="preformat"> 825 $Id: matchdelim.pro 134 2006-07-07 10:19:08Z navarro $</div> 826 <h4>History</h4><div class="preformat"> 827 $Log: matchdelim.pro,v $ 828 Revision 1.3 1996/06/14 20:00:27 mcraig 829 Updated Copyright info. 830 831 Revision 1.2 1996/05/09 00:22:17 mcraig 832 Removed restriction that open delim must be first char. Added argument 833 to allow for return of position of open delim. 834 835 Revision 1.1 1996/01/31 18:41:06 mcraig 836 Initial revision; 837 838 Copyright (C) 1996 The Regents of the University of California, All 839 Rights Reserved. Written by Matthew W. Craig. 840 See the file COPYRIGHT for restrictions on distrubting this code. 841 This code comes with absolutely NO warranty; see DISCLAIMER for details. 842 </div> 843 844 845 <h3>Known issues</h3> 846 847 848 849 <h4>Restrictions</h4><div class="preformat"> 850 Any pair of (nonidentical) characters can be used as delimiters. 851 </div> 852 853 <h3>Other attributes</h3> 854 855 856 <h4>Uses routines</h4><div class="preformat"> 857 858 </div> 859 860 861 862 863 <h3>Statistics</h3> 864 <table class="statistics"> 865 <tr><td>McCabe cyclic</td><td> 8</td></tr> 866 <tr><td>McCabe essential</td><td> 1</td></tr> 867 <tr><td>McCabe modular design</td><td> 1</td></tr> 868 </table> 877 869 878 870 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/nexttok.html
r157 r163 858 858 859 859 860 <h3>Statistics</h3> 861 <table class="statistics"> 862 <tr><td>McCabe cyclic</td><td> 5</td></tr> 863 <tr><td>McCabe essential</td><td> 1</td></tr> 864 <tr><td>McCabe modular design</td><td> 1</td></tr> 865 </table> 860 866 861 867 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/showtex.html
r157 r163 712 712 713 713 714 <div class="routine_details" id="_ Showtex">715 716 <h2><a class="top" href="#container">top</a> Showtex </h2>714 <div class="routine_details" id="_showtex"> 715 716 <h2><a class="top" href="#container">top</a>showtex </h2> 717 717 718 718 <p class="header"> 719 Showtex, <a href="#_Showtex_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_Showtex_keyword_HELP">HELP</a>=<span class="result">HELP</span></p>719 showtex, <a href="#_showtex_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_showtex_keyword_HELP">HELP</a>=<span class="result">HELP</span></p> 720 720 721 721 <div class="comments"> … … 774 774 <h3>Keywords</h3> 775 775 776 <h4 id="_ Showtex_keyword_FONT">FONT 776 <h4 id="_showtex_keyword_FONT">FONT 777 777 778 778 … … 787 787 <div class="comments"></div> 788 788 789 <h4 id="_ Showtex_keyword_HELP">HELP 789 <h4 id="_showtex_keyword_HELP">HELP 790 790 791 791 … … 823 823 824 824 825 <h3>Statistics</h3> 826 <table class="statistics"> 827 <tr><td>McCabe cyclic</td><td> 9</td></tr> 828 <tr><td>McCabe essential</td><td> 1</td></tr> 829 <tr><td>McCabe modular design</td><td> 1</td></tr> 830 </table> 825 831 826 832 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/str_token.html
r157 r163 712 712 713 713 714 <div class="routine_details" id="_ Str_token">715 716 <h2><a class="top" href="#container">top</a> Str_token </h2>714 <div class="routine_details" id="_str_token"> 715 716 <h2><a class="top" href="#container">top</a>str_token </h2> 717 717 718 718 <p class="header"> 719 <span class="result">result = </span> Str_token(<span class="result"><a href="#_Str_token_param_string">string</a>, <a href="#_Str_token_param_token">token</a></span>, <a href="#_Str_token_keyword_TRIM">TRIM</a>=<span class="result">TRIM</span>, <a href="#_Str_token_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>719 <span class="result">result = </span>str_token(<span class="result"><a href="#_str_token_param_string">string</a>, <a href="#_str_token_param_token">token</a></span>, <a href="#_str_token_keyword_TRIM">TRIM</a>=<span class="result">TRIM</span>, <a href="#_str_token_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 720 720 721 721 <div class="comments"> … … 785 785 786 786 787 <h4 id="_ Str_token_param_string">string 787 <h4 id="_str_token_param_string">string 788 788 789 789 … … 798 798 <div class="comments"></div> 799 799 800 <h4 id="_ Str_token_param_token">token 800 <h4 id="_str_token_param_token">token 801 801 802 802 … … 818 818 <h3>Keywords</h3> 819 819 820 <h4 id="_ Str_token_keyword_TRIM">TRIM 820 <h4 id="_str_token_keyword_TRIM">TRIM 821 821 822 822 … … 831 831 <div class="comments"></div> 832 832 833 <h4 id="_ Str_token_keyword_HELP">HELP 833 <h4 id="_str_token_keyword_HELP">HELP 834 834 835 835 … … 867 867 868 868 869 <h3>Statistics</h3> 870 <table class="statistics"> 871 <tr><td>McCabe cyclic</td><td> 4</td></tr> 872 <tr><td>McCabe essential</td><td> 1</td></tr> 873 <tr><td>McCabe modular design</td><td> 1</td></tr> 874 </table> 869 875 870 876 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/strcnt.html
r157 r163 699 699 </div> 700 700 701 <div id="file_comments"></div> 701 <div id="file_comments"> 702 Count number of occurrences of a substring in a string. 703 </div> 702 704 703 705 … … 712 714 713 715 714 <div class="routine_details" id="_Strcnt"> 715 716 <h2><a class="top" href="#container">top</a>Strcnt </h2> 716 <div class="routine_details" id="_strcnt"> 717 718 <h2><a class="top" href="#container">top</a>strcnt <span class="categories"> 719 Text, String 720 </span></h2> 717 721 718 722 <p class="header"> 719 <span class="result">result = </span>Strcnt(<span class="result"><a href="#_Strcnt_param_strn">strn</a>, <a href="#_Strcnt_param_substrn">substrn</a>, <a href="#_Strcnt_param_startpos">startpos</a></span>, <a href="#_Strcnt_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 723 <span class="result">result = </span>strcnt(<span class="result"><a href="#_strcnt_param_strn">strn</a>, <a href="#_strcnt_param_substrn">substrn</a>, <a href="#_strcnt_param_startpos">startpos</a></span>, <a href="#_strcnt_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 724 725 <div class="comments"></div> 726 727 <h3>Return value</h3><div class="preformat"> 728 Number of occurances of substring in string. 729 </div> 730 731 732 <h3>Parameters</h3> 733 734 735 <h4 id="_strcnt_param_strn">strn 736 <span class="attr">in</span> 737 738 739 <span class="attr">required</span> 740 741 <span class="attr">type:</span> <span class="value">string</span> 742 743 744 </h4> 720 745 721 746 <div class="comments"> 722 NAME: 723 STRCNT 724 PURPOSE: 725 Count number of occurrences of a substring in a string. 726 CATEGORY: 727 text/strings 728 CALLING SEQUENCE: 729 num = strcnt(strn, substring, [pos]) 730 INPUTS: 731 string -- The string in which to count occurences. in 732 substring -- The substring to count occurrences of. in 733 pos -- the position at which to begin the search. [in] 734 If not supplied, start at beginning of 735 string. 736 KEYWORD PARAMETERS: 737 /HELP -- Print useful message and return. 738 OUTPUTS: 739 num -- Number of occurances of substring in string. out 740 COMMON BLOCKS: 741 SIDE EFFECTS: 742 NOTES: 743 Overlapping occurances are not counted separately. For 744 example, counting occurances of 'bb' in 'blah bbb' returns one 745 occurance. 746 EXAMPLE: 747 MODIFICATION HISTORY: 748 $Id: strcnt.pro 134 2006-07-07 10:19:08Z navarro $ 747 The string in which to count occurences. 748 </div> 749 750 <h4 id="_strcnt_param_substrn">substrn 751 <span class="attr">in</span> 752 753 754 <span class="attr">required</span> 755 756 <span class="attr">type:</span> <span class="value">string</span> 757 758 759 </h4> 760 761 <div class="comments"> 762 The substring to count occurrences of. 763 </div> 764 765 <h4 id="_strcnt_param_startpos">startpos 766 <span class="attr">in</span> 767 768 769 <span class="attr">required</span> 770 771 772 773 774 </h4> 775 776 <div class="comments"> 777 The position at which to begin the search. 778 If not supplied, start at beginning of string. 779 </div> 780 781 782 783 784 785 786 <h3>Keywords</h3> 787 788 <h4 id="_strcnt_keyword_HELP">HELP 789 790 791 792 793 794 795 796 797 </h4> 798 799 <div class="comments"> 800 Print useful message and return. 801 </div> 802 803 804 805 806 <h3>Version history</h3> 807 808 <h4>Version</h4><div class="preformat"> 809 $Id: strcnt.pro 134 2006-07-07 10:19:08Z navarro $</div> 810 <h4>History</h4><div class="preformat"> 749 811 $Log: strcnt.pro,v $ 750 812 Revision 1.3 1996/06/14 20:00:27 mcraig … … 758 820 Initial revision 759 821 760 RELEASE:761 $Name: Rel_2_1_2 $762 763 COPYRIGHT:764 822 Copyright (C) 1996 The Regents of the University of California, All 765 823 Rights Reserved. Written by Matthew W. Craig. 766 824 See the file COPYRIGHT for restrictions on distrubting this code. 767 This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 768 769 770 771 772 <h3>Parameters</h3> 773 774 775 <h4 id="_Strcnt_param_strn">strn 776 777 778 779 780 781 782 783 784 </h4> 785 786 <div class="comments"></div> 787 788 <h4 id="_Strcnt_param_substrn">substrn 789 790 791 792 793 794 795 796 797 </h4> 798 799 <div class="comments"></div> 800 801 <h4 id="_Strcnt_param_startpos">startpos 802 803 804 805 806 807 808 809 810 </h4> 811 812 <div class="comments"></div> 813 814 815 816 817 818 819 <h3>Keywords</h3> 820 821 <h4 id="_Strcnt_keyword_HELP">HELP 822 823 824 825 826 827 828 829 830 </h4> 831 832 <div class="comments"></div> 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 825 This code comes with absolutely NO warranty; see DISCLAIMER for details. 826 </div> 827 828 829 <h3>Known issues</h3> 830 831 832 833 <h4>Restrictions</h4><div class="preformat"> 834 Overlapping occurances are not counted separately. For 835 example, counting occurances of 'bb' in 'blah bbb' returns one 836 occurance. 837 </div> 838 839 840 841 842 843 844 845 846 847 <h3>Statistics</h3> 848 <table class="statistics"> 849 <tr><td>McCabe cyclic</td><td> 7</td></tr> 850 <tr><td>McCabe essential</td><td> 1</td></tr> 851 <tr><td>McCabe modular design</td><td> 1</td></tr> 852 </table> 857 853 858 854 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/strtrans.html
r157 r163 891 891 892 892 893 <h3>Statistics</h3> 894 <table class="statistics"> 895 <tr><td>McCabe cyclic</td><td> 8</td></tr> 896 <tr><td>McCabe essential</td><td> 1</td></tr> 897 <tr><td>McCabe modular design</td><td> 1</td></tr> 898 </table> 893 899 894 900 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/sub_sup_idl.html
r157 r163 814 814 815 815 816 <h3>Statistics</h3> 817 <table class="statistics"> 818 <tr><td>McCabe cyclic</td><td> 6</td></tr> 819 <tr><td>McCabe essential</td><td> 1</td></tr> 820 <tr><td>McCabe modular design</td><td> 1</td></tr> 821 </table> 816 822 817 823 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/textable.html
r157 r163 699 699 </div> 700 700 701 <div id="file_comments"></div> 701 <div id="file_comments"> 702 Returns a translation table from TeX to IDL. 703 </div> 702 704 703 705 … … 714 716 <div class="routine_details" id="_textable"> 715 717 716 <h2><a class="top" href="#container">top</a>textable </h2> 718 <h2><a class="top" href="#container">top</a>textable <span class="categories"> 719 Text, String 720 </span></h2> 717 721 718 722 <p class="header"> 719 723 <span class="result">result = </span>textable(<a href="#_textable_keyword_POSTSCRIPT">POSTSCRIPT</a>=<span class="result">POSTSCRIPT</span>, <a href="#_textable_keyword_VECTOR">VECTOR</a>=<span class="result">VECTOR</span>, <a href="#_textable_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 720 724 721 <div class="comments"> 722 NAME: 723 TEXTABLE 724 PURPOSE: 725 Returns a translation table from TeX to IDL. 726 CATEGORY: 727 text/strings 728 CALLING SEQUENCE: 729 table = textable() 730 INPUTS: 731 None 732 KEYWORD PARAMETERS: 733 /POSTSCRIPT -- If set, return postscript translation 734 table rather than vector fonts table. 735 Default is translations for vector 736 fonts. 737 /HELP -- Print help and exit. 738 OUTPUTS: 739 table -- a 2D text array. table(0,*) contains out 740 the words to be translated away, table(1,*) 741 contains the words to translate them to. 742 COMMON BLOCKS: 743 SIDE EFFECTS: 744 NOTES: 745 To find out what TeX sequences are available, look at 746 table(0,*). 747 EXAMPLE: 748 MODIFICATION HISTORY: 749 $Id: textable.pro 134 2006-07-07 10:19:08Z navarro $ 725 <div class="comments"></div> 726 727 <h3>Return value</h3><div class="preformat"> 728 a 2D text array. table(0,*) contains the words to be translated away, table(1,*) 729 contains the words to translate them to. 730 </div> 731 732 733 734 735 736 <h3>Keywords</h3> 737 738 <h4 id="_textable_keyword_POSTSCRIPT">POSTSCRIPT 739 740 741 742 743 744 745 746 747 </h4> 748 749 <div class="comments"> 750 If set, return postscript translation 751 table rather than vector fonts table. 752 Default is translations for vector fonts. 753 </div> 754 755 <h4 id="_textable_keyword_VECTOR">VECTOR 756 757 758 759 760 761 762 763 764 </h4> 765 766 <div class="comments"> 767 768 </div> 769 770 <h4 id="_textable_keyword_HELP">HELP 771 772 773 774 775 776 777 778 779 </h4> 780 781 <div class="comments"> 782 Print help and exit. 783 </div> 784 785 786 787 788 <h3>Version history</h3> 789 790 <h4>Version</h4><div class="preformat"> 791 $Id: textable.pro 134 2006-07-07 10:19:08Z navarro $</div> 792 <h4>History</h4><div class="preformat"> 750 793 $Log: textable.pro,v $ 751 794 Revision 1.8 2004/06/15 17:25:54 mcraig … … 753 796 754 797 Revision 1.7 1996/07/22 23:56:08 mcraig 755 Added \vartheta.798 Added vartheta. 756 799 757 800 Revision 1.6 1996/07/12 21:31:42 mcraig 758 Fixed \varphi in vector font, added \circ.801 Fixed varphi in vector font, added circ. 759 802 760 803 Revision 1.5 1996/06/14 20:00:27 mcraig … … 766 809 767 810 Revision 1.3 1996/02/08 19:49:35 mcraig 768 Removed control sequence \perp because the postscript code for it is '^'.811 Removed control sequence perp because the postscript code for it is '^'. 769 812 770 813 Revision 1.2 1996/02/08 18:53:38 mcraig … … 775 818 Initial revision 776 819 777 RELEASE:778 $Name: Rel_2_1_2 $779 780 COPYRIGHT:781 820 Copyright (C) 1996 The Regents of the University of California, All 782 821 Rights Reserved. Written by Matthew W. Craig. 783 822 See the file COPYRIGHT for restrictions on distrubting this code. 784 This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 785 786 787 788 789 790 791 792 <h3>Keywords</h3> 793 794 <h4 id="_textable_keyword_POSTSCRIPT">POSTSCRIPT 795 796 797 798 799 800 801 802 803 </h4> 804 805 <div class="comments"></div> 806 807 <h4 id="_textable_keyword_VECTOR">VECTOR 808 809 810 811 812 813 814 815 816 </h4> 817 818 <div class="comments"></div> 819 820 <h4 id="_textable_keyword_HELP">HELP 821 822 823 824 825 826 827 828 829 </h4> 830 831 <div class="comments"></div> 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 823 This code comes with absolutely NO warranty; see DISCLAIMER for details. 824 </div> 825 826 827 <h3>Known issues</h3> 828 829 830 831 <h4>Restrictions</h4><div class="preformat"> 832 To find out what TeX sequences are available, look at table(0,*). 833 </div> 834 835 836 837 838 839 840 841 842 843 <h3>Statistics</h3> 844 <table class="statistics"> 845 <tr><td>McCabe cyclic</td><td> 3</td></tr> 846 <tr><td>McCabe essential</td><td> 1</td></tr> 847 <tr><td>McCabe modular design</td><td> 1</td></tr> 848 </table> 856 849 857 850 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/textoidl.html
r157 r163 699 699 </div> 700 700 701 <div id="file_comments"></div> 701 <div id="file_comments"> 702 Convert a valid TeX string to a valid IDL string for plot labels. 703 </div> 702 704 703 705 … … 712 714 713 715 714 <div class="routine_details" id="_Textoidl"> 715 716 <h2><a class="top" href="#container">top</a>Textoidl </h2> 716 <div class="routine_details" id="_textoidl"> 717 718 <h2><a class="top" href="#container">top</a>textoidl <span class="categories"> 719 Text, String 720 </span></h2> 717 721 718 722 <p class="header"> 719 <span class="result">result = </span>Textoidl(<span class="result"><a href="#_Textoidl_param_InputString">InputString</a></span>, <a href="#_Textoidl_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_Textoidl_keyword_HELP">HELP</a>=<span class="result">HELP</span>, <a href="#_Textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES</a>=<span class="result">TEX_SEQUENCES</span>)</p> 723 <span class="result">result = </span>textoidl(<span class="result"><a href="#_textoidl_param_InputString">InputString</a></span>, <a href="#_textoidl_keyword_FONT">FONT</a>=<span class="result">FONT</span>, <a href="#_textoidl_keyword_HELP">HELP</a>=<span class="result">HELP</span>, <a href="#_textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES</a>=<span class="result">TEX_SEQUENCES</span>)</p> 724 725 <div class="comments"></div> 726 727 728 729 730 <h3>Parameters</h3> 731 732 733 <h4 id="_textoidl_param_InputString">InputString 734 <span class="attr">in</span> 735 736 737 <span class="attr">required</span> 738 739 740 741 742 </h4> 720 743 721 744 <div class="comments"> 722 NAME: 723 TEXTOIDL 724 PURPOSE: 725 Convert a valid TeX string to a valid IDL string for plot labels. 726 CATEGORY: 727 text/strings 728 CALLING SEQUENCE: 729 new = textoidl(old) 730 INPUTS: 731 old -- TeX string to be converted. Will not be in 732 modified. old may be a string array. 733 KEYWORD PARAMETERS: 734 FONT -- Set to 0 to use hardware font, -1 to use 735 vector. Note that the only hardware font 736 supported is PostScript. 737 /TEX_SEQUENCES -- return the available TeX sequences 738 /HELP -- print out info on use of the function 739 and exit. 740 OUTPUTS: 741 new -- IDL string corresponding to old. out 742 COMMON BLOCKS: 743 SIDE EFFECTS: 744 NOTES: 745 TeX string to be converted. Will not be modified. old may be a string array. 746 </div> 747 748 749 750 751 752 753 <h3>Keywords</h3> 754 755 <h4 id="_textoidl_keyword_FONT">FONT 756 757 758 759 760 761 762 763 764 </h4> 765 766 <div class="comments"> 767 Set to 0 to use hardware font, -1 to use 768 vector. Note that the only hardware font 769 supported is PostScript. 770 </div> 771 772 <h4 id="_textoidl_keyword_HELP">HELP 773 774 775 776 777 778 779 780 781 </h4> 782 783 <div class="comments"> 784 print out info on use of the function and exit. 785 </div> 786 787 <h4 id="_textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES 788 789 790 791 792 793 794 795 796 </h4> 797 798 <div class="comments"> 799 return the available TeX sequences 800 </div> 801 802 803 804 <h3>Examples</h3><div class="preformat"> 805 out = TeXtoIDL('Gamma^2 + 5N_{ed}') 806 The string out may be used in XYOUTS or other IDL text 807 display routines. It will be an uppercase Gamma, with an 808 exponent of 2, then a plus sign, then an N with the subscript 809 ed. 810 </div> 811 <h3>Version history</h3> 812 813 <h4>Version</h4><div class="preformat"> 814 $Id: textoidl.pro 134 2006-07-07 10:19:08Z navarro $</div> 815 <h4>History</h4><div class="preformat"> 816 $Log: textoidl.pro,v $ 817 Revision 1.7 2004/06/15 17:25:54 mcraig 818 Fixed bug in regular expression, changed array notation to square brackets 819 820 Revision 1.6 2004/01/11 01:49:00 mcraig 821 Changed format of one array to newer [] style to avoidf conflict with function name in astro library. 822 823 Revision 1.5 2001/11/23 21:10:55 mcraig 824 Added backslash '' to tex sequences in translation table to protect them during regexp search in strsplit. 825 826 Revision 1.4 1996/06/14 20:00:27 mcraig 827 Updated Copyright info. 828 829 Revision 1.3 1996/05/09 00:22:17 mcraig 830 Added error handling, cleaned up documentation. 831 832 Revision 1.2 1996/02/08 18:52:50 mcraig 833 Added ability to use hardware fonts for PostScript device. 834 835 Revision 1.1 1996/01/31 18:47:37 mcraig 836 Initial revision 837 838 Copyright (C) 1996 The Regents of the University of California, All 839 Rights Reserved. Written by Matthew W. Craig. 840 See the file COPYRIGHT for restrictions on distrubting this code. 841 This code comes with absolutely NO warranty; see DISCLAIMER for details. 842 </div> 843 844 845 <h3>Known issues</h3> 846 847 848 849 <h4>Restrictions</h4><div class="preformat"> 745 850 - Use the procedure SHOWTEX to get a list of the available TeX 746 851 control sequences. … … 751 856 - The FONT keyword overrides the font selected' 752 857 by !p.font' 753 EXAMPLE: 754 out = TeXtoIDL('\Gamma^2 + 5N_{ed}') 755 The string out may be used in XYOUTS or other IDL text 756 display routines. It will be an uppercase Gamma, with an 757 exponent of 2, then a plus sign, then an N with the subscript 758 ed. 759 MODIFICATION HISTORY: 760 $Id: textoidl.pro 134 2006-07-07 10:19:08Z navarro $ 761 $Log: textoidl.pro,v $ 762 Revision 1.7 2004/06/15 17:25:54 mcraig 763 Fixed bug in regular expression, changed array notation to square brackets 764 765 Revision 1.6 2004/01/11 01:49:00 mcraig 766 Changed format of one array to newer [] style to avoidf conflict with function name in astro library. 767 768 Revision 1.5 2001/11/23 21:10:55 mcraig 769 Added backslash '\' to tex sequences in translation table to protect them during regexp search in strsplit. 770 771 Revision 1.4 1996/06/14 20:00:27 mcraig 772 Updated Copyright info. 773 774 Revision 1.3 1996/05/09 00:22:17 mcraig 775 Added error handling, cleaned up documentation. 776 777 Revision 1.2 1996/02/08 18:52:50 mcraig 778 Added ability to use hardware fonts for PostScript device. 779 780 Revision 1.1 1996/01/31 18:47:37 mcraig 781 Initial revision 782 783 RELEASE: 784 $Name: Rel_2_1_2 $ 785 786 COPYRIGHT: 787 Copyright (C) 1996 The Regents of the University of California, All 788 Rights Reserved. Written by Matthew W. Craig. 789 See the file COPYRIGHT for restrictions on distrubting this code. 790 This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 791 792 793 794 795 <h3>Parameters</h3> 796 797 798 <h4 id="_Textoidl_param_InputString">InputString 799 800 801 802 803 804 805 806 807 </h4> 808 809 <div class="comments"></div> 810 811 812 813 814 815 816 <h3>Keywords</h3> 817 818 <h4 id="_Textoidl_keyword_FONT">FONT 819 820 821 822 823 824 825 826 827 </h4> 828 829 <div class="comments"></div> 830 831 <h4 id="_Textoidl_keyword_HELP">HELP 832 833 834 835 836 837 838 839 840 </h4> 841 842 <div class="comments"></div> 843 844 <h4 id="_Textoidl_keyword_TEX_SEQUENCES">TEX_SEQUENCES 845 846 847 848 849 850 851 852 853 </h4> 854 855 <div class="comments"></div> 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 858 </div> 859 860 861 862 863 864 865 866 867 868 <h3>Statistics</h3> 869 <table class="statistics"> 870 <tr><td>McCabe cyclic</td><td> 8</td></tr> 871 <tr><td>McCabe essential</td><td> 1</td></tr> 872 <tr><td>McCabe modular design</td><td> 1</td></tr> 873 </table> 880 874 881 875 -
trunk/SRC/Documentation/idldoc_html_output/Textoidl/translate_sub_super.html
r157 r163 699 699 </div> 700 700 701 <div id="file_comments"></div> 701 <div id="file_comments"> 702 Return the proper IDL font positioning command for TeX 703 sub/superscripts. 704 </div> 702 705 703 706 … … 713 716 <dl> 714 717 715 <dt><p><a href="#_ Sub_sup_idl"><span class="result">result = </span>Sub_sup_idl(<span class="result">token</span>, FORCE_UD=<span class="result">FORCE_UD</span>)</a></p><dt>716 <dd> SPECIAL NOTE: The file translate_sub_super.</dd>717 718 <dt><p><a href="#_ Translate_sub_super"><span class="result">result = </span>Translate_sub_super(<span class="result">InputString</span>, RECURSED=<span class="result">RECURSED</span>, HELP=<span class="result">HELP</span>)</a></p><dt>718 <dt><p><a href="#_sub_sup_idl"><span class="result">result = </span>sub_sup_idl(<span class="result">token</span>, FORCE_UD=<span class="result">FORCE_UD</span>)</a></p><dt> 719 <dd></dd> 720 721 <dt><p><a href="#_translate_sub_super"><span class="result">result = </span>translate_sub_super(<span class="result">InputString</span>, RECURSED=<span class="result">RECURSED</span>, HELP=<span class="result">HELP</span>)</a></p><dt> 719 722 <dd> NAME: TRANSLATE_SUB_SUPER PURPOSE: Translate TeX sub/superscripts to IDL sub/superscripts.</dd> 720 723 … … 726 729 727 730 728 <div class="routine_details" id="_Sub_sup_idl"> 729 730 <h2><a class="top" href="#container">top</a>Sub_sup_idl </h2> 731 <div class="routine_details" id="_sub_sup_idl"> 732 733 <h2><a class="top" href="#container">top</a>sub_sup_idl <span class="categories"> 734 Text, String 735 </span></h2> 731 736 732 737 <p class="header"> 733 <span class="result">result = </span>Sub_sup_idl(<span class="result"><a href="#_Sub_sup_idl_param_token">token</a></span>, <a href="#_Sub_sup_idl_keyword_FORCE_UD">FORCE_UD</a>=<span class="result">FORCE_UD</span>)</p> 738 <span class="result">result = </span>sub_sup_idl(<span class="result"><a href="#_sub_sup_idl_param_token">token</a></span>, <a href="#_sub_sup_idl_keyword_FORCE_UD">FORCE_UD</a>=<span class="result">FORCE_UD</span>)</p> 739 740 <div class="comments"></div> 741 742 <h3>Return value</h3><div class="preformat"> 743 Either '!U' or !E' for superscripts, or '!D' or '!I' for subscripts. 744 </div> 745 746 747 <h3>Parameters</h3> 748 749 750 <h4 id="_sub_sup_idl_param_token">token 751 752 753 754 755 756 757 758 759 </h4> 734 760 735 761 <div class="comments"> 736 SPECIAL NOTE: 737 The file translate_sub_super.pro contains two functions, 738 translate_sub_super, and sub_sup_idl. The former is the 739 generic routine for processing TeX sub/superscripts, the 740 latter is used only by translate_sub_super and has no general 741 utility. Hence it lives here. You will see documentation for 742 translate_sub_super second if you use DOC_LIBRARY.</div> 743 744 745 746 747 <h3>Parameters</h3> 748 749 750 <h4 id="_Sub_sup_idl_param_token">token 751 752 753 754 755 756 757 758 759 </h4> 760 761 <div class="comments"></div> 762 Either '^' or '_', the TeX super/subscript characters 763 </div> 762 764 763 765 … … 768 770 <h3>Keywords</h3> 769 771 770 <h4 id="_ Sub_sup_idl_keyword_FORCE_UD">FORCE_UD 772 <h4 id="_sub_sup_idl_keyword_FORCE_UD">FORCE_UD 771 773 772 774 … … 779 781 </h4> 780 782 781 <div class="comments"></div> 783 <div class="comments"> 784 Set this to use !U/!D instead of !E/!I for sub/superscripts. 785 </div> 782 786 783 787 784 788 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 789 <h3>Examples</h3><div class="preformat"> 790 791 </div> 792 <h3>Version history</h3> 793 794 <h4>Version</h4><div class="preformat"> 795 $Id: translate_sub_super.pro 134 2006-07-07 10:19:08Z navarro $</div> 796 <h4>History</h4><div class="preformat"> 797 $Log: translate_sub_super.pro,v $ 798 Revision 1.5 2000/06/14 19:09:22 mcraig 799 Changed name of strtok str_token to avoid conflict in IDL 5.3. 800 801 Revision 1.4 1996/06/14 20:00:27 mcraig 802 Updated Copyright info. 803 804 Revision 1.3 1996/05/09 00:22:17 mcraig 805 Changed some function calls to reflect changes in those functions, moved 806 some code out of the main loop that didn't need to be there, added 807 documentation. 808 809 Revision 1.1 1996/01/31 18:47:37 mcraig 810 Initial revision 811 812 Copyright (C) 1996 The Regents of the University of California, All 813 Rights Reserved. Written by Matthew W. Craig. 814 See the file COPYRIGHT for restrictions on distrubting this code. 815 This code comes with absolutely NO warranty; see DISCLAIMER for details. 816 </div> 817 818 819 <h3>Known issues</h3> 820 821 822 823 <h4>Restrictions</h4><div class="preformat"> 824 Make sure sub_sup_idl stays before translate_sub_super. At least 825 for now, when IDL encounters a function and automatically compiles 826 it, it only compiles the functions in the file up to the named 827 function. So even if sub_sup_idl was declared with 828 FORWARD_FUNCTION in translate_sub_super, it would not properly 829 compile. 830 831 The file translate_sub_super.pro contains two functions, 832 translate_sub_super, and sub_sup_idl. The former is the 833 generic routine for processing TeX sub/superscripts, the 834 latter is used only by translate_sub_super and has no general 835 utility. Hence it lives here. You will see documentation for 836 translate_sub_super second if you use DOC_LIBRARY. 837 838 Used only by translate_sub_super. Should be kept in same 839 file. 840 </div> 841 842 <h3>Other attributes</h3> 843 844 845 <h4>Uses routines</h4><div class="preformat"> 846 847 </div> 848 849 850 851 852 <h3>Statistics</h3> 853 <table class="statistics"> 854 <tr><td>McCabe cyclic</td><td> 7</td></tr> 855 <tr><td>McCabe essential</td><td> 1</td></tr> 856 <tr><td>McCabe modular design</td><td> 1</td></tr> 857 </table> 806 858 807 859 … … 809 861 810 862 811 <div class="routine_details" id="_ Translate_sub_super">812 813 <h2><a class="top" href="#container">top</a> Translate_sub_super </h2>863 <div class="routine_details" id="_translate_sub_super"> 864 865 <h2><a class="top" href="#container">top</a>translate_sub_super </h2> 814 866 815 867 <p class="header"> 816 <span class="result">result = </span> Translate_sub_super(<span class="result"><a href="#_Translate_sub_super_param_InputString">InputString</a></span>, <a href="#_Translate_sub_super_keyword_RECURSED">RECURSED</a>=<span class="result">RECURSED</span>, <a href="#_Translate_sub_super_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>868 <span class="result">result = </span>translate_sub_super(<span class="result"><a href="#_translate_sub_super_param_InputString">InputString</a></span>, <a href="#_translate_sub_super_keyword_RECURSED">RECURSED</a>=<span class="result">RECURSED</span>, <a href="#_translate_sub_super_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 817 869 818 870 <div class="comments"> … … 885 937 886 938 887 <h4 id="_ Translate_sub_super_param_InputString">InputString 939 <h4 id="_translate_sub_super_param_InputString">InputString 888 940 889 941 … … 905 957 <h3>Keywords</h3> 906 958 907 <h4 id="_ Translate_sub_super_keyword_RECURSED">RECURSED 959 <h4 id="_translate_sub_super_keyword_RECURSED">RECURSED 908 960 909 961 … … 918 970 <div class="comments"></div> 919 971 920 <h4 id="_ Translate_sub_super_keyword_HELP">HELP 972 <h4 id="_translate_sub_super_keyword_HELP">HELP 921 973 922 974 … … 954 1006 955 1007 1008 <h3>Statistics</h3> 1009 <table class="statistics"> 1010 <tr><td>McCabe cyclic</td><td> 11</td></tr> 1011 <tr><td>McCabe essential</td><td> 1</td></tr> 1012 <tr><td>McCabe modular design</td><td> 1</td></tr> 1013 </table> 956 1014 957 1015
Note: See TracChangeset
for help on using the changeset viewer.
