Support/Comments for UltimateParent 2.0-pl

<br />* @name UltimateParent<br /> * @version 1.3<br /> * @author Susan Ottwell <[email protected]> March 2006<br /> * @author Al B <> May 18, 2007<br /> * @author S. Hamblett <[email protected]><br /> * @author Shaun McCormick <[email protected]><br /> * @author Jason Coward <[email protected]><br /> *<br /> * @param &id The id of the document whose parent you want to find.<br /> * @param &top The top node for the search.<br /> * @param &topLevel The top level node for the search (root = level 1)<br /> *<br /> * @license Public Domain, use as you like.<br /> *<br /> * @example [[UltimateParent? &id=`45` &top=`6`]]<br /> * Will find the ultimate parent of document 45 if it is a child of document 6;<br /> * otherwise it will return 45.<br /> *<br /> * @example [[UltimateParent? &topLevel=`2`]]<br /> * Will find the ultimate parent of the current document at a depth of 2 levels<br /> * in the document hierarchy, with the root level being level 1.<br /> *<br /> * This snippet travels up the document tree from a specified document and<br /> * returns the "ultimate" parent.  Version 2.0 was rewritten to use the new<br /> * getParentIds function features available only in MODx 0.9.5 or later.<br /> *<br /> * Based on the original UltimateParent 1.x snippet by Susan Ottwell<br /> * <[email protected]>.  The topLevel parameter was introduced by staed and<br /> * adopted here.<br /> */<br />