[LON-CAPA-cvs] cvs: loncom / lonc /auth lonroles.pm

[bowersj2]

bowersj2		Thu Jul 24 21:16:29 2003 EDT

  Modified files:              
    /loncom	lonc 
    /loncom/auth	lonroles.pm 
  Log:
  Documentation updates
  
  
Index: loncom/lonc
diff -u loncom/lonc:1.51 loncom/lonc:1.52
--- loncom/lonc:1.51	Wed Jul 23 12:52:30 2003
+++ loncom/lonc	Thu Jul 24 21:16:29 2003
@@ -5,7 +5,7 @@
 # provides persistent TCP connections to the other servers in the network
 # through multiplexed domain sockets
 #
-# $Id: lonc,v 1.51 2003/07/23 16:52:30 bowersj2 Exp $
+# $Id: lonc,v 1.52 2003/07/25 01:16:29 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1151,12 +1151,12 @@
 B<H>'s Home Server, so this information gets forwarded to B<E>, where
 the records of H are updated.
 
-=head2 lond, lonc, lonnet
+=head2 lond, lonc, and lonnet
 
 =begin latex
 
 \begin{figure}
-\includegraphics[width=0.75\paperwidth,keepaspectratio]{LONCAPA_Network_Diagram2}
+\includegraphics[width=0.65\paperwidth,keepaspectratio]{LONCAPA_Network_Diagram2}
   \caption{\label{Overview_Of_Network_Communication}Overview of
 Network Communication} \end{figure}
 
@@ -1428,9 +1428,9 @@
 B<D7>, which represents steps Steps B<U4a> through B<U6> in the
 replication figure.
 
-=head2 Load Balancing X<load balancing>
+=head2 Load Balancing 
 
-C<lond> provides a function to query the server's current loadavg. As
+X<load balancing>C<lond> provides a function to query the server's current loadavg. As
 a configuration parameter, one can determine the value of loadavg,
 which is to be considered 100%, for example, 2.00.
 
Index: loncom/auth/lonroles.pm
diff -u loncom/auth/lonroles.pm:1.63 loncom/auth/lonroles.pm:1.64
--- loncom/auth/lonroles.pm:1.63	Sat Jul  5 06:07:11 2003
+++ loncom/auth/lonroles.pm	Thu Jul 24 21:16:29 2003
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # User Roles Screen
 #
-# $Id: lonroles.pm,v 1.63 2003/07/05 10:07:11 www Exp $
+# $Id: lonroles.pm,v 1.64 2003/07/25 01:16:29 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -593,6 +593,36 @@
  ErrorDocument     403 /adm/login
  ErrorDocument	  500 /adm/errorhandler
  </Location>
+
+=head1 OVERVIEW
+
+=head2 Choosing Roles
+
+C<lonroles> is a handler that allows a user to switch roles in
+mid-session. LON-CAPA attempts to work with "No Role Specified", the
+default role that a user has before selecting a role, as widely as
+possible, but certain handlers for example need specification which
+course they should act on, etc. Both in this scenario, and when the
+handler determines via C<lonnet>'s C<&allowed> function that a certain
+action is not allowed, C<lonroles> is used as error handler. This
+allows the user to select another role which may have permission to do
+what they were trying to do. C<lonroles> can also be accessed via the
+B<CRS> button in the Remote Control. 
+
+=begin latex
+
+\begin{figure}
+\begin{center}
+\includegraphics[width=0.45\paperwidth,keepaspectratio]{Sample_Roles_Screen}
+  \caption{\label{Sample_Roles_Screen}Sample Roles Screen} 
+\end{center}
+\end{figure}
+
+=end latex
+
+=head2 Role Initialization
+
+The privileges for a user are established at login time and stored in the session environment. As a consequence, a new role does not become active till the next login. Handlers are able to query for privileges using C<lonnet>'s C<&allowed> function. When a user first logs in, their role is the "common" role, which means that they have the sum of all of their privileges. During a session it might become necessary to choose a particular role, which as a consequence also limits the user to only the privileges in that particular role.
 
 =head1 INTRODUCTION