Apache::Wyrd::Site::NavPull

Apache::Wyrd::Site::NavPull is a Perl module to display a list of documents in a navigation-tree.
Download

Apache::Wyrd::Site::NavPull Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Perl Artistic License
  • Price:
  • FREE
  • Publisher Name:
  • Barry King
  • Publisher web site:
  • http://search.cpan.org/~wyrd/Apache-Wyrd-0.98/Wyrd/Services/CodeRing.pm

Apache::Wyrd::Site::NavPull Tags


Apache::Wyrd::Site::NavPull Description

Apache::Wyrd::Site::NavPull is a Perl module to display a list of documents in a navigation-tree. Apache::Wyrd::Site::NavPull is a Perl module to display a list of documents in a navigation-tree.SYNOPSIS < BASECLASS::NavPull root="/someplace/index.html" maxdepth="3" > < BASECLASS::Template name="list" > < blockquote>$:items < /BASECLASS::Template > < BASECLASS::Template name="item" > < p >< a href="$:name" >$:title< /a >< /p > < /BASECLASS::Template > < BASECLASS::Template name="selected" > < p >$:title< /p > < /BASECLASS::Template > < BASECLASS::Template name="nearest" > < p >< a href="$:name" >< b >$:title< /a >< b >< /p > < /BASECLASS::Template > < /BASECLASS::NavPull >NavPull is designed to make navigation bars self-managing. It does so by recursively building the hierarchy out of the stated "parent" attributes of indexed Pages. Beginning with a "root", which can be an arbitrary page or (the default) a section root, it builds the list using five templates:list"list" is the HTML which bounds the list itself: in one of the list tags, it represents the list tags themselves (e.g. < UL >...< /UL >). Where the items of the list are to appear, the placemarker $:items should appear.item"item" is the HTML which represents an individual page. Whatever attributes of the Page you want to display in the list need to be given in placemarkers of this template.selectedIdentical to "item", but used only if the document in the NavPull list is the document on which it appears. This template is kept separate from the item template to allow the document to be treated differently on the page on which it appears, for example, not at all, or unlinked, so that it is clear it can't be navigated to. (Not normally used, see "metoo" flag, below.)nearestIdentical to "selected", but represents the closest parent node before the depth of the tree runs out. For example, if the NavPull is instructed to draw the tree only three nodes deep and the document on which the NavPull appears is five nodes down, the "nearest" template is used to draw the last ancestor which appears. Unless supplied, it defaults to the "item" template.leafWhen the "tree" tag is in effect, the last page in a branch, i.e. the "leaf" is drawn using this template. Unless supplied, it defaults to the "item" template.These templates can be extended down the depth of the tree by leaving as-is, or any depth level can be made different from the shallower ones by appending the depth level to the template name: list2, item2, selected2, list3, item3, selected3, etc. If templates for a depth level are not provided, they default to the next-shallower depth.Very crude templates are supplied automatically if no level of the template is specified in the body of the NavPull.NOTE: There is some support for multiple parentage. If a page declares two parents (separated by commas), the decision as to how to draw the tree depends on the referrer field of the HTTP request. If it indicates one of the ancestors of the page up one geneology, the navigation tree is drawn to reflect that branch, not the other(s). Multiple parents must belong in the same section, however, and there can be no circular relationships between parents. Requirements: · Perl


Apache::Wyrd::Site::NavPull Related Software