HierarchicalNavigation < TWiki

---+!! Hierarchical Navigation

*Navigation block that displays the current topic, its parent and children (if any).* %BR%
This is intended to be included in other topics, for example in a side navigation bar (WebLeftBar).

_NOTE: The lookup for parent and children will increase the loading time of your pages._

%TOC%

---++ Usage
Two sections are defined:
   * =all=
   * =children=
   
---+++ Displaying the Parent - Current - Children block
<blockquote>
<verbatim>
%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="all"}%
</verbatim>
</blockquote>
generates:

%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="all"}%


When included in WebLeftBar (using default Pattern skin) this is styled to:

<div id="patternLeftBarContents">
%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="all"}%
</div>

---+++ Displaying child topics
<blockquote>
<verbatim>
*Child topics:*
%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="children"}%
</verbatim>
</blockquote>
generates:

*Child topics:*
%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="children"}%

When included in WebLeftBar (using default Pattern skin) this is styled to:

<div id="patternLeftBarContents">
%INCLUDE{"%SYSTEMWEB%.HierarchicalNavigation" section="children"}%
</div>

<verbatim style="display:none;">
%STARTSECTION{name="all"}%<div class="twikiHierarchicalNavigation">
<ul>
%SEARCH{
"parent"
type="query"
topic="%BASETOPIC%"
web="%BASEWEB%"
nonoise="on"
format="<li class='twikiParentTopic'><img src='%ICONURL{parent_gray}%' width='16' height='16' alt='' border='0' /> [[$web.$parent][$parent]]</li>"
}%
<li class='twikiCurrentTopic' style='font-weight:bold;'><nop>%BASETOPIC%</li>%INCLUDE{"%TOPIC%" section="childlist"}%
</ul>
</div><!--/twikiHierarchicalNavigation-->%ENDSECTION{name="all"}%

%STARTSECTION{name="children"}%<div class="twikiHierarchicalNavigation">
<ul>%INCLUDE{"%TOPIC%" section="childlist"}%</ul>
</div><!--/twikiHierarchicalNavigation-->%ENDSECTION{name="children"}%</div>%ENDSECTION{name="children"}%

%STARTSECTION{name="childlist"}%%SEARCH{
"parent.name='%BASETOPIC%'"
web="%BASEWEB%"
type="query"
nonoise="on"
format="<li class='childTopic'><img src='%ICONURL{line_ur_gray}%' width='16' height='16' alt='' border='0' /> [[$web.$topic][$topic]]</li>"
}%%ENDSECTION{name="childlist"}%
</verbatim>

This topic: TWiki > WebHome > HierarchicalNavigation
Topic revision: r4 - 2010-09-12 - TWikiContributor

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.HierarchicalNavigation.