Macro: logoffForm

Usage:

<!--#logoffForm-->

Overview:

Displays a form for logging off a conversation which uses cookie-based authentication ( the default ).

By default, logging off a conversation is handled at the the url "http://[yoursite]/logoff", however, using this macro, you can place a customized logoff form anywhere in your site. By default, the macro uses the "logoffForm READONLY" template, however you may create your own template based on this template to customize the appearance of the form. Please make sure you include all the required special macros listed below for the form to operate properly.

Note that you may also customize the appearance of the logoff form on the actual /logoff page of your site by adding a template attribute to the #logoffForm macro in Logoff Text preferences at Preferences->Web Server->Logon/Logoff in the admin interface.

See also:

• #logonForm macro
• #signupForm macro

Optional Attributes:

• template="templateName" : The name of the template that controls the layout of the form. Default: "logoffForm READONLY"

Required template macros:

• <!--#logoffSubmitButton--> : Produces the form submit button. Supports attributes:
  • label="string" : button text, default "Logoff".
  • CSS attributes : class, id
  • Javascript attributes : onclick

Hidden redirect controls:

By default, logoff forms post to the /logoff page, where the user is shown a confirmation message. You may override this behavior and cause the user's browser to be redirected to another page after a successful logoff by including the following hidden tag:

• <input type="hidden" name="redirectOnLogoffSuccess" value="[url to go to]" /> ; If this tag is included in the template, the user will be redirected to the url specified in the value attribute on a successful logoff.