File:  [LON-CAPA] / doc / help / developer.manual.texxml
Revision 1.4: download - view: text, annotated - select for diffs
Fri Jul 25 04:14:32 2003 UTC (20 years, 9 months ago) by bowersj2
Branches: MAIN
CVS tags: HEAD
Documentation updates.

    1: <texxml>
    2: 	<title name="LON-CAPA Developer's Manual" />
    3: 	<file name="Developer_Manual_Title_Page.tex"/>
    4: 
    5: 	<section name="LON-CAPA High-Level Overview">
    6: 		<subsection name="LON-CAPA Network">
    7: 			<pod file="lonc" section="OVERVIEW/.+" h1level='2' />
    8: 			</subsection>
    9: 		<subsection name="Data Storage">
   10: 			<subsubsection name="User Data Storage">
   11: 				<file name="Guts_User_Dir.tex" />
   12: 				</subsubsection>
   13: 			<subsubsection name="Course Data Storage">
   14: 				<file name="Guts_Course_Dir.tex" />
   15: 				</subsubsection>
   16: 			</subsection>
   17: 		<subsection name="Roles">
   18: 			<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 &quot;student&quot; in different courses. Roles can have start and expiration dates." />
   19: 			<pod file="interface/loncreateuser.pm" section="OVERVIEW/Custom Roles" />
   20: 			<pod file="auth/lonroles.pm" section="OVERVIEW/Choosing Roles" />
   21: 			<pod file="auth/lonroles.pm" section="OVERVIEW/Role Initialization" />
   22: 			</subsection>
   23: 		<subsection name="Messaging">
   24: 			<pod file="interface/lonmsg.pm" section="OVERVIEW/Messaging Overview" />
   25: 
   26: 			</subsection>
   27: 		<subsection name="Resources and Publication">
   28: 			<pod file="publisher/lonpublisher.pm section="OVERVIEW" />
   29: 			<pod file="../rat/lonratedt.pm" section="OVERVIEW" />
   30: 			<file name="Guts_Authoring.tex" />
   31: 			<pod file="../rat/lonuserstate.pm" section="OVERVIEW" />
   32: 		</section>
   33: 
   34: 	<section name="About The Webserver Environment">
   35: 		<subsection name="Apache">
   36: 			<file name="Guts_Apache.tex" />
   37: 			</subsection>
   38: 		<subsection name="Apache Modules">
   39: 			<file name="Guts_Apache_Modules.tex" />
   40: 			</subsection>
   41: 		<subsection name="Authentication">
   42: 			<file name="Guts_Authentication.tex" />
   43: 			</subsection>
   44: 		<subsection name="Environment">
   45: 			<file name="Guts_Apache_Env.tex" />
   46: 			</subsection>
   47: 		</section>
   48: 
   49: 	<section name="Navigation Maps Rendering and Info">	
   50: 		<pod file="interface/lonnavmaps.pm" section="!NAME|SYNOPSIS" />
   51: 		</section>
   52: 
   53: 	<section name="LON-CAPA Help System">
   54: 		<pod file="../doc/help/texxml2latex.pl"
   55: 			section="!NAME|SYNOPSIS" />
   56: 		</section>
   57: 
   58: 	<section name="Construction Space And Publishing">
   59: 		<subsection name="Handling Uploaded Files">
   60: 			<pod file="publisher/lonupload.pm" section="!NAME|SYNOPSIS" h1level='3' />
   61: 			</subsection>
   62: 		<subsection name="Construction Space Directory Listing">
   63: 			<pod file="publisher/lonpubdir.pm" section="!NAME|SYNOPSIS" h1level='3' />
   64: 			</subsection>
   65: 		<subsection name="Retrieving Old Versions of Published Files">
   66: 			<pod file="publisher/lonretrieve.pm" section="!NAME|SYNOPSIS" h1level='3' />
   67: 			</subsection>
   68: 		<subsection name="Publishing Files">
   69: 			<pod file="publisher/lonpublisher.pm" section="!NAME|SYNOPSIS" h1level='3' />
   70: 			</subsection>
   71: 		</section>
   72: 	
   73: 	<section name="Resource Rendering">
   74: 		<tex content="Note 'rendering' includes the concept of 'rendering an edit form', so the resource editing interface, except the RATs, are actually 'renders' of resources as well." />
   75: 		<subsection name="Editing Homework Support">
   76: 			<pod file="homework/edit.pm" section="!NAME|SYNOPSIS" h1level='3' />
   77: 			</subsection>
   78: 		<subsection name="Rendering Pages">
   79: 			<pod file="../rat/lonpage.pm" section="!NAME|SYNOPSIS" h1level='3' />
   80: 			</subsection>
   81: 		
   82: 		</section>
   83: 
   84: 	<section name="LON-CAPA Network">
   85: 		<subsection name="lonc">
   86: 			<pod file="lonc" section="!NAME|SYNOPSIS|OVERVIEW" h1level='3' />
   87: 			</subsection>
   88: 		<subsection name="lond">
   89: 			<pod file="lond" section="!NAME|SYNOPSIS|OVERVIEW" h1level='3' />
   90: 			</subsection>
   91: 		</section>
   92: 
   93: 	<section name="Common HTML routines">
   94: 		<pod file="interface/loncommon.pm" section="!NAME|SYNOPSIS" />
   95: 		</section>
   96: 
   97: 	<section name="Searching LON-CAPA">
   98: 		<pod file="interface/lonsearchcat.pm" section="!NAME|SYNOPSIS" />
   99: 		</section>
  100: 
  101: 	<section name="Parameter Setting">
  102: 		<pod file="interface/lonparmset.pm" section="!NAME|SYNOPSIS" />
  103: 		</section>
  104: 
  105: 	<section name="Preparing User State">
  106: 		<pod file="../rat/lonuserstate.pm" section="!NAME|SYNOPSIS" />
  107: 		</section>
  108: 
  109: 	<section name="Access Control">
  110: 		<subsection name="acc">
  111: 			<pod file="auth/lonacc.pm" section="!NAME|SYNOPSIS" h1level='3' />
  112: 			</subsection>
  113: 		<subsection name="racc">
  114: 			<pod file="auth/lonracc.pm" section="!NAME|SYNOPSIS" h1level='3' />
  115: 			</subsection>
  116: 		<subsection name="cacc">
  117: 			<pod file="auth/loncacc.pm" section="!NAME|SYNOPSIS" h1level='3' />
  118: 			</subsection>
  119: 		</section>
  120: 	
  121: 	<section name="Roles Selection">
  122: 		<pod file="auth/lonroles.pm" section="!NAME|SYNOPSIS" />
  123: 		</section>
  124: 
  125: 	<section name="Indexing">
  126: 		<pod file="interface/lonindexer.pm" section="!NAME|SYNOPSIS" />
  127: 		</section>
  128: 
  129: 	<section name="LON-CAPA Network Access">
  130: 		<pod file="lonnet/perl/lonnet.pm" section="!NAME|SYNOPSIS" />
  131: 		</section>
  132: 
  133: 	<tex content="\printindex{}" />
  134: 
  135: 	</texxml>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>