[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_Spreadsheet.tex Spreadsheet_About.tex Spreadsheet_Authoring.tex Spreadsheet_Category_Grades.tex Spreadsheet_Files.tex Spreadsheet_Functions.tex Spreadsheet_Hierarchy.tex Spreadsheet_Levels.tex Spreadsheet_Student_View.tex doc/help course.manual.texxml
lira
lira at source.lon-capa.org
Wed Dec 28 21:12:16 EST 2016
lira Thu Dec 29 02:12:16 2016 EDT
Added files:
/loncom/html/adm/help/tex Spreadsheet_Authoring.tex
Removed files:
/loncom/html/adm/help/tex Authoring_Spreadsheet.tex
Modified files:
/doc/help course.manual.texxml
/loncom/html/adm/help/tex Spreadsheet_About.tex
Spreadsheet_Category_Grades.tex
Spreadsheet_Files.tex
Spreadsheet_Functions.tex
Spreadsheet_Hierarchy.tex
Spreadsheet_Levels.tex
Spreadsheet_Student_View.tex
Log:
improving spreadsheet documentation
-------------- next part --------------
Index: doc/help/course.manual.texxml
diff -u doc/help/course.manual.texxml:1.47 doc/help/course.manual.texxml:1.48
--- doc/help/course.manual.texxml:1.47 Sun Jan 3 05:09:13 2016
+++ doc/help/course.manual.texxml Thu Dec 29 02:12:12 2016
@@ -418,16 +418,14 @@
<subsection name="Student View">
<file name="Spreadsheet_Student_View.tex" />
</subsection>
- <subsection name="Spreadsheet Organization">
- <subsubsection name="Spreadsheet Hierarchy">
- <file name="Spreadsheet_Hierarchy.tex" />
+ <subsection name="Spreadsheet Hierarchy">
+ <file name="Spreadsheet_Hierarchy.tex" />
+ <subsubsection name="The Three Spreadsheet Levels">
+ <file name="Spreadsheet_Levels.tex" />
</subsubsection>
<subsubsection name="Layout">
<file name="Spreadsheet_Layout.tex" />
</subsubsection>
- <subsubsection name="The Three Spreadsheet Levels">
- <file name="Spreadsheet_Levels.tex" />
- </subsubsection>
<subsubsection name="Export Row">
<file name="Spreadsheet_Export_Row.tex" />
</subsubsection>
@@ -438,7 +436,7 @@
<file name="Spreadsheet_Row_Numbers.tex" />
</subsubsection>
<subsubsection name="Authoring Spreadsheet Files">
- <file name="Authoring_Spreadsheet.tex" />
+ <file name="Spreadsheet_Authoring.tex" />
</subsubsection>
</subsection>
<subsection name="Modifying the Spreadsheet">
Index: loncom/html/adm/help/tex/Spreadsheet_About.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_About.tex:1.5 loncom/html/adm/help/tex/Spreadsheet_About.tex:1.6
--- loncom/html/adm/help/tex/Spreadsheet_About.tex:1.5 Sun Jan 3 04:37:07 2016
+++ loncom/html/adm/help/tex/Spreadsheet_About.tex Thu Dec 29 02:12:15 2016
@@ -1,19 +1,22 @@
\label{Spreadsheet_About}
The \textbf{Spreadsheet} is used to implement complex grading policies in
-your course. It has the flexability to implement most grading schemes and
-it provides access to all the parameters associated with the homework and
-exams in your course.
+your course. It has the flexibility to implement most grading schemes
+including partial credit for multiple trials, grading categories, use of maxiumum
+or minimum scores, etc. and the spreadsheet tools
+provide access to all the parameters associated with the homework and
+exams in your course.
-For basic information about the structure and function of the spreadsheet,
-see \textbf{Spreadsheet Hierarchy} (\ref{Spreadsheet_Hierarchy})
-and \textbf{Spreadsheet Layout} (\ref{Spreadsheet_Layout}).
+This section of the course manual is divided into three main subsections. The
+\textbf{Student View} section (\ref{Spreadsheet_Student_View}) describes what the students see.
-For help creating and editing spreadsheets, see
-\textbf{Spreadsheet Files} (\ref{Spreadsheet_Files}) and
-\textbf{Spreadsheet Editing Overview} (\ref{Spreadsheet_Editing}).
+The section \textbf{Spreadsheet Hierarchy} (\ref{Spreadsheet_Hierarchy})
+describes information about the structure and function of the spreadsheet. A basic
+understanding of the hierarchy is necessary before creating and editing spreadsheets.
-To access the spreadsheet functionality select
+The section \textbf{Modyfying the Spreadsheet} (\ref{Spreadsheet_Files}) describes
+how to create and edit spreadsheets.
+
+From the course Main Menu, to access the spreadsheet functionality select
\includegraphics[width=0.03\paperwidth]{sprs}
-\textbf{View calculated grades (Spreadsheet)}
-on the Main Menu.
+\textbf{View calculated grades (Spreadsheet)}.
Index: loncom/html/adm/help/tex/Spreadsheet_Category_Grades.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Category_Grades.tex:1.4 loncom/html/adm/help/tex/Spreadsheet_Category_Grades.tex:1.5
--- loncom/html/adm/help/tex/Spreadsheet_Category_Grades.tex:1.4 Wed Aug 17 23:12:47 2016
+++ loncom/html/adm/help/tex/Spreadsheet_Category_Grades.tex Thu Dec 29 02:12:15 2016
@@ -1,7 +1,7 @@
\label{Spreadsheet_Category_Grades}
\index{grade categories}\index{categories}The spreadsheet can be configured with reasonable ease to accommodate grade categories. The
-strategy involves configuring assessment level spreadsheets for each category, the student level spreadsheet, and the course spreadsheet.\\
+strategy involves configuring assessment level spreadsheets for each category, configuring the student level spreadsheet to assign the activities to categories add calculate the overall grade, and configuring the course spreadsheet to calculate overall category averages, etc.\\
\noindent
\textbf{Configuring the Assessment Level Spreadsheets}
Index: loncom/html/adm/help/tex/Spreadsheet_Files.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Files.tex:1.7 loncom/html/adm/help/tex/Spreadsheet_Files.tex:1.8
--- loncom/html/adm/help/tex/Spreadsheet_Files.tex:1.7 Sun Jan 3 06:12:45 2016
+++ loncom/html/adm/help/tex/Spreadsheet_Files.tex Thu Dec 29 02:12:15 2016
@@ -25,7 +25,7 @@
Using the \underline{Select Spreadsheet File} link opens the LON-CAPA resource browser.
Only files with the extension \texttt{.spreadsheet} can be selected. The
-spreadsheet definition file must be valid XML. See \textbf{Authoring Spreadsheet Files} (\ref{Authoring_Spreadsheet}) for information on
+spreadsheet definition file must be valid XML. See \textbf{Authoring Spreadsheet Files} (\ref{Spreadsheet_Authoring}) for information on
creating spreadsheet files.\\
\noindent
Index: loncom/html/adm/help/tex/Spreadsheet_Functions.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Functions.tex:1.10 loncom/html/adm/help/tex/Spreadsheet_Functions.tex:1.11
--- loncom/html/adm/help/tex/Spreadsheet_Functions.tex:1.10 Sun Jan 3 04:45:45 2016
+++ loncom/html/adm/help/tex/Spreadsheet_Functions.tex Thu Dec 29 02:12:15 2016
@@ -82,7 +82,7 @@
\noindent
In addition, most non-IO Perl functions work in cells. Perl offers a compact \texttt{if} structure using the logic
-\texttt{TEST\char`_EXPR?IF\char`_TRUE\char`_EXPR\char`:IF\char`_FALSE\char`_EXPR;}. The \texttt{if} statements can be nested. For example, to scale the points awarded on the assessment spreadsheet (by default in \texttt{Z0}) with the number of tries (by default in \texttt{C0}), the adjusted score can be programmed in an empty cell in assessment spreadsheet row 0, where\\
+\texttt{TEST\char`_EXPR?IF\char`_TRUE\char`_EXPR\char`:IF\char`_FALSE\char`_EXPR;}. The \texttt{if} statements can be nested. Suppose that students are to receive full credit for a correct answer on the first attempt, 3/4 credit for a correct answer on two attempts, and half credit for a correct answer on more than two attempts. To scale the points awarded on the assessment spreadsheet (by default in \texttt{Z0}) with the number of tries (by default in \texttt{C0}), the adjusted score can be programmed in an empty export cell in the Assessment Spreadsheet row 0, as illustrated by the following example:\\
\noindent
\texttt{C0$>$2 ? (0.5*Z0) \char`: (C0$>$1 ? (0.75*Z0) \char`: Z0);}\\
Index: loncom/html/adm/help/tex/Spreadsheet_Hierarchy.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Hierarchy.tex:1.4 loncom/html/adm/help/tex/Spreadsheet_Hierarchy.tex:1.5
--- loncom/html/adm/help/tex/Spreadsheet_Hierarchy.tex:1.4 Sun Jan 3 04:48:01 2016
+++ loncom/html/adm/help/tex/Spreadsheet_Hierarchy.tex Thu Dec 29 02:12:15 2016
@@ -1,37 +1,9 @@
\label{Spreadsheet_Hierarchy}
-There are three different types of spreadsheets inside LON-CAPA: Assessment Spreadsheets, Student Spreadsheet, and Course Spreadsheet.
+There are three nested levels of spreadsheets inside LON-CAPA: a Course Spreadsheet, \index{course level spreadsheet} a Student Spreadsheet, and various Assessment Spreadsheets. The Course spreadsheet provides an overview of student performance and links to each student's details.
+The Student Spreadsheet configures how the overall course grade is to be calculated. Each graded item can
+be configured using an Assessment Spreadsheet to specify how the problem parameters are to be evaluated.
-\begin{enumerate}
+Course Spreadsheet \textless -- Student Spreadsheet \textless -- multiple Assessment Spreadsheets
-\item \textbf{The Assessment Spreadsheets}
-An assessment-level spreadsheet provides access to all of the parameters
-associated with a student's performance on a particular homework assignment, quiz,
-or exam.
-Each student has an assessment spreadsheet for every assessment in the course.
-The assessment spreadsheets provide data to their parent, the student level
-spreadsheet, via the assessment spreadsheet \textbf{export row} (\ref{Spreadsheet_Export_Row}).
-Multiple assessment spreadsheets can be used in cases where the instructor configures
-grade categories.
-
-\item \textbf{The Student Spreadsheet}
-
-The student level spreadsheet summarizes the assessment spreadsheet data for the students.
-There is only one default student level spreadsheet definition,
-but the data varies for each student.
-The student spreadsheet is programmed to permit the instructor to assign different
-assessment spreadsheets for different grade categories or other uses.
-The data present in the student spreadsheet is imported from the
-\textbf{export row} (\ref{Spreadsheet_Export_Row})
-of each assessment spreadsheet for all of the assessments currently in
-the course.
-The student spreadsheets pass summary data to the course-level spreadsheet
-via the student spreadsheet \textbf{export row} (\ref{Spreadsheet_Export_Row}).
-
-\item \textbf{The Course Spreadsheet}
-
-The course spreadsheet contains all of the summary data for the students in
-the course.
-
-\end{enumerate}
Index: loncom/html/adm/help/tex/Spreadsheet_Levels.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Levels.tex:1.5 loncom/html/adm/help/tex/Spreadsheet_Levels.tex:1.6
--- loncom/html/adm/help/tex/Spreadsheet_Levels.tex:1.5 Mon Aug 23 16:16:18 2010
+++ loncom/html/adm/help/tex/Spreadsheet_Levels.tex Thu Dec 29 02:12:15 2016
@@ -1,18 +1,46 @@
\label{Spreadsheet_Levels}
-The course spreadsheet has three levels.
-\index{course level spreadsheet}
-The top-level is the "course level" sheet, which is not accessible to
-students. It lists the export rows of all "student level" sheets (the
-sheet that students get to see when they press
-\includegraphics[width=0.03\paperwidth]{feedback}
-\textbf{View current problem status and grading information}
-on Main Menu).
-These in turn import the export rows of all assessment level sheets.
-
-The figure shows the spreadsheet hierarchy.
+Each Student and Assessment level spreadsheets permit sophisticated calculations. The summary values that are to be passed to the parent spreadhseet are summarized in the \textbf{export row} of the sheet. The figure shows the spreadsheet hierarchy and indicates the flow of information.
\begin{figure}
\begin{center}\includegraphics[ width=0.80\paperwidth]{spreadsheet_hierarchy}
\end{center}
\end{figure}
+
+\begin{enumerate}
+
+\item \textbf{The Course Spreadsheet}
+
+The course spreadsheet contains all of the summary data for all the students in
+the course.
+
+\item \textbf{The Student Spreadsheet}
+
+The student level spreadsheet summarizes the assessment spreadsheet data for the students.
+There is only one default student level spreadsheet definition,
+but the data varies for each student.
+The student spreadsheet is programmed to permit the instructor to assign different
+assessment spreadsheets for different grade categories or other uses.
+The data present in the student spreadsheet is imported from the
+\textbf{export row} (\ref{Spreadsheet_Export_Row})
+of each assessment spreadsheet for all of the assessments currently in
+the course.
+The student spreadsheets pass summary data to the course-level spreadsheet
+via the student spreadsheet \textbf{export row} (\ref{Spreadsheet_Export_Row}).
+
+\item \textbf{The Assessment Spreadsheets}
+
+An assessment-level spreadsheet provides access to all of the parameters
+associated with a student's performance on a particular homework assignment, quiz,
+or exam.
+Each student has an assessment spreadsheet for every assessment in the course.
+The assessment spreadsheets provide data to their parent, the student level
+spreadsheet, via the assessment spreadsheet \textbf{export row} (\ref{Spreadsheet_Export_Row}).
+Multiple assessment spreadsheets can be used in a course facilitating organizing assessments into
+categories or for other purposes.
+
+
+\end{enumerate}
+
+
+
Index: loncom/html/adm/help/tex/Spreadsheet_Student_View.tex
diff -u loncom/html/adm/help/tex/Spreadsheet_Student_View.tex:1.4 loncom/html/adm/help/tex/Spreadsheet_Student_View.tex:1.5
--- loncom/html/adm/help/tex/Spreadsheet_Student_View.tex:1.4 Sun Jan 3 05:00:23 2016
+++ loncom/html/adm/help/tex/Spreadsheet_Student_View.tex Thu Dec 29 02:12:15 2016
@@ -1,13 +1,18 @@
\label{Spreadsheet_Student_View}
-The student view of the spreadsheet is restricted to the student level
-spreadsheet in courses where the environment has been set to allow the student
+The student view of the spreadsheet is restricted to the student's personal data, calculated
+by the Student Spreadsheet. Students are only able to view their personal data in courses
+where the environment has been set to allow the student
view of the spreadsheet, see \textbf{Changing Course Environment for Student Access to
-Spreadsheet} (\ref{GradingOptions}). Students cannot modify the spreadsheet in any way.
-Students are not able to view the assessment level spreadsheets
-or course level spreadsheet.
+Spreadsheet} (\ref{GradingOptions}). To view their data, from the Main Menu they press
+\includegraphics[width=0.03\paperwidth]{feedback}
+\textbf{View current problem status and grading information}.
If the course contains assessments which indicate the student should not
be able to view the results, as is the default for an exam, the row will appear
blacked out and the data will not be present. Once the answer date has passed
for the resource, the row will be shown.
+
+Students cannot modify the spreadsheet in any way.
+Students are not able to view the Assessment Spreadsheets
+or Course Spreadsheet.
Index: loncom/html/adm/help/tex/Spreadsheet_Authoring.tex
+++ loncom/html/adm/help/tex/Spreadsheet_Authoring.tex
\label{Spreadsheet_Authoring}
To use a spreadsheet in multiple courses, authors can create spreadsheet XML files in their authoring space. Published spreadsheets can be imported into courses. See \textbf{Loading a Spreadsheet Definition from a Published File} (\ref{Spreadsheet_Loading}). The spreadsheet syntax is illustrated by the following example demonstrating both text and formulas:
\begin{verbatim}
<field col=A row=0>`Available Points:'</field>
<field col=B row=0>&SUM(`X*')</field>
<field col=C row=0>`Awarded Points:'</field>
<field col=D row=0>&SUM(`Z*')</field>
\end{verbatim}
See \textbf{Modifying the Spreadsheet} (\ref{Spreadsheet_Editing}) for more information on programming cells. Very complex calculations can be performed in the cells. The file must be saved in authoring space with the extension .spreadsheet. Currently, a spreadsheet must be imported into authoring space as a .txt file and then renamed to a .spreadsheet. After it is published with the .spreadsheet extension, it can be imported into a course.
More information about the LON-CAPA-cvs
mailing list