[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_ExternalResponse.tex

[albertel]

albertel		Tue Sep 11 15:21:59 2007 EDT

  Modified files:              
    /loncom/html/adm/help/tex	Authoring_ExternalResponse.tex 
  Log:
  - BUG#5419 - fix the documentation of externalresponse
             - add more information about what is POSTed
  
  
Index: loncom/html/adm/help/tex/Authoring_ExternalResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_ExternalResponse.tex:1.2 loncom/html/adm/help/tex/Authoring_ExternalResponse.tex:1.3
--- loncom/html/adm/help/tex/Authoring_ExternalResponse.tex:1.2	Tue Feb 22 09:57:21 2005
+++ loncom/html/adm/help/tex/Authoring_ExternalResponse.tex	Tue Sep 11 15:21:57 2007
@@ -9,18 +9,30 @@
 \begin{itemize}
 \item \textbf{url}\index{url}: url to submit the answer form to. It does
 not need to be a LON-CAPA machine.
-\item \textbf{answer}\index{answer}:  string or scalar variable that can
-encode something that should encode the correct answer. In some cases,
-this may be nothing. 
+\item \textbf{answer}\index{answer}: data to post in the form element 
+\texttt{LONCAPA\_correct\_answer} to the remote site.
 \item \textbf{form}\index{form}: hash variable name that will be submitted
 to the remote site as a HTTP form.
 \end{itemize}
+
+The form sent will consist of
+\begin{itemize}
+\item \textbf{LONCAPA\_student\_response} full text of
+what the student entered in the entry field
+\item \textbf{LONCAPA\_correct\_answer} contents of the answer
+attribute
+\item \textbf{LONCAPA\_language} specified language encoding
+of the requesting resource
+\item \textbf{all items in the form attribute} if any of these clash with the
+above, the above values will overwite the value in the form attribute
+\end{itemize}
+
 The response of the remote server needs to be in XML as follows: 
 
 \begin{itemize}
 \item \textbf{loncapagrade}\index{loncapagrade}: takes no attributes, but
 must surround the response.
-\item \textbf{awardetail}\index{awardetail}: required. The delimited text
+\item \textbf{awarddetail}\index{awarddetail}: required. The delimited text
 inside must be one of the detailed results that appears in the data
 storage documentation. CVS:loncapa/doc/homework/datastorage, look
 for \textbf{resource.partid.responseid.awarddetail}.
@@ -28,7 +40,7 @@
 the student.
 \end{itemize}
 Example: \begin{verbatim} <loncapagrade>
-    <awardetail>INCORRECT</awardetail>
+    <awarddetail>INCORRECT</awarddetail>
     <message>
 A message to be shown to the students
     </message>