File:  [LON-CAPA] / loncom / html / adm / help / tex / Authoring_ExternalResponse.tex
Revision 1.3: download - view: text, annotated - select for diffs
Tue Sep 11 19:21:57 2007 UTC (16 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: version_2_9_X, version_2_9_99_0, version_2_9_1, version_2_9_0, version_2_8_X, version_2_8_99_1, version_2_8_99_0, version_2_8_2, version_2_8_1, version_2_8_0, version_2_7_X, version_2_7_99_1, version_2_7_99_0, version_2_7_1, version_2_7_0, version_2_6_X, version_2_6_99_1, version_2_6_99_0, version_2_6_3, version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_99_1, version_2_5_99_0, version_2_12_X, version_2_11_X, version_2_11_5_msu, version_2_11_5, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2, version_2_11_1, version_2_11_0_RC3, version_2_11_0_RC2, version_2_11_0_RC1, version_2_11_0, version_2_10_X, version_2_10_1, version_2_10_0_RC2, version_2_10_0_RC1, version_2_10_0, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, bz6209-base, bz6209, bz5969, bz2851, PRINT_INCOMPLETE_base, PRINT_INCOMPLETE, HEAD, GCI_3, GCI_2, GCI_1, BZ5971-printing-apage, BZ5434-fox, BZ4492-merge, BZ4492-feature_horizontal_radioresponse
- BUG#5419 - fix the documentation of externalresponse
           - add more information about what is POSTed

    1: \label{Authoring_ExternalResponse}
    2: 
    3: 
    4: \textbf{externalresponse} is an advanced type of response tag that
    5: implements the ability to have an external program grade a response.
    6: It expects either a \textbf{textline} or \textbf{textfield} inside
    7: the tag. Possible attributes are:
    8: 
    9: \begin{itemize}
   10: \item \textbf{url}\index{url}: url to submit the answer form to. It does
   11: not need to be a LON-CAPA machine.
   12: \item \textbf{answer}\index{answer}: data to post in the form element 
   13: \texttt{LONCAPA\_correct\_answer} to the remote site.
   14: \item \textbf{form}\index{form}: hash variable name that will be submitted
   15: to the remote site as a HTTP form.
   16: \end{itemize}
   17: 
   18: The form sent will consist of
   19: \begin{itemize}
   20: \item \textbf{LONCAPA\_student\_response} full text of
   21: what the student entered in the entry field
   22: \item \textbf{LONCAPA\_correct\_answer} contents of the answer
   23: attribute
   24: \item \textbf{LONCAPA\_language} specified language encoding
   25: of the requesting resource
   26: \item \textbf{all items in the form attribute} if any of these clash with the
   27: above, the above values will overwite the value in the form attribute
   28: \end{itemize}
   29: 
   30: The response of the remote server needs to be in XML as follows: 
   31: 
   32: \begin{itemize}
   33: \item \textbf{loncapagrade}\index{loncapagrade}: takes no attributes, but
   34: must surround the response.
   35: \item \textbf{awarddetail}\index{awarddetail}: required. The delimited text
   36: inside must be one of the detailed results that appears in the data
   37: storage documentation. CVS:loncapa/doc/homework/datastorage, look
   38: for \textbf{resource.partid.responseid.awarddetail}.
   39: \item \textbf{message}\index{message}: optional message to have shown to
   40: the student.
   41: \end{itemize}
   42: Example: \begin{verbatim} <loncapagrade>
   43:     <awarddetail>INCORRECT</awarddetail>
   44:     <message>
   45: A message to be shown to the students
   46:     </message>
   47: </loncapagrade>
   48: \end{verbatim}

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>