navigation-procs.tcl

Provides procedures to spit out the navigational parts of the site.

Location:
packages/acs-tcl/tcl/navigation-procs.tcl
Created:
11/5/98 (adapted originally from the Cognet server)
Author:
philg@mit.edu
CVS Identification:
$Id: navigation-procs.tcl,v 1.50 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

ad_choice_bar (public)

 ad_choice_bar items links values [ default ]

Displays a list of choices (Yahoo style), with the currently selected one highlighted.

Parameters:
items (required)
links (required)
values (required)
default (optional)
See Also:

Testcases:
ad_html_bars

ad_context_bar (public)

 ad_context_bar [ -from_node from_node ] [ -node_id node_id ] \
    [ -separator separator ] [ args... ]

Returns a Yahoo-style hierarchical navbar. Includes "Administration" or "Subsite Administration" if applicable, and the subsite if not global. 'args' can be either one or more lists, or a simple string.

Switches:
-from_node (optional)
If provided do not generate links to the given node and above.
-node_id (optional)
If provided work up from this node, otherwise the current node
-separator (optional)
The text placed between each link (passed to ad_context_bar_html if provided)
Returns:
an HTML fragment generated by ad_context_bar_html
See Also:

Testcases:
ad_context_bar

ad_context_bar_html (public)

 ad_context_bar_html [ -separator separator ] context

Generate the an HTML fragment for a context bar. This is the function that takes a list in the format 

    [list [list url1 text1] [list url2 text2] ... "terminal text"]
    
    and generates the HTML fragment.  In general, the higher level
    proc ad_context_bar should be
    used, and then only in the sitewide master rather than on
    individual pages.





Switches:


-separator (optional)
The text placed between each link


Parameters:


context (required)
list as with ad_context_bar




Returns:
HTML fragment


See Also:




Testcases:

ad_context_bar_html

ad_context_bar_multirow (public)

 ad_context_bar_multirow [ -from_node from_node ] [ -node_id node_id ] \
    [ -multirow multirow ] context

Returns a Yahoo-style hierarchical navbar. Includes "Administration" if applicable, and the subsite if not global.

Switches:
-from_node (optional)
If provided do not generate links to the given node and above.
-node_id (optional)
If provided work up from this node, otherwise the current node
-multirow (optional, defaults to "context")
Parameters:
context (required)
Returns:
an HTML fragment generated by ad_context_bar_html
See Also:

Testcases:
ad_context_bar_multirow

ad_context_node_list (public)

 ad_context_node_list [ -from_node from_node ] node_id

Starting with the given node_id, return a list of [list url instance_name] items for parent nodes.

Switches:
-from_node (optional)
Parameters:
node_id (required)
Options:
-from_node
The top-most node_id for which we'll show context bar. This can be used with the node_id of the nearest subsite to get the context-bar only up to the nearest subsite.
Author:
Peter Marklund

Testcases:
webtest_example, web_forum_view, web_forum_edit, web_forums_message_and_reply

ad_navbar (public)

 ad_navbar [ args... ]

Produces a navigation bar. Notice that navigation bar is different than context bar, which displays packages in the site map. Navbar will only generate HTML for those links passed to it.

Returns:
HTML fragment
See Also:

Testcases:
ad_html_bars

util_current_location_node_id (public)

 util_current_location_node_id

returns node_id of util_current_location. Useful for hostnode mapped sites using ad_context_bar

Testcases:
No testcase defined.
[ show source ]