| Function |
Description |
Order of Initialisation |
| this%SiteName |
The Site Name |
arg, scheme, "Portal" |
| this%SiteURL |
The Site URL |
arg, scheme, {sys%url:server} |
| this%MenuName |
The Menu Name used as the global Menu Object and as the menu file name |
arg, scheme, "Menu" |
| this%MenuType |
The type of menu data: VB (default), DB (Database) and CSV (Comma-Separated-Values) |
arg, scheme, "VB" |
| this%MenuModel |
The Menu Model: "Page" (entries click into another page) or "Action" (entries click into an action) |
arg, scheme, "Page" |
| this%PageHeadingName |
The variable name of the page heading. A non-blank {text%{this%PageHeading}} is used to determine the existance of a page.)
|
arg, scheme, "PageHeading" |
| this%PageTarget |
The name of the target frame where the page is loaded |
arg, scheme, "_top" |
| this%PageTargetObject |
The name of the target object for the client script (e.g. JavaScript) |
"window" if {this%PageTarget} is "_top"; document.frames.parent.{this%PageTarget} otherwise. |
| this%SessionTimeout |
The Session Timeout (logged-in session will expire after such period) |
arg, scheme, blank (no SessionTimeout) |
| this%IdleTimeout |
The Idle Timeout (logged-in session will expire if no access in such period) |
arg, scheme, blank (no IdleTimeout) |
| this%EasyNew |
Whether or not to include a link in the page bar for creating a new page without going through the Organizer. (If set to true, you need to provide a newpage.htm, which contains only one line: [beeinclude "portal/newpage.bs"] |
arg, scheme, 0 (no "new" link on the page bar) |
| this%Cache |
The name of the scheme file that stores cached information. |
arg, scheme, "cache" |
| this%BuildListMenu |
Whether or not to build the list menu |
arg, scheme, 0 |
| this%BuildPathMenu |
Whether or not to build the path menu |
arg, scheme, 0 |
| this%BuildPageBar |
Whether or not to build the pagebar |
arg, scheme, 0
(PageBar requires ListMenu for chapter navigation. If BuildListMenu is false, the chapter navigation arrows will not be shown.) |
| this%ListMenuFormat |
Format array for the list menu |
arg, scheme |
| this%PathMenuFormat |
Format array for the path menu |
arg, scheme |
| this%Subpath |
The Subpath (see Terminology) |
arg, scheme, blank (no Subpath so all PP and SP variables are the same) |
| this%PP |
The Path Page (see Terminology) |
arg, {sys%urlredirect:pathpage}, {sys%urlpart:pathpage}, "/index.htm" if blank or "/" |
| this%PPOriginal |
Same as this%PP, except that it will not change after the object is created (while this%PP can be altered by this%pathPage) |
{this%PP} |
| this%EntryPP |
The Entry of the Path Page (see Terminology) |
(derived from {this%PP}) |
| this%FamilyPP |
The Family of the Path Page (see Terminology) |
(derived from {this%PP}) |
| this%PageNumber |
The Page Number - the "n" part of the URL or "1" if "_n" is absent. |
(derived from {this%PP}) |
| this%PageExt |
The Page Extension (including the dot, e.g. ".htm") |
(derived from {this%PP}) |
| this%SP |
The Subpage (see Terminology) |
(derived from {this%PP}) |
| this%EntrySP |
The Entry of the Subpage (see Terminology) |
(derived from {this%PP}) |
| this%FamilySP |
The Family of the Subpage (see Terminology) |
(derived from {this%PP}) |
| this%Topic |
The "Topic" of the current page which uniquely identify its Menu entry |
arg, {sys%form:Topic} |
| this%PageInfo |
The Array containing the Menu entry of the current page |
(loaded from the Menu identified by {this%TopicAddress} or {this%EntrySP} if {this%TopicAddress} is blank. |
| this%PrevMenu |
The PageInfo of the menu entry immediately before the current one |
Initialised in function this%listMenu |
| this%NextMenu |
The PageInfo of the menu entry immediately after the current one |
Initialised in function this%listMenu |
| this%DirectoryIndex |
The file name assumed if the page name is not specified. |
arg, scheme, "index.htm" |
| this%MenuSelectOptionTags |
A series of <option ...> tags in for all menu entries, with proper indentation. If the {arg%selected} is specified, the <option ...> tag containing the value {arg%selected} will be marked "selected". |
Initialised in function this%menuSelectOptionTags |
| this%ListMenu |
A ready-made HTML string presenting menu entries vertically |
Initialised in function this%listMenu |
| this%PathMenu |
A ready-made HTML string presenting the menu path to the current entry horizontally |
Initialised in function this%pathMenu |
| this%PageBar |
A ready-made HTML string presenting a page bar containing all pages of the topic ({this%PageNumber} of them) with navigation arrows |
Initialised in function this%pageBar |
| this%AuthStatus |
The result of the authentication process. "0" means successful. |
Set by function this%auth |
| this%AuthMessage |
The message from the authentication process. Blank means successful. |
Set by function this%auth |
|
|
|