- Timestamp:
- 08/29/06 14:59:46 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
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.
