|
|
Documentation >> Macros >> signupForm
Macro: signupForm
Usage:
<!--#signupForm-->
Overview:
Displays a form for signing up as a member of a conversation which uses cookie-based authentication ( the default ).
By default, signup to a conversation is handled at the the url "http://[yoursite]/signup", however, using this macro, you can place a customized signup form anywhere in your site. By default, the macro uses the "signupForm 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 signup form on the actual /signup page of your site by adding a template attribute to the #signupForm macro in Signup Text preferences at Preferences->Web Server->Signup in the admin interface.
See also:
Optional Attributes:
- template="templateName" : The name of the template that controls the layout of the form. Default: "signupForm READONLY"
Required template macros:
<!--#signupMemberName--> : Produces the input tag for member name. Supports attributes:
- defaultValue="string" : a default value for the field
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
<!--#signupUsername--> : Produces the input tag for username. Supports attributes:
- defaultValue="string" : a default value for the field
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
<!--#signupPassword--> : Produces the input tag for password. Supports attributes:
- defaultValue="string" : a default value for the field
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
<!--#signupPasswordRepeat--> : Produces the input tag for password confirmation. Supports attributes:
- defaultValue="string" : a default value for the field
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
<!--#signupSubmitButton--> : Produces the form submit button. Supports attributes:
- label="string" : button text, default "Logon".
- CSS attributes : class, id
- Javascript attributes : onclick
Optional template macros:
<!--#signupHomepage--> : Produces the input tag for the URL to the new member's home page. Supports attributes:
- defaultValue="string" : a default value for the field, such as 'http://'
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
<!--#signupOrganization--> : Produces the input tag for the new member's organization/company name. Supports attributes:
- defaultValue="string" : a default value for the field
- size="[number]" : width of the field
- CSS attributes : class, id
- Javascript attributes : onfocus, onblur, onchange
-
<!--#signupMessage--> : Returns an error string for unsuccessful signup. This macro will only produce text when used in a template used on the actual /signup page. It is important to include this macro on templates used on this page, however, or the user will not receive feedback when a logon fails.
Hidden redirect controls:
By default, signup forms post to the /signup page, and will remain there giving the user a confirmation/error message. You may override this behavior and cause the user's browser to be redirected to another page on success or failure of a singup form by including one or both of the following hidden tags:
<input type="hidden" name="redirectOnSignupSuccess" 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 signup.
<input type="hidden" name="redirectOnSignupFailure" 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 failed signup. Note that if you use this, the page you redirect to should probably contain some explaination of what might have gone wrong, or the user could get confused and believe they have successfully signup as a member.
View in DG
|
|