Chapter 15. Site navigation facilities

Table of Contents

Introduction to navigation facilities in Obliquid
Contents of the XML navigation files
How to customize navigation entries
Creating a navigation script

There are two levels of navigation within Obliquid.

One is the typical icon navigation bar across the top. These icons typically represent the main entry points within the various modules in Obliquid. So, there are a "view posts", and an "administer posts" icons. All the icons are defined in an XML file common/navxml/nav.xml. Which icons actually are displayed to the current user depends on their permissions. The function 'getNav' in common/classes/obliquid/nav.php automatically checks permissions, and only returns those icons which the current user is allowed access to.

The second type of navigation is typically a set of text links that is on the left of the screen. These are normally used for navigation within a module, and are displayed by common/pages/mmmm/index.php. The contents of these links are also controlled in XML files in common/navxml/. The files are named mmmm.xml, where mmmm is the module name. Not all modules have an index.php and a corresponding text link navigation because there is typically only one entry point, and all the rest of the navigation is via pick lists from the main screen.