modx CMS

 * **************************
 * Snippet: PrevJumpNext
 * By: Jeroen Bosch modded by OncleBen31 modded by Aaron Heinrich
 * Date: May 2006 - July 2008
 * version: 0.5 (based on the PrevNext v0.9)
 * **************************
 *
 * DESCRIPTION
 *
 * Generates links to navigate between documents in a directory.
 * Highly configurable. It can display :
 *  - 'Showing article x of x'
 *  - 'Prev' and 'Next' links with or without document titles
 *  - 'First' and 'Last' links.
 *  - 'Index' link to parent folder
 *  - A select to jump quickly to a document
 *
 *  Can output links or generate placeholders 
 *
 * PARAMETERS
 *
 * - startID : Int: id of document folder to start from (default: parent document id);
 * - sortBy : String : Document variable to sort items by. 'menuindex' or 'id' or 'createdon', etc...  (default: createdon);
 * - sortHow : [ASC|DESC] : Sort order? 'ASC' or 'DESC' (default ASC);
 * - displayTitle : Boolean : Display document titles instead of &prevText and &nextText (default true);
 * - displayFixed : Boolean : Show 'first' and 'last' links (default false);
 * - usePlaceHolder : Boolean : Generate placeholders and do not output html :  ,  ,  ,  ,  ,   (default false);
 * - useJump : Boolean : Replace the index link by the select list when NOT using the placeholders (default false);
 * - indexDocumentID : Int : ID of the document linked as "index". (default &startID);
 * - displayNoPrevNext : Boolean : Display &noPrevNextText in place of "previous" and "next" when there is no previous or next item (default false);
 * - noPrevNextText : String : Text to display if there is no Prev or Next item and &displayNoPrevNext == 1 :(default "No more records");
 * - indexText : String : Title for "index" item (default "Index");
 * - jumpText : String : Title for select list (default :"Please Select");
 * - firstText : String : Title for "first" link (default "First");
 * - prevText : String : Title for "previous" item when $displayTitle is set to false (default "Prev");
 * - nextText : String : Title for "next" item when $displayTitle is set to false (default "Next");
 * - lastText : String : Title for "last" item (default "Last");
 * - exclude : Array : Comma-separated list of document IDs to exclude from navigation (default [empty])
 * - separator : String : Inserted between items (default " | ");
 * - displayIndex : Boolean: display index menu item (default true);
 * - firstSymbol : String : Prefixed to "First" menu item (default [empty]);
 * - prevSymbol : String : Prefixed to "Previous" menu item (default [empty]);
 * - nextSymbol : String : Suffixed to "Next" menu item (default [empty]);
 * - lastSymbol : String : Prefixed to "Last" menu item (default [empty]);
 * - displayTotal : Boolean : Show "Showing article X of Y" item (default true)
 * - recordTypeName : String : Name of records type for "Total" item.  E.g. (if = "post") "Showing post 3 of 25" (default "article");
 * - includeFolders : Boolean : include folder documents in the menu (default true);
 * - maxTitleChars : Int : Truncate document titles to this number of characters (default 0 [=display entire title]
 *
 * OUTPUT
 *
 *  Output consists of anchor elements with semantic class names E.G.:
 *  <a href="url" class="previous">Previous Title</a> | <a href="url" class="index">Index</a> | <a href="url" class="next">Next Title</a>
 *  Class names are: total, current, totalNumber, first, previous, index, next, last
 *