When iManager reads a specific header or footer file, it looks for
a few special tags:
__TITLE__ (parsed for in header only)
__JAVASCRIPT__ (parsed for in header only)
__NAVIGATION_MENU__ (parsed for header and footer)
__ROOT_DIR__ (parsed for in header and footer)
__AUTH_CREDENTIALS__ (parsed for in header and footer)
The __TITLE_ and __JAVASCRIPT__
tags are looked for when a header is parsed. The __TITLE__
tag is the title of the page that iManager is building. If the page
being built has some supplementary JavaScript code, then it is passed
into the label header function to be inserted into the header where
the string "__JAVASCRIPT__ " occurs. Typically,
a header file would include a string in this manner:
<html>
<head>
<title>__TITLE__</title>
__JAVASCRIPT__</head>
For an example of how this works, see the generic_header
file.
Both the label footer and label header functions
parse the __NAVIGATION_MENU__ , but typically you would
include this tag in the footer. iManager will replace this string
with the text navigation menu appropriate for the page being built.
Here is an example:
<hr noshade>
<!-- begin navigation menu -->
__NAVIGATION_MENU__
<!-- end navigation menu -->
<p>
For an example of how this works, see the generic_footer
file.
The __ROOT_DIR__ is used to indicate
to iManager the relative location of the imanager root directory
that should be used. This is necessary to allow for sub hosts to
link to iManager resources using relative URLs rather than absolute
URLs. Here is an example:
<img width="350" height="100" src="__ROOT_DIR__/graphics/entry.gif">
The __AUTH_CREDENTIALS__ is scanned
for and replaced by the session authorization string before the
header and/or footer are displayed. It is necessary to include this
tag in any hypertext references to iManager wizards inside header
and footer files. For example:
<a href="__ROOT_DIR__/wizards/filemanager.cgi?__AUTH_CREDENTIALS__">
File Manager Wizard</a>
For further clarification, refer to the example
files located in the ~imanager/label/default/ directory. These files
illustrate how to use these special tags in a complete context.
|