// ---------------------------------------- // KNOWLEDGE MAP NAVIGATION MENUS STRUCTURE // ---------------------------------------- // Copyright (c) 2004-2007 The Salamander Organization Ltd. All Rights Reserved. // // THIS WORK IS SUBJECT TO U.K. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES. // // DISCLAIMER: // // The Salamander Organization Ltd. (hereto referred as "Salamander") makes no representations or warranties // with respect to the contents or use of this code, and specifically disclaims any express or implied // warranties of merchantability or fitness for any particular purpose. Further, Salamander reserves the right // to revise this publication and to make changes to its content, at any time, without obligation to notify any // person or entity of such revisions or changes. // // Further, Salamander makes no representations or warranties with respect to any software, and specifically // disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Salamander // reserves the right to make changes to any and all parts of the software, at any time, without obligation to notify // any person or entity of such changes. // // Inclusion of the above notice does not necessarily imply publication. // ----------------------------------------- // --- USER MODIFIABLE NAVIGATION BLOCKS --- // ----------------------------------------- // // To create a new arbitrary navigation block to contain navigation links, use the form: // // CreateNavigationBlock(areaNames, blockName, classIdText, htmlBlockOpen, htmlSeparator, htmlBlockClose); // // SUMMARY: // areaName - identifiers of the navigation area to assign this block to, separated by | (pipe symbol) // blockName - the text used to put a navigation link into this block // classIdText - css class name to use for links in this block // htmlBlockOpen - html used to start this block (can be a function that returns a string) // htmlSeparator - html used to separate links in the block (can be a function that returns a string) // htmlBlockClose - html used to end this block (can be a function that returns a string) // -- note: the order of the blocks is important // -- top navigation area blocks CreateNavigationBlock("topnav", "top", "topbar", "", " - ", ""); //CreateNavigationBlock("topnav", "knowledge", "krResource", LayoutTopNavBlockOpen("Associated Resources"), "", LayoutTopNavBlockClose()); //CreateNavigationBlock("topnav", "control", "", LayoutTopNavBlockOpen("Page Controls"), "", LayoutTopNavBlockClose()); // -- side navigation area blocks CreateNavigationBlock("sidenav|sidenav_index|sidenav_search", "page", "", LayoutSideNavBlockOpen("On this page"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav|sidenav_index|sidenav_search", "seealso", "", LayoutSideNavBlockOpen("See also"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav", "knowledge", "krResource", LayoutSideNavBlockOpen("Resources for this page"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav|sidenav_search", "control", "", LayoutSideNavBlockOpen("Control this page"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav_index", "control_index", "", LayoutSideNavBlockOpen("Control this page"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav|sidenav_index", "search", "", LayoutSideNavBlockOpen("Search"), "", LayoutSideNavBlockClose()); CreateNavigationBlock("sidenav|sidenav_index|sidenav_search", "user", "", LayoutSideNavBlockOpen("User Defined Block"), "", LayoutSideNavBlockClose()); // ------------------------------------------------------------------------- // --------------------------------------- // --- USER MODIFIABLE NAVIGATION BARS --- // --------------------------------------- // // Can either add a navigation link (for normal hypertext links) or a navigation block item (such as a search input box or arbitrary text) // // --- NAVIGATION LINKS --- // // AddNavigationLink(navBlockName, linkName, linkUrl, htmlLinkOpen, htmlLinkClose, toolTipText, linkIdText, isOutsideKMap); // // SUMMARY: // string navBlockName - name of the navigation block to send this navigation item to (e.g. "top", "control", etc) // string linkName - name of the link to appear on the page // string linkUrl - well known function or link id || a partial url || an absolute url // string htmlLinkOpen - html to open each link (can be empty) // string htmlLinkClose - html to close each link (can be empty) // string toolTipText - text to appear in a tooltip mouseover // string linkIdText - DOM id to use for this link // bool isOutsideKMap - set "true" for "link is outside KMap, do not add URL path", else omit or set false // // e.g. to add the system-defined link or function call to a block // AddNavigationLink("top", "Home", "HOMEPAGE", "Return to the Home Page"); // AddNavigationLink("top", "Contents", "INDEXPAGES"); // AddNavigationLink("control", "Feedback", "FEEDBACK", "Email Feedback"); // // e.g. to add a link that is within the Knowledge Map (all paths MUST be from the root folder) // NOTE: To use the OUTPUT_EXTENSION mood tag, append the outputExtension variable to your URL string // AddNavigationLink("user", "Some Link", "Indexes/ContextIndex" + outputExtension); // AddNavigationLink("user", "Another Link", "HelperPages/copyright.htm"); // // e.g. to add a generic external link // AddNavigationLink("top", "Some Other Link", "http://www.tsorg.com/", "Salamander Web Site", "", true); // AddNavigationLink("control", "Contact Person", "mailto:someperson@someplace.com", "", "", true); // AddNavigationLink("user", "Relative Url", "../../../SomeFolder/someFile.txt", "", "", true); // // --- NAVIGATION BLOCK ITEMS --- // // AddBlockItem(navBlockName, itemName, itemText, htmlItemOpen, htmlItemClose, toolTipText, linkIdText, overrideClassIdText); // // SUMMARY: // string navBlockName - name of the navigation block to send this item to (e.g. "top", "control", etc) // string itemName - name of the item if a well-known block item, else a blank string // string itemText - arbitrary text (can include html) for the block item - well-known blocks may override this parameter // string htmlItemOpen - html to open each item (can be empty) // string htmlItemClose - html to close each item (can be empty) // string toolTipText - text to appear in a tooltip mouseover - well-known blocks may override this parameter // string linkIdText - DOM id to use for this link (may be ignored, depending on the block item) // string overrideClassIdText - css class to use for this block - OVERRIDES the default class id for this block for this item only // // e.g. to add some arbitrary text to a block // AddBlockItem("user", "", "Some text to appear on in the block.", "", "", "cssTextClass"); // // e.g. to add the search input box and submit button // AddBlockItem("search", "SEARCHINPUT", "28", "", "", "txtSimpleSearchTerms"); // -- itemText overrides to input box size // -- linkIdText is required // AddBlockItem("search", "SEARCHBUTTON", pageUrlPath, "Quick Search Now!", "", "quickSearch"); // -- itemText overrides to the URL_PATH of this page (from the pageUrlPath global) // -- toolTipText overrides to the text on the button // -- styled buttons have an override css class // --- ADD/REMOVE LINES IN THIS SECTION TO MODIFY THE TOP NAVIGATION BAR --- // -- note: the order of the links is important AddNavigationLink_Top("Home", "HOMEPAGE"); //AddNavigationLink_Top("Back", "BACK"); //AddNavigationLink_Top("Contents", "INDEXPAGES"); //AddNavigationLink_Top("FAQ", "FAQ"); //AddNavigationLink_Top("Resources", "KNOWLEDGEINDEX"); AddNavigationLink_Top("Feedback", "FEEDBACK"); //AddNavigationLink_Top("Help", "HELP"); // ------------------------------------------------------------------------- // --- ADD/REMOVE LINES IN THIS SECTION TO MODIFY THE "Control this page..." NAVIGATION BLOCK (NORMAL PAGES) --- // -- note: the order of the links is important AddNavigationLink_Control("Printer Friendly Page", "PRINTABLEPAGE", "Create a printable version of the content currently displayed."); //AddNavigationLink_Control("Show All Sections", "SHOWALL", "Open all the sections available on this page."); //AddNavigationLink_Control("Hide Non-Sticky Sections", "HIDEALL_NOTSTICKY", "Hide all the sections on this page, unless they are sticky - i.e. forced to be open."); //AddNavigationLink_Control("Hide All Sections", "HIDEALL", "Hide all the sections on this page (regardless of whether they are 'sticky' or not)."); //AddNavigationLink_Control("Toggle Navigation Auto-Hide", "TOGGLEAUTOHIDE", "Temporarily toggle the auto-hide of the navigation on this page.", "autoHideText"); //AddNavigationLink_Control("Clear Page Memory", "CLEARSTATECOOKIES", "Clear the memory of open page sections and categories for all pages."); // ------------------------------------------------------------------------- // --- ADD/REMOVE LINES IN THIS SECTION TO MODIFY THE "Control this page..." NAVIGATION BLOCK (INDEX & HIERARCHY PAGES)--- // -- note: the order of the links is important AddNavigationLink_ControlIndex("Printer Friendly Page", "PRINTABLEPAGE", "Create a printable version of the content currently displayed."); //AddNavigationLink_ControlIndex("Show All Sections", "SHOWALL", "Show all the sections on this page."); //AddNavigationLink_ControlIndex("Hide All Sections", "HIDEALL", "Hide all the sections on this page."); //AddNavigationLink_ControlIndex("Toggle Navigation Auto-Hide", "TOGGLEAUTOHIDE", "Temporarily toggle the auto-hide of the navigation on this page.", "autoHideText"); //AddNavigationLink_ControlIndex("Clear Page Memory", "CLEARSTATECOOKIES", "Clear the memory of open page sections and categories for all pages."); // ------------------------------------------------------------------------- // --- ADD/REMOVE LINES IN THIS SECTION TO MODIFY THE "Search" NAVIGATION BLOCK --- // -- note: the order of the links is important //AddBlockItem_Search("SEARCHINPUT", "28", "", "txtSimpleSearchTerms", ""); //AddBlockItem_Search("SEARCHBUTTON", pageUrlPath, "Quick Search Now!", "", "quickSearch"); //AddNavigationLink_Search("Full Search", "Indexes/Search/websearch" + outputExtension); // ------------------------------------------------------------------------- //AddNavigationLink_User("Show Cookie Contents", "javascript:ShowCookieContents()", "Displays a dialogue with the contents of this Knowledge Map's cookie details.", "", true);