--- loncom/html/adm/help/tex/all_functions_table.tex 2008/06/14 16:41:34 1.12 +++ loncom/html/adm/help/tex/all_functions_table.tex 2018/06/06 18:40:08 1.17 @@ -96,17 +96,27 @@ var\_in\_tex(a) &\&var\_in\_tex(\$a) &Eq \hline to\_string(x), to\_string(x,y) &\&to\_string(\$x), \&to\_string(\$x,\$y) &If x is an integer, returns a string. If x is real than the output is a string with format given by y. For example, if x = 12.3456, \&to\_string(x,''.3F'') = 12.345 and \&to\_string(x,''.3E'') = 1.234E+01. &  \\ \hline -capa\_id(), class(), section(), set(), problem() &\&class(), \§ion() &Returns null string, class descriptive name, section number, set number and null string. &capa\_id(), set() and problem() are no longer used. Currently, they return a null value. \\ +capa\_id(), class(), section(), set(), problem() &\&class(), \&sec() &Returns null string, class descriptive name, section number, set number and null string. &capa\_id(), set() and problem() are no longer used. Currently, they return a null value. \\ \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 identifying the current status of a part. True values mean that a part is ``done'' (either unanswerable because of tries exhaustion, or correct) or a false value if a part can still be attempted. If \$part is unspecified, 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 attempted and wrong but still has tries, 1 means it is marked correct, 2 means the user has exceeded the maximum number of tries, and 3 means it is after the answer date &  \\ +NOT IMPLEMENTED IN CAPA &\&check\_status(\$partid) &Returns a number identifying the current status of a part. True values mean that a part is ``done'': either unanswerable because of tries exhaustion, or fully correct, or only partially correct (and retries not permitted). A false value means that a part can still be attempted. If \$part is unspecified, 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 attempted but still has tries, and is either wrong (or partially correct, retries allowed), 1 means it is fully correct or partially correct (no retries), 2 means the user has exceeded the maximum number of tries, and 3 means it is after the answer date &  \\ \hline open\_date(), due\_date(), answer\_date() &\&open\_date(\$partid), \&due\_date(\$partid), \&answer\_date(\$partid) &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 &\&open\_date\_epoch(\$partid), \&due\_date\_epoch(\$partid), \&answer\_date\_epoch(\$partid) &Problem open date, due date and answer date in seconds after the epoch. These numbers can be used in calculations.&\\ \hline -&\&submission(\$partid,\$responseid,\$version) & Returns what the student submitted for response \$responseid in part \$part. You can get these IDs from the XML-code of the problem. \$version is optional and returns the \$version-th submission of the student that was graded.&\\ +&\&submission(\$partid,\$responseid,\$version, +\$encode,\$cleanupnum) & Returns what the student submitted for response \$responseid in part \$part. You can get these IDs from the XML-code of the problem. Use 0 as \$partid for problems without parts. \$version is optional and returns the \$version-th submission of the student that was graded. If \$version is 0 or ommitted, the latest submission is returned. +\$encode is also optional and allows the author to explicitly encode the returned string. It's up to the author to take care of properly escaping all characters which might be interpreted by the browser. +\$cleanupnum is also optional, and supports clean-up of the retrieved submission. It is a reference to a hash, with one or more of the following: +exponent =$>$ 1, +comma =$>$ 1, +letterforzero =$>$ 1, +spaces =$>$ 1, +format =$>$ 'ns' +(where n is an integer, i.e., number of significant digits). For example, to convert a student submission of +11,300 to 11300 include \{ comma =$>$ 1, \} as the fifth arg.&\\ \hline &\¤tpart() & Returns the ID of the current part.&\\ \hline