[1328] Latest edit on
2008-11-01 23:23:06 by
BrianKoontz [Removed HomePage link]
Deletions:
HomePage
[1100] Edited on
2008-05-17 22:37:56 by
BrianKoontz [Added new section for creating modules]
Additions:
Creating UR Modules
A tutorial for creating UR modules, based upon the URInviteCodeModule, can be found here. Additional code examples can be found here.
Additions:
'UR_validation_modules' => 'URDummyModule, URInviteCodeModule',
Deletions:
'UR_validation_modules' => 'URDummyModule, URInviteCode',
[657] Edited on
2008-02-13 07:15:26 by
BrianKoontz [Removed generic category]
Deletions:
CategoryDocumentation
Additions:
The current UR framework is a work in progress. While operational, several features remain to be implemented. Suggestions for improvement are always welcome.
Deletions:
The current UR framework is a work in progress. While operations, several features remain to be implemented. Suggestions for improvement are always welcome.
Additions:
CategoryEN
Additions:
Installing UR Modules
The release version of 1.1.6.4 includes two default UR modules:
URDummyModule Always validates as true. This module is useful for testing or as a template for developing customized UR modules.
URInviteCodeModule Requires new registrants to provide an invitation code (password) for successful registration.
Currently, modules (other than those listed above) must be installed manually by copying the modules to <wikka-dir>/libs/UR/<URModuleName>. It is important that this directory naming convention be observed, as the main UR classes depend upon UR modules residing here.
Enabling UR Modules
Manual installation of a UR module does not "enable" the module. This must be done by setting the appropriate configuration parameters in wikka.config.php.
The first step is to add the UR module name to the UR_validation_modules configuration parameter. If this parameter does not yet exist in wikka.config.php, simply create it and add the module name. If the parameter already exists, and you want the new module to co-exist with previous modules, add the module name to the parameter argument using a comma as the separator.
Examples:
'UR_validation_modules' => 'URDummyModule',
'UR_validation_modules' => 'URDummyModule, URInviteCode',
The following table summarizes the module-specific configuration parameters required for each UR module:
| UR Module Name | Configuration Parameter | Options | Description |
| URDummyModule | UR_validation_modules | URDummyModule | Enables the URDummy module |
| URInviteCodeModule | UR_validation_modules | URInviteCodeModule | Enables the URInviteCode module |
| UR_InviteCode_password | <string> | A string that sets an invitation code that will be required from a registrant before a registration is successfully processed |
Future Enhancements
The current UR framework is a work in progress. While operations, several features remain to be implemented. Suggestions for improvement are always welcome.
Additions:
NOTE
This feature is available since:
WikkaWiki 1.1.6.4
Additions:
User Registration (UR) Validation Framework
Introduction
Version 1.1.6.4 introduces a new lightweight framework for implementing user registration (UR) validation schemes. By default, this framework does not introduce any new UR functionality in an upgraded installation. In order to enable a validation scheme, the following steps must be taken:
- The desired UR module must be installed.
- The UR module must be enabled by setting one or more module configuration settings in wikka.config.php.
CategoryDocumentation
Deletions:
Title of the page
This page is a generic template intended for documentation of official Wikka features. This page belongs to CategoryTemplate (which contains more handy templates). To create a Wikka documentation page, clone this page (most documentation page names end in 'Info' so it's useful to stick to that convention), replace the title with a meaningful one and replace this paragraph with the actual page content.
Remember to change the category link at the bottom of this page to CategoryDocumentation when the new page is ready to be published.
If you are documenting a specific component (an action, a handler etc.), please choose the appropriate template from CategoryTemplate
CategoryTemplate
[642] The oldest known version of this page was created on
2008-02-09 22:03:52 by
BrianKoontz [Cloned from DocumentationTemplate]
HomePage
Title of the page
This page is a generic
template intended for documentation of
official Wikka features. This page belongs to
CategoryTemplate (which contains more handy templates). To create a Wikka
documentation page,
clone this page (most documentation page names end in 'Info' so it's useful to stick to that convention), replace the title with a meaningful one and replace this paragraph with the actual page content.
Remember to change the category link at the bottom of this page to
CategoryDocumentation when the new page is ready to be published.
If you are documenting a specific component (an action, a handler etc.), please choose the appropriate template from
CategoryTemplate
CategoryTemplate