--- loncom/html/adm/help/tex/Institutional_Integration_Course_Codes.tex 2008/07/28 23:14:54 1.1 +++ loncom/html/adm/help/tex/Institutional_Integration_Course_Codes.tex 2008/07/29 17:51:08 1.2 @@ -1,16 +1,14 @@ \label{Institutional_Integration_Course_Codes} Courses in a domain can be self-cataloging if assigned an institutional -code. For this to work, two routines need to be customized in localenroll.pm +code. For this to work two routines need to be customized in localenroll.pm - \emph{instcode\_format()} and \emph{instcode\_defaults()}. The first of these is used to split institutional course codes into their constituent -parts, and to populate some perl data structures with these data. -LON-CAPA will use these perl structures to generate linked select boxes -which can be used when searching the {}``official'' course catalog. -The second routine is used when constructing a regular expression for -retrieval of courses based on search criteria specified by the user via the -linked select boxes. The search criteria are combined with defaults for any -components not explicitly selected (the defaults are fragments of a generic -institutional code) to create the regular expression used in the course search. +parts, and populate some perl data structures with these data, which +LON-CAPA can use to generate linked select boxes which users can use +to create filters to apply when searching the {}``official'' course +catalog. The second routine constructs a regular expression used when +searching for courses based on the filter chosen by the user, which +will contain fragments of an institutional code. \textbf{\large instcode\_format} @@ -40,14 +38,14 @@ titles (\$cat\_order), e.g., @\{\$\$cat\ \end{enumerate} The routine returns 'ok' if no errors occurred. -At MSU, {}``fs03nop590'' is an example of an institutional course +At MSU, {}``fs03nop590,'' is an example of an institutional course code; including the following entry in the instcodes hash passed in by reference - \$\$instcodes\{'43551dedcd43febmsul1'\} = 'fs03nop590' would cause the \$codes perl data structure to be populated. fs03nop590 would be split as follows: -\$\$codes\{'year'\} = '2003' +\$\$codes\{\{'year'\} = '2003' \$\$codes\{'semester'\} = 'Fall' @@ -129,7 +127,7 @@ in institutional code. (\$code\_order) \end{enumerate} The routine returns 'ok' if no errors occurred. -At MSU , the regaular expression fragments used mirror those included +At MSU, the regular expression fragments used mirror those included in the regular expression used in instcode\_format() to split an institutional course code into its component parts.