Index: openacs-4/packages/dotlrn-dotlrn/tcl/dotlrn-dotlrn-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/dotlrn-dotlrn/tcl/dotlrn-dotlrn-procs.tcl,v diff -u -r1.42 -r1.43 --- openacs-4/packages/dotlrn-dotlrn/tcl/dotlrn-dotlrn-procs.tcl 20 Sep 2018 13:23:03 -0000 1.42 +++ openacs-4/packages/dotlrn-dotlrn/tcl/dotlrn-dotlrn-procs.tcl 20 Sep 2018 13:24:53 -0000 1.43 @@ -15,9 +15,9 @@ # ad_library { - - Procs to set up the core dotLRN portlets. + Procs to set up the core dotLRN portlets. + 1. the soon-to-be-renamed "dotlrn-main" portlet (The thing that lists a users communities on their portal) 2. the "dotlrn" portlet (a.k.a. "subgroups" on comm portals) @@ -33,18 +33,18 @@ } namespace eval dotlrn_dotlrn { - + ad_proc portal_element_key { } { What portlet is this applet associated with? } { - return "dotlrn-portlet" + return "dotlrn-portlet" } ad_proc -public get_pretty_name { } { } { - return "[_ dotlrn-dotlrn.Core_DotLRN_Applets]" + return "[_ dotlrn-dotlrn.Core_DotLRN_Applets]" } ad_proc -public my_package_key { @@ -62,30 +62,30 @@ ad_proc -public add_applet { } { - Add the applet to dotlrn - one time init - must be repeatable! + Add the applet to dotlrn - one time init - must be repeatable! } { dotlrn_applet::add_applet_to_dotlrn -applet_key [applet_key] -package_key [my_package_key] } ad_proc -public remove_applet { - package_id + package_id } { - Remove the applet from dotlrn. + Remove the applet from dotlrn. } { ad_return_complaint \ 1 \ "[applet_key] remove_applet called - this should not happen ever!" } ad_proc -public add_applet_to_community { - community_id + community_id } { - Add the core dotlrn applets to a specific community + Add the core dotlrn applets to a specific community } { # # comm type-specific stuff # - # we call add_self_to_page again with the + # we call add_self_to_page again with the # real comm_id, and it gets overwritten set portal_id [dotlrn_community::get_portal_id \ @@ -138,24 +138,24 @@ dotlrn_dotlrn::add_portlet_helper $portal_id $args - # return the empty string - return "" + # return the empty string + return "" } ad_proc -public remove_applet_from_community { - community_id + community_id } { - remove the dotlrn applet from a specific community + remove the dotlrn applet from a specific community } { ad_return_complaint \ 1 \ "[applet_key] remove_applet_from_community not implemented!" } ad_proc -public add_user { - user_id + user_id } { - Called for one time init when this user is added to dotlrn. + Called for one time init when this user is added to dotlrn. Do nothing, since the portal system will copy the dotlrn-main portal from the user template. that's set up below } { @@ -171,35 +171,35 @@ } ad_proc -public add_user_to_community { - community_id - user_id + community_id + user_id } { Add user to a comm } { # noop } ad_proc -public remove_user_from_community { - community_id - user_id + community_id + user_id } { - Remove a user from a community. Since this applet is not shown - on a user's portal, no action is required here. + Remove a user from a community. Since this applet is not shown + on a user's portal, no action is required here. } { # noop } - + ad_proc -public add_portlet { portal_id } { - @param portal_id + @param portal_id } { set community_id 0 set args [ns_set create] ns_set put $args community_id $community_id set type [dotlrn::get_type_from_portal_id -portal_id $portal_id] - + switch $type { user { dotlrn_main_portlet::add_self_to_page -portal_id $portal_id @@ -234,10 +234,10 @@ } ad_proc -private add_portlet_helper { - portal_id - args + portal_id + args } { - Does the call to add the portlet to the portal. + Does the call to add the portlet to the portal. Params for the portlet are sent to this proc by the caller. } { dotlrn_portlet::add_self_to_page \ @@ -249,8 +249,8 @@ portal_id args } { - A helper proc to remove the underlying portlet from the given portal. - + A helper proc to remove the underlying portlet from the given portal. + @param portal_id @param args } { @@ -262,7 +262,7 @@ new_community_id } { Clone this applet's content from the old community to the new one. - Since there's no data to copy, just add the applet to the new + Since there's no data to copy, just add the applet to the new community. } { ns_log notice "Cloning: [applet_key]" @@ -274,10 +274,10 @@ event old_value new_value - } { - listens for the following events: - } { - } + } { + listens for the following events: + } { + } ad_proc -private get_default_page { portal_type } { The pretty name of the page to add the portlet to. @@ -303,7 +303,7 @@ } return $page_name - } + } } # Local variables: Index: openacs-4/packages/dotlrn-portlet/tcl/dotlrn-members-staff-portlet-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/dotlrn-portlet/tcl/dotlrn-members-staff-portlet-procs.tcl,v diff -u -r1.13 -r1.14 --- openacs-4/packages/dotlrn-portlet/tcl/dotlrn-members-staff-portlet-procs.tcl 20 Sep 2018 13:23:03 -0000 1.13 +++ openacs-4/packages/dotlrn-portlet/tcl/dotlrn-members-staff-portlet-procs.tcl 20 Sep 2018 13:24:53 -0000 1.14 @@ -38,60 +38,59 @@ } { Get the pretty name. } { - return "#dotlrn-portlet.members_staff_portlet_pretty_name#" + return "#dotlrn-portlet.members_staff_portlet_pretty_name#" } ad_proc -public link { } { Get the link. This is currently empty. } { - return "" + return "" } ad_proc -public add_self_to_page { - {-portal_id:required} - {-community_id:required} + {-portal_id:required} + {-community_id:required} } { Add the "dotlrn members staff" portlet to the page. } { set force_region [parameter::get_from_package_key \ - -package_key [my_package_key] \ - -parameter "dotlrn_members_staff_portlet_force_region" + -package_key [my_package_key] \ + -parameter "dotlrn_members_staff_portlet_force_region" ] return [portal::add_element_parameters \ - -portal_id $portal_id \ - -pretty_name [get_pretty_name] \ - -portlet_name [get_my_name] \ - -force_region $force_region \ - -key "community_id" \ - -value $community_id + -portal_id $portal_id \ + -pretty_name [get_pretty_name] \ + -portlet_name [get_my_name] \ + -force_region $force_region \ + -key "community_id" \ + -value $community_id ] } ad_proc -public remove_self_from_page { {-portal_id:required} } { - Removes the PE from the given page. + Removes the PE from the given page. } { portal::remove_element \ -portal_id $portal_id \ -portlet_name [get_my_name] } ad_proc -public show { - cf + cf } { - Call the template to display. + Call the template to display. - @param cf A config array + @param cf A config array } { portal::show_proc_helper \ -package_key [my_package_key] \ -config_list $cf \ -template_src "dotlrn-members-staff-portlet" } - } # Local variables: