[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Problem_LON-CAPA_Functions.tex Script_Functions.tex all_functions_table.tex
albertel
lon-capa-cvs@mail.lon-capa.org
Fri, 01 Apr 2005 18:32:42 -0000
albertel Fri Apr 1 13:32:42 2005 EDT
Modified files:
/loncom/html/adm/help/tex Problem_LON-CAPA_Functions.tex
Script_Functions.tex
all_functions_table.tex
Log:
- documentation updates for prettyprint(), format(), dollarformat(),
- documentation adds for check_status()
Index: loncom/html/adm/help/tex/Problem_LON-CAPA_Functions.tex
diff -u loncom/html/adm/help/tex/Problem_LON-CAPA_Functions.tex:1.4 loncom/html/adm/help/tex/Problem_LON-CAPA_Functions.tex:1.5
--- loncom/html/adm/help/tex/Problem_LON-CAPA_Functions.tex:1.4 Thu May 6 11:22:47 2004
+++ loncom/html/adm/help/tex/Problem_LON-CAPA_Functions.tex Fri Apr 1 13:32:42 2005
@@ -45,13 +45,13 @@
\&asinh(\$x), \&acosh(\$x), \&atanh(\$x) & Inverse hyperbolic functions. \$x can be a pure number \\
\hline
-\&format(\$x,'nn') & Display or format \$x as nn where nn is nF or nE and n is an integer. Also supports the first character being a \$, it thjen will format the result with a call to \&dollarformat() described below. \\
+\&format(\$x,'nn') & Display or format \$x as nn where nn is nF or nE or nS and n is an integer. \\
\hline
-\&prettyprint(\$x,'nn') & Display or format \$x as nn where nn is nF or nE and n is an integer. Also supports the first character being a \$, it then will format the result with a a call to \&dollarformat() described below. In E mode it will attempt to generate a pretty x10\^{}3 rather than a E3 following the number \\
+\&prettyprint(\$x,'nn','optional target') &Display or format \$x as nn where nn is nF or nE or nS and n is an integer. Also supports the first character being a \$, it then will format the result with a a call to \&dollarformat() described below. If the first character is a , it will format it with commas grouping the thousands. In S mode it will fromat the number to the specified number of significant figures and display it in F mode. In E mode it will attempt to generate a pretty x10\^{}3 rather than a E3 following the number, the 'optional target' argument is optional but can be used to force \&prettyprint to generate either 'tex' output, or 'web' output, most people do not need to specify this argument and can leave it blank. \\
\hline
-\&dollarformat(\$x) & Reformats \$x to have a \$ (or $\backslash$\$ if in tex mode) and to have , grouping thousands. \\
+\&dollarformat(\$x,'optional target') & Reformats \$x to have a \$ (or $\backslash$\$ if in tex mode) and to have , grouping thousands. The 'optional target' argument is optional but can be used to force \&prettyprint to generate either 'tex' output, or 'web' output, most people do not need to specify this argument and can leave it blank. \\
\hline
\&roundto(\$x,\$n) & Rounds a real number to n decimal points. \$x and \$n can be pure numbers \\
@@ -118,7 +118,8 @@
\&name(), \&student\_number() & Return the full name in the following format: lastname, firstname initial. Student\_number returns the student 9-alphanumeric string. If undefined, the functions return null. \\
\hline
-
+\&check\_status(\$partid) &Returns a number identifing the current status of a part. Ture values mean that a part is ``done'' (either unanswerable becuase of tries exhuastion, or correct) or a false value if a part can still be attempted. If \$part is unspecfied, it will check either the current $<$part$>$'s status or if outside of a $<$part$>$, check the status of previous $<$part$>$. The full set of return codes are: 'undef' means it is unattempted, 0 means it is attmpted and wrong but still has tries, 1 means it is marked correct, 2 means they have exceed maximum number of tries, 3 means it after the answer date \\
+\hline
\&open\_date(), \&due\_date(), \&answer\_date() & Problem open date, due date and answer date. The time is also included in 24-hr format. \\
\hline
Index: loncom/html/adm/help/tex/Script_Functions.tex
diff -u loncom/html/adm/help/tex/Script_Functions.tex:1.2 loncom/html/adm/help/tex/Script_Functions.tex:1.3
--- loncom/html/adm/help/tex/Script_Functions.tex:1.2 Fri Feb 25 14:58:24 2005
+++ loncom/html/adm/help/tex/Script_Functions.tex Fri Apr 1 13:32:42 2005
@@ -29,10 +29,11 @@
\item to\_string(x), to\_string(x,y)
\item class(), section()
\item name(), student\_number()
+\item check\_status(partid)
\item open\_date(), due\_date(), answer\_date()
\item sub\_string()
\item array\_moments(array)
-\item format(x,y),prettyprint(x,y)
+\item format(x,y),prettyprint(x,y,target),dollarformat(x,target)
\item map(...)
\item caparesponse\_check
\item caparesponse\_check\_list
Index: loncom/html/adm/help/tex/all_functions_table.tex
diff -u loncom/html/adm/help/tex/all_functions_table.tex:1.5 loncom/html/adm/help/tex/all_functions_table.tex:1.6
--- loncom/html/adm/help/tex/all_functions_table.tex:1.5 Thu Mar 31 09:43:14 2005
+++ loncom/html/adm/help/tex/all_functions_table.tex Fri Apr 1 13:32:42 2005
@@ -88,6 +88,8 @@
\hline
name(), student\_number() &\&name(), \&student\_number() &Return the full name in the following format: lastname, firstname initial. Student\_number returns the student 9-alphanumeric string. If undefined, the functions return null. & \\
\hline
+NOT IMPLEMENTED IN CAPA &\&check\_status(\$partid) &Returns a number identifing the current status of a part. Ture values mean that a part is ``done'' (either unanswerable becuase of tries exhuastion, or correct) or a false value if a part can still be attempted. If \$part is unspecfied, it will check either the current $<$part$>$'s status or if outside of a $<$part$>$, check the status of previous $<$part$>$. The full set of return codes are: 'undef' means it is unattempted, 0 means it is attmpted and wrong but still has tries, 1 means it is marked correct, 2 means they have exceed maximum number of tries, 3 means it after the answer date & \\
+ \hline
open\_date(), due\_date(), answer\_date() &\&open\_date(), \&due\_date(), \&answer\_date() &Problem open date, due date and answer date. The time is also included in 24-hr format. &Output format for time is changed slightly. If pass noon, it displays ..pm else it displays ..am. So 23:59 is displayed as 11:59 pm. \\
\hline
get\_seed(), set\_seed() &Not implemented &Get and set the random seed. & \\