Difference between revisions of "WebConfig - Requirements guideline"

From Catglobe Wiki
Jump to: navigation, search
(WebConfig Requirements)
Line 16: Line 16:
 
'''Description'''
 
'''Description'''
  
| What is that ? What's that used for? (The purpose of the key)
+
| What is that? What's that used for? (The purpose of the key)
 
|-
 
|-
 
|  
 
|  
Line 31: Line 31:
 
'''Default value'''
 
'''Default value'''
  
| The default value for the key
+
| The default value for the key, if it is missing. Obviously it makes no sense to have a default, if it is required.
 
|-
 
|-
 
|  
 
|  
 
'''Recommend value'''
 
'''Recommend value'''
  
| The recommend value
+
| How should the administrator of the site determine what to set this value to.
 
|-
 
|-
 
|  
 
|  

Revision as of 08:32, 11 March 2009

There are some requirements you should specify clearly when making a request for the new webconfig keys:

WebConfig Requirements

Syntax

Syntax of that new key

Description

What is that? What's that used for? (The purpose of the key)

Type

Type of key's value (Int, UInt, Boolean, String...etc)

Required

Is that key required or not?

Default value

The default value for the key, if it is missing. Obviously it makes no sense to have a default, if it is required.

Recommend value

How should the administrator of the site determine what to set this value to.

Validation rule

Describe the validation rule for the key. We will base on these rules to implement the validation method for the

new one. If no any validation rule specified, we will implement the validation base on Type, Required...etc

Example

Give us an example of the new key plz