--- doc/help/developer.manual.texxml 2003/07/21 20:26:26 1.2 +++ doc/help/developer.manual.texxml 2003/09/22 19:08:39 1.5 @@ -2,12 +2,132 @@ <file name="Developer_Manual_Title_Page.tex"/> - <section name="LON-CAPA High-Level Overview"> - <tex content="A high-level overview of all the pieces of all the pieces of LON-CAPA, and how they fit together, goes here." /> + <section name="About This Document"> + <file name="About_Developers_Manual.tex" /> </section> - <section name="Introductory Tutorials"> - <tex content="Some of the tutorials from the Guts manual will go here." /> + <section name="What is LON-CAPA?"> + <file name="What_Is_LON-CAPA.tex" /> + <subsection name="Why LON-CAPA?"> + <file name="Why_LON-CAPA.tex" /> + </subsection> + <subsection name="Features"> + <tex content="TBD" /> + </subsection> + <subsection name="Philosophy and Pedagogy"> + <tex content="TBD" /> + </subsection> + <subsection name="Conclusion"> + <tex content="We hope by now you're as excited as we are about the system. LON-CAPA +is really powerful and good for both students and instructors, and +you can't beat the bang-for-the-buck. + +Now you know what LON-CAPA is all about, let's start looking at the +internals to see how we do all this great stuff." /> + </subsection> + </section> + + <section name="Resources Overview"> + <tex content="In a nutshell, LON-CAPA is all about bringing learning \textbf{resources} and \textbf{people} together with \textbf{technology}. Thus, the best way to understand the system is to understand how it models learning resources, how it understand people, and last (and really, least importantly) what technology supports it." /> + <file name="Guts_Authoring.tex" /> +te <subsection name="LON-CAPA Network"> + <pod file="lonc" section="OVERVIEW/.+" h1level='2' /> + </subsection> + <subsection name="Courses"> + <tex content="The end result of all of this assembly is an actual course that students can participate in." /> + <tex content="Courses are themselves sequences that tell the system what the course consists of. Course instructors or administrators can manipulate this sequence through the use of the Course Documents screen; see the Course Documents Screen chapter in the Course Management Manual (http://msu.loncapa.org/adm/help/course.manual.pdf) for more detailed information about that." /> + <pod file="../rat/lonuserstate.pm" section="OVERVIEW/.+" h1level='2' /> + <subsubsection name="Sections"> + <tex content='LON-CAPA fully supports the idea of "sections" in a course. Roles can be assigned to specific sections, allowing you to create Teaching Assisstants or Instructors that have power only over students in their section, and directly recieve student feedback from their corresponding students. As discussed in the next section, assignments parameters such as due dates can be set by section, which is extremely helpful in very large courses with tens of sections.' /> + </subsubsection> + </subsection> + <subsection name="Cascading Parameters"> + <file name="Cascading_Parameters.tex" /> + <subsubsection name="Parameters As Seen By Users"> + <tex content="\textit{The following is from the Course Administrator's Manual, describing how the cascading parameters are seen from the LON-CAPA user's point of view.}" /> + <file name="Course_Parameter_Levels.tex" /> + </subsubsection> + </subsection> + <subsection name="Finding Resources"> + <file name="Finding_Resources.tex" /> + <tex content="Note: more details belong here" /> + <subsection name="Permissions"> + <tex content="TBD" /> + </subsection> + <subsection name="Navigation"> + <tex content="TBD" /> + </subsection> + </section> + + <section name="People Overview"> + <tex content="LON-CAPA is a roles-based system. A single physical person will typically have one login, which will granted various roles connected to various courses or domains." /> + <subsection name="Authentication"> + <tex name="Authentication.tex" /> + </subsection> + <subsection name="Roles"> + <tex name="Roles_About.tex" /> + </subsection> + <subsection name="Communication"> + <subsubsection name="Internal Email"> + <pod file="interface/lonmsg.pm" section="OVERVIEW/Messaging Overview" /> + <tex content="When a resource fails to work for some reason, usually because of a programming error in a problem, the instructor will recieve a "bomb" message as an internal email, showing them exactly what went wrong, and for whom it went wrong, allowing them to take appropriate corrective action. This "bomb" message will show up in their email, and also as a bomb icon on the instructor's Navigation screen." /> + </subsubsection> + <subsubsection name="Resource Discussion"> + <tex file="Resource_Discussion.tex" /> + </subsubsection> + <subsubsection name="Chat"> + <tex file="Chatting.tex" /> + </subsubsection> + <subsubsection name="About Communication"> + <tex file="About_Communication.tex" /> + </subsubsection> + </subsection> + </section> + + <section name="Technology Overview"> + <subsection name="Data Storage"> + <subsubsection name="User Data Storage"> + <file name="Guts_User_Dir.tex" /> + </subsubsection> + <subsubsection name="Course Data Storage"> + <file name="Guts_Course_Dir.tex" /> + </subsubsection> + </subsection> + <subsection name="Roles"> + <tex content="Users keep their login, data, preferences, etc, over their complete tenure in the system. Every user can have several roles, and the roles can change over the lifetime of a username. For example, over the course of studies, a student username assumes the role of "student" in different courses. Roles can have start and expiration dates." /> + <pod file="interface/loncreateuser.pm" section="OVERVIEW/Custom Roles" /> + <pod file="auth/lonroles.pm" section="OVERVIEW/Choosing Roles" /> + <pod file="auth/lonroles.pm" section="OVERVIEW/Role Initialization" /> + </subsection> + <subsection name="Resources and Publication"> + <pod file="publisher/lonpublisher.pm" section="OVERVIEW" /> + <pod file="../rat/lonratedt.pm" section="OVERVIEW" /> + <file name="Guts_Authoring.tex" /> + </subsection> + <subsection name="Coding Guidelines"> + <file name="Guts_Coding_Guidelines.tex" /> + </subsection> + </section> + + <section name="Technology Overview - Webserver"> + <subsection name="Apache"> + <file name="Guts_Apache.tex" /> + </subsection> + <subsection name="Apache Modules"> + <file name="Guts_Apache_Modules.tex" /> + </subsection> + <subsection name="Authentication"> + <file name="Guts_Authentication.tex" /> + </subsection> + <subsection name="Environment"> + <file name="Guts_Apache_Env.tex" /> + </subsection> + </section> + + <file name="Developer_Tutorial.tex" /> + + <section name="Internationalizing LON-CAPA"> + <pod file="localize/lonlocal.pm" section="!NAME|SYNOPSIS" /> </section> <section name="Navigation Maps Rendering and Info"> @@ -19,6 +139,11 @@ section="!NAME|SYNOPSIS" /> </section> + <section name="Helpers"> + <pod file="interface/lonhelper.pm" + section="!NAME|SYNOPSIS" /> + </section> + <section name="Construction Space And Publishing"> <subsection name="Handling Uploaded Files"> <pod file="publisher/lonupload.pm" section="!NAME|SYNOPSIS" h1level='3' /> @@ -45,7 +170,19 @@ </section> - <section name="Common HTML routines"> + <section name="LON-CAPA Network"> + <subsection name="lonc"> + <pod file="lonc" section="!NAME|SYNOPSIS|OVERVIEW" h1level='3' /> + </subsection> + <subsection name="lond"> + <pod file="lond" section="!NAME|SYNOPSIS|OVERVIEW" h1level='3' /> + </subsection> + <subsection name="lonsql"> + <pod file="lonsql" section="!NAME|SYNOPSIS" h1level='3' /> + </subsection> + </section> + + <section name="Common HTML routines: Apache::loncommon"> <pod file="interface/loncommon.pm" section="!NAME|SYNOPSIS" /> </section> @@ -73,6 +210,10 @@ </subsection> </section> + <section name="Advanced RAT"> + <pod file="../rat/lonratedt.pm" section="!NAME|SYNOPSUS|OVERVIEW" /> + </section> + <section name="Roles Selection"> <pod file="auth/lonroles.pm" section="!NAME|SYNOPSIS" /> </section>