doc/loncapafiles/loncapafiles.html - diff

Return to loncapafiles.html CVS log

Up to [LON-CAPA] / doc / loncapafiles

Diff for /doc/loncapafiles/Attic/loncapafiles.html between versions 1.56 and 1.76

-version 1.56, 2001/02/15 16:02:38
+version 1.76, 2001/04/05 19:17:29
  Line 161  browser and can only be seen be examinin
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/html/adm/rat" CATEGORY="server readonly" DESCRIPTION="home of the rat">
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/html/adm/lonIcons" CATEGORY="server readonly">
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/html/adm/lonKaputt" CATEGORY="server readonly">
- <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/lonUsers" CATEGORY="server standard" DESCRIPTION="home directories of local users">
+ <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/lonUsers" CATEGORY="server standard" DESCRIPTION="<BR>Home directories of local users.  There is a five-tier structure to the directories: [domain]/[firstletter]/[secondletter]/[thirdletter]/[userid].  For example, a user fredflint at MSU would have his information located in lonUsers/msu/f/r/e/fredflint.<P>Within this directory there are a variety of files which govern the scope of what a user can do within the LON-CAPA system.  A passwd file determines the type of authentication mechanism to use.  There is also are files such as roles.hist (and its database compilation, roles.db) which specify the roles and privileges for a user in the
+ LON-CAPA system.">
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/html/lon-status" CATEGORY="server standard" DESCRIPTION="status reports">
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="usr/lib/perl5/site_perl/5.005" CATEGORY="standard">
  <LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/html/adm/MathML" CATEGORY="server readonly">
- Line 191  browser and can only be seen be examinin
+ Line 192  browser and can only be seen be examinin
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/access.conf" TARGET="etc/httpd/conf/access.conf" CATEGORY="conf">
  <DESCRIPTION>
- define handlers, set parameters
+ This file has two major functions.
+ For the Apache web server, it defines a global
+ access configuration which defines what server options (Indexes", "Includes",
+ "FollowSymLinks", "ExecCGI", or "MultiViews") are associated
+ with specific directories ("/", "/home/httpd/html", "/home/httpd/cgi-bin",
+ and "/usr/doc").  For the LON-CAPA network server and perl module
+ handlers, it defines machine specific settings (lonHostID, lonRole,
+ lonAdmEMail, lonDefDomain, lonLoadLim, lonExpire, and lonReceipt)
+ and internal machine settings for specific directories, socket ports,
+ and browser detection logic.
  </DESCRIPTION>
  <NOTE>
  <B>configure</B>
- Line 209  define handlers, set parameters
+ Line 219  define handlers, set parameters
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/httpd.conf" TARGET="etc/httpd/conf/httpd.conf" CATEGORY="static conf">
  <DESCRIPTION>
- main server configuration file
+ This is the main server configuration file.  The settings here are
+ more or less standard for the Apache web server.  Most notably (and
+ importantly!), perl handling and mod_perl are enabled in this configuration
+ file.
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/srm.conf" TARGET="etc/httpd/conf/srm.conf" CATEGORY="static conf">
  <DESCRIPTION>
- name space configuration
+ <P>
+ This file configures the "name space" of the Apache web server.
+ <TT>srm.conf</TT>
+ defines when specific perl modules should be called to handle a given
+ request.  This definition is a function of both the name of the perl module,
+ and a specific regular expression associated with the URL, such as
+ "^/res/.*\.page".
+ </P>
+ <P>
+ Here is an example entry:
+ <PRE>
+ &lt;LocationMatch "^/res/.*\.page$&gt;
+ SetHandler perl-script
+ PerlHandler Apache::lonpage
+ &lt;/LocationMatch&gt;
+ </PRE>
+ </P>
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/startup.pl" TARGET="etc/httpd/conf/startup.pl" CATEGORY="static conf">
  <DESCRIPTION>
- set paths to modules; invoked by <TT>access.conf</TT>
+ This file provides initializations for perl handlers.  It adjusts what
+ the module path space is (so as to include /home/httpd/lib/perl/Apache) as
+ well as causing the Apache module to be used for every perl handler.
+ <TT>startup.pl</TT> is invoked by <TT>access.conf</TT>.
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/filetypes.tab" TARGET="home/httpd/lonTabs/filetypes.tab" CATEGORY="static conf">
  <DESCRIPTION>
- Descriptive list of file extensions, and extension groupings
+ Descriptive list of file extensions, and extension groupings.
+ </DESCRIPTION>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/default.assesscalc" TARGET="home/httpd/html/res/adm/includes/default.assesscalc" CATEGORY="static conf">
+ <DESCRIPTION>
+ Default spreadsheet for individual assessment.
+ </DESCRIPTION>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/default.studentcalc" TARGET="home/httpd/html/res/adm/includes/default.studentcalc" CATEGORY="static conf">
+ <DESCRIPTION>
+ Default spreadsheet for assessment of students.
+ </DESCRIPTION>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/default.classcalc" TARGET="home/httpd/html/res/adm/includes/default.classcalc" CATEGORY="static conf">
+ <DESCRIPTION>
+ Default spreadsheet for assessment of a class.
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
- Line 329  proxy server
+ Line 379  proxy server
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/lond" TARGET="home/httpd/perl/lond" CATEGORY="script">
  <DESCRIPTION>
- remote command interpreter
+ This is a remote command interpreter on a TCP LON-CAPA network layer.
+ It accepts and processes incoming requests from other LON-CAPA machines
+ on the network.  lond's functionality is self-contained in the sense
+ that it does not reference (import, require, use) any other file
+ described in this document.  There are only 15 subroutines in this
+ script, however the <TT>make_new_child</TT> subroutine is quite
+ complex since it parses and responds about 29 different types of
+ network requests (i.e. enc, ping, pong, ekey, load, auth, passwd,
+ makeuser, home, update, unsub, sub, log, put, rolesput, get, eget,
+ del, keys, dump, store, restore, querysend, queryreply, idput, idget,
+ tmpput, tmpget, and ls).
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
- Line 414  Table which has hash data necessary for
+ Line 474  Table which has hash data necessary for
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/homework/essayresponse.pm" TARGET="home/httpd/lib/perl/Apache/essayresponse.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler to evaluate essay (ungraded) style responses.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/publisher/lonpubdir.pm" TARGET="home/httpd/lib/perl/Apache/lonpubdir.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler to publish directories.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/publisher/lonretrieve.pm" TARGET="home/httpd/lib/perl/Apache/lonretrieve.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler to retrieve old versions from resource space.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/homework/edit.pm" TARGET="home/httpd/lib/perl/Apache/edit.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Helper functions when in homework edit mode.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/lonmeta.pm" TARGET="home/httpd/lib/perl/Apache/lonmeta.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Metadata display handler.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="rat/lonambiguous.pm" TARGET="home/httpd/lib/perl/Apache/lonambiguous.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler to resolve ambiguous file locations.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="rat/lonratparms.pm" TARGET="home/httpd/lib/perl/Apache/lonratparms.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler to set resource parameters inside of the RAT based on metadata.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
+ <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="rat/lonsequence.pm" TARGET="home/httpd/lib/perl/Apache/lonsequence.pm" CATEGORY="handler">
+ <DESCRIPTION>
+ Handler for showing sequence objects of educational resources.
+ </DESCRIPTION>
+ <STATUS>works/unverified</STATUS>
+ </METAGROUP>
+ <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/loncreatecourse.pm" TARGET="home/httpd/lib/perl/Apache/loncreatecourse.pm" CATEGORY="handler">
  <DESCRIPTION>
- Creates a new course and assigns course coordinator
+ Creates a new course and assigns course coordinator.
  </DESCRIPTION>
  <STATUS>works/unverified</STATUS>
  </METAGROUP>
- Line 715  handles request to the CAPA homework pro
+ Line 831  handles request to the CAPA homework pro
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/auth/lonacc.pm" TARGET="home/httpd/lib/perl/Apache/lonacc.pm" CATEGORY="handler">
  <DESCRIPTION>
- access to for a LON-CAPA user session
+ (This module, like loncacc.pm also authenticates with cookies.)
+ <TT>lonacc.pm</TT> coordinates access to a wide range of administrative-type
+ functions (e.g. roles, logout, annotations, and bookmarks) as well
+ as coordinating access to educational resources.
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
- Line 727  access handler for file transfers
+ Line 846  access handler for file transfers
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/auth/loncacc.pm" TARGET="home/httpd/lib/perl/Apache/loncacc.pm" CATEGORY="handler">
  <DESCRIPTION>
- access to construction area
+ This module provides access to an educational resource construction area.
+ This module is invoked by the URL-related pattern syntax
+ <TT>LocationMatch "^/priv.*"</TT> or <TT>LocationMatch "^/\~.*"</TT>.
+ Authentication of user identity
+ is coordinated through cookies.  The abbreviation "cacc" corresponds
+ to "construction-space access").  If the cookie handle is invalid, then
+ this module returns a forbidden status and makes appropriate log entries.
+ If the cookie handle is valid, status is determined to be okay (and,
+ for the "priv"-type access, the resource is delivered by the
+ <TT>lonconstruct</TT> module).
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>
- Line 757  replication
+ Line 885  replication
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/auth/lonroles.pm" TARGET="home/httpd/lib/perl/Apache/lonroles.pm" CATEGORY="handler">
  <DESCRIPTION>
- roles picking
+ This perl handling module reads in the available roles available
+ for a LON-CAPA user (different courses, different privileges, etc)
+ and produces a form-element HTML page which allows the user to select
+ which role he wishes to exercise in the LON-CAPA system.  For instance,
+ a user may want to select between being a student in a thermodynamics
+ physics course or a teaching assistant for an introductory calculus
+ class.
  </DESCRIPTION>
- </METAGROUP>
+ </METGROUP>
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/interface/lonindexer.pm" TARGET="home/httpd/lib/perl/Apache/lonindexer.pm" CATEGORY="handler">
  <DESCRIPTION>
- Line 769  cross server filesystem browser
+ Line 903  cross server filesystem browser
  <METAGROUP>
  <LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/lonnet/perl/lonnet.pm" TARGET="home/httpd/lib/perl/Apache/lonnet.pm" CATEGORY="handler">
  <DESCRIPTION>
- interface to lonc
+ This file is an interface to the lonc processes of the LON-CAPA network
+ as well as set of elaborated functions for handling information necessary
+ for navigating through a given cluster of LON-CAPA machines within a domain.
+ There are over 40 specialized functions in this module which handle
+ the reading and transmission of metadata, user information
+ (ids, names, environments, roles, logs), file information (storage, reading,
+ directories, extensions, replication, embedded styles and descriptors),
+ educational resources (course descriptions, section names and numbers),
+ url hashing (to assign roles on a url basis), and translating abbreviated
+ symbols to and from more descriptive phrases or explanations.
  </DESCRIPTION>
  </METAGROUP>
  <METAGROUP>

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

Removed from v.1.56
changed lines
	Added in v.1.76