User Registration components

Major page components.

Section: title - Page Title

%STARTSECTION{"title"}%---+ %MAKETEXT{"Registration"}%
%ENDSECTION{"title"}%

Section: notes - User feedback

These sections provide feedback whether registration is enabled and required browser settings are met. (javascript and cookies must be on)

%STARTSECTION{"notes"}%
%IF{"not context registration_supported"
  then=" *%MAKETEXT{"Self registration is not supported by this site."}%* "
  else="
    %IF{"NOT context registration_enabled"
      then="%INCLUDE{"%REGPARTS%" section="note:registrationNotEnabled"}%"
      else="%IF{
   "$REGISTRATION_DISABLED='DISABLED'"
   then="%INCLUDE{"%REGPARTS%" section="note:registrationTemporarilyDisabled"}%"
   else="%INCLUDE{"%REGPARTS%" section="note:registrationOk"}%%INCLUDE{"%REGPARTS%" section="note:requiredBrowserSettings"}%"
      }%"
    }%"
}%%ENDSECTION{"notes"}%

%STARTSECTION{"note:registrationNotEnabled"}%%IF{
   "$USERNAME ingroup 'AdminGroup'"
   then="<strong>%MAKETEXT{"Registration is disabled either by configuration setting {EnableNewUserRegistration}, or due to errors with the password system. Check the configuration for errors."}%</strong>

          %MAKETEXT{"If registration is not disabled by errors, administrators can still register users to this site using [_1]." args="[[%SYSTEMWEB%.BulkRegistration][BulkRegistration]]"}%"
   else="<strong>%MAKETEXT{"New user registration is disabled on this site."}%</strong>"
}%
%ENDSECTION{"note:registrationNotEnabled"}%

%STARTSECTION{"note:registrationTemporarilyDisabled"}%<strong>%MAKETEXT{"Sorry, registration has been temporarily disabled."}%</strong>%ENDSECTION{"note:registrationTemporarilyDisabled"}%

%STARTSECTION{"note:registrationOk"}%<strong>%MAKETEXT{"Create your account to edit pages on this site."}%</strong>%ENDSECTION{"note:registrationOk"}%

%STARTSECTION{"note:requiredBrowserSettings"}%<div class='registerMakeHidden foswikiNotification foswikiAlert'>%MAKETEXT{"We noticed you have disabled !JavaScript. Please switch on !JavaScript if you wish to register."}%</div><div class='foswikiNotification foswikiAlert registerMakeVisible showIfNoCookies'>%MAKETEXT{"We noticed you have disabled cookies. Please enable cookies if you wish to register."}%</div>%ENDSECTION{"note:requiredBrowserSettings"}%

Section: help - Help text at bottom of page

%STARTSECTION{"help"}%<p>
%MAKETEXT{"If you have any questions about registration, send an e-mail to [_1]." args="<a href='mailto:%WIKIWEBMASTER%?subject=%BASETOPIC%&#32;Question'>%WIKIWEBMASTER%</a>"}%</p>%ENDSECTION{"help"}%

Section: privacyInformation (optional)

%STARTSECTION{"privacyInformation"}%<p> %MAKETEXT{"*Important:* the information provided in this form will be stored in a database on the web server. This database is accessible to anyone who can access the server through the web (though passwords will be encrypted, and e-mail addresses will be obfuscated to help prevent spamming). Your country, or the country where the server is hosted, may have Data Protection laws governing the maintenance of such databases. If you are in doubt, you should contact [_1] for details of the Data Protection Policy of this web server before registering." args="[[mailto:%WIKIWEBMASTER%?subject=Data%20Protection%20Policy][%WIKIWEBMASTER%]]"}%</p>%ENDSECTION{"privacyInformation"}%

Section: form - The registration form

Conditionally include the registration form when registration is enabled

%STARTSECTION{"form"}%
%IF{"$REGISTRATION_DISABLED!='DISABLED'" then="$percentINCLUDE{\"%REGPARTS%\" section=\"liveform\"}$percent"}%
%ENDSECTION{"form"}%

The actual registration form.

%STARTSECTION{"liveform"}%
<div class="registerMakeVisible hideIfNoCookies registration"><form name="registration" action="%SCRIPTURLPATH{"register"}%/%USERSWEB%/%HOMETOPIC%" method="post">
   <div class="foswikiFormSteps">
      <div class="foswikiFormStep">
         <p class="required"><em>%MAKETEXT{"Fields marked <span class='required'>*</span> are required."}%</em></p>
         <ul>%INCLUDE{"%REGPARTS%" section="requiredFields"}%%INCLUDE{"%REGPARTS%" section="optionalFields"}%%INCLUDE{"%REGPARTS%" section="requiredButton_submit"}%</ul>
         <div class='foswikiClear'></div>
      </div>
   </div>
%IF{"context BlackListPluginEnabled" then='<input type="hidden" name="rx" value="$percentBLACKLISTPLUGIN{action=$quotmagic$quot}$percent" />' else='<!-- -->'}%
<input type="hidden" name="topic" value="%BASETOPIC%" />
<input type="hidden" name="action" value="register" />
<input type="hidden" name="templatetopic" value="%NEWUSERTEMPLATE{default="NewUserTemplate"}%" />
</form>
</div>%ENDSECTION{"liveform"}%

Section: resources - Extra CSS and Javascript resources for this page.

%STARTSECTION{"resources"}%%IF{"$REGISTRATION_DISABLED!='DISABLED'" then="
%ADDTOZONE{ "head"
  id="UserRegistrationRequiredStyle"
  text="<link type='text/css' rel='stylesheet' media='all' href='%PUBURLPATH{"requiredstyle.css" topic="%CSSJSTOPIC%"}%' />"
}%"}%
%ADDTOZONE{ "head"
  id="UserRegistrationFormStyle"
  text="<link type='text/css' rel='stylesheet' media='all' href='%PUBURLPATH{"formstyle.css" topic="%CSSJSTOPIC%"}%' />"
}%
%JQREQUIRE{"validate, wikiword, cookie"}%
<literal>
<div id="FwkVD" class="foswikiHidden">
{
  "url":"%SCRIPTURL{view}%/%SYSTEMWEB%.UserRegistrationParts",
  "MinPasswordLength":%QUERY{"{MinPasswordLength}"}%,
  "messages": {
    "Fwk1FirstName":"%MAKETEXT{"Please enter your first name."}%",
    "Fwk1LastName":"%MAKETEXT{"Please enter your last name."}%",
    "Fwk1WikiName": {
      "required": "%MAKETEXT{"Please enter a WikiName."}%",
      "wikiword": "%MAKETEXT{"This is not a valid WikiName."}%",
      "remote": "%MAKETEXT{"This WikiName is already in use."}%"
    },
    "Fwk1Email": "%MAKETEXT{"Please enter a valid email address."}%",
    "Fwk1LoginName": {
      "required": "%MAKETEXT{"Please enter a login username."}%",
      "remote": "%MAKETEXT{"This username is already in use."}%"
    },
    "Fwk1Password": {
      "required": "%MAKETEXT{"Please enter a password."}%",
      "minlength": "%MAKETEXT{"Your password must be at least [_1] characters long." args="%QUERY{"{MinPasswordLength}"}%"}%"
    },
    "Fwk1Confirm": {
      "required": "%MAKETEXT{"Please confirm your password."}%",
      "equalTo": "%MAKETEXT{"Please enter the same password as above."}%",
      "minlength": "%MAKETEXT{"Your password must be at least [_1] characters long." args="%QUERY{"{MinPasswordLength}"}%"}%"
    }
  }
}
</div>
</literal>
%ADDTOZONE{ "script"
  id="UserRegistrationValidation"
  requires="JQUERYPLUGIN::VALIDATE, JQUERYPLUGIN::WIKIWORD, JQUERYPLUGIN::COOKIE"
  text="<script type='text/javascript' src='%PUBURLPATH{"validate.js" topic="%CSSJSTOPIC%"}%'></script>"
}%
%ENDSECTION{"resources"}%

Individual Field Definitions

Required field: FirstName

<label class="desc" for="Fwk1FirstName"><span class="required">*</span>%MAKETEXT{"First name:"}%</label>
<div><input type="text" id="Fwk1FirstName" name="Fwk1FirstName" size="40" class="foswikiInputField foswikiFocus" value="" tabindex="1" /></div></li>%ENDSECTION{"requiredField_firstName"}%

Required field: LastName

%STARTSECTION{"requiredField_lastName"}%<li><label class="desc" for="Fwk1LastName"><span class="required">*</span>%MAKETEXT{"Last name:"}%</label>
<div><input type="text" id="Fwk1LastName" name="Fwk1LastName" size="40" class="foswikiInputField" value="" tabindex="2" /></div></li>%ENDSECTION{"requiredField_lastName"}%

Required field: WikiName

%STARTSECTION{"requiredField_wikiName"}%<li><label class="desc" for="Fwk1WikiName"><span class="required">*</span>%MAKETEXT{"<nop>WikiName:"}%</label>
<div><input type="text" id="Fwk1WikiName" name="Fwk1WikiName" size="40" class="foswikiInputField" value="" tabindex="3" /><label class="expl">%MAKETEXT{"Your name as displayed by [_1]." args="%WIKITOOLNAME%"}% %POPUPWINDOW{"%SYSTEMWEB%.WikiName" label="%MAKETEXT{"This must be a unique WikiName."}%"}%</label></div></li>%JQREQUIRE{"popupwindow"}%%ENDSECTION{"requiredField_wikiName"}%

Required field: LoginName

Only shown if ALLOWLOGINNAME is true.

%STARTSECTION{"requiredField_loginName"}%<li><label class="desc" for="Fwk1LoginName"><span class="required">*</span>%MAKETEXT{"Login username:"}%</label>
<div><input type="text" id="Fwk1LoginName" name="Fwk1LoginName" size="40" class="foswikiInputField" value="%REMOTE_USER%" tabindex="4" /><label class="expl">%MAKETEXT{"The username that identifies you to the signon system. [_1]" args="%POPUPWINDOW{"%SYSTEMWEB%.UserName" label="%MAKETEXT{"This must be a valid login username."}%"}%"}%</label></div></li>%JQREQUIRE{"popupwindow"}%%ENDSECTION{"requiredField_loginName"}%

Required field: Email

%STARTSECTION{"requiredField_email"}%<li><label class="desc" for="Fwk1Email"><span class="required">*</span>%MAKETEXT{"Email address:"}%</label>
<div><input type="text" id="Fwk1Email" name="Fwk1Email" size="40" class="foswikiInputField" value="" tabindex="5" /><label class="expl">%MAKETEXT{"Your email address will be kept confidential."}%</label></div></li>%ENDSECTION{"requiredField_email"}%

Required field: Password

Only shown if the password manager supports changing the password / email. Displays one password field and (if {Register}{DisablePasswordConfirmation} is not unset) one confirmation password field.

%STARTSECTION{"requiredField_password"}%<li><label class="desc" for="Fwk1Password"><span class="required">*</span>%MAKETEXT{"Your password:"}%</label>
<div><input type="password" id="Fwk1Password" name="Fwk1Password" size="40" class="foswikiInputField" value="" tabindex="6" /></div></li>%IF{"NOT {Register}{DisablePasswordConfirmation}" then="<li><label class=\"desc\" for=\"Fwk1Confirm\"><span class=\"required\">*</span>$percntMAKETEXT{\"Confirm password:\"}$percnt</label>
<div><input type=\"password\" id=\"Fwk1Confirm\" name=\"Fwk1Confirm\" size=\"40\" class=\"foswikiInputField\" value=\"\" tabindex=\"7\" /></div></li>"}%%ENDSECTION{"requiredField_password"}%

Optional field: OrganisationName

%STARTSECTION{"extraField_organisationName"}%<li><label class="desc" for="Fwk0OrganisationName">%MAKETEXT{"Organisation name:"}%</label>
<div><input type="text" id="Fwk0OrganisationName" name="Fwk0OrganisationName" size="40" class="foswikiInputField" value="" tabindex="8" /></div></li>%ENDSECTION{"extraField_organisationName"}%

Optional field: organisationURL

%STARTSECTION{"extraField_organisationUrl"}%<li><label class="desc" for="Fwk0OrganisationURL">%MAKETEXT{"Organisation website:"}%</label>
<div><input type="text" id="Fwk0OrganisationURL" name="Fwk0OrganisationURL" size="40" class="foswikiInputField" value="http://" tabindex="9" /></div></li>%ENDSECTION{"extraField_organisationUrl"}%

Optional field: Country

%STARTSECTION{"extraField_country"}%<li><label class="desc" for="Fwk0Country">%MAKETEXT{"Country:"}%</label>
<div><select class="foswikiSelect" id="Fwk0Country" name="Fwk0Country" size="1" tabindex="10">%SEARCH{
"^\|[^\*\|]*\|"
topic="CountryList"
web="%SYSTEMWEB%"
type="regex"
multiple="on"
nosearch="on"
nototal="on"
format="<option>$pattern(^\| *(.*?) *\|.*)</option>"
}%</select></div></li>%ENDSECTION{"extraField_country"}%

Optional field: groups

Defines the components needed for manual and automatic group memberships. Two steps needed to enable this feature:

1. Enable the setting REGISTRATIONGROUPTYPE in the Main.SitePreferences topic to automatic, one, multiple,
2. List extraField_groups in the %FIELDS% setting in the registration topic.

%STARTSECTION{"extraField_groups"}%%INCLUDE{"%REGPARTS%" section="groups"}%%ENDSECTION{"extraField_groups"}%

Group Section groups

%STARTSECTION{"groups"}%%IF{"$USERNAME ingroup 'AdminGroup' and '%REGISTRATIONGROUPTYPE%' = 'automatic' and not defined 'REGISTRATIONGROUPS'" then="<blockquote><span class=\"foswikiAlert\"> *Caution!* Registering a user while logged in as an Administrator will add them to ALL GROUPS in the system.</span> REGISTRATIONGROUPTYPE is set to =automatic=, and no groups are set in REGISTRATIONGROUPS. </blockquote>"}%
%IF{"($WIKINAME!='WikiGuest') and  (not ($USERNAME ingroup 'AdminGroup')) and ('%REGISTRATIONGROUPTYPE%' = 'automatic') and (not defined 'REGISTRATIONGROUPS')" then="<blockquote><span class=\"foswikiAlert\"> *Caution!* Registering a user while logged in will add the new user to all groups you have permission to change.</span> REGISTRATIONGROUPTYPE is set to =automatic=, and no groups are set in REGISTRATIONGROUPS. </blockquote>"}%
%FORMAT{
   "%IF{"defined 'REGISTRATIONGROUPS'" then="%REGISTRATIONGROUPS%" else="%GROUPINFO{
         show="allowchange%IF{"$ WIKINAME='WikiGuest'" then="(RegistrationAgent)"}%"
         format="$name"
         separator=","
      }%"}%"
   header="$percentINCLUDE{$quot%WEB%.%REGPARTS%$quot section=$quot%IF{
                  "'%REGISTRATIONGROUPTYPE%' = 'automatic' and $ WIKINAME='WikiGuest'"
                  then="hidden"
               }%rendergroupheader$quot}$percent"
   footer="$percentINCLUDE{$quot%WEB%.%REGPARTS%$quot section=$quotrendergroupfooter$quot}$percent"
   zeroresults="no groups<!-- no groups available -->"
   format="$percentINCLUDE{$quot%WEB%.%REGPARTS%$quot
      section=$quotrendergroup$quot
      groupname=$quot$topic$quot
        inputtype=$quot%IF{"'%REGISTRATIONGROUPTYPE%' = 'automatic' and $ WIKINAME!='WikiGuest'" then="checkbox"}%%IF{"'%REGISTRATIONGROUPTYPE%' = 'automatic' and $ WIKINAME='WikiGuest'" then="hidden"}%%IF{"'%REGISTRATIONGROUPTYPE%' = 'one'" then="radio"}%%IF{"'%REGISTRATIONGROUPTYPE%' = 'multiple'" then="checkbox"}%$quot
        inputother=$quot%IF{"'%REGISTRATIONGROUPTYPE%' = 'automatic'" then="checked readonly"}%$quot
       }$percent"
      separator=" "
}%%ENDSECTION{"groups"}%

Group Section nochange

%STARTSECTION{"nochange"}%<!-- nochange// --> %ENDSECTION{"nochange"}%

Group Section rendergroup

parameters: groupname, inputtype

%STARTSECTION{"rendergroup"}%<input type="%inputtype%" %inputother% name="Fwk0AddToGroups" id="cb_%groupname%" value="%groupname%" />
   <label class="desc" for="cb_%groupname%">%IF{"istopic '%USERSWEB%.%groupname%'" then=" [[%USERSWEB%.%groupname%][%groupname%]] " else="%groupname%" }%</label>%ENDSECTION{"rendergroup"}%

Group Section rendergroupheader

%STARTSECTION{"rendergroupheader"}%<li><label class="desc" for="Fwk0AddToGroups">%IF{"'%REGISTRATIONGROUPTYPE%' = 'multiple'" then='%MAKETEXT{"Select groups to join:"}%' else='%MAKETEXT{"Select the group to join:"}%'}%</label>
<div class="joinGroups">%ENDSECTION{"rendergroupheader"}%

Group section: rendergroupfooter

%STARTSECTION{"rendergroupfooter"}%</div></li>%ENDSECTION{"rendergroupfooter"}%

Group Section: hiddenrendergroupheader

%STARTSECTION{"hiddenrendergroupheader"}%<li class="tml">
<div class="joinGroups">%ENDSECTION{"hiddenrendergroupheader"}%

Required: Submit Button

%STARTSECTION{"requiredButton_submit"}%<li><label class="desc">&nbsp;</label><div><input type="submit" tabindex="99" class="foswikiSubmit" value="%MAKETEXT{"Register"}%" /><span class="expl tml">%MAKETEXT{"Please correct the entered data before you continue."}%</span></div></li>%ENDSECTION{"requiredButton_submit"}%

Utility sections

These sections are used to include sections from a list of sections. They are referenced in the section named liveform

Optional field includes

Includes all optional sections named in the =%FIELDS% setting.

%STARTSECTION{"optionalFields"}%%FORMAT{
   "%FIELDS{default=""}%"
   separator="$n"
   type="string"
   format="$percntINCLUDE{$quot%REGPARTS%$quot section=$quot$item$quot}$percnt"
}%%ENDSECTION{"optionalFields"}%

Required fields for all registrations

Includes all of the required fields.

%STARTSECTION{"requiredFields"}%%FORMAT{
   "requiredField_firstName, requiredField_lastName, requiredField_wikiName%IF{"$ALLOWLOGINNAME" then=", requiredField_loginName"}%, requiredField_email%IF{"context passwords_modifyable" then=", requiredField_password"}%"
   separator="$n"
   type="string"
   format="$percntINCLUDE{$quot%REGPARTS%$quot section=$quot$item$quot}$percnt"
}%%ENDSECTION{"requiredFields"}%

Test if user topic exists. Used for form validation.

%STARTSECTION{"checkWikiName"}%%IF{"istopic '%USERSWEB%.%URLPARAM{"name"}%'"
  then="false"
  else="true"
}%%ENDSECTION{"checkWikiName"}%

Test if user login name exists. Used for form validation.

%STARTSECTION{"checkLoginName"}%%IF{
  "'%USERINFO{"%URLPARAM{"name"}%" format="$username"}%'!=''"
  then="false"
  else="true"
}%%ENDSECTION{"checkLoginName"}%