#====================================== # Breadcrumb script configuration file #====================================== # # Description # ----------- # This file allows you to specify certain rules which the breadcrumb # script will use instead of the server defaults. These rules will allow # you to create specific directory mappings. # # Usage # ----- # Place a copy of this file with your specific rules in the TOP LEVEL # DIRECTORY of your Web domain or sub-domain. If you have called the # breadcrumb script from your (X)HTML pages [include reference to # doc here] the rules in this file will apply to the directory it # resides in as well as subsequent sub-directories. # # Format of rules # --------------- # The general format of rules look like: # RULETYPE=rule declaration # # Only one rule is allowed on a line at a time. # Spaces are allowed, but ensure that there is only ONE equals sign '=' # in any one line. # Depending on rule type, rule declarations can consist of more than one # items separated by a semi-colon (;). Blank lines and lines which contain # whitespace only will be ignored. # # Rule types # ---------- # Supported rule types are: MAPDIR, MAPPATH, ALIASDIR, ALIASNAME, # SITEROOT, SUPPRESS_FILESYSTEM_ROOT # # See specific examples found in the MAPPINGS section of this file. # # Including comments # ------------------ # A 'hash' (#) at the beginning of a line denotes a comment and the # content of the line after the hash will be ignored by the breadcrumb # script. # # # ========== # MAPPINGS # ========== # This section contains example mappings. Copy them and change them to # match your needs. # # Rules which you want to apply must NOT have the hash (#) in the # beginning. # # 1) Site roots # # These items will consistently appear before all other breadcrumb items # in order they are specified. # # If SUPPRESS_FILESYSTEM_ROOT is set to 'yes', the hierarchy leading up # to your site will not be shown in the breadcrumb trail, and only what # is specified by the SITEROOT declarations will be used. # # If SUPPRESS_FILESYSTEM_ROOT is set to 'no', and SITEROOTs are # specified, then items declared in SITEROOTS will appear before other # filesystem directories in the breadcrumb trail. # # Format: # SITEROOT=Link text; Link URI # SUPPRESS_FILESYSTEM_ROOT=[yes|no] #SITEROOT=Monash University; http://www.monash.edu.au/ #SITEROOT=Faculty of Science; http://www.science.monash.edu.au/ SITEROOT=Faculty of Engineering; http://www.eng.monash.edu.au/ # #SITEROOT=Monash; http://www.monash.edu.au/ #SITEROOT=Catalogue; http://library.monash.edu.au/ #SITEROOT=Library home; http://www.lib.monash.edu.au/ # #SUPPRESS_FILESYSTEM_ROOT=yes # 2) Directory mappings # # These directories specified in this section will be remapped # # Format: # MAPDIR=directory # MAPPATH=link name; link URI # # MAPDIR refers to the directory path that is being mapped to something # else. # MAPPATH contains two items: the text that will be shown as a link and # the URI of the link, separated by a semicolon. The URI can be a # relative link (relative to the placement of this file), or can be a full URI. # # In the following example, whenever /databases/ is accessed, the # breadcrumb script will output: # Resources > Databases # #MAPDIR=matheson #MAPPATH=Branches; /libraries/ #MAPPATH=Matheson Library; /matheson/ # 3) Aliases # Format: # ALIASDIR=directory # ALIASNAME=Alias name # # ALIASDIR refers to the directory path you would like to create an alias # for. # ALIASNAME contains the alias text. # end of breadcrumb config file