--- doc/loncapafiles/Attic/loncapafiles.html 2000/12/08 23:19:23 1.28 +++ doc/loncapafiles/Attic/loncapafiles.html 2001/05/21 12:43:57 1.96 @@ -27,7 +27,7 @@ The format of these tags is:

Here are examples of all the different types of LONCAPA make/build tags. -
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/modules/TexConvert/tthperl/lontex.pm" TARGET="home/httpd/lib/perl/Apache/lontex.pm" CATEGORY="handler"> +
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="modules/TexConvert/tthperl/lontex.pm" TARGET="home/httpd/lib/perl/Apache/lontex.pm" CATEGORY="handler">
<LONCAPA TYPE=DIRECTORY DIST="redhat6.2" TARGET="home/httpd/lib/perl/Apache" CATEGORY="writeable by server">
<LONCAPA TYPE=OWNERSHIP DIST="redhat6.2" CATEGORY="setuid" CHMOD="6755" CHOWN="root:root">
<LONCAPA TYPE=RPM NAME="Vendor" VALUE="Laboratory for Instructional Technology Education, Division of Science and Mathematics Education, Michigan State University."> @@ -52,19 +52,19 @@ The NAME tags associated with TYPE=RPM a

Data can also be attached to any LON-CAPA tag. This is especially important for files. This is shown by these three examples:
<METAGROUP> -
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/modules/TexConvert/tthperl/lontex.pm" TARGET="home/httpd/lib/perl/Apache/lontex.pm" CATEGORY="handler"> +
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="modules/TexConvert/tthperl/lontex.pm" TARGET="home/httpd/lib/perl/Apache/lontex.pm" CATEGORY="handler">
<DESCRIPTION>
Handler for TeX files
</DESCRIPTION>
</METAGROUP>
 
<METAGROUP> -
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="loncom/modules/TexConvert/tthperl/tth.so" TARGET="usr/lib/perl5/site_perl/5.005/tth.so" CATEGORY="system file"> +
<LONCAPA TYPE=LOCATION DIST="redhat6.2" SOURCE="modules/TexConvert/tthperl/tth.so" TARGET="usr/lib/perl5/site_perl/5.005/tth.so" CATEGORY="system file">
<DESCRIPTION>
shared library file for dynamic loading and unloading of TeX-to-HTML functionality
</DESCRIPTION>
<BUILD> -
loncom/modules/TexConvert/tthperl/commands +
modules/TexConvert/tthperl/commands
</BUILD>
<DEPENDENCIES>
../tthdynamic/tthfunc.c @@ -104,6 +104,8 @@ you can just view the internal tags of t This section contains the actual LONCAPA tag information. These tags are probably not viewable with your browser and can only be seen be examining the HTML source.

+ + @@ -144,6 +146,7 @@ browser and can only be seen be examinin + @@ -157,7 +160,10 @@ browser and can only be seen be examinin - + + + @@ -169,7 +175,15 @@ browser and can only be seen be examinin + + + + + + + + @@ -179,7 +193,16 @@ browser and can only be seen be examinin -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. configure @@ -197,50 +220,96 @@ define handlers, set parameters -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. -name space configuration +

+This file configures the "name space" of the Apache web server. +srm.conf +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". +

+

+Here is an example entry: +

+<LocationMatch "^/res/.*\.page$>
+SetHandler perl-script
+PerlHandler Apache::lonpage
+</LocationMatch>
+
+

-set paths to modules; invoked by access.conf +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. +startup.pl is invoked by access.conf. -Descriptive list of file extensions, and extension groupings +Descriptive list of file extensions, and extension groupings. + + + + + +Describes what tags are allowed inside other tags. - + + +Default spreadsheet for individual assessment. + + + + + +Default spreadsheet for assessment of students. + + + + + +Default spreadsheet for assessment of a class. + + + + List of privileges associated with users of multiple types (for example: Teaching Assistant, Exam Proctor, Course Coordinator) - + Descriptive list of abbreviations used in roles.tab for user types and privileges available in the network with function - + List of all machines in the LON-CAPA network. Relates lonHostID to lonDefDomain and IP address - + Spare hosts to offload session to if the LON-CAPA machine is overloaded @@ -257,13 +326,13 @@ each list element consists of only one v
- + Basic auth password to access /lon-status and /server-status - + which Kerberos server to contact for which Kerberos domains @@ -284,7 +353,7 @@ each list element consists of only two s - + configuration file to make LON-CAPA server file space accessible to network neighborhood @@ -293,7 +362,7 @@ configure - + which NTP server to contact for information (XNTP3 standard) @@ -309,91 +378,400 @@ Example:
server ntp.msu.edu
- + + +Batch script for updating SQL metadata database. + + + + proxy server - + -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 make_new_child 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). - + housekeeping - + maintain secondary database of metadata - + coordinates the system services and files in order to allow lond to change user passwords - + coordinates the system services and files in order to allow lond to add a new user - + coordinates the system services and files in order to allow lond to delete a user - + coordinates the system services and files in order to allow lond to enable NFS for a user - + coordinates the system services and files in order to allow lond to disable NFS for a user - + + +HTML frame that presents a form element to allow for the publishing of +resources, directories and underlying subdirectories. + + + + + +The relevant conditions and metadata to attach to LectureOnline-specific tags. + + + + + +File which contains words which should not be keywords used to specify resource +content. + + + + + +Table which contains list of copyright possibilities for educational resources. + + + + + +Table which contains string abbreviations of language::font rendering +combinations. + + + + + +Table which has hash data necessary for distinguishing IDs from indices. + + + + + +Handler to show statistics on solving LON-CAPA problems. + +works/unverified + + + + +Handler to show difference between two files. + +works/unverified + + + + +Handler to upload files through browser into construction space. + +works/unverified + + + + +Handler to evaluate essay (ungraded) style responses. + +works/unverified + + + + +Handler to publish directories. + +works/unverified + + + + +Handler to retrieve old versions from resource space. + +works/unverified + + + + +Helper functions when in homework edit mode. + +works/unverified + + + + +Metadata display handler. + +works/unverified + + + + +Handler to resolve ambiguous file locations. + +works/unverified + + + + +Handler to set resource parameters inside of the RAT based on metadata. + +works/unverified + + + + +Handler for showing sequence objects of educational resources. + +works/unverified + + + + +Creates a new course and assigns course coordinator. + +works/unverified + + + + +Creates a new user and/or changes user privileges + +works/unverified + + + + +Produces simple LectureOnline-like student assessment performance chart + +works/unverified + + + + +Makes a table out of the previous attempts. Inputs result_from_symbread, +user, domain, home_server, course_id + +works/unverified + + + + +Handles the viewing of grades. + + + + + +Coordinates the response to clicking an image. + + + + + +Handles tags associated with showing a list of options. + + + + + +Handles tags associated with output. Seems to relate to due dates of the +assignment. + + + + + +Used for debugging and testing the LON-CAPA system. + + + + + +Handles multiple-choice style responses. + + + + + +Handles processing of assignments. + + + + + +Handles communication. + + + + + +Handles errors. + + + + + +Handles evaluation. + + + + + +Handles feedback from students to instructors and system administrators. + + + + + +Unknown function. + + + + + +Handles navigational maps. + + + + + +Handles user preferences associated with customizing the online LON-CAPA +educational environment. + + + + + +Handles the production of printable files and resources. + + + + + +Handles a searchable catalogue. + + + + + +Handler to drop and add students in courses. + + + + + +Routines for messaging. + + + + + +This handler coordinates the delivery of hints to students working on LON-CAPA +problems and assignments. + + + + + +Spreadsheet/Grades Display Handler + + + + + +Handler to resolve ambiguous file locations + + + + + +Page wrapper for handling construction space. + + + + + +Publishes an LON-CAPA educational resource complete with metadata +(authorship, language, copyright, creation date, etc). + + + + Has routines which control the remote control. - + Deals with forward, backward, and other page flips. - + Builds up frame set and loads in the right thing. - + + +Homework remote control. + + + + This will take annotations and then plug them into a page - + This will take bookmarks and get/write/display them for the LON-CAPA user interface - + Handler tat takes output from RAT and stores it on disk. Handles the upper hidden frame of the added window that comes up in RAT. (3 frames come up in RAT server, @@ -401,200 +779,239 @@ code, and output. This module handles s - + bundles pages into one page - + compile course into binary data structure (in loncom/rat) - + -Handler for tex files (somewhere in loncom/modules) +Handler for tex files (somewhere in modules) - + Access to tth/ttm - + XML Parsing Module - + Style Parsing Module - - -Tags Default Definition Module - - - - + Tags Default Definition Module - + used to prevent poorly written problems from causing lingering after effects - + implements <script>, <scriptlib>, <parserlib>, and <import> - + handles requests for output, evaluation, and alteration of homework resource - + produces HTML input tags (<INPUT>) for rendering homework resources - + produces HTML tags necessary for structuring the presentation of homework resources - + defines different types of responses given to student as well as syntax for producing response values - + handles request to the CAPA homework processing engine - + -access to for a LON-CAPA user session +(This module, like loncacc.pm also authenticates with cookies.) +lonacc.pm 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. - + access handler for file transfers - + -access to construction area +This module provides access to an educational resource construction area. +This module is invoked by the URL-related pattern syntax +LocationMatch "^/priv.*" or LocationMatch "^/\~.*". +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 +lonconstruct module). - + authenticate, set up session environment - + login screen - + logout - + replication - + -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. - + - + cross server filesystem browser - + -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. - + bumps to login + + +symbolic link to /etc/mime.types + + + symbolic link to /home/httpd/html/res - + static html page that is shown when an attempt is made to access a document not present on the web server - + static html page that is shown when an attempt is made to access a document which is restricted based on file or server configurations - + frameset - + + +Parameter input window. + + + + javascript - + bumper + + + +A blank page with very minimal HTML structural elements. + + - + graphic files @@ -707,42 +1124,116 @@ sutd.gif - + + +icons to indicate an unexpected result + + +lonconstruct.gif +lonlogo_broken.gif +lonlogo_broken_tsp.gif + + + + + +icon to indicate an unexpected result + + + + + +icon to indicate an unexpected result + + + + + +icon to indicate an unexpected result + + + + logos liteani.gif -logo.gif -logos.gif +lonlogo.gif +lonlogos.gif + + + + + +miscellaneous resources + + +cat_button.gif - + perl module for invoking functions specific to Tex-to-HTML conversion + +Has the same dependencies and build process as tth.so. +Currently, only the tth.so file specifications invoke +the build process however. + + + + + +shared library file for dynamic loading and unloading + + +modules/TexConvert/tthperl/commands + + +../tthdynamic/tthfunc.c +../ttmdynamic/ttmfunc.c + - + perl module for invoking functions specific to CAPA + +Has the same dependencies and build process as capa.so. +Currently, only the capa.so file specifications invoke +the build process however. + - + bootstrap file associated with dynamic loading of this module on multiple architectures + +Has the same dependencies and build process as capa.so. +Currently, only the capa.so file specifications invoke +the build process however. + - + shared library file for dynamic loading and unloading + +loncom/homework/caparesponse/commands + + +caparesponse.c +caparesponse.pm +[ALWAYS_RUN_BUILD_COMMAND] + - + entity files @@ -769,37 +1260,48 @@ isomscr.ent isonum.ent isopub.ent isotech.ent -mathml.dtd mmlalias.ent mmlextra.ent - + cascading style sheet - + document type definition - + Encryption Routines according to Data Encryption Standard DES, written in javascript - + used by lonxml::xmlparse() as input variable $safeinit to Apache::run::run() + + + +used by lonxml::xmlparse() as input variable $safeinit to Apache::run::run() + + + + + +Define unit prefixing and conversion for CAPA problem handling. + + - + icons used for the entire LON-CAPA user interface @@ -825,6 +1327,7 @@ j.gif k.gif l.gif ledblink.gif +ledgreen.gif ledoff.gif ledon.gif ledsend.gif @@ -853,32 +1356,56 @@ z.gif - + image maps for the LON-CAPA remote control - + welcoming page to the LON-CAPA system upon login - + renders the HTML (including image maps) for the LON-CAPA remote control - + icons used for the bookmark portion of the LON-CAPA user interface -button_close.gif -button_edit.gif -button_preview.gif +a.gif +alert.black.gif +alert.red.gif +back.gif +ball.gray.gif +ball.red.gif +binary.gif +binhex.gif +blank.gif +bomb.gif +box1.gif +box2.gif +broken.gif +burst.gif +c.gif +comp.blue.gif +comp.gray.gif +compressed.gif +continued.gif +course.gif +dir.gif +down.gif +dvi.gif +f.gif +folder.gif +folder.open.gif +folder.sec.gif folder_closed.gif folder_closed_pressed.gif folder_new.gif @@ -888,15 +1415,75 @@ folder_pointer_closed.gif folder_pointer_opened.gif folder_spacer.gif folder_trash.gif +forward.gif +generic.gif +generic.red.gif +generic.sec.gif +hand.right.gif +hand.up.gif +html.gif +image1.gif +image2.gif +image3.gif +index.gif +layout.gif +left.gif +link.gif +mov.gif +movie1.gif +p.gif +patch.gif +pdf.gif +portal.gif +problem.gif +ps.gif +quill.gif +right.gif +screw1.gif +screw2.gif +script.gif +sound1.gif +sound2.gif +sphere1.gif +sphere2.gif +tar.gif +tex.gif +text.gif +transfer.gif +unknown.gif +up.gif +uu.gif +uuencoded.gif +white_space_20_22.gif +white_space_22_22.gif +world1.gif +world2.gif + + + + + +icons used for directory indexing and login screen + + +folder_anim.gif +folder_close.gif +folder_drag.gif +folder_new.gif +folder_open.gif +folder_pointer_closed.gif +folder_pointer_opened.gif +folder_static.gif +folder_trash.gif +folder_trash_hover.gif left_bar.gif -line_l_shape.gif -line_side_T.gif -line_vertical.gif link.gif -link_pressed.gif +link_anim.gif +link_drag.gif ll_corner.gif lower_bar.gif lr_corner.gif +pix.gif right_bar.gif toolbar_bg.gif ul_corner.gif @@ -905,74 +1492,61 @@ ur_corner.gif - + associated with the frameset scheme of displaying bookmarks -aaloader.html -annotator_bb.html -annotator_left.html -annotator_ll.html -annotator_lr.html -annotator_right.html -annotator_toolbar.html -annotator_ul.html -annotator_ur.html -annotator_uu.html -bookmarkpal.html -bookmarkpal_old.html -bookmarkpal_v2.html -bookmarkpal_v2_backup.html -index.html -loading_bookmarks.html +bookmarkmenu_toolbar.html +blank.html +closechildren.html - + javascript for handling client-side interactions with bookmark interface - + checks the system RPMs against what install.lon-capa.org specifies - + checks the important base LON-CAPA files against what install.lon-capa.org specifies - + restores .rpmsave files after a LON-CAPA-base upgrade - + does all the things to coordinate updating of LON-CAPA base files. Should be used with caution so that you do not lose work - + makes verification report using loncapaverifypackages and loncapaverifybasepackage - + file that specifies periodic processes to run for the LON-CAPA machine - + file that stimulates running of ntpdate upon init.d/xntpd initiation @@ -983,20 +1557,20 @@ file that stimulates running of ntpdate - - - - - - - - + + + + + + + + system init and control handling for the LON-CAPA network - + configuration file to make LON-CAPA server file space accessible to Appleshares access (Macintosh)