[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Batch_Creation.tex /interface loncreatecourse.pm

[raeburn]

raeburn		Fri Aug 18 21:21:23 2006 EDT

  Added files:                 
    /loncom/html/adm/help/tex	Batch_Creation.tex 

  Modified files:              
    /loncom/interface	loncreatecourse.pm 
  Log:
  Documenting XML used to describe courses for batch course creation.
  
  
Index: loncom/interface/loncreatecourse.pm
diff -u loncom/interface/loncreatecourse.pm:1.96 loncom/interface/loncreatecourse.pm:1.97
--- loncom/interface/loncreatecourse.pm:1.96	Fri Aug 11 18:00:08 2006
+++ loncom/interface/loncreatecourse.pm	Fri Aug 18 21:21:22 2006
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Create a course
 #
-# $Id: loncreatecourse.pm,v 1.96 2006/08/11 22:00:08 albertel Exp $
+# $Id: loncreatecourse.pm,v 1.97 2006/08/19 01:21:22 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -719,14 +719,18 @@
                      name => &mt('Create courses/groups by uploading an attributes file'),
                      short_description =>
     &mt('Upload an attributes file containing specifications for one or more courses or groups in XML format'),
+                     help => 'Batch_Creation',
                  },
     );
     my $options;
     foreach my $choice (@choices) {
         $options .='    <h3><a href="/adm/createcourse?phase='.
             $choice->{'internal_name'}.'" >'.
-            $choice->{'name'}."</a></h3>\n";
-        $options .= '    '.('&nbsp;'x8).$choice->{'short_description'}.
+            $choice->{'name'}.'</a>';
+        if (exists($choice->{'help'})) {
+            $options .= &Apache::loncommon::help_open_topic($choice->{'help'});
+        }
+        $options .= "</h3>\n".'    '.('&nbsp;'x8).$choice->{'short_description'}.
             "\n";
     }
 

Index: loncom/html/adm/help/tex/Batch_Creation.tex
+++ loncom/html/adm/help/tex/Batch_Creation.tex
\label{Batch Course Creation}
If you choose to batch create LON-CAPA courses by uploading a file
containing an XML-based description of the attributes of one or more
courses, the XML used in course description should conform to the
following, with MSU-specific values replaced with values appropriate for your domain and institution:


\paragraph{Example of XML for a single course}

<?xml version=\char`\"{}1.0\char`\"{} encoding=\char`\"{}UTF-8\char`\"{}?>

<!DOCTYPE text>

<class id=\char`\"{}ss05ubw101\char`\"{}>

<title>Underwater Basket Weaving</title>

<crstype>Course</crstype>

<coursecode>ss05ubw101</coursecode>

<coursehome>msul1</coursehome>

<coursedomain>msu</coursedomain>

<reshome>/res/msu/</reshome>

<optional\_id></optional\_id>

<adds>1</adds>

<drops>1</drops>

<enrollstart>2005:01:04:10:30</enrollstart>

<enrollend>2005:07:04:20:30</enrollend>

<accessstart>2005:01:10:10:30</accessstart>

<accessend>2005:05:31:10:30</accessend>

<authentication>

<method>krb4</method>

<param>MSU.EDU</param>

</authentication>

<nonstandard></nonstandard>

<topmap></topmap>

<firstres>nav</firstres>

<crsquota>20</crsquota>

<clonecrs>466011437c34194msul1</clonecrs>

<clonedom>msu</clonedom>

<showphotos></showphotos>

<setpolicy>1</setpolicy>

<setcontent>1</setcontent>

<setkeys>0</setkeys>

<keyauth>keyadmin@msu</keyauth>

<disresdis>1</disresdis>

<disablechat>1</disablechat>

<openall></openall>

<notify\_dc>1</notify\_dc>

<notify\_owner>1</notify\_owner>

<owner>

<username>sparty</username>

<domain>msu</domain>

<authtype>krb4</authtype>

<autharg>MSU.EDU</autharg>

</owner>

<sections>

<section>

<inst>001</inst>

<loncapa>1</loncapa>

</section>

<section>

<inst>002</inst>

<loncapa>2</loncapa>

</section>

</sections>

<crosslists>

<xlist>

<inst>ss05zzz101001</inst>

<loncapa>1</loncapa>

</xlist>

</crosslists>

<users>

<user>

<username>sparty</username>

<domain>msu</domain>

<email>sparty@msu.edu</email>

<authtype>krb4</authtype>

<autharg></autharg>

<firstname>MSU</firstname>

<generation></generation>

<lastname>Spartan</lastname>x

<middlename></middlename>

<studentID></studentID>

<roles></roles>

</user>

<user>

<username>itds0001</username>

<domain>northwood5</domain>

<email>itds0001@msu.edu</email>

<authtype>int</authtype>

<autharg></autharg>

<firstname>Info</firstname>

<generation></generation>

<lastname>Techc</lastname>x

<middlename></middlename>

<studentID></studentID>

<roles>

<role id='in'>

<start>2005:01:01:12:10</start>

<end>2005:12:01:12:10</end>

<usec>1</usec>

<usec>2</usec>

</role>

</roles>

</user>

</users>

</class>

Many of these are binary options (corresponding to either checkboxes
or radio buttons in the interactive {}``Create Course'' page). 

Examples include: setpolicy, setcontent, setkeys, disableresdis, disablechat,
openall. 

A value of 1 between opening and closing tags is equivalent to a checked
checkbox or 'Yes' response in the original interactive {}``Create
Course'' web page. 

A value of 0 or blank is equivalent to an unchecked box or 'No' response. 

Dates are in the format YYYY:MM:DD:HH:MM:SS (:separators required)

firstres can be nav, syl, or blank for \char`\"{}Navigate Contents\char`\"{},
Syllabus, or no entry respectively. 

crstype is currently Course

crsquota is the total disk space (in Mb) permitted for course group portfolio
files in all course groups.

For format of other parameters, refer to the interactive CCRS page
and view how the equivalent parameter is displayed in the web form.