- Publicity: Public Only All
directory-procs.tcl
Definitions for the User Directory module
- Location:
- packages/directory/tcl/directory-procs.tcl
- Author:
- Mike Bonnet <mikeb@arsdigita.com>
- CVS Identification:
$Id: directory-procs.tcl,v 1.7 2018/10/22 08:32:17 gustafn Exp $
Procedures in this file
- dir_all_letters (public)
- dir_alpha_nav_bar (public)
- dir_app_group_info (public)
- dir_navbar_list (public)
- dir_subsite_info (public)
Detailed information
dir_all_letters (public)
dir_all_letters
returns a list of all A-Z letters in uppercase
- Testcases:
- No testcase defined.
dir_alpha_nav_bar (public)
dir_alpha_nav_bar [ -group_id group_id ] [ -all_users all_users ] \
letter [ excluded_vars ]Returns an A-Z bar with greyed out letters not in initial_list and bolds "letter". Includes all existing url vars except those in the "excluded_vars" list.
- Switches:
- -group_id (optional)
- -all_users (optional)
- Parameters:
- letter (required)
- excluded_vars (optional)
- Testcases:
- No testcase defined.
dir_app_group_info (public)
dir_app_group_info
Return a list containing the group_id (lindex 0) and group_name (lindex 1) of the application group associated with the subsite that the current directory package is mounted under. The directory package does not need to be mounted directly under the subsite; it will find the closest instance of subsite than is an ancestor of the package.
- Testcases:
- No testcase defined.
dir_navbar_list (public)
dir_navbar_list [ -top ] [ navbar_list_list ]
- Switches:
- -top (optional, boolean)
- Parameters:
- navbar_list_list (optional)
- Testcases:
- No testcase defined.
dir_subsite_info (public)
dir_subsite_info
Return a list containing the subsite_id (lindex 0) and subsite_name (lindex 1) of the subsite that the current directory package is mounted under. The directory package does not need to be mounted directly under the subsite; it will find the closest instance of subsite than is an ancestor of the package.
- Testcases:
- No testcase defined.
