TWiki/HierarchicalNavigation.mdwn

   1 # <a name="Hierarchical Navigation"></a><a name=" Hierarchical Navigation"></a> Hierarchical Navigation
   2
   3 **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]]).
   4
   5 _NOTE: The lookup for parent and children will increase the loading time of your pages._
   6
   7 <div>
   8   <ul>
   9     <li>
  10       <ul>
  11         <li><a href="#Usage"> Usage</a><ul>
  12             <li><a href="#Displaying the Parent - Current"> Displaying the Parent - Current - Children block</a></li>
  13             <li><a href="#Displaying child topics"> Displaying child topics</a></li>
  14           </ul>
  15         </li>
  16       </ul>
  17     </li>
  18     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
  19     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
  20     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
  21   </ul>
  22 </div>
  23
  24 ## <a name="Usage"></a> Usage
  25
  26 Two sections are defined:
  27
  28 - `all`
  29 - `children`
  30
  31 ### <a name="Displaying the Parent - Current"></a><a name="Displaying the Parent - Current "></a> Displaying the Parent - Current - Children block
  32
  33 > %INCLUDE{"%TWIKIWEB%.HierarchicalNavigation" section="all"}%
  34
  35 generates:
  36
  37 When included in [[WebLeftBar]] (using default Pattern skin) this is styled to:
  38
  39 <div id="patternLeftBarContents">
  40   <p>
  41   </p>
  42 </div>
  43
  44 ### <a name="Displaying child topics"></a> Displaying child topics
  45
  46 > *Child topics:*
  47 >     %INCLUDE{"%TWIKIWEB%.HierarchicalNavigation" section="children"}%
  48
  49 generates:
  50
  51 **Child topics:**
  52
  53 <div style="display: none">
  54   <div>
  55     <div>
  56       <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)</div>
  57     <div>
  58       <ul>
  59         <li> WebHome </li>
  60       </ul>
  61     </div>
  62     <div>
  63       <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)</div>
  64   </div>
  65   <p>
  66   </p>
  67   <div>
  68     <div>
  69       <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)</div>
  70   </div>
  71   <p>
  72   </p>
  73 </div>