This procedure, useful when creating your own Active Server web Pages (ASPs) allows you to use HomeSeer's page header generating function with parameters that allow you to get all or part of the header information.
As this procedure has options for returning the header with the HTML, HEAD, and BODY tags, you should make sure your use of this procedure does not generate duplicates of the above tags in your resulting page.
Parameter: title
Type: string
Description: The title for the web page to be displayed at the top of the
page before the logo bar.
Parameter: extra_meta
Type: string
Description: This parameter allows you to specify additional HTML to be
included in the HEAD section of the page, and it should be formatted as
a complete <meta ...> tag.
Parameter: HSOnload
Type: string
Description: This parameter is used by HomeSeer to specify Body_OnLoad
procedures in the resulting page. They
are prepended to the "Web Site" configuration item of the same
name.
Parameter: ExcludeNavLinks
Type: Boolean
Description: If TRUE is passed to this parameter, the navigation links
will not be included in the output.
Parameter: NoHeader
Type: Boolean
Description: If TRUE is passed to this parameter, the HTML tag and all
contents of the HEAD section will be excluded from the output. The
HEAD section includes the META tags, the page title, and the BODY tag
(and thus Body_OnLoad is excluded).
Optional Parameter: HeadContentOnly
Type: Boolean
Description: If set to TRUE, only the contents of the HEAD html tag will
be returned - use this if you are generating the other page elements yourself.
See the
"NoHeader" parameter for information on what is included in
the HEAD tag section. The
default value if this parameter is not specified is FALSE.
Optional Parameter: BodyContentOnly
Type: Boolean
Description: If set to TRUE, only the contents of the BODY html tag will
be returned - this includes any Body_OnLoad specifications that are passed
with the "HSOnload" parameter or the user's Body_OnLoad configuration
value. This
is useful when generating your own web pages but wish to maintain the
user's Body_OnLoad options which may be used with other plug-ins in the
system. The
BODY tag is included in the output. The
default value if this parameter is not specified is FALSE.
Optional Parameter: BodyOnLoadOnly
Type: Boolean
Description: If set to TRUE, only the contents of the "HSOnload"
parameter and the user's Body_OnLoad configuration value. See
"BodyContentOnly" for a usage scenario. The
BODY html tag is not included in the output. The
default value if this parameter is not specified is FALSE.
A string value containing the HTML content specified through the parameter choices.
A summary of a complete HomeSeer generated page header are as follows:
HTML Tag
HEAD Tag
HomeSeer expiration and cache META tags, and any user specified HTML from the file "Web Site" configuration or META.HTM file.
The TITLE tag and the title of the page.
The BODY tag and any additional Body_OnLoad procedure specifications from the "Web Site" configuration.
The contents of the HEAD.HTM file if it exists.
The HomeSeer logo table area, enclosed in a "logotable" SPAN tag, and including these elements:
The page title portion of the logo table area, enclosed in a "pgtitle" SPAN tag.
The clock portion of the logo table area, enclosed in a "clock" SPAN tag, and an empty "userclock" SPAN tag for use in replacing the HomeSeer clock with a user generated version.
The sunrise portion of the logo table area, enclosed in a "lbsunrise" SPAN tag.
The sunset portion of the logo table area, enclosed in a "lbsunset" SPAN tag.
The logged on user portion of the logo table area enclosed in a "lbuser" SPAN tag.
The navigation links, if specified to be included in the top of the page, enclosed in a "navtop" SPAN tag.