plainblack.com
Username Password
search
Bookmark and Share
Subscribe

Login Box Macro

^L; or ^L(); - Login Box
A small login form. This macro takes up to three parameters. The first is used to set the width of text boxes for entering the username and password: ^L(20);. This width is scaled by 2/3 if the user's browser isn't IE due to differences in the way that different browsers draw the text boxes. The second sets the message displayed after the user is logged in: ^L(20,"Hi ^a(^@;);. Click %here% if you have to scoot!");. Text between percent signs (%) is replaced by a link to the logout operation. The third parameter is the ID of a template in the Macro/L_loginBox namespace to replace the default template. The variables below are available for use in the template.

NOTES:

  • The .loginBox style sheet class is tied to this macro.
  • This Macro may not be nested inside other Macros.

user.isVisitor

True if the user is a visitor.

customText

The text supplied to the macro to display if the user is logged in. In general, this is used instead of the logout.label and logout.url variables.

hello.label

Internationalized welcome message.

customText

The text supplied to the macro to display if the user is logged in. In general, this is used instead of the logout.label and logout.url variables.

account.display.url

URL to display the account.

logout.label

Internationalized logout message.

form.header

Form header.

username.label

Internationalized label for "username".

username.form

Form element for the username.

password.label

Internationalized label for "password".

password.form

Form element for the password.

form.login

Action to perform when logging in.

account.create.url

URL to create an account.

account.create.label

Internationalized label for "create an account".

form.footer

Form footer.

webgui.version

The version of WebGUI on your site.

webgui.status

The release status for this version of WebGUI (stable, beta, gamma, etc.)

session.user.username

The current user's username.

session.user.firstDayOfWeek

From the current user's profile, the day they selected to be the first day of the week.

session.config.extrasurl

From the WebGUI config, the URL for the extras directory. session.var.adminOn This variable will be true if the user is in Admin mode.

session.setting.companyName

From the WebGUI settings, the company name.

session.setting.anonymousRegistration

From the WebGUI settings, whether or not anonymous registration has been enabled.

session form variables Session Form Variables

Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned.

session scratch variables Session Scratch Variables

Any scratch variables will be available in the template with this syntax:

<tmpl_var session.scratch.variable>

Keywords: login macro

Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved