NAME

SYNOPSIS

  my $nav = DocSet::NavigateCache->new($cache_path, $id, $rel_path);

  # go through all nodes from left to right, and remember the sequence
  # number of the $nav node (from which we have started)
  my $iterator = $nav->first;
  my $seq = 0;
  my $counter = 0;
  my @meta = ();
  while ($iterator) {
     $seq = $counter if $iterator->id eq $nav->id;
     push @meta, $iterator->meta;
     $iterator = $iterator->next;
     $counter++;
  }
  # add index node's meta data
  push @meta, $nav->index_node;

  # prev object
  $prev  = $nav->prev;

  # get all the ancestry
  my @parents = ();
  $p = $nav->up;
  while ($p) {
      push @parents, $p;
      $p = $p->up;
  }

  # access the docsets of the child nodes
  $child_docset = $nav->down()

DESCRIPTION

This object can be used to retrieve node's meta data, its id and its index node's meta data.

Currently it is used in the templates for the internal navigation widgets creation. That's where you will find the examples of its use (e.g. tmpl/custom/html/menu_top_level and tmpl/custom/html/navbar_global).

As "DocSet::NavigateCache" reads cache files in, it caches them, since usually the same file is required many times in a few subsequent calls.

Note that "DocSet::NavigateCache" doesn't see any hidden objects stored in the cache.

AUTHORS