Return to Author_LON-CAPA_Introduction.tex CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

Annotation of loncom/html/adm/help/tex/Author_LON-CAPA_Introduction.tex, revision 1.12

1.2       bowersj2    1: \label{Author_LON-CAPA_Introduction}
1.1       bowersj2    2: 
1.5       raeburn     3: LON-CAPA is a web-based content management system that helps to organize and present your
                      4: course website, deliver and manage assignments, and manage student enrollment, assessment, and grading.
                      5: Typically all author functions will be completed using a web browser (Firefox, Chrome, Safari, IE or similar).
                      6: The one exception to this is where your LON-CAPA domain has been configured to support webDAV access, in which
                      7: case you may be able to carry out standard file operations (copy, move, add file etc.) using your computer's 
                      8: standard filesystem interface, after you have established access to your authoring space volume.
1.1       bowersj2    9: 
1.12    ! lira       10: LON-CAPA has three work spaces: the ROLES menu, the course/community space where courses are developed from resources, and the authoring space where resources are composed and published. There are two user manuals for LON-CAPA, a course coordinator manual and author manual. Also, there are quick reference guides to building a course and building an exam,  available at \texttt{http://help.loncapa.org} . This is the author manual used to create resources such as problems that can later be added to your course.
1.3       lira       11: 
1.4       lira       12: Before creating problems, you should have:
1.1       bowersj2   13: 
                     14: \begin{itemize}
1.4       lira       15: \item developed learning objectives that you want to evaluate for your course/community
                     16: \item determined the appropriate question formats and developed your problems for input into LON-CAPA. Examples for question formats are provided in this manual and also when authoring a problem.
                     17: \item developed the directory structure that you plan to use to organize your resources
1.1       bowersj2   18: \end{itemize}
1.4       lira       19: 
                     20: \textbf{Overview of the Authoring Process}
                     21: 
1.11      raeburn    22: Graphics, problems, and html pages are all considered \textbf{resources.} Additional resources include reusable snippets of perl, xml, cascading style sheets, etc. This manual documents the process used to create and organize the more advanced types of resources.
1.4       lira       23: 
                     24: The authoring process involves these steps:
                     25: \begin{itemize}
                     26: \item create or upload a resource. The resource can combine other uploaded resources such as graphics, code snippets, or problem sequences
                     27: \item test and revise your resource
                     28: \item publish the resource to make it available for integration into a course/community and/or sharing
                     29: \item revise your resources after publishing to improve clarity or eliminate bugs
                     30: \end{itemize}
                     31: 
                     32: \textbf{Importance of Planning your Directory Structure}
                     33: 
1.5       raeburn    34: Once a resource has been published, the published version can never be moved or deleted. Thus, it is important to plan your folder structure. Old resources
                     35: can be marked obsolete, and the version in your authoring space deleted,  but the published version(s) will remain in your folders in the locations in which
                     36: they were originally published.
1.4       lira       37: 
                     38: \textbf{Understanding xml and the Colorful Editor}
                     39: 
                     40: Problems are written in xml markup, which can appear complex when you first start to work with LON-CAPA if you have not done html or other coding. However, each xml element has a starting and closing argument, just like html. This manual includes a reference on xml markup used to write problems.
                     41: 
1.10      raeburn    42: The authoring environment includes a `colorful' web-based editor that can be used for authoring your first problems. Even experts will
1.4       lira       43: often start with the colorful editor to build a template for a problem. It is possible to switch back and forth between the colorful editor and xml when composing and testing your problems. Often simple issues are easier to clean up directly in xml. Also, it is easier to copy/paste xml to 
                     44: build additional problem sections compared to using the colorful editor.
                     45: 
                     46: \textbf{Scripts}
                     47: 
1.9       raeburn    48: The power of LON-CAPA for problem randomization and computing randomized answers is realized through writing perl script at the top of a problem. Example scripts are included in many example problems, and most resource authors publish scripts with the problems, so many examples are available. Many special functions have been created for use in scripts. This manual includes a section on writing scripts.
1.4       lira       49: 
                     50: \textbf{Maxima and R}
                     51: 
                     52: Two computer algebra systems are interfaced to LON-CAPA, Maxima and R. This provides for algebra and calculus problems and responses. The R system has strong capabilities for statistics. Special script functions are provided to call Maxima and R to generate correct responses for a randomized problem, and also to check student responses.
                     53: 
1.6       lira       54: \textbf{Comments}
                     55: 
1.8       raeburn    56: Commenting your xml and scripts is important for both you and other users. Commenting within a loncapa/perl script 
1.6       lira       57: is denoted with a \#. This can be entered anwhere in a line and the remainder of the line will be ignored when
1.7       lira       58: parsing. Problems are coded in xml. Comments in xml are of the format \texttt{<!-- comment -->}.
                     59: \index{comment markers}However, it is important to know that the XML comments 
                     60: propagate through to the rendered web page viewed by students while the perl comments 
                     61: within the script are not. Hence, writing solution hints within XML comments is 
                     62: discouraged for obvious reasons.
1.6       lira       63: